BigQuery Connection V1 API - Class Google::Cloud::Bigquery::Connection::V1::ConnectionService::Client (v1.0.0)

Reference documentation and code samples for the BigQuery Connection V1 API class Google::Cloud::Bigquery::Connection::V1::ConnectionService::Client.

Client for the ConnectionService service.

Manages external data source connections and credentials.

Inherits

Object

Includes

Google::Cloud::Bigquery::Connection::V1::ConnectionService::Paths

Methods

.configure

def self.configure() { |config| ... } -> Client::Configuration

Configure the ConnectionService Client class.

See Configuration for a description of the configuration fields.

Yields

(config) — Configure the Client client.

Yield Parameter

config (Client::Configuration)

Returns

(Client::Configuration)

Example

# Modify the configuration for all ConnectionService clients
::Google::Cloud::Bigquery::Connection::V1::ConnectionService::Client.configure do |config|
  config.timeout = 10.0
end

#configure

def configure() { |config| ... } -> Client::Configuration

Configure the ConnectionService Client instance.

The configuration is set to the derived mode, meaning that values can be changed, but structural changes (adding new fields, etc.) are not allowed. Structural changes should be made on Client.configure.

See Configuration for a description of the configuration fields.

Yields

(config) — Configure the Client client.

Yield Parameter

config (Client::Configuration)

Returns

(Client::Configuration)

#create_connection

def create_connection(request, options = nil) -> ::Google::Cloud::Bigquery::Connection::V1::Connection
def create_connection(parent: nil, connection_id: nil, connection: nil) -> ::Google::Cloud::Bigquery::Connection::V1::Connection

Creates a new connection.

Overloads

def create_connection(request, options = nil) -> ::Google::Cloud::Bigquery::Connection::V1::Connection

Pass arguments to create_connection via a request object, either of type Google::Cloud::Bigquery::Connection::V1::CreateConnectionRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::Bigquery::Connection::V1::CreateConnectionRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def create_connection(parent: nil, connection_id: nil, connection: nil) -> ::Google::Cloud::Bigquery::Connection::V1::Connection

Pass arguments to create_connection via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

parent (::String) — Required. Parent resource name. Must be in the format projects/{project_id}/locations/{location_id}
connection_id (::String) — Optional. Connection id that should be assigned to the created connection.
connection (::Google::Cloud::Bigquery::Connection::V1::Connection, ::Hash) — Required. Connection to create.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Google::Cloud::Bigquery::Connection::V1::Connection)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Google::Cloud::Bigquery::Connection::V1::Connection)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/bigquery/connection/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Bigquery::Connection::V1::ConnectionService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Bigquery::Connection::V1::CreateConnectionRequest.new

# Call the create_connection method.
result = client.create_connection request

# The returned object is of type Google::Cloud::Bigquery::Connection::V1::Connection.
p result

#delete_connection

def delete_connection(request, options = nil) -> ::Google::Protobuf::Empty
def delete_connection(name: nil) -> ::Google::Protobuf::Empty

Deletes connection and associated credential.

Overloads

def delete_connection(request, options = nil) -> ::Google::Protobuf::Empty

Pass arguments to delete_connection via a request object, either of type DeleteConnectionRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::Bigquery::Connection::V1::DeleteConnectionRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def delete_connection(name: nil) -> ::Google::Protobuf::Empty

Pass arguments to delete_connection via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameter

name (::String) — Required. Name of the deleted connection, for example: projects/{project_id}/locations/{location_id}/connections/{connection_id}

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Google::Protobuf::Empty)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Google::Protobuf::Empty)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/bigquery/connection/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Bigquery::Connection::V1::ConnectionService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Bigquery::Connection::V1::DeleteConnectionRequest.new

# Call the delete_connection method.
result = client.delete_connection request

# The returned object is of type Google::Protobuf::Empty.
p result

#get_connection

def get_connection(request, options = nil) -> ::Google::Cloud::Bigquery::Connection::V1::Connection
def get_connection(name: nil) -> ::Google::Cloud::Bigquery::Connection::V1::Connection

