Interface DirectAccessAgentsAPI

interface DirectAccessAgentsAPI {
    clearCache: () => void;
    getDirectAccessAgentConfiguration: (
        agentId: string,
        query: { queryProperties?: string[] },
        options?: ApiCallOptions,
    ) => Promise<GetDirectAccessAgentConfigurationHttpResponse>;
    getDirectAccessAgentConnectorCustomDataTypeMappings: (
        agentId: string,
        connectorType: string,
        options?: ApiCallOptions,
    ) => Promise<
        GetDirectAccessAgentConnectorCustomDataTypeMappingsHttpResponse,
    >;
    getDirectAccessAgentConnectorFile: (
        agentId: string,
        connectorType: string,
        fileType: string,
        options?: ApiCallOptions,
    ) => Promise<GetDirectAccessAgentConnectorFileHttpResponse>;
    getDirectAccessAgentConnectorFiles: (
        agentId: string,
        connectorType: string,
        query: Record<string, unknown>,
        options?: ApiCallOptions,
    ) => Promise<GetDirectAccessAgentConnectorFilesHttpResponse>;
    getDirectAccessAgentConnectorFilesWithoutQuery: (
        agentId: string,
        connectorType: string,
        options?: ApiCallOptions,
    ) => Promise<GetDirectAccessAgentConnectorFilesWithoutQueryHttpResponse>;
    patchDirectAccessAgentConfiguration: (
        agentId: string,
        body: Operation[],
        options?: ApiCallOptions,
    ) => Promise<PatchDirectAccessAgentConfigurationHttpResponse>;
    putDirectAccessAgentConnectorCustomDataTypeMappings: (
        agentId: string,
        connectorType: string,
        body: UpdateOdbcCustomTypeMappingsRequest,
        options?: ApiCallOptions,
    ) => Promise<
        PutDirectAccessAgentConnectorCustomDataTypeMappingsHttpResponse,
    >;
    restartDirectAccessAgent: (
        agentId: string,
        agentAction: string,
        options?: ApiCallOptions,
    ) => Promise<RestartDirectAccessAgentHttpResponse>;
    updateDirectAccessAgentConnectorFile: (
        agentId: string,
        connectorType: string,
        fileType: string,
        query: Record<string, unknown>,
        body: UpdateConfigurationFlatFileRequest,
        options?: ApiCallOptions,
    ) => Promise<UpdateDirectAccessAgentConnectorFileHttpResponse>;
    updateDirectAccessAgentConnectorFileWithoutQuery: (
        agentId: string,
        connectorType: string,
        fileType: string,
        body: UpdateConfigurationFlatFileRequest,
        options?: ApiCallOptions,
    ) => Promise<UpdateDirectAccessAgentConnectorFileWithoutQueryHttpResponse>;
}
Index

Properties

clearCache getDirectAccessAgentConfiguration getDirectAccessAgentConnectorCustomDataTypeMappings getDirectAccessAgentConnectorFile getDirectAccessAgentConnectorFiles getDirectAccessAgentConnectorFilesWithoutQuery patchDirectAccessAgentConfiguration putDirectAccessAgentConnectorCustomDataTypeMappings restartDirectAccessAgent updateDirectAccessAgentConnectorFile updateDirectAccessAgentConnectorFileWithoutQuery

Properties

clearCache: () => void

Clears the cache for direct-access-agents api requests.

Type declaration

    • (): void

    • Clears the cache for direct-access-agents api requests.

      Returns void

getDirectAccessAgentConfiguration: (
    agentId: string,
    query: { queryProperties?: string[] },
    options?: ApiCallOptions,
) => Promise<GetDirectAccessAgentConfigurationHttpResponse>

Retrieves the connector agent configuration from the specified agent. Requestor must be assigned the TenantAdmin role and needs to be either a Gateway's space owner or a member in the Gateway's space with Can Consume Data role. Available in Direct Access Gateway V1.7.2+.

Type declaration

    • (
          agentId: string,
          query: { queryProperties?: string[] },
          options?: ApiCallOptions,
      ): Promise<GetDirectAccessAgentConfigurationHttpResponse>

    • Retrieves the connector agent configuration from the specified agent. Requestor must be assigned the TenantAdmin role and needs to be either a Gateway's space owner or a member in the Gateway's space with Can Consume Data role. Available in Direct Access Gateway V1.7.2+.

      Parameters

      • agentId: string

        The agent ID

      • query: { queryProperties?: string[] }

        an object with query parameters

        • OptionalqueryProperties?: string[]

          Individual properties within the agent configuration

      • Optionaloptions: ApiCallOptions

      Returns Promise<GetDirectAccessAgentConfigurationHttpResponse>

      GetDirectAccessAgentConfigurationHttpError

The agent ID

an object with query parameters

GetDirectAccessAgentConfigurationHttpError

