class Google::Cloud::VpcAccess::V1::VpcAccessService::Client

Client for the VpcAccessService service.

Serverless VPC Access API allows users to create and manage connectors for App Engine, Cloud Functions and Cloud Run to have internal connections to Virtual Private Cloud networks.

Attributes

operations_client[R]

Get the associated client for long-running operations.

@return [::Google::Cloud::VpcAccess::V1::VpcAccessService::Operations]

vpc_access_service_stub[R]

@private

Public Class Methods

configure() { |configure| ... } click to toggle source

Configure the VpcAccessService Client class.

See {::Google::Cloud::VpcAccess::V1::VpcAccessService::Client::Configuration} for a description of the configuration fields.

@example

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

@yield [config] Configure the Client client. @yieldparam config [Client::Configuration]

@return [Client::Configuration]

# File lib/google/cloud/vpc_access/v1/vpc_access_service/client.rb, line 58
def self.configure
  @configure ||= begin
    namespace = ["Google", "Cloud", "VpcAccess", "V1"]
    parent_config = while namespace.any?
                      parent_name = namespace.join "::"
                      parent_const = const_get parent_name
                      break parent_const.configure if parent_const.respond_to? :configure
                      namespace.pop
                    end
    default_config = Client::Configuration.new parent_config

    default_config.timeout = 60.0
    default_config.retry_policy = {
      initial_delay: 1.0, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 2]
    }

    default_config.rpcs.create_connector.timeout = 60.0

    default_config.rpcs.get_connector.timeout = 60.0

    default_config.rpcs.list_connectors.timeout = 60.0

    default_config.rpcs.delete_connector.timeout = 60.0

    default_config
  end
  yield @configure if block_given?
  @configure
end
new() { |config| ... } click to toggle source

Create a new VpcAccessService client object.

@example

# Create a client using the default configuration
client = ::Google::Cloud::VpcAccess::V1::VpcAccessService::Client.new

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

@yield [config] Configure the VpcAccessService client. @yieldparam config [Client::Configuration]

# File lib/google/cloud/vpc_access/v1/vpc_access_service/client.rb, line 124
def initialize
  # These require statements are intentionally placed here to initialize
  # the gRPC module only when it's required.
  # See https://github.com/googleapis/toolkit/issues/446
  require "gapic/grpc"
  require "google/cloud/vpcaccess/v1/vpc_access_services_pb"

  # Create the configuration object
  @config = Configuration.new Client.configure

  # Yield the configuration if needed
  yield @config if block_given?

  # Create credentials
  credentials = @config.credentials
  # Use self-signed JWT if the endpoint is unchanged from default,
  # but only if the default endpoint does not have a region prefix.
  enable_self_signed_jwt = @config.endpoint == Client.configure.endpoint &&
                           !@config.endpoint.split(".").first.include?("-")
  credentials ||= Credentials.default scope: @config.scope,
                                      enable_self_signed_jwt: enable_self_signed_jwt
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
    credentials = Credentials.new credentials, scope: @config.scope
  end
  @quota_project_id = @config.quota_project
  @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id

  @operations_client = Operations.new do |config|
    config.credentials = credentials
    config.endpoint = @config.endpoint
  end

  @vpc_access_service_stub = ::Gapic::ServiceStub.new(
    ::Google::Cloud::VpcAccess::V1::VpcAccessService::Stub,
    credentials:  credentials,
    endpoint:     @config.endpoint,
    channel_args: @config.channel_args,
    interceptors: @config.interceptors
  )
end

Public Instance Methods

configure() { |config| ... } click to toggle source

Configure the VpcAccessService 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 {::Google::Cloud::VpcAccess::V1::VpcAccessService::Client::Configuration} for a description of the configuration fields.

@yield [config] Configure the Client client. @yieldparam config [Client::Configuration]

@return [Client::Configuration]

# File lib/google/cloud/vpc_access/v1/vpc_access_service/client.rb, line 103
def configure
  yield @config if block_given?
  @config
end
create_connector(request, options = nil) { |response, operation| ... } click to toggle source

Creates a Serverless VPC Access connector, returns an operation.

@overload create_connector(request, options = nil)

Pass arguments to `create_connector` via a request object, either of type
{::Google::Cloud::VpcAccess::V1::CreateConnectorRequest} or an equivalent Hash.

@param request [::Google::Cloud::VpcAccess::V1::CreateConnectorRequest, ::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.
@param options [::Gapic::CallOptions, ::Hash]
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

@overload create_connector(parent: nil, connector_id: nil, connector: nil)

Pass arguments to `create_connector` 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).

