Class: Google::Apis::ConnectorsV2::ConnectorsService

Inherits:
Google::Apis::Core::BaseService
  • Object
show all
Defined in:
lib/google/apis/connectors_v2/service.rb

Overview

Connectors API

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

Examples:

require 'google/apis/connectors_v2'

Connectors = Google::Apis::ConnectorsV2 # Alias the module
service = Connectors::ConnectorsService.new

See Also:

Constant Summary collapse

DEFAULT_ENDPOINT_TEMPLATE = 
"https://connectors.$UNIVERSE_DOMAIN$/"

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ ConnectorsService

Returns a new instance of ConnectorsService.



48
49
50
51
52
53
 
# File 'lib/google/apis/connectors_v2/service.rb', line 48

def initialize
  super(DEFAULT_ENDPOINT_TEMPLATE, '',
        client_name: 'google-apis-connectors_v2',
        client_version: Google::Apis::ConnectorsV2::GEM_VERSION)
  @batch_path = 'batch'
end

Instance Attribute Details

#key ⇒ String

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

Returns:

  • (String) —

    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.



41
42
43
 
# File 'lib/google/apis/connectors_v2/service.rb', line 41

def key
  @key
end

#quota_user ⇒ String

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

Returns:

  • (String) —

    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.



46
47
48
 
# File 'lib/google/apis/connectors_v2/service.rb', line 46

def quota_user
  @quota_user
end

Instance Method Details

#check_project_location_connection_readiness(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ConnectorsV2::CheckReadinessResponse

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

Parameters:

  • name (String)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



75
76
77
78
79
80
81
82
83
 
# File 'lib/google/apis/connectors_v2/service.rb', line 75

