Connectors

import { Connectors } from "https://googleapis.deno.dev/v1/connectors:v2.ts";

Enables users to create and manage connections to Google Cloud services and third-party business applications using the Connectors interface.

class Connectors {

constructor(client?: CredentialsClient, baseUrl?: string);

async projectsLocationsConnectionsActionsExecute(name: string, req: ExecuteActionRequest): Promise<ExecuteActionResponse>;

async projectsLocationsConnectionsActionsGet(name: string): Promise<Action>;

async projectsLocationsConnectionsActionsList(parent: string, opts?: ProjectsLocationsConnectionsActionsListOptions): Promise<ListActionsResponse>;

async projectsLocationsConnectionsCheckReadiness(name: string): Promise<CheckReadinessResponse>;

async projectsLocationsConnectionsCheckStatus(name: string): Promise<CheckStatusResponse>;

async projectsLocationsConnectionsEntityTypesEntitiesCreate(parent: string, req: Entity): Promise<Entity>;

async projectsLocationsConnectionsEntityTypesEntitiesDelete(name: string): Promise<Empty>;

async projectsLocationsConnectionsEntityTypesEntitiesDeleteEntitiesWithConditions(entityType: string, opts?: ProjectsLocationsConnectionsEntityTypesEntitiesDeleteEntitiesWithConditionsOptions): Promise<Empty>;

async projectsLocationsConnectionsEntityTypesEntitiesGet(name: string): Promise<Entity>;

async projectsLocationsConnectionsEntityTypesEntitiesList(parent: string, opts?: ProjectsLocationsConnectionsEntityTypesEntitiesListOptions): Promise<ListEntitiesResponse>;

async projectsLocationsConnectionsEntityTypesEntitiesPatch(name: string, req: Entity): Promise<Entity>;

async projectsLocationsConnectionsEntityTypesEntitiesUpdateEntitiesWithConditions(

entityType: string,

req: Entity,

opts?: ProjectsLocationsConnectionsEntityTypesEntitiesUpdateEntitiesWithConditionsOptions,

): Promise<UpdateEntitiesWithConditionsResponse>;

async projectsLocationsConnectionsEntityTypesGet(name: string): Promise<EntityType>;

async projectsLocationsConnectionsEntityTypesList(parent: string, opts?: ProjectsLocationsConnectionsEntityTypesListOptions): Promise<ListEntityTypesResponse>;

async projectsLocationsConnectionsExchangeAuthCode(name: string, req: ExchangeAuthCodeRequest): Promise<ExchangeAuthCodeResponse>;

async projectsLocationsConnectionsExecuteSqlQuery(connection: string, req: ExecuteSqlQueryRequest): Promise<ExecuteSqlQueryResponse>;

async projectsLocationsConnectionsRefreshAccessToken(name: string, req: RefreshAccessTokenRequest): Promise<RefreshAccessTokenResponse>;

}

§Constructors

new Connectors(client?: CredentialsClient, baseUrl?: string)

[src]

§Methods

projectsLocationsConnectionsActionsExecute(name: string, req: ExecuteActionRequest): Promise<ExecuteActionResponse>

[src]

Executes an action with the name specified in the request. The input parameters for executing the action are passed through the body of the ExecuteAction request.

@param name

Required. Resource name of the Action. Format: projects/{project}/locations/{location}/connections/{connection}/actions/{action}

projectsLocationsConnectionsActionsGet(name: string): Promise<Action>

[src]

Gets the schema of the given action.

@param name

Required. Resource name of the Action. Format: projects/{project}/locations/{location}/connections/{connection}/actions/{action}

projectsLocationsConnectionsActionsList(parent: string, opts?: ProjectsLocationsConnectionsActionsListOptions): Promise<ListActionsResponse>

[src]

Gets the schema of all the actions supported by the connector.

@param parent

Required. Parent resource name of the Action. Format: projects/{project}/locations/{location}/connections/{connection}

projectsLocationsConnectionsCheckReadiness(name: string): Promise<CheckReadinessResponse>

[src]

Reports readiness status of the connector. Similar logic to GetStatus but modified for kubernetes health check to understand.

projectsLocationsConnectionsCheckStatus(name: string): Promise<CheckStatusResponse>

[src]

Reports the status of the connection. Note that when the connection is in a state that is not ACTIVE, the implementation of this RPC method must return a Status with the corresponding State instead of returning a gRPC status code that is not "OK", which indicates that ConnectionStatus itself, not the connection, failed.

projectsLocationsConnectionsEntityTypesEntitiesCreate(parent: string, req: Entity): Promise<Entity>

[src]

Creates a new entity row of the specified entity type in the external system. The field values for creating the row are contained in the body of the request. The response message contains a Entity message object returned as a response by the external system.

