class Google::Cloud::NetworkConnectivity::V1::HubService::Client

Client for the HubService service.

Network Connectivity Center is a hub-and-spoke abstraction for network connectivity management in Google Cloud. It reduces operational complexity through a simple, centralized connectivity management model.

Attributes

hub_service_stub[R]

@private

operations_client[R]

Get the associated client for long-running operations.

@return [::Google::Cloud::NetworkConnectivity::V1::HubService::Operations]

Public Class Methods

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

Configure the HubService Client class.

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

@example

# Modify the configuration for all HubService clients
::Google::Cloud::NetworkConnectivity::V1::HubService::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/network_connectivity/v1/hub_service/client.rb, line 58
def self.configure
  @configure ||= begin
    namespace = ["Google", "Cloud", "NetworkConnectivity", "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: 10.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config.rpcs.create_hub.timeout = 60.0

    default_config.rpcs.update_hub.timeout = 60.0

    default_config.rpcs.delete_hub.timeout = 60.0

    default_config.rpcs.create_spoke.timeout = 60.0

    default_config.rpcs.update_spoke.timeout = 60.0

    default_config.rpcs.delete_spoke.timeout = 60.0

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

Create a new HubService client object.

@example

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

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

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

# File lib/google/cloud/network_connectivity/v1/hub_service/client.rb, line 128
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/networkconnectivity/v1/hub_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

  @hub_service_stub = ::Gapic::ServiceStub.new(
    ::Google::Cloud::NetworkConnectivity::V1::HubService::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 HubService 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::NetworkConnectivity::V1::HubService::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/network_connectivity/v1/hub_service/client.rb, line 107
def configure
  yield @config if block_given?
  @config
end
create_hub(request, options = nil) { |response, operation| ... } click to toggle source

Creates a new hub in the specified project.

@overload create_hub(request, options = nil)

Pass arguments to `create_hub` via a request object, either of type
{::Google::Cloud::NetworkConnectivity::V1::CreateHubRequest} or an equivalent Hash.

@param request [::Google::Cloud::NetworkConnectivity::V1::CreateHubRequest, ::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_hub(parent: nil, hub_id: nil, hub: nil, request_id: nil)

Pass arguments to `create_hub` 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 parent resource.
@param hub_id [::String]
  Optional. A unique identifier for the hub.
@param hub [::Google::Cloud::NetworkConnectivity::V1::Hub, ::Hash]
  Required. The initial values for a new hub.
@param request_id [::String]
  Optional. A unique request ID (optional). If you specify this ID, you can use it
  in cases when you need to retry your request. When you need to retry, this
  ID lets the server know that it can ignore the request if it has already
  been completed. The server guarantees that for at least 60 minutes after
  the first request.

  For example, consider a situation where you make an initial request and
  the request times out. If you make the request again with the same request
  ID, the server can check to see whether the original operation
  was received. If it was, the server ignores the second request. This
  behavior prevents clients from mistakenly creating duplicate commitments.

  The request ID must be a valid UUID, with the exception that zero UUID is
  not supported (00000000-0000-0000-0000-000000000000).

@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/network_connectivity/v1/hub_service/client.rb, line 371
def create_hub request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::NetworkConnectivity::V1::CreateHubRequest

  # 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_hub.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::NetworkConnectivity::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_hub.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.create_hub.retry_policy

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

  @hub_service_stub.call_rpc :create_hub, 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
create_spoke(request, options = nil) { |response, operation| ... } click to toggle source

Creates a spoke in the specified project and location.

@overload create_spoke(request, options = nil)

Pass arguments to `create_spoke` via a request object, either of type
{::Google::Cloud::NetworkConnectivity::V1::CreateSpokeRequest} or an equivalent Hash.

@param request [::Google::Cloud::NetworkConnectivity::V1::CreateSpokeRequest, ::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_spoke(parent: nil, spoke_id: nil, spoke: nil, request_id: nil)

Pass arguments to `create_spoke` 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 parent resource.
@param spoke_id [::String]
  Optional. Unique id for the spoke to create.
@param spoke [::Google::Cloud::NetworkConnectivity::V1::Spoke, ::Hash]
  Required. The initial values for a new spoke.
@param request_id [::String]
  Optional. A unique request ID (optional). If you specify this ID, you can use it
  in cases when you need to retry your request. When you need to retry, this
  ID lets the server know that it can ignore the request if it has already
  been completed. The server guarantees that for at least 60 minutes after
  the first request.

  For example, consider a situation where you make an initial request and
  the request times out. If you make the request again with the same request
  ID, the server can check to see whether the original operation
  was received. If it was, the server ignores the second request. This
  behavior prevents clients from mistakenly creating duplicate commitments.

  The request ID must be a valid UUID, with the exception that zero UUID is
  not supported (00000000-0000-0000-0000-000000000000).

@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/network_connectivity/v1/hub_service/client.rb, line 778
def create_spoke request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::NetworkConnectivity::V1::CreateSpokeRequest

  # 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_spoke.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::NetworkConnectivity::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_spoke.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.create_spoke.retry_policy

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

  @hub_service_stub.call_rpc :create_spoke, 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_hub(request, options = nil) { |response, operation| ... } click to toggle source

Deletes the specified hub.

@overload delete_hub(request, options = nil)

Pass arguments to `delete_hub` via a request object, either of type
{::Google::Cloud::NetworkConnectivity::V1::DeleteHubRequest} or an equivalent Hash.

@param request [::Google::Cloud::NetworkConnectivity::V1::DeleteHubRequest, ::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_hub(name: nil, request_id: nil)

Pass arguments to `delete_hub` 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. The name of the hub to delete.
@param request_id [::String]
  Optional. A unique request ID (optional). If you specify this ID, you can use it
  in cases when you need to retry your request. When you need to retry, this
  ID lets the server know that it can ignore the request if it has already
  been completed. The server guarantees that for at least 60 minutes after
  the first request.

  For example, consider a situation where you make an initial request and
  the request times out. If you make the request again with the same request
  ID, the server can check to see whether the original operation
  was received. If it was, the server ignores the second request. This
  behavior prevents clients from mistakenly creating duplicate commitments.

  The request ID must be a valid UUID, with the exception that zero UUID is
  not supported (00000000-0000-0000-0000-000000000000).

@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/network_connectivity/v1/hub_service/client.rb, line 545
def delete_hub request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::NetworkConnectivity::V1::DeleteHubRequest

  # 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_hub.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::NetworkConnectivity::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_hub.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.delete_hub.retry_policy

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

  @hub_service_stub.call_rpc :delete_hub, 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_spoke(request, options = nil) { |response, operation| ... } click to toggle source

Deletes the specified spoke.

@overload delete_spoke(request, options = nil)

Pass arguments to `delete_spoke` via a request object, either of type
{::Google::Cloud::NetworkConnectivity::V1::DeleteSpokeRequest} or an equivalent Hash.

@param request [::Google::Cloud::NetworkConnectivity::V1::DeleteSpokeRequest, ::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_spoke(name: nil, request_id: nil)

Pass arguments to `delete_spoke` 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. The name of the spoke to delete.
@param request_id [::String]
  Optional. A unique request ID (optional). If you specify this ID, you can use it
  in cases when you need to retry your request. When you need to retry, this
  ID lets the server know that it can ignore the request if it has already
  been completed. The server guarantees that for at least 60 minutes after
  the first request.

  For example, consider a situation where you make an initial request and
  the request times out. If you make the request again with the same request
  ID, the server can check to see whether the original operation
  was received. If it was, the server ignores the second request. This
  behavior prevents clients from mistakenly creating duplicate commitments.

  The request ID must be a valid UUID, with the exception that zero UUID is
  not supported (00000000-0000-0000-0000-000000000000).

@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/network_connectivity/v1/hub_service/client.rb, line 952
def delete_spoke request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::NetworkConnectivity::V1::DeleteSpokeRequest

  # 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_spoke.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::NetworkConnectivity::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_spoke.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.delete_spoke.retry_policy

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

  @hub_service_stub.call_rpc :delete_spoke, 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_hub(request, options = nil) { |response, operation| ... } click to toggle source

Gets details about the specified hub.

@overload get_hub(request, options = nil)

Pass arguments to `get_hub` via a request object, either of type
{::Google::Cloud::NetworkConnectivity::V1::GetHubRequest} or an equivalent Hash.

@param request [::Google::Cloud::NetworkConnectivity::V1::GetHubRequest, ::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_hub(name: nil)

Pass arguments to `get_hub` 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. The name of the hub resource to get.

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

@return [::Google::Cloud::NetworkConnectivity::V1::Hub]

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

# File lib/google/cloud/network_connectivity/v1/hub_service/client.rb, line 284
def get_hub request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::NetworkConnectivity::V1::GetHubRequest

  # 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_hub.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::NetworkConnectivity::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_hub.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_hub.retry_policy

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

  @hub_service_stub.call_rpc :get_hub, 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
get_spoke(request, options = nil) { |response, operation| ... } click to toggle source

Gets details about the specified spoke.

@overload get_spoke(request, options = nil)

Pass arguments to `get_spoke` via a request object, either of type
{::Google::Cloud::NetworkConnectivity::V1::GetSpokeRequest} or an equivalent Hash.

@param request [::Google::Cloud::NetworkConnectivity::V1::GetSpokeRequest, ::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_spoke(name: nil)

Pass arguments to `get_spoke` 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. The name of the spoke resource.

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

@return [::Google::Cloud::NetworkConnectivity::V1::Spoke]

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

# File lib/google/cloud/network_connectivity/v1/hub_service/client.rb, line 691
def get_spoke request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::NetworkConnectivity::V1::GetSpokeRequest

  # 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_spoke.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::NetworkConnectivity::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_spoke.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_spoke.retry_policy

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

  @hub_service_stub.call_rpc :get_spoke, 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_hubs(request, options = nil) { |response, operation| ... } click to toggle source

Lists hubs in a given project.

@overload list_hubs(request, options = nil)

Pass arguments to `list_hubs` via a request object, either of type
{::Google::Cloud::NetworkConnectivity::V1::ListHubsRequest} or an equivalent Hash.

@param request [::Google::Cloud::NetworkConnectivity::V1::ListHubsRequest, ::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_hubs(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil)

Pass arguments to `list_hubs` 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 parent resource's name.
@param page_size [::Integer]
  The maximum number of results per page that should be returned.
@param page_token [::String]
  The page token.
@param filter [::String]
  An expression that filters the results listed in the response.
@param order_by [::String]
  Sort the results by a certain order.

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

@return [::Gapic::PagedEnumerable<::Google::Cloud::NetworkConnectivity::V1::Hub>]

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

# File lib/google/cloud/network_connectivity/v1/hub_service/client.rb, line 215
def list_hubs request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::NetworkConnectivity::V1::ListHubsRequest

  # 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_hubs.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::NetworkConnectivity::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_hubs.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_hubs.retry_policy

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

  @hub_service_stub.call_rpc :list_hubs, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @hub_service_stub, :list_hubs, 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
list_spokes(request, options = nil) { |response, operation| ... } click to toggle source

Lists the spokes in the specified project and location.

@overload list_spokes(request, options = nil)

Pass arguments to `list_spokes` via a request object, either of type
{::Google::Cloud::NetworkConnectivity::V1::ListSpokesRequest} or an equivalent Hash.

@param request [::Google::Cloud::NetworkConnectivity::V1::ListSpokesRequest, ::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_spokes(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil)

Pass arguments to `list_spokes` 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 parent resource.
@param page_size [::Integer]
  The maximum number of results per page that should be returned.
@param page_token [::String]
  The page token.
@param filter [::String]
  An expression that filters the results listed in the response.
@param order_by [::String]
  Sort the results by a certain order.

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

@return [::Gapic::PagedEnumerable<::Google::Cloud::NetworkConnectivity::V1::Spoke>]

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

# File lib/google/cloud/network_connectivity/v1/hub_service/client.rb, line 622
def list_spokes request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::NetworkConnectivity::V1::ListSpokesRequest

  # 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_spokes.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::NetworkConnectivity::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_spokes.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_spokes.retry_policy

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

  @hub_service_stub.call_rpc :list_spokes, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @hub_service_stub, :list_spokes, 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
update_hub(request, options = nil) { |response, operation| ... } click to toggle source

Updates the description and/or labels of the specified hub.

@overload update_hub(request, options = nil)

Pass arguments to `update_hub` via a request object, either of type
{::Google::Cloud::NetworkConnectivity::V1::UpdateHubRequest} or an equivalent Hash.

@param request [::Google::Cloud::NetworkConnectivity::V1::UpdateHubRequest, ::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 update_hub(update_mask: nil, hub: nil, request_id: nil)

Pass arguments to `update_hub` 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 update_mask [::Google::Protobuf::FieldMask, ::Hash]
  Optional. In the case of an update to an existing hub, field mask is used to specify
  the fields to be overwritten. The fields specified in the update_mask are
  relative to the resource, not the full request. A field is overwritten if
  it is in the mask. If the user does not provide a mask, then all fields are
  overwritten.
@param hub [::Google::Cloud::NetworkConnectivity::V1::Hub, ::Hash]
  Required. The state that the hub should be in after the update.
@param request_id [::String]
  Optional. A unique request ID (optional). If you specify this ID, you can use it
  in cases when you need to retry your request. When you need to retry, this
  ID lets the server know that it can ignore the request if it has already
  been completed. The server guarantees that for at least 60 minutes after
  the first request.

  For example, consider a situation where you make an initial request and
  the request times out. If you make the request again with the same request
  ID, the server can check to see whether the original operation
  was received. If it was, the server ignores the second request. This
  behavior prevents clients from mistakenly creating duplicate commitments.

  The request ID must be a valid UUID, with the exception that zero UUID is
  not supported (00000000-0000-0000-0000-000000000000).

@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/network_connectivity/v1/hub_service/client.rb, line 461
def update_hub request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::NetworkConnectivity::V1::UpdateHubRequest

  # 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.update_hub.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::NetworkConnectivity::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "hub.name" => request.hub.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.update_hub.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.update_hub.retry_policy

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

  @hub_service_stub.call_rpc :update_hub, 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
update_spoke(request, options = nil) { |response, operation| ... } click to toggle source

Updates the parameters of the specified spoke.

@overload update_spoke(request, options = nil)

Pass arguments to `update_spoke` via a request object, either of type
{::Google::Cloud::NetworkConnectivity::V1::UpdateSpokeRequest} or an equivalent Hash.

@param request [::Google::Cloud::NetworkConnectivity::V1::UpdateSpokeRequest, ::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 update_spoke(update_mask: nil, spoke: nil, request_id: nil)

Pass arguments to `update_spoke` 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 update_mask [::Google::Protobuf::FieldMask, ::Hash]
  Optional. In the case of an update to an existing spoke, field mask is used to
  specify the fields to be overwritten. The fields specified in the
  update_mask are relative to the resource, not the full request. A field is
  overwritten if it is in the mask. If the user does not provide a mask, then
  all fields are overwritten.
@param spoke [::Google::Cloud::NetworkConnectivity::V1::Spoke, ::Hash]
  Required. The state that the spoke should be in after the update.
@param request_id [::String]
  Optional. A unique request ID (optional). If you specify this ID, you can use it
  in cases when you need to retry your request. When you need to retry, this
  ID lets the server know that it can ignore the request if it has already
  been completed. The server guarantees that for at least 60 minutes after
  the first request.

  For example, consider a situation where you make an initial request and
  the request times out. If you make the request again with the same request
  ID, the server can check to see whether the original operation
  was received. If it was, the server ignores the second request. This
  behavior prevents clients from mistakenly creating duplicate commitments.

  The request ID must be a valid UUID, with the exception that zero UUID is
  not supported (00000000-0000-0000-0000-000000000000).

@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/network_connectivity/v1/hub_service/client.rb, line 868
def update_spoke request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::NetworkConnectivity::V1::UpdateSpokeRequest

  # 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.update_spoke.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::NetworkConnectivity::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "spoke.name" => request.spoke.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.update_spoke.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.update_spoke.retry_policy

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

  @hub_service_stub.call_rpc :update_spoke, 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