View Source GoogleApi.Connectors.V2.Api.Projects (google_api_connectors v0.10.0)
API calls for all endpoints tagged Projects
.
Summary
Functions
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.
Gets the schema of the given action.
Gets the schema of all the actions supported by the connector.
Reports readiness status of the connector. Similar logic to GetStatus but modified for kubernetes health check to understand.
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.
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.
Deletes an existing entity row matching the entity type and entity id specified in the request.
Deletes entities based on conditions specified in the request and not on entity id.
Gets a single entity row matching the entity type and entity id specified in the request.
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.
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.
Updates entities based on conditions specified in the request and not on entity id.
Gets metadata of given entity type
Lists metadata related to all entity types present in the external system.
ExchangeAuthCode exchanges the OAuth authorization code (and other necessary data) for an access token (and associated credentials).
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'.
RefreshAccessToken exchanges the OAuth refresh token (and other necessary data) for a new access token (and new associated credentials).
Functions
connectors_projects_locations_connections_actions_execute(connection, name, optional_params \\ [], opts \\ [])
View Source@spec connectors_projects_locations_connections_actions_execute( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Connectors.V2.Model.ExecuteActionResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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.
Parameters
-
connection
(type:GoogleApi.Connectors.V2.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. Resource name of the Action. Format: projects/{project}/locations/{location}/connections/{connection}/actions/{action} -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.Connectors.V2.Model.ExecuteActionRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Connectors.V2.Model.ExecuteActionResponse{}}
on success -
{:error, info}
on failure
connectors_projects_locations_connections_actions_get(connection, name, optional_params \\ [], opts \\ [])
View Source@spec connectors_projects_locations_connections_actions_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Connectors.V2.Model.Action.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets the schema of the given action.
Parameters
-
connection
(type:GoogleApi.Connectors.V2.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. Resource name of the Action. Format: projects/{project}/locations/{location}/connections/{connection}/actions/{action} -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Connectors.V2.Model.Action{}}
on success -
{:error, info}
on failure
connectors_projects_locations_connections_actions_list(connection, parent, optional_params \\ [], opts \\ [])
View Source@spec connectors_projects_locations_connections_actions_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Connectors.V2.Model.ListActionsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets the schema of all the actions supported by the connector.
Parameters
-
connection
(type:GoogleApi.Connectors.V2.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. Parent resource name of the Action. Format: projects/{project}/locations/{location}/connections/{connection} -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:pageSize
(type:integer()
) - Number of Actions to return. Defaults to 25. -
:pageToken
(type:String.t
) - Page token, return from a previous ListActions call, that can be used retrieve the next page of content. If unspecified, the request returns the first page of actions. -
:view
(type:String.t
) - Specifies which fields of the Action are returned in the response.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Connectors.V2.Model.ListActionsResponse{}}
on success -
{:error, info}
on failure
connectors_projects_locations_connections_check_readiness(connection, name, optional_params \\ [], opts \\ [])
View Source@spec connectors_projects_locations_connections_check_readiness( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Connectors.V2.Model.CheckReadinessResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Reports readiness status of the connector. Similar logic to GetStatus but modified for kubernetes health check to understand.
Parameters
-
connection
(type:GoogleApi.Connectors.V2.Connection.t
) - Connection to server -
name
(type:String.t
) - -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Connectors.V2.Model.CheckReadinessResponse{}}
on success -
{:error, info}
on failure
connectors_projects_locations_connections_check_status(connection, name, optional_params \\ [], opts \\ [])
View Source@spec connectors_projects_locations_connections_check_status( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Connectors.V2.Model.CheckStatusResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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.
Parameters
-
connection
(type:GoogleApi.Connectors.V2.Connection.t
) - Connection to server -
name
(type:String.t
) - -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Connectors.V2.Model.CheckStatusResponse{}}
on success -
{:error, info}
on failure
connectors_projects_locations_connections_entity_types_entities_create(connection, parent, optional_params \\ [], opts \\ [])
View Source@spec connectors_projects_locations_connections_entity_types_entities_create( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Connectors.V2.Model.Entity.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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.
Parameters
-
connection
(type:GoogleApi.Connectors.V2.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. Resource name of the Entity Type. Format: projects/{project}/locations/{location}/connections/{connection}/entityTypes/{type} -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.Connectors.V2.Model.Entity.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Connectors.V2.Model.Entity{}}
on success -
{:error, info}
on failure
connectors_projects_locations_connections_entity_types_entities_delete(connection, name, optional_params \\ [], opts \\ [])
View Source@spec connectors_projects_locations_connections_entity_types_entities_delete( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Connectors.V2.Model.Empty.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Deletes an existing entity row matching the entity type and entity id specified in the request.
Parameters
-
connection
(type:GoogleApi.Connectors.V2.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. Resource name of the Entity Type. Format: projects/{project}/locations/{location}/connections/{connection}/entityTypes/{type}/entities/{id} -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Connectors.V2.Model.Empty{}}
on success -
{:error, info}
on failure
connectors_projects_locations_connections_entity_types_entities_delete_entities_with_conditions(connection, entity_type, optional_params \\ [], opts \\ [])
View Source@spec connectors_projects_locations_connections_entity_types_entities_delete_entities_with_conditions( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Connectors.V2.Model.Empty.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Deletes entities based on conditions specified in the request and not on entity id.
Parameters
-
connection
(type:GoogleApi.Connectors.V2.Connection.t
) - Connection to server -
entity_type
(type:String.t
) - Required. Resource name of the Entity Type. Format: projects/{project}/locations/{location}/connections/{connection}/entityTypes/{type} -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:conditions
(type:String.t
) - Required. Conditions to be used when deleting entities. From a proto standpoint, There are no restrictions on what can be passed using this field. The connector documentation should have information about what format of filters/conditions are supported. Note: If this conditions field is left empty, an exception is thrown. We don't want to consider 'empty conditions' to be a match-all case. Connector developers can determine and document what a match-all case constraint would be.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Connectors.V2.Model.Empty{}}
on success -
{:error, info}
on failure
connectors_projects_locations_connections_entity_types_entities_get(connection, name, optional_params \\ [], opts \\ [])
View Source@spec connectors_projects_locations_connections_entity_types_entities_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Connectors.V2.Model.Entity.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets a single entity row matching the entity type and entity id specified in the request.
Parameters
-
connection
(type:GoogleApi.Connectors.V2.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. Resource name of the Entity Type. Format: projects/{project}/locations/{location}/connections/{connection}/entityTypes/{type}/entities/{id} -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Connectors.V2.Model.Entity{}}
on success -
{:error, info}
on failure
connectors_projects_locations_connections_entity_types_entities_list(connection, parent, optional_params \\ [], opts \\ [])
View Source@spec connectors_projects_locations_connections_entity_types_entities_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Connectors.V2.Model.ListEntitiesResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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.
Parameters
-
connection
(type:GoogleApi.Connectors.V2.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. Resource name of the Entity Type. Format: projects/{project}/locations/{location}/connections/{connection}/entityTypes/{type} -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:conditions
(type:String.t
) - Conditions to be used when listing entities. From a proto standpoint, There are no restrictions on what can be passed using this field. The connector documentation should have information about what format of filters/conditions are supported. -
:pageSize
(type:integer()
) - Number of entity rows to return. Defaults page size = 25. Max page size = 200. -
:pageToken
(type:String.t
) - Page token value if available from a previous request. -
:sortBy
(type:list(String.t)
) - List of 'sort_by' columns to use when returning the results.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Connectors.V2.Model.ListEntitiesResponse{}}
on success -
{:error, info}
on failure
connectors_projects_locations_connections_entity_types_entities_patch(connection, name, optional_params \\ [], opts \\ [])
View Source@spec connectors_projects_locations_connections_entity_types_entities_patch( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Connectors.V2.Model.Entity.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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.
Parameters
-
connection
(type:GoogleApi.Connectors.V2.Connection.t
) - Connection to server -
name
(type:String.t
) - Output only. Resource name of the Entity. Format: projects/{project}/locations/{location}/connections/{connection}/entityTypes/{type}/entities/{id} -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.Connectors.V2.Model.Entity.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Connectors.V2.Model.Entity{}}
on success -
{:error, info}
on failure
connectors_projects_locations_connections_entity_types_entities_update_entities_with_conditions(connection, entity_type, optional_params \\ [], opts \\ [])
View Source@spec connectors_projects_locations_connections_entity_types_entities_update_entities_with_conditions( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Connectors.V2.Model.UpdateEntitiesWithConditionsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Updates entities based on conditions specified in the request and not on entity id.
Parameters
-
connection
(type:GoogleApi.Connectors.V2.Connection.t
) - Connection to server -
entity_type
(type:String.t
) - Required. Resource name of the Entity Type. Format: projects/{project}/locations/{location}/connections/{connection}/entityTypes/{type} -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:conditions
(type:String.t
) - Required. Conditions to be used when updating entities. From a proto standpoint, There are no restrictions on what can be passed using this field. The connector documentation should have information about what format of filters/conditions are supported. Note: If this conditions field is left empty, an exception is thrown. We don't want to consider 'empty conditions' to be a match-all case. Connector developers can determine and document what a match-all case constraint would be. -
:body
(type:GoogleApi.Connectors.V2.Model.Entity.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Connectors.V2.Model.UpdateEntitiesWithConditionsResponse{}}
on success -
{:error, info}
on failure
connectors_projects_locations_connections_entity_types_get(connection, name, optional_params \\ [], opts \\ [])
View Source@spec connectors_projects_locations_connections_entity_types_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Connectors.V2.Model.EntityType.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets metadata of given entity type
Parameters
-
connection
(type:GoogleApi.Connectors.V2.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. Resource name of the Entity Type. Format: projects/{project}/locations/{location}/connections/{connection}/entityTypes/{entityType} -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Connectors.V2.Model.EntityType{}}
on success -
{:error, info}
on failure
connectors_projects_locations_connections_entity_types_list(connection, parent, optional_params \\ [], opts \\ [])
View Source@spec connectors_projects_locations_connections_entity_types_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Connectors.V2.Model.ListEntityTypesResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists metadata related to all entity types present in the external system.
Parameters
-
connection
(type:GoogleApi.Connectors.V2.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. Resource name of the Entity Type. Format: projects/{project}/locations/{location}/connections/{connection} -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:pageSize
(type:integer()
) - Number of entity types to return. Defaults to 25. -
:pageToken
(type:String.t
) - Page token, return from a previous ListEntityTypes call, that can be used retrieve the next page of content. If unspecified, the request returns the first page of entity types. -
:view
(type:String.t
) - Specifies which fields of the Entity Type are returned in the response.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Connectors.V2.Model.ListEntityTypesResponse{}}
on success -
{:error, info}
on failure
connectors_projects_locations_connections_exchange_auth_code(connection, name, optional_params \\ [], opts \\ [])
View Source@spec connectors_projects_locations_connections_exchange_auth_code( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Connectors.V2.Model.ExchangeAuthCodeResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
ExchangeAuthCode exchanges the OAuth authorization code (and other necessary data) for an access token (and associated credentials).
Parameters
-
connection
(type:GoogleApi.Connectors.V2.Connection.t
) - Connection to server -
name
(type:String.t
) - -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.Connectors.V2.Model.ExchangeAuthCodeRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Connectors.V2.Model.ExchangeAuthCodeResponse{}}
on success -
{:error, info}
on failure
connectors_projects_locations_connections_execute_sql_query(connection, connection, optional_params \\ [], opts \\ [])
View Source@spec connectors_projects_locations_connections_execute_sql_query( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Connectors.V2.Model.ExecuteSqlQueryResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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'.
Parameters
-
connection
(type:GoogleApi.Connectors.V2.Connection.t
) - Connection to server -
connection
(type:String.t
) - Required. Resource name of the Connection. Format: projects/{project}/locations/{location}/connections/{connection} -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.Connectors.V2.Model.ExecuteSqlQueryRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Connectors.V2.Model.ExecuteSqlQueryResponse{}}
on success -
{:error, info}
on failure
connectors_projects_locations_connections_refresh_access_token(connection, name, optional_params \\ [], opts \\ [])
View Source@spec connectors_projects_locations_connections_refresh_access_token( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Connectors.V2.Model.RefreshAccessTokenResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
RefreshAccessToken exchanges the OAuth refresh token (and other necessary data) for a new access token (and new associated credentials).
Parameters
-
connection
(type:GoogleApi.Connectors.V2.Connection.t
) - Connection to server -
name
(type:String.t
) - -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.Connectors.V2.Model.RefreshAccessTokenRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Connectors.V2.Model.RefreshAccessTokenResponse{}}
on success -
{:error, info}
on failure