getDirectAccessAgentConnectorCustomDataTypeMappings: (
    agentId: string,
    connectorType: string,
    options?: ApiCallOptions,
) => Promise<
    GetDirectAccessAgentConnectorCustomDataTypeMappingsHttpResponse,
>

Retrieves custom data type mapping settings for the Generic ODBC Connector. Requestor must be assigned the TenantAdmin role. Available in Direct Access Gateway V1.7.5+.

Type declaration

The agent ID.

The connector type. Must be odbc-connector for this endpoint.

GetDirectAccessAgentConnectorCustomDataTypeMappingsHttpError

getDirectAccessAgentConnectorFile: (
    agentId: string,
    connectorType: string,
    fileType: string,
    options?: ApiCallOptions,
) => Promise<GetDirectAccessAgentConnectorFileHttpResponse>

Retrieves the configuration items in the flat file for the specified connector. Requestor must be assigned the TenantAdmin role and needs to be either a Gateway's space owner or a member in the Gateway's space with Can Consume Data role. Available in Direct Access Gateway V1.7.4+.

Type declaration

    • (
          agentId: string,
          connectorType: string,
          fileType: string,
          options?: ApiCallOptions,
      ): Promise<GetDirectAccessAgentConnectorFileHttpResponse>

    • Retrieves the configuration items in the flat file for the specified connector. Requestor must be assigned the TenantAdmin role and needs to be either a Gateway's space owner or a member in the Gateway's space with Can Consume Data role. Available in Direct Access Gateway V1.7.4+.

      Parameters

      • agentId: string

        The agent ID

      • connectorType: string

        The connector type to retrieve

      • fileType: string

        The type of file to retrieve

      • Optionaloptions: ApiCallOptions

      Returns Promise<GetDirectAccessAgentConnectorFileHttpResponse>

      GetDirectAccessAgentConnectorFileHttpError

The agent ID

The connector type to retrieve

The type of file to retrieve

GetDirectAccessAgentConnectorFileHttpError

getDirectAccessAgentConnectorFiles: (
    agentId: string,
    connectorType: string,
    query: Record<string, unknown>,
    options?: ApiCallOptions,
) => Promise<GetDirectAccessAgentConnectorFilesHttpResponse>

Retrieves the configuration files associated with the connector. Requestor must be assigned the TenantAdmin role and needs to be either a Gateway's space owner or a member in the Gateway's space with Can Consume Data role. Available in Direct Access Gateway V1.7.4+.

Type declaration

    • (
          agentId: string,
          connectorType: string,
          query: Record<string, unknown>,
          options?: ApiCallOptions,
      ): Promise<GetDirectAccessAgentConnectorFilesHttpResponse>

    • Retrieves the configuration files associated with the connector. Requestor must be assigned the TenantAdmin role and needs to be either a Gateway's space owner or a member in the Gateway's space with Can Consume Data role. Available in Direct Access Gateway V1.7.4+.

      Parameters

      • agentId: string

        The agent ID

      • connectorType: string

        The connector to retrieve the list of files for

      • query: Record<string, unknown>

        an object with query parameters

      • Optionaloptions: ApiCallOptions

      Returns Promise<GetDirectAccessAgentConnectorFilesHttpResponse>

      GetDirectAccessAgentConnectorFilesHttpError

The agent ID

The connector to retrieve the list of files for

an object with query parameters

GetDirectAccessAgentConnectorFilesHttpError

getDirectAccessAgentConnectorFilesWithoutQuery: (
    agentId: string,
    connectorType: string,
    options?: ApiCallOptions,
) => Promise<GetDirectAccessAgentConnectorFilesWithoutQueryHttpResponse>

Retrieves the configuration files associated with the connector. Requestor must be assigned the TenantAdmin role and needs to be either a Gateway's space owner or a member in the Gateway's space with Can Consume Data role. Available in Direct Access Gateway V1.7.4+.

Type declaration

The agent ID

The connector to retrieve the list of files for

GetDirectAccessAgentConnectorFilesWithoutQueryHttpError

patchDirectAccessAgentConfiguration: (
    agentId: string,
    body: Operation[],
    options?: ApiCallOptions,
) => Promise<PatchDirectAccessAgentConfigurationHttpResponse>

Makes changes to the local agent configuration using JSON Patch. Requestor must be assigned the TenantAdmin role and needs to be either a Gateway's space owner or a member in the Gateway's space with Can Consume Data role. Available in Direct Access Gateway V1.7.2+.

Type declaration

The agent ID

Param: body

an object with the body content

PatchDirectAccessAgentConfigurationHttpError

putDirectAccessAgentConnectorCustomDataTypeMappings: (
    agentId: string,
    connectorType: string,
    body: UpdateOdbcCustomTypeMappingsRequest,
    options?: ApiCallOptions,
) => Promise<
    PutDirectAccessAgentConnectorCustomDataTypeMappingsHttpResponse,
