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
Methods
.configure
def self.configure() { |config| ... } -> Client::Configuration
Configure the ConnectionService Client class.
See Configuration for a description of the configuration fields.
- (config) — Configure the Client client.
- config (Client::Configuration)
# 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.
- (config) — Configure the Client client.
- config (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.
def create_connection(request, options = nil) -> ::Google::Cloud::Bigquery::Connection::V1::Connection
create_connection
via a request object, either of type
Google::Cloud::Bigquery::Connection::V1::CreateConnectionRequest or an equivalent Hash.
- 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
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).
-
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.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Cloud::Bigquery::Connection::V1::Connection)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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.
def delete_connection(request, options = nil) -> ::Google::Protobuf::Empty
delete_connection
via a request object, either of type
DeleteConnectionRequest or an equivalent Hash.
- 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
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).
-
name (::String) — Required. Name of the deleted connection, for example:
projects/{project_id}/locations/{location_id}/connections/{connection_id}
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Protobuf::Empty)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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.
def get_connection(request, options = nil) -> ::Google::Cloud::Bigquery::Connection::V1::Connection
get_connection
via a request object, either of type
GetConnectionRequest or an equivalent Hash.
- 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
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).
-
name (::String) — Required. Name of the requested connection, for example:
projects/{project_id}/locations/{location_id}/connections/{connection_id}
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Cloud::Bigquery::Connection::V1::Connection)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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.
def get_iam_policy(request, options = nil) -> ::Google::Iam::V1::Policy
get_iam_policy
via a request object, either of type
Iam::V1::GetIamPolicyRequest or an equivalent Hash.
- 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
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).
- 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 toGetIamPolicy
.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Iam::V1::Policy)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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.
- (config) — Configure the ConnectionService client.
- config (Client::Configuration)
- (Client) — a new instance of Client
# 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.
def list_connections(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Bigquery::Connection::V1::Connection>
list_connections
via a request object, either of type
ListConnectionsRequest or an equivalent Hash.
- 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>
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).
-
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.
- (response, operation) — Access the result along with the RPC operation
- response (::Gapic::PagedEnumerable<::Google::Cloud::Bigquery::Connection::V1::Connection>)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::PagedEnumerable<::Google::Cloud::Bigquery::Connection::V1::Connection>)
- (::Google::Cloud::Error) — if the RPC is aborted.
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 all elements by calling #each, and the enumerable # will lazily make API calls to fetch subsequent pages. Other # methods are also available for managing paging directly. result.each do |response| # Each element is of type ::Google::Cloud::Bigquery::Connection::V1::Connection. p response 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.
def set_iam_policy(request, options = nil) -> ::Google::Iam::V1::Policy
set_iam_policy
via a request object, either of type
Iam::V1::SetIamPolicyRequest or an equivalent Hash.
- 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
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).
- 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"
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Iam::V1::Policy)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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.
def test_iam_permissions(request, options = nil) -> ::Google::Iam::V1::TestIamPermissionsResponse
test_iam_permissions
via a request object, either of type
Iam::V1::TestIamPermissionsRequest or an equivalent Hash.
- 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
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).
- 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.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Iam::V1::TestIamPermissionsResponse)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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
#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.
def update_connection(request, options = nil) -> ::Google::Cloud::Bigquery::Connection::V1::Connection
update_connection
via a request object, either of type
UpdateConnectionRequest or an equivalent Hash.
- 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
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).
-
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.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Cloud::Bigquery::Connection::V1::Connection)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
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