class Google::Apis::BigqueryconnectionV1beta1::BigQueryConnectionServiceService

BigQuery Connection API

Allows users to manage BigQuery connections to external data sources.

@example

require 'google/apis/bigqueryconnection_v1beta1'

Bigqueryconnection = Google::Apis::BigqueryconnectionV1beta1 # Alias the module
service = Bigqueryconnection::BigQueryConnectionServiceService.new

@see cloud.google.com/bigquery/

Attributes

key[RW]

@return [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.
quota_user[RW]

@return [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.

Public Class Methods

new() click to toggle source
Calls superclass method
# File lib/google/apis/bigqueryconnection_v1beta1/service.rb, line 45
def initialize
  super('https://bigqueryconnection.googleapis.com/', '',
        client_name: 'google-apis-bigqueryconnection_v1beta1',
        client_version: Google::Apis::BigqueryconnectionV1beta1::GEM_VERSION)
  @batch_path = 'batch'
end

Public Instance Methods

create_project_location_connection(parent, connection_object = nil, connection_id: nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Creates a new connection. @param [String] parent

Required. Parent resource name. Must be in the format `projects/`project_id`/
locations/`location_id``

@param [Google::Apis::BigqueryconnectionV1beta1::Connection] connection_object @param [String] connection_id

Optional. Connection id that should be assigned to the created connection.

@param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

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.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::BigqueryconnectionV1beta1::Connection] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::BigqueryconnectionV1beta1::Connection]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/bigqueryconnection_v1beta1/service.rb, line 76
def create_project_location_connection(parent, connection_object = nil, connection_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+parent}/connections', options)
  command.request_representation = Google::Apis::BigqueryconnectionV1beta1::Connection::Representation
  command.request_object = connection_object
  command.response_representation = Google::Apis::BigqueryconnectionV1beta1::Connection::Representation
  command.response_class = Google::Apis::BigqueryconnectionV1beta1::Connection
  command.params['parent'] = parent unless parent.nil?
  command.query['connectionId'] = connection_id unless connection_id.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(name, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Deletes connection and associated credential. @param [String] name

Required. Name of the deleted connection, for example: `projects/`project_id`/
locations/`location_id`/connections/`connection_id``

@param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

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.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::BigqueryconnectionV1beta1::Empty] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::BigqueryconnectionV1beta1::Empty]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/bigqueryconnection_v1beta1/service.rb, line 110
def delete_project_location_connection(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::BigqueryconnectionV1beta1::Empty::Representation
  command.response_class = Google::Apis::BigqueryconnectionV1beta1::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
get_connection_iam_policy(resource, get_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. @param [String] resource

REQUIRED: The resource for which the policy is being requested. See the
operation documentation for the appropriate value for this field.

@param [Google::Apis::BigqueryconnectionV1beta1::GetIamPolicyRequest] get_iam_policy_request_object @param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

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.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::BigqueryconnectionV1beta1::Policy] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::BigqueryconnectionV1beta1::Policy]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/bigqueryconnection_v1beta1/service.rb, line 174
def get_connection_iam_policy(resource, get_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+resource}:getIamPolicy', options)
  command.request_representation = Google::Apis::BigqueryconnectionV1beta1::GetIamPolicyRequest::Representation
  command.request_object = get_iam_policy_request_object
  command.response_representation = Google::Apis::BigqueryconnectionV1beta1::Policy::Representation
  command.response_class = Google::Apis::BigqueryconnectionV1beta1::Policy
  command.params['resource'] = resource unless resource.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(name, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Returns specified connection. @param [String] name

Required. Name of the requested connection, for example: `projects/`project_id`
/locations/`location_id`/connections/`connection_id``

@param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

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.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::BigqueryconnectionV1beta1::Connection] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::BigqueryconnectionV1beta1::Connection]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/bigqueryconnection_v1beta1/service.rb, line 141
def get_project_location_connection(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::BigqueryconnectionV1beta1::Connection::Representation
  command.response_class = Google::Apis::BigqueryconnectionV1beta1::Connection
  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_connections(parent, max_results: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Returns a list of connections in the given project. @param [String] parent

Required. Parent resource name. Must be in the form: `projects/`project_id`/
locations/`location_id``

@param [Fixnum] max_results

Required. Maximum number of results per page.

@param [String] page_token

Page token.

@param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

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.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::BigqueryconnectionV1beta1::ListConnectionsResponse] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::BigqueryconnectionV1beta1::ListConnectionsResponse]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/bigqueryconnection_v1beta1/service.rb, line 211
def list_project_location_connections(parent, max_results: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+parent}/connections', options)
  command.response_representation = Google::Apis::BigqueryconnectionV1beta1::ListConnectionsResponse::Representation
  command.response_class = Google::Apis::BigqueryconnectionV1beta1::ListConnectionsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['maxResults'] = max_results unless max_results.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(name, connection_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Updates the specified connection. For security reasons, also resets credential if connection properties are in the update field mask. @param [String] name

Required. Name of the connection to update, for example: `projects/`project_id`
/locations/`location_id`/connections/`connection_id``

@param [Google::Apis::BigqueryconnectionV1beta1::Connection] connection_object @param [String] update_mask

Required. Update mask for the connection fields to be updated.

@param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

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.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::BigqueryconnectionV1beta1::Connection] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::BigqueryconnectionV1beta1::Connection]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/bigqueryconnection_v1beta1/service.rb, line 248
def patch_project_location_connection(name, connection_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1beta1/{+name}', options)
  command.request_representation = Google::Apis::BigqueryconnectionV1beta1::Connection::Representation
  command.request_object = connection_object
  command.response_representation = Google::Apis::BigqueryconnectionV1beta1::Connection::Representation
  command.response_class = Google::Apis::BigqueryconnectionV1beta1::Connection
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end
set_connection_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and ` PERMISSION_DENIED` errors. @param [String] resource

REQUIRED: The resource for which the policy is being specified. See the
operation documentation for the appropriate value for this field.

@param [Google::Apis::BigqueryconnectionV1beta1::SetIamPolicyRequest] set_iam_policy_request_object @param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

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.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::BigqueryconnectionV1beta1::Policy] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::BigqueryconnectionV1beta1::Policy]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/bigqueryconnection_v1beta1/service.rb, line 285
def set_connection_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+resource}:setIamPolicy', options)
  command.request_representation = Google::Apis::BigqueryconnectionV1beta1::SetIamPolicyRequest::Representation
  command.request_object = set_iam_policy_request_object
  command.response_representation = Google::Apis::BigqueryconnectionV1beta1::Policy::Representation
  command.response_class = Google::Apis::BigqueryconnectionV1beta1::Policy
  command.params['resource'] = resource unless resource.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end