Returns specified connection.

Overloads

def get_connection(request, options = nil) -> ::Google::Cloud::Bigquery::Connection::V1::Connection

Pass arguments to get_connection via a request object, either of type GetConnectionRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::Bigquery::Connection::V1::GetConnectionRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def get_connection(name: nil) -> ::Google::Cloud::Bigquery::Connection::V1::Connection

Pass arguments to get_connection via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameter

name (::String) — Required. Name of the requested connection, for example: projects/{project_id}/locations/{location_id}/connections/{connection_id}

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Google::Cloud::Bigquery::Connection::V1::Connection)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Google::Cloud::Bigquery::Connection::V1::Connection)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/bigquery/connection/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Bigquery::Connection::V1::ConnectionService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Bigquery::Connection::V1::GetConnectionRequest.new

# Call the get_connection method.
result = client.get_connection request

# The returned object is of type Google::Cloud::Bigquery::Connection::V1::Connection.
p result

#get_iam_policy

def get_iam_policy(request, options = nil) -> ::Google::Iam::V1::Policy
def get_iam_policy(resource: nil, options: nil) -> ::Google::Iam::V1::Policy

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

Overloads

def get_iam_policy(request, options = nil) -> ::Google::Iam::V1::Policy

Pass arguments to get_iam_policy via a request object, either of type Iam::V1::GetIamPolicyRequest or an equivalent Hash.

Parameters

request (::Google::Iam::V1::GetIamPolicyRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def get_iam_policy(resource: nil, options: nil) -> ::Google::Iam::V1::Policy

Pass arguments to get_iam_policy via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

resource (::String) — REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.
options (::Google::Iam::V1::GetPolicyOptions, ::Hash) — OPTIONAL: A GetPolicyOptions object for specifying options to GetIamPolicy.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Google::Iam::V1::Policy)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Google::Iam::V1::Policy)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/bigquery/connection/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Bigquery::Connection::V1::ConnectionService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Iam::V1::GetIamPolicyRequest.new

# Call the get_iam_policy method.
result = client.get_iam_policy request

# The returned object is of type Google::Iam::V1::Policy.
p result

#initialize

def initialize() { |config| ... } -> Client

Create a new ConnectionService client object.

Yields

(config) — Configure the ConnectionService client.

Yield Parameter

config (Client::Configuration)

Returns

(Client) — a new instance of Client

Example

# Create a client using the default configuration
client = ::Google::Cloud::Bigquery::Connection::V1::ConnectionService::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::Bigquery::Connection::V1::ConnectionService::Client.new do |config|
  config.timeout = 10.0
end

#list_connections