@param parent [::String]
  Required. The project and location in which the configuration should be created,
  specified in the format `projects/*/locations/*`.
@param connector_id [::String]
  Required. The ID to use for this connector.
@param connector [::Google::Cloud::VpcAccess::V1::Connector, ::Hash]
  Required. Resource to create.

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Gapic::Operation] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Gapic::Operation]

@raise [::Google::Cloud::Error] if the RPC is aborted.

# File lib/google/cloud/vpc_access/v1/vpc_access_service/client.rb, line 208
def create_connector request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::VpcAccess::V1::CreateConnectorRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.create_connector.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::VpcAccess::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "parent" => request.parent
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.create_connector.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.create_connector.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @vpc_access_service_stub.call_rpc :create_connector, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end
delete_connector(request, options = nil) { |response, operation| ... } click to toggle source

Deletes a Serverless VPC Access connector. Returns NOT_FOUND if the resource does not exist.

@overload delete_connector(request, options = nil)

Pass arguments to `delete_connector` via a request object, either of type
{::Google::Cloud::VpcAccess::V1::DeleteConnectorRequest} or an equivalent Hash.

@param request [::Google::Cloud::VpcAccess::V1::DeleteConnectorRequest, ::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.
@param options [::Gapic::CallOptions, ::Hash]
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

@overload delete_connector(name: nil)

Pass arguments to `delete_connector` 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).

@param name [::String]
  Required. Name of a Serverless VPC Access connector to delete.

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Gapic::Operation] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Gapic::Operation]

@raise [::Google::Cloud::Error] if the RPC is aborted.

# File lib/google/cloud/vpc_access/v1/vpc_access_service/client.rb, line 420
def delete_connector request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::VpcAccess::V1::DeleteConnectorRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.delete_connector.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::VpcAccess::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "name" => request.name
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.delete_connector.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.delete_connector.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @vpc_access_service_stub.call_rpc :delete_connector, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end
get_connector(request, options = nil) { |response, operation| ... } click to toggle source

Gets a Serverless VPC Access connector. Returns NOT_FOUND if the resource does not exist.

@overload get_connector(request, options = nil)

Pass arguments to `get_connector` via a request object, either of type
{::Google::Cloud::VpcAccess::V1::GetConnectorRequest} or an equivalent Hash.

@param request [::Google::Cloud::VpcAccess::V1::GetConnectorRequest, ::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.
@param options [::Gapic::CallOptions, ::Hash]
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

@overload get_connector(name: nil)

Pass arguments to `get_connector` 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).

@param name [::String]
  Required. Name of a Serverless VPC Access connector to get.

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::VpcAccess::V1::Connector] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Google::Cloud::VpcAccess::V1::Connector]

@raise [::Google::Cloud::Error] if the RPC is aborted.

# File lib/google/cloud/vpc_access/v1/vpc_access_service/client.rb, line 278
def get_connector request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::VpcAccess::V1::GetConnectorRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.get_connector.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::VpcAccess::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "name" => request.name
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.get_connector.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_connector.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @vpc_access_service_stub.call_rpc :get_connector, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end
list_connectors(request, options = nil) { |response, operation| ... } click to toggle source

Lists Serverless VPC Access connectors.

@overload list_connectors(request, options = nil)

Pass arguments to `list_connectors` via a request object, either of type
{::Google::Cloud::VpcAccess::V1::ListConnectorsRequest} or an equivalent Hash.

@param request [::Google::Cloud::VpcAccess::V1::ListConnectorsRequest, ::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.
@param options [::Gapic::CallOptions, ::Hash]
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

@overload list_connectors(parent: nil, page_size: nil, page_token: nil)

Pass arguments to `list_connectors` 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).

@param parent [::String]
  Required. The project and location from which the routes should be listed.
@param page_size [::Integer]
  Maximum number of functions to return per call.
@param page_token [::String]
  Continuation token.

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::VpcAccess::V1::Connector>] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Gapic::PagedEnumerable<::Google::Cloud::VpcAccess::V1::Connector>]

@raise [::Google::Cloud::Error] if the RPC is aborted.

# File lib/google/cloud/vpc_access/v1/vpc_access_service/client.rb, line 350
def list_connectors request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::VpcAccess::V1::ListConnectorsRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.list_connectors.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::VpcAccess::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "parent" => request.parent
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.list_connectors.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_connectors.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @vpc_access_service_stub.call_rpc :list_connectors, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @vpc_access_service_stub, :list_connectors, request, response, operation, options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end