Class: Google::Apis::ConnectorsV2::ConnectorsService
- Inherits:
-
Google::Apis::Core::BaseService
- Object
- Google::Apis::Core::BaseService
- Google::Apis::ConnectorsV2::ConnectorsService
- 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.
Instance Attribute Summary collapse
-
#key ⇒ String
API key.
-
#quota_user ⇒ String
Available to use for quota purposes for server-side applications.
Instance Method Summary collapse
-
#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.
-
#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.
-
#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.
-
#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.
-
#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.
-
#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.
-
#initialize ⇒ ConnectorsService
constructor
A new instance of ConnectorsService.
-
#list_project_location_connection_actions(parent, page_size: nil, page_token: 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.
-
#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.
-
#list_project_location_connection_entity_types(parent, page_size: nil, page_token: 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.
-
#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.
-
#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.
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.
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.
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.
228 229 230 231 232 233 234 235 236 237 238 |
# File 'lib/google/apis/connectors_v2/service.rb', line 228 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', ) 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.
262 263 264 265 266 267 268 269 270 |
# File 'lib/google/apis/connectors_v2/service.rb', line 262 def delete_project_location_connection_entity_type_entity(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v2/{+name}', ) 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.
302 303 304 305 306 307 308 309 310 311 |
# File 'lib/google/apis/connectors_v2/service.rb', line 302 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', ) 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.
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', ) 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'.
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', ) 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_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.
335 336 337 338 339 340 341 342 343 |
# File 'lib/google/apis/connectors_v2/service.rb', line 335 def get_project_location_connection_entity_type_entity(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2/{+name}', ) 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, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ConnectorsV2::ListActionsResponse
Gets the schema of all the actions supported by the connector.
152 153 154 155 156 157 158 159 160 161 162 |
# File 'lib/google/apis/connectors_v2/service.rb', line 152 def list_project_location_connection_actions(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2/{+parent}/actions', ) 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['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:
- 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.
385 386 387 388 389 390 391 392 393 394 395 396 397 |
# File 'lib/google/apis/connectors_v2/service.rb', line 385 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', ) 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, 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.
191 192 193 194 195 196 197 198 199 200 201 |
# File 'lib/google/apis/connectors_v2/service.rb', line 191 def list_project_location_connection_entity_types(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2/{+parent}/entityTypes', ) 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['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.
425 426 427 428 429 430 431 432 433 434 435 |
# File 'lib/google/apis/connectors_v2/service.rb', line 425 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}', ) 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.
468 469 470 471 472 473 474 475 476 477 478 479 |
# File 'lib/google/apis/connectors_v2/service.rb', line 468 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', ) 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 |