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:

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ ConnectorsService

Returns a new instance of ConnectorsService.



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

def initialize
  super('https://connectors.googleapis.com/', '',
        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.



39
40
41
 
# File 'lib/google/apis/connectors_v2/service.rb', line 39

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.



44
45
46
 
# File 'lib/google/apis/connectors_v2/service.rb', line 44

def quota_user
  @quota_user
end

Instance Method Details

#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



296
297
298
299
300
301
302
303
304
305
306
 
# File 'lib/google/apis/connectors_v2/service.rb', line 296

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



330
331
332
333
334
335
336
337
338
 
# File 'lib/google/apis/connectors_v2/service.rb', line 330

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



370
371
372
373
374
375
376
377
378
379
 
# File 'lib/google/apis/connectors_v2/service.rb', line 370

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

#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



113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/google/apis/connectors_v2/service.rb', line 113

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



77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/google/apis/connectors_v2/service.rb', line 77

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



146
147
148
149
150
151
152
153
154
 
# File 'lib/google/apis/connectors_v2/service.rb', line 146

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



219
220
221
222
223
224
225
226
227
 
# File 'lib/google/apis/connectors_v2/service.rb', line 219

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



403
404
405
406
407
408
409
410
411
 
# File 'lib/google/apis/connectors_v2/service.rb', line 403

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



185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/google/apis/connectors_v2/service.rb', line 185

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



453
454
455
456
457
458
459
460
461
462
463
464
465
 
# File 'lib/google/apis/connectors_v2/service.rb', line 453

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



258
259
260
261
262
263
264
265
266
267
268
269
 
# File 'lib/google/apis/connectors_v2/service.rb', line 258

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



493
494
495
496
497
498
499
500
501
502
503
 
# File 'lib/google/apis/connectors_v2/service.rb', line 493

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

#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



536
537
538
539
540
541
542
543
544
545
546
547
 
# File 'lib/google/apis/connectors_v2/service.rb', line 536

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