@param parent

Required. Resource name of the Entity Type. Format: projects/{project}/locations/{location}/connections/{connection}/entityTypes/{type}

projectsLocationsConnectionsEntityTypesEntitiesDelete(name: string): Promise<Empty>

[src]

Deletes an existing entity row matching the entity type and entity id specified in the request.

@param name

Required. Resource name of the Entity Type. Format: projects/{project}/locations/{location}/connections/{connection}/entityTypes/{type}/entities/{id}

projectsLocationsConnectionsEntityTypesEntitiesDeleteEntitiesWithConditions(entityType: string, opts?: ProjectsLocationsConnectionsEntityTypesEntitiesDeleteEntitiesWithConditionsOptions): Promise<Empty>

[src]

Deletes entities based on conditions specified in the request and not on entity id.

@param entityType

Required. Resource name of the Entity Type. Format: projects/{project}/locations/{location}/connections/{connection}/entityTypes/{type}

projectsLocationsConnectionsEntityTypesEntitiesGet(name: string): Promise<Entity>

[src]

Gets a single entity row matching the entity type and entity id specified in the request.

@param name

Required. Resource name of the Entity Type. Format: projects/{project}/locations/{location}/connections/{connection}/entityTypes/{type}/entities/{id}

projectsLocationsConnectionsEntityTypesEntitiesList(parent: string, opts?: ProjectsLocationsConnectionsEntityTypesEntitiesListOptions): Promise<ListEntitiesResponse>

[src]

Lists entity rows of a particular entity type contained in the request. Note: 1. Currently, only max of one 'sort_by' column is supported. 2. If no 'sort_by' column is provided, the primary key of the table is used. If zero or more than one primary key is available, we default to the unpaginated list entities logic which only returns the first page. 3. The values of the 'sort_by' columns must uniquely identify an entity row, otherwise undefined behaviors may be observed during pagination. 4. Since transactions are not supported, any updates, inserts or deletes during pagination can lead to stale data being returned or other unexpected behaviors.

@param parent

Required. Resource name of the Entity Type. Format: projects/{project}/locations/{location}/connections/{connection}/entityTypes/{type}

projectsLocationsConnectionsEntityTypesEntitiesPatch(name: string, req: Entity): Promise<Entity>

[src]

Updates an existing entity row matching the entity type and entity id specified in the request. The fields in the entity row that need to be modified are contained in the body of the request. All unspecified fields are left unchanged. The response message contains a Entity message object returned as a response by the external system.

@param name

Output only. Resource name of the Entity. Format: projects/{project}/locations/{location}/connections/{connection}/entityTypes/{type}/entities/{id}

projectsLocationsConnectionsEntityTypesEntitiesUpdateEntitiesWithConditions(entityType: string, req: Entity, opts?: ProjectsLocationsConnectionsEntityTypesEntitiesUpdateEntitiesWithConditionsOptions): Promise<UpdateEntitiesWithConditionsResponse>

[src]

Updates entities based on conditions specified in the request and not on entity id.

@param entityType

Required. Resource name of the Entity Type. Format: projects/{project}/locations/{location}/connections/{connection}/entityTypes/{type}

projectsLocationsConnectionsEntityTypesGet(name: string): Promise<EntityType>

[src]

Gets metadata of given entity type

@param name

Required. Resource name of the Entity Type. Format: projects/{project}/locations/{location}/connections/{connection}/entityTypes/{entityType}

projectsLocationsConnectionsEntityTypesList(parent: string, opts?: ProjectsLocationsConnectionsEntityTypesListOptions): Promise<ListEntityTypesResponse>

[src]

Lists metadata related to all entity types present in the external system.

@param parent

Required. Resource name of the Entity Type. Format: projects/{project}/locations/{location}/connections/{connection}

projectsLocationsConnectionsExchangeAuthCode(name: string, req: ExchangeAuthCodeRequest): Promise<ExchangeAuthCodeResponse>

[src]

ExchangeAuthCode exchanges the OAuth authorization code (and other necessary data) for an access token (and associated credentials).

projectsLocationsConnectionsExecuteSqlQuery(connection: string, req: ExecuteSqlQueryRequest): Promise<ExecuteSqlQueryResponse>

[src]

Executes a SQL statement specified in the body of the request. An example of this SQL statement in the case of Salesforce connector would be 'select

from Account a, Order o where a.Id = o.AccountId'.

@param connection

Required. Resource name of the Connection. Format: projects/{project}/locations/{location}/connections/{connection}

projectsLocationsConnectionsRefreshAccessToken(name: string, req: RefreshAccessTokenRequest): Promise<RefreshAccessTokenResponse>

[src]

RefreshAccessToken exchanges the OAuth refresh token (and other necessary data) for a new access token (and new associated credentials).