Class DataSourceInstanceAccessor

Hierarchy (View Summary)

ElementInstanceAccessor<
    DataSourceInstance,
    DataSourceInstanceSelector,
    CreateDataSourceInstanceRequest,
    UpdateDataSourceInstanceRequest,
>
- DataSourceInstanceAccessor

Index

Constructors

constructor

new DataSourceInstanceAccessor(
client: IntegrationAppApiClient,
selector: string | DataSourceInstanceSelector,
): DataSourceInstanceAccessor
Parameters
- client: IntegrationAppApiClient
- selector: string | DataSourceInstanceSelector
Returns DataSourceInstanceAccessor
Overrides ElementInstanceAccessor.constructor
- Defined in data-sources/accessors.ts:101

Properties

`Protected`options

options: {
    client: IntegrationAppApiClient;
    instancePath: string;
    selector: string | DataSourceInstanceSelector;
    type?: WorkspaceElementType;
}

client

client: IntegrationAppApiClient

Methods

getUniqueIdentifier

getUniqueIdentifier(): string
Returns string
Inherited from ElementInstanceAccessor.getUniqueIdentifier
- Defined in accessors.ts:151

get

get(): Promise<DataSourceInstance>
Returns Promise<DataSourceInstance>
Inherited from ElementInstanceAccessor.get
- Defined in accessors.ts:155

getId

getId(): Promise<string>
Returns Promise<string>
Inherited from ElementInstanceAccessor.getId
- Defined in accessors.ts:159

create

create(data?: CreateDataSourceInstanceRequest): Promise<DataSourceInstance>
Parameters
- Optionaldata: CreateDataSourceInstanceRequest
Returns Promise<DataSourceInstance>
Inherited from ElementInstanceAccessor.create
- Defined in accessors.ts:174

put

put(data: CreateDataSourceInstanceRequest): Promise<DataSourceInstance>
Parameters
- data: CreateDataSourceInstanceRequest
Returns Promise<DataSourceInstance>
Inherited from ElementInstanceAccessor.put
- Defined in accessors.ts:193

patch

patch(data: UpdateDataSourceInstanceRequest): Promise<DataSourceInstance>
Parameters
- data: UpdateDataSourceInstanceRequest
Returns Promise<DataSourceInstance>
Inherited from ElementInstanceAccessor.patch
- Defined in accessors.ts:203

archive

archive(): Promise<void>
Returns Promise<void>
Inherited from ElementInstanceAccessor.archive
- Defined in accessors.ts:213

delete

delete(): Promise<void>
Returns Promise<void>
Deprecated
- use archive instead
Inherited from ElementInstanceAccessor.delete
- Defined in accessors.ts:220

restore

restore(): Promise<DataSourceInstance>
Returns Promise<DataSourceInstance>
Inherited from ElementInstanceAccessor.restore
- Defined in accessors.ts:224

`Protected`getPath

getPath(operation?: string): string
Parameters
- operation: string = ''
Returns string
Inherited from ElementInstanceAccessor.getPath
- Defined in accessors.ts:228

setup

setup(): Promise<void>
Returns Promise<void>
- Defined in data-sources/accessors.ts:112

reset

reset(): Promise<void>
Returns Promise<void>
- Defined in data-sources/accessors.ts:116

openConfiguration

openConfiguration(
__namedParameters?: OpenDataSourceConfigurationOptions,
): Promise<void>
Parameters
- __namedParameters: OpenDataSourceConfigurationOptions = {}
Returns Promise<void>
- Defined in data-sources/accessors.ts:120

unifiedFieldsToNative

unifiedFieldsToNative(unifiedFields: any): Promise<any>
Parameters
- unifiedFields: any
Returns Promise<any>
- Defined in data-sources/accessors.ts:128

getCollection

getCollection(): Promise<DataCollectionSpec>
Returns Promise<DataCollectionSpec>
- Defined in data-sources/accessors.ts:132

listRecords

listRecords(
request?: DataCollectionListRequest,
): Promise<DataCollectionListResponse>
Parameters
- request: DataCollectionListRequest = {}
Returns Promise<DataCollectionListResponse>
- Defined in data-sources/accessors.ts:136

matchRecord

matchRecord(
request: DataCollectionMatchRequest,
): Promise<DataCollectionMatchResponse>
Parameters
- request: DataCollectionMatchRequest
Returns Promise<DataCollectionMatchResponse>
- Defined in data-sources/accessors.ts:140

searchRecords

searchRecords(
request: DataCollectionSearchRequest,
): Promise<DataCollectionSearchResponse>
Parameters
- request: DataCollectionSearchRequest
Returns Promise<DataCollectionSearchResponse>
- Defined in data-sources/accessors.ts:144

findRecordById

findRecordById(
request: string | DataCollectionFindByIdRequest,
): Promise<DataCollectionFindByIdResponse>
Parameters
- request: string | DataCollectionFindByIdRequest
Returns Promise<DataCollectionFindByIdResponse>
- Defined in data-sources/accessors.ts:148

createRecord

createRecord(
request: DataCollectionCreateRequest,
): Promise<DataCollectionCreateResponse>
Parameters
- request: DataCollectionCreateRequest
Returns Promise<DataCollectionCreateResponse>
- Defined in data-sources/accessors.ts:154

updateRecord

updateRecord(
request: DataCollectionUpdateRequest,
): Promise<DataCollectionUpdateResponse>
Parameters
- request: DataCollectionUpdateRequest
Returns Promise<DataCollectionUpdateResponse>
- Defined in data-sources/accessors.ts:158

deleteRecord

deleteRecord(
request: string | DataCollectionFindByIdRequest,
): Promise<DataCollectionDeleteResponse>
Parameters
- request: string | DataCollectionFindByIdRequest
Returns Promise<DataCollectionDeleteResponse>
- Defined in data-sources/accessors.ts:162

findRecords

findRecords(
request?: DataCollectionFindRequest,
): Promise<DataCollectionFindResponse>
Parameters
- request: DataCollectionFindRequest = {}
Returns Promise<DataCollectionFindResponse>
Deprecated
- use listRecords instead
- Defined in data-sources/accessors.ts:171