>

Completely replaces the contents of the custom data type mapping configuration file for the Generic ODBC connector. Partial updates are not supported. There are property naming differences between the API and the file contents. Use the API property format when making changes. Requestor must be assigned the TenantAdmin role. Available in Direct Access Gateway V1.7.5+.

Type declaration

The agent ID.

The connector type. Must be odbc-connector for this endpoint.

Param: body

an object with the body content

PutDirectAccessAgentConnectorCustomDataTypeMappingsHttpError

restartDirectAccessAgent: (
    agentId: string,
    agentAction: string,
    options?: ApiCallOptions,
) => Promise<RestartDirectAccessAgentHttpResponse>

Restarts the specified agent. If a reload is in RELOADING status the restart action will be ignored. Use force-restart to restart the agent even if a reload is in RELOADING status. Requestor must be assigned the TenantAdmin role and needs to be either a Gateway's space owner or a member in the Gateway's space with Can Consume Data role. Available in Direct Access Gateway V1.7.2+.

Type declaration

    • (
          agentId: string,
          agentAction: string,
          options?: ApiCallOptions,
      ): Promise<RestartDirectAccessAgentHttpResponse>

    • Restarts the specified agent. If a reload is in RELOADING status the restart action will be ignored. Use force-restart to restart the agent even if a reload is in RELOADING status. Requestor must be assigned the TenantAdmin role and needs to be either a Gateway's space owner or a member in the Gateway's space with Can Consume Data role. Available in Direct Access Gateway V1.7.2+.

      Parameters

      • agentId: string

        The agent ID

      • agentAction: string

        The type of action to perform. Permitted values are restart (will not restart the agent if a reload is in RELOADING status) and force-restart (will restart the agent even if a reload is in RELOADING status).

      • Optionaloptions: ApiCallOptions

      Returns Promise<RestartDirectAccessAgentHttpResponse>

      RestartDirectAccessAgentHttpError

The agent ID

The type of action to perform. Permitted values are restart (will not restart the agent if a reload is in RELOADING status) and force-restart (will restart the agent even if a reload is in RELOADING status).

RestartDirectAccessAgentHttpError

updateDirectAccessAgentConnectorFile: (
    agentId: string,
    connectorType: string,
    fileType: string,
    query: Record<string, unknown>,
    body: UpdateConfigurationFlatFileRequest,
    options?: ApiCallOptions,
) => Promise<UpdateDirectAccessAgentConnectorFileHttpResponse>

Completely replaces the contents of the connector's configuration file. Partial updates are not supported. Requestor must be assigned the TenantAdmin role and needs to be either a Gateway's space owner or a member in the Gateway's space with Can Consume Data role. Available in Direct Access Gateway V1.7.4+.

Type declaration

    • (
          agentId: string,
          connectorType: string,
          fileType: string,
          query: Record<string, unknown>,
          body: UpdateConfigurationFlatFileRequest,
          options?: ApiCallOptions,
      ): Promise<UpdateDirectAccessAgentConnectorFileHttpResponse>

    • Completely replaces the contents of the connector's configuration file. Partial updates are not supported. Requestor must be assigned the TenantAdmin role and needs to be either a Gateway's space owner or a member in the Gateway's space with Can Consume Data role. Available in Direct Access Gateway V1.7.4+.

      Parameters

      • agentId: string

        The agent ID

      • connectorType: string

        The connector type to update

      • fileType: string

        The file type to update

      • query: Record<string, unknown>

        an object with query parameters

      • body: UpdateConfigurationFlatFileRequest

        an object with the body content

      • Optionaloptions: ApiCallOptions

      Returns Promise<UpdateDirectAccessAgentConnectorFileHttpResponse>

      UpdateDirectAccessAgentConnectorFileHttpError

The agent ID

The connector type to update

The file type to update

an object with query parameters

Param: body

an object with the body content

UpdateDirectAccessAgentConnectorFileHttpError

updateDirectAccessAgentConnectorFileWithoutQuery: (
    agentId: string,
    connectorType: string,
    fileType: string,
    body: UpdateConfigurationFlatFileRequest,
    options?: ApiCallOptions,
) => Promise<UpdateDirectAccessAgentConnectorFileWithoutQueryHttpResponse>

Completely replaces the contents of the connector's configuration file. Partial updates are not supported. Requestor must be assigned the TenantAdmin role and needs to be either a Gateway's space owner or a member in the Gateway's space with Can Consume Data role. Available in Direct Access Gateway V1.7.4+.

Type declaration

The agent ID

The connector type to update

The file type to update

Param: body

an object with the body content

UpdateDirectAccessAgentConnectorFileWithoutQueryHttpError

Settings

Member Visibility

On This Page

Properties