def check_project_location_connection_readiness(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/{+name}:checkReadiness', options)
  command.response_representation = Google::Apis::ConnectorsV2::CheckReadinessResponse::Representation
  command.response_class = Google::Apis::ConnectorsV2::CheckReadinessResponse
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#check_project_location_connection_status(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ConnectorsV2::CheckStatusResponse

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:

  • name (String)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



108
109
110
111
112
113
114
115
116
 
# File 'lib/google/apis/connectors_v2/service.rb', line 108

def check_project_location_connection_status(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/{+name}:checkStatus', options)
  command.response_representation = Google::Apis::ConnectorsV2::CheckStatusResponse::Representation
  command.response_class = Google::Apis::ConnectorsV2::CheckStatusResponse
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_connection_entity_type_entity(parent, entity_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ConnectorsV2::Entity

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:

  • parent (String) —

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

  • entity_object (Google::Apis::ConnectorsV2::Entity) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



427
428
429
430
431
432
433
434
435
436
437
 
# File 'lib/google/apis/connectors_v2/service.rb', line 427

def create_project_location_connection_entity_type_entity(parent, entity_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/{+parent}/entities', options)
  command.request_representation = Google::Apis::ConnectorsV2::Entity::Representation
  command.request_object = entity_object
  command.response_representation = Google::Apis::ConnectorsV2::Entity::Representation
  command.response_class = Google::Apis::ConnectorsV2::Entity
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_connection_entity_type_entity(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ConnectorsV2::Empty

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

Parameters:

  • name (String) —

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

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



461
462
463
464
465
466
467
468
469
 
# File 'lib/google/apis/connectors_v2/service.rb', line 461

def delete_project_location_connection_entity_type_entity(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v2/{+name}', options)
  command.response_representation = Google::Apis::ConnectorsV2::Empty::Representation
  command.response_class = Google::Apis::ConnectorsV2::Empty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_connection_entity_type_entity_entities_with_conditions(entity_type, conditions: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ConnectorsV2::Empty

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

Parameters:

  • entity_type (String) —

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

  • conditions (String) (defaults to: nil) —

    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.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



501
502
503
504
505
506
507
508
509
510
 
# File 'lib/google/apis/connectors_v2/service.rb', line 501

def delete_project_location_connection_entity_type_entity_entities_with_conditions(entity_type, conditions: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/{+entityType}/entities:deleteEntitiesWithConditions', options)
  command.response_representation = Google::Apis::ConnectorsV2::Empty::Representation
  command.response_class = Google::Apis::ConnectorsV2::Empty
  command.params['entityType'] = entity_type unless entity_type.nil?
  command.query['conditions'] = conditions unless conditions.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#exchange_connection_auth_code(name, exchange_auth_code_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ConnectorsV2::ExchangeAuthCodeResponse

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

Parameters:

  • name (String)
  • exchange_auth_code_request_object (Google::Apis::ConnectorsV2::ExchangeAuthCodeRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/google/apis/connectors_v2/service.rb', line 139

def exchange_connection_auth_code(name, exchange_auth_code_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/{+name}:exchangeAuthCode', options)
  command.request_representation = Google::Apis::ConnectorsV2::ExchangeAuthCodeRequest::Representation
  command.request_object = exchange_auth_code_request_object
  command.response_representation = Google::Apis::ConnectorsV2::ExchangeAuthCodeResponse::Representation
  command.response_class = Google::Apis::ConnectorsV2::ExchangeAuthCodeResponse
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#execute_action(name, execute_action_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ConnectorsV2::ExecuteActionResponse

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:

  • name (String) —

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

  • execute_action_request_object (Google::Apis::ConnectorsV2::ExecuteActionRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



244
245
246
247
248
249
250
251
252
253
254
 
# File 'lib/google/apis/connectors_v2/service.rb', line 244

def execute_action(name, execute_action_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/{+name}:execute', options)
  command.request_representation = Google::Apis::ConnectorsV2::ExecuteActionRequest::Representation
  command.request_object = execute_action_request_object
  command.response_representation = Google::Apis::ConnectorsV2::ExecuteActionResponse::Representation
  command.response_class = Google::Apis::ConnectorsV2::ExecuteActionResponse
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#execute_connection_sql_query(connection, execute_sql_query_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ConnectorsV2::ExecuteSqlQueryResponse

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 (String) —

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

  • execute_sql_query_request_object (Google::Apis::ConnectorsV2::ExecuteSqlQueryRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



175
176
177
178
179
180
181
182
183
184
185
 
# File 'lib/google/apis/connectors_v2/service.rb', line 175

def execute_connection_sql_query(connection, execute_sql_query_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/{+connection}:executeSqlQuery', options)
  command.request_representation = Google::Apis::ConnectorsV2::ExecuteSqlQueryRequest::Representation
  command.request_object = execute_sql_query_request_object
  command.response_representation = Google::Apis::ConnectorsV2::ExecuteSqlQueryResponse::Representation
  command.response_class = Google::Apis::ConnectorsV2::ExecuteSqlQueryResponse
  command.params['connection'] = connection unless connection.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_connection_action(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ConnectorsV2::Action

Gets the schema of the given action.

Parameters:

  • name (String) —

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

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



277
278
279
280
281
282
283
284
285
 
# File 'lib/google/apis/connectors_v2/service.rb', line 277

def get_project_location_connection_action(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/{+name}', options)
  command.response_representation = Google::Apis::ConnectorsV2::Action::Representation
  command.response_class = Google::Apis::ConnectorsV2::Action
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_connection_entity_type(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ConnectorsV2::EntityType

Gets metadata of given entity type

Parameters:

  • name (String) —

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

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



350
351
352
353
354
355
356
357
358
 
# File 'lib/google/apis/connectors_v2/service.rb', line 350

def get_project_location_connection_entity_type(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/{+name}', options)
  command.response_representation = Google::Apis::ConnectorsV2::EntityType::Representation
  command.response_class = Google::Apis::ConnectorsV2::EntityType
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_connection_entity_type_entity(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ConnectorsV2::Entity

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

Parameters:

  • name (String) —

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

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



534
535
536
537
538
539
540
541
542
 
# File 'lib/google/apis/connectors_v2/service.rb', line 534

def get_project_location_connection_entity_type_entity(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/{+name}', options)
  command.response_representation = Google::Apis::ConnectorsV2::Entity::Representation
  command.response_class = Google::Apis::ConnectorsV2::Entity
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_connection_actions(parent, page_size: nil, page_token: nil, view: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ConnectorsV2::ListActionsResponse

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

Parameters:

  • parent (String) —

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

  • page_size (Fixnum) (defaults to: nil) —

    Number of Actions to return. Defaults to 25.

  • page_token (String) (defaults to: nil) —

    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 (String) (defaults to: nil) —

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

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



316
317
318
319
320
321
322
323
324
325
326
327
 
# File 'lib/google/apis/connectors_v2/service.rb', line 316

def list_project_location_connection_actions(parent, page_size: nil, page_token: nil, view: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/{+parent}/actions', options)
  command.response_representation = Google::Apis::ConnectorsV2::ListActionsResponse::Representation
  command.response_class = Google::Apis::ConnectorsV2::ListActionsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['view'] = view unless view.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_connection_entity_type_entities(parent, conditions: nil, page_size: nil, page_token: nil, sort_by: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ConnectorsV2::ListEntitiesResponse

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:

  • parent (String) —

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

  • conditions (String) (defaults to: nil) —

    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.

  • page_size (Fixnum) (defaults to: nil) —

    Number of entity rows to return. Defaults page size = 25. Max page size = 200.

  • page_token (String) (defaults to: nil) —

    Page token value if available from a previous request.

  • sort_by (Array<String>, String) (defaults to: nil) —

    List of 'sort_by' columns to use when returning the results.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



584
585
586
587
588
589
590
591
592
593
594
595
596
 
# File 'lib/google/apis/connectors_v2/service.rb', line 584

def list_project_location_connection_entity_type_entities(parent, conditions: nil, page_size: nil, page_token: nil, sort_by: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/{+parent}/entities', options)
  command.response_representation = Google::Apis::ConnectorsV2::ListEntitiesResponse::Representation
  command.response_class = Google::Apis::ConnectorsV2::ListEntitiesResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['conditions'] = conditions unless conditions.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['sortBy'] = sort_by unless sort_by.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_connection_entity_types(parent, page_size: nil, page_token: nil, view: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ConnectorsV2::ListEntityTypesResponse

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

Parameters:

  • parent (String) —

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

  • page_size (Fixnum) (defaults to: nil) —

    Number of entity types to return. Defaults to 25.

  • page_token (String) (defaults to: nil) —

    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 (String) (defaults to: nil) —

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

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



389
390
391
392
393
394
395
396
397
398
399
400
 
# File 'lib/google/apis/connectors_v2/service.rb', line 389

def list_project_location_connection_entity_types(parent, page_size: nil, page_token: nil, view: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/{+parent}/entityTypes', options)
  command.response_representation = Google::Apis::ConnectorsV2::ListEntityTypesResponse::Representation
  command.response_class = Google::Apis::ConnectorsV2::ListEntityTypesResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['view'] = view unless view.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_connection_entity_type_entity(name, entity_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ConnectorsV2::Entity

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:

  • name (String) —

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

  • entity_object (Google::Apis::ConnectorsV2::Entity) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



624
625
626
627
628
629
630
631
632
633
634
 
# File 'lib/google/apis/connectors_v2/service.rb', line 624

def patch_project_location_connection_entity_type_entity(name, entity_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v2/{+name}', options)
  command.request_representation = Google::Apis::ConnectorsV2::Entity::Representation
  command.request_object = entity_object
  command.response_representation = Google::Apis::ConnectorsV2::Entity::Representation
  command.response_class = Google::Apis::ConnectorsV2::Entity
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#refresh_connection_access_token(name, refresh_access_token_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ConnectorsV2::RefreshAccessTokenResponse

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

Parameters:

  • name (String)
  • refresh_access_token_request_object (Google::Apis::ConnectorsV2::RefreshAccessTokenRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



208
209
210
211
212
213
214
215
216
217
218
 
# File 'lib/google/apis/connectors_v2/service.rb', line 208

def refresh_connection_access_token(name, refresh_access_token_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/{+name}:refreshAccessToken', options)
  command.request_representation = Google::Apis::ConnectorsV2::RefreshAccessTokenRequest::Representation
  command.request_object = refresh_access_token_request_object
  command.response_representation = Google::Apis::ConnectorsV2::RefreshAccessTokenResponse::Representation
  command.response_class = Google::Apis::ConnectorsV2::RefreshAccessTokenResponse
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#update_project_location_connection_entity_type_entity_entities_with_conditions(entity_type, entity_object = nil, conditions: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ConnectorsV2::UpdateEntitiesWithConditionsResponse

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

Parameters:

  • entity_type (String) —

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

  • entity_object (Google::Apis::ConnectorsV2::Entity) (defaults to: nil)
  • conditions (String) (defaults to: nil) —

    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.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



667
668
669
670
671
672
673
674
675
676
677
678
 
# File 'lib/google/apis/connectors_v2/service.rb', line 667

def update_project_location_connection_entity_type_entity_entities_with_conditions(entity_type, entity_object = nil, conditions: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/{+entityType}/entities:updateEntitiesWithConditions', options)
  command.request_representation = Google::Apis::ConnectorsV2::Entity::Representation
  command.request_object = entity_object
  command.response_representation = Google::Apis::ConnectorsV2::UpdateEntitiesWithConditionsResponse::Representation
  command.response_class = Google::Apis::ConnectorsV2::UpdateEntitiesWithConditionsResponse
  command.params['entityType'] = entity_type unless entity_type.nil?
  command.query['conditions'] = conditions unless conditions.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end