Show / Hide Table of Contents

Namespace Google.Apis.Connectors.v2

Classes

ConnectorsBaseServiceRequest<TResponse>

A base abstract class for Connectors requests.

ConnectorsService

The Connectors Service.

ConnectorsService.Scope

Available OAuth 2.0 scopes for use with the Connectors API.

ConnectorsService.ScopeConstants

Available OAuth 2.0 scope constants for use with the Connectors API.

ProjectsResource

The "projects" collection of methods.

ProjectsResource.LocationsResource

The "locations" collection of methods.

ProjectsResource.LocationsResource.ConnectionsResource

The "connections" collection of methods.

ProjectsResource.LocationsResource.ConnectionsResource.ActionsResource

The "actions" collection of methods.

ProjectsResource.LocationsResource.ConnectionsResource.ActionsResource.ExecuteRequest

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.

ProjectsResource.LocationsResource.ConnectionsResource.ActionsResource.GetRequest

Gets the schema of the given action.

ProjectsResource.LocationsResource.ConnectionsResource.ActionsResource.ListRequest

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

ProjectsResource.LocationsResource.ConnectionsResource.CheckReadinessRequest

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

ProjectsResource.LocationsResource.ConnectionsResource.CheckStatusRequest

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.

ProjectsResource.LocationsResource.ConnectionsResource.EntityTypesResource

The "entityTypes" collection of methods.

ProjectsResource.LocationsResource.ConnectionsResource.EntityTypesResource.EntitiesResource

The "entities" collection of methods.

ProjectsResource.LocationsResource.ConnectionsResource.EntityTypesResource.EntitiesResource.CreateRequest

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.

ProjectsResource.LocationsResource.ConnectionsResource.EntityTypesResource.EntitiesResource.DeleteEntitiesWithConditionsRequest

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

ProjectsResource.LocationsResource.ConnectionsResource.EntityTypesResource.EntitiesResource.DeleteRequest

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

ProjectsResource.LocationsResource.ConnectionsResource.EntityTypesResource.EntitiesResource.GetRequest

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

ProjectsResource.LocationsResource.ConnectionsResource.EntityTypesResource.EntitiesResource.ListRequest

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.

ProjectsResource.LocationsResource.ConnectionsResource.EntityTypesResource.EntitiesResource.PatchRequest

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.

ProjectsResource.LocationsResource.ConnectionsResource.EntityTypesResource.EntitiesResource.UpdateEntitiesWithConditionsRequest

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

ProjectsResource.LocationsResource.ConnectionsResource.EntityTypesResource.GetRequest

Gets metadata of given entity type

ProjectsResource.LocationsResource.ConnectionsResource.EntityTypesResource.ListRequest

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

ProjectsResource.LocationsResource.ConnectionsResource.ExchangeAuthCodeRequest

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

ProjectsResource.LocationsResource.ConnectionsResource.ExecuteSqlQueryRequest

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'.

ProjectsResource.LocationsResource.ConnectionsResource.RefreshAccessTokenRequest

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

Enums

ConnectorsBaseServiceRequest<TResponse>.AltEnum

Data format for response.

ConnectorsBaseServiceRequest<TResponse>.XgafvEnum

V1 error format.

ProjectsResource.LocationsResource.ConnectionsResource.ActionsResource.GetRequest.ViewEnum

Specified view of the action schema.

ProjectsResource.LocationsResource.ConnectionsResource.ActionsResource.ListRequest.ViewEnum

Specifies which fields of the Action are returned in the response.

ProjectsResource.LocationsResource.ConnectionsResource.EntityTypesResource.GetRequest.ViewEnum

Specifies view for entity type schema.

ProjectsResource.LocationsResource.ConnectionsResource.EntityTypesResource.ListRequest.ViewEnum

Specifies which fields of the Entity Type are returned in the response.

In this article
Back to top Generated by DocFX