def list_connections(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Bigquery::Connection::V1::Connection>
def list_connections(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Bigquery::Connection::V1::Connection>

Returns a list of connections in the given project.

Overloads

def list_connections(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Bigquery::Connection::V1::Connection>

Pass arguments to list_connections via a request object, either of type ListConnectionsRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::Bigquery::Connection::V1::ListConnectionsRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def list_connections(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Bigquery::Connection::V1::Connection>

Pass arguments to list_connections via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

parent (::String) — Required. Parent resource name. Must be in the form: projects/{project_id}/locations/{location_id}
page_size (::Integer) — Required. Page size.
page_token (::String) — Page token.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Gapic::PagedEnumerable<::Google::Cloud::Bigquery::Connection::V1::Connection>)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Gapic::PagedEnumerable<::Google::Cloud::Bigquery::Connection::V1::Connection>)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/bigquery/connection/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Bigquery::Connection::V1::ConnectionService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Bigquery::Connection::V1::ListConnectionsRequest.new

# Call the list_connections method.
result = client.list_connections request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::Bigquery::Connection::V1::Connection.
  p item
end

#set_iam_policy

def set_iam_policy(request, options = nil) -> ::Google::Iam::V1::Policy
def set_iam_policy(resource: nil, policy: nil, update_mask: nil) -> ::Google::Iam::V1::Policy

Sets the access control policy on the specified resource. Replaces any existing policy.

Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

Overloads

def set_iam_policy(request, options = nil) -> ::Google::Iam::V1::Policy

Pass arguments to set_iam_policy via a request object, either of type Iam::V1::SetIamPolicyRequest or an equivalent Hash.

Parameters

request (::Google::Iam::V1::SetIamPolicyRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def set_iam_policy(resource: nil, policy: nil, update_mask: nil) -> ::Google::Iam::V1::Policy

Pass arguments to set_iam_policy via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

resource (::String) — REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
policy (::Google::Iam::V1::Policy, ::Hash) — REQUIRED: The complete policy to be applied to the resource. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them.
update_mask (::Google::Protobuf::FieldMask, ::Hash) — OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used:

paths: "bindings, etag"

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Google::Iam::V1::Policy)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Google::Iam::V1::Policy)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/bigquery/connection/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Bigquery::Connection::V1::ConnectionService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Iam::V1::SetIamPolicyRequest.new

# Call the set_iam_policy method.
result = client.set_iam_policy request

# The returned object is of type Google::Iam::V1::Policy.
p result

#test_iam_permissions

def test_iam_permissions(request, options = nil) -> ::Google::Iam::V1::TestIamPermissionsResponse
def test_iam_permissions(resource: nil, permissions: nil) -> ::Google::Iam::V1::TestIamPermissionsResponse

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.

Overloads

def test_iam_permissions(request, options = nil) -> ::Google::Iam::V1::TestIamPermissionsResponse

Pass arguments to test_iam_permissions via a request object, either of type Iam::V1::TestIamPermissionsRequest or an equivalent Hash.

Parameters

request (::Google::Iam::V1::TestIamPermissionsRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def test_iam_permissions(resource: nil, permissions: nil) -> ::Google::Iam::V1::TestIamPermissionsResponse

Pass arguments to test_iam_permissions via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

resource (::String) — REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
permissions (::Array<::String>) — The set of permissions to check for the resource. Permissions with wildcards (such as '' or 'storage.') are not allowed. For more information see IAM Overview.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Google::Iam::V1::TestIamPermissionsResponse)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Google::Iam::V1::TestIamPermissionsResponse)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/bigquery/connection/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Bigquery::Connection::V1::ConnectionService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Iam::V1::TestIamPermissionsRequest.new

# Call the test_iam_permissions method.
result = client.test_iam_permissions request

# The returned object is of type Google::Iam::V1::TestIamPermissionsResponse.
p result

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns

(String)

#update_connection

def update_connection(request, options = nil) -> ::Google::Cloud::Bigquery::Connection::V1::Connection
def update_connection(name: nil, connection: nil, update_mask: nil) -> ::Google::Cloud::Bigquery::Connection::V1::Connection

Updates the specified connection. For security reasons, also resets credential if connection properties are in the update field mask.

Overloads

def update_connection(request, options = nil) -> ::Google::Cloud::Bigquery::Connection::V1::Connection

Pass arguments to update_connection via a request object, either of type UpdateConnectionRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::Bigquery::Connection::V1::UpdateConnectionRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def update_connection(name: nil, connection: nil, update_mask: nil) -> ::Google::Cloud::Bigquery::Connection::V1::Connection

Pass arguments to update_connection via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

Parameters

name (::String) — Required. Name of the connection to update, for example: projects/{project_id}/locations/{location_id}/connections/{connection_id}
connection (::Google::Cloud::Bigquery::Connection::V1::Connection, ::Hash) — Required. Connection containing the updated fields.
update_mask (::Google::Protobuf::FieldMask, ::Hash) — Required. Update mask for the connection fields to be updated.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Google::Cloud::Bigquery::Connection::V1::Connection)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Google::Cloud::Bigquery::Connection::V1::Connection)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/bigquery/connection/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Bigquery::Connection::V1::ConnectionService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Bigquery::Connection::V1::UpdateConnectionRequest.new

# Call the update_connection method.
result = client.update_connection request

# The returned object is of type Google::Cloud::Bigquery::Connection::V1::Connection.
p result