test_connection_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a ` NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may “fail open” without warning. @param [String] resource

REQUIRED: The resource for which the policy detail is being requested. See the
operation documentation for the appropriate value for this field.

@param [Google::Apis::BigqueryconnectionV1beta1::TestIamPermissionsRequest] test_iam_permissions_request_object @param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

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.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::BigqueryconnectionV1beta1::TestIamPermissionsResponse] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::BigqueryconnectionV1beta1::TestIamPermissionsResponse]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/bigqueryconnection_v1beta1/service.rb, line 323
def test_connection_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+resource}:testIamPermissions', options)
  command.request_representation = Google::Apis::BigqueryconnectionV1beta1::TestIamPermissionsRequest::Representation
  command.request_object = test_iam_permissions_request_object
  command.response_representation = Google::Apis::BigqueryconnectionV1beta1::TestIamPermissionsResponse::Representation
  command.response_class = Google::Apis::BigqueryconnectionV1beta1::TestIamPermissionsResponse
  command.params['resource'] = resource unless resource.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_credential(name, connection_credential_object = nil, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Sets the credential for the specified connection. @param [String] name

Required. Name of the connection, for example: `projects/`project_id`/
locations/`location_id`/connections/`connection_id`/credential`

@param [Google::Apis::BigqueryconnectionV1beta1::ConnectionCredential] connection_credential_object @param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

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.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::BigqueryconnectionV1beta1::Empty] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::BigqueryconnectionV1beta1::Empty]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/bigqueryconnection_v1beta1/service.rb, line 357
def update_project_location_connection_credential(name, connection_credential_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1beta1/{+name}', options)
  command.request_representation = Google::Apis::BigqueryconnectionV1beta1::ConnectionCredential::Representation
  command.request_object = connection_credential_object
  command.response_representation = Google::Apis::BigqueryconnectionV1beta1::Empty::Representation
  command.response_class = Google::Apis::BigqueryconnectionV1beta1::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

Protected Instance Methods

apply_command_defaults(command) click to toggle source
# File lib/google/apis/bigqueryconnection_v1beta1/service.rb, line 371
def apply_command_defaults(command)
  command.query['key'] = key unless key.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
end