Module: Google::Cloud::BeyondCorp::ClientGateways

Defined in:
lib/google/cloud/beyond_corp/client_gateways.rb,
lib/google/cloud/beyond_corp/client_gateways/version.rb

Class Method Summary collapse

Class Method Details

.client_gateways_service(version: :v1, &block) ⇒ ::Object

Create a new client object for ClientGatewaysService.

By default, this returns an instance of Google::Cloud::BeyondCorp::ClientGateways::V1::ClientGatewaysService::Client for a gRPC client for version V1 of the API. However, you can specify a different API version by passing it in the version parameter. If the ClientGatewaysService service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned.

About ClientGatewaysService

API Overview:

The beyondcorp.googleapis.com service implements the Google Cloud BeyondCorp API.

Data Model:

The ClientGatewaysService exposes the following resources:

  • Client Gateways, named as follows: projects/{project_id}/locations/{location_id}/clientGateways/{client_gateway_id}.

Parameters:

  • version (::String, ::Symbol) (defaults to: :v1) —

    The API version to connect to. Optional. Defaults to :v1.

Returns:

  • (::Object) —

    A client object for the specified version.



78
79
80
81
82
83
84
85
86
87
 
# File 'lib/google/cloud/beyond_corp/client_gateways.rb', line 78

def self.client_gateways_service version: :v1, &block
  require "google/cloud/beyond_corp/client_gateways/#{version.to_s.downcase}"

  package_name = Google::Cloud::BeyondCorp::ClientGateways
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  service_module = Google::Cloud::BeyondCorp::ClientGateways.const_get(package_name).const_get(:ClientGatewaysService)
  service_module.const_get(:Client).new(&block)
end

.configure {|::Google::Cloud.configure.beyond_corp_client_gateways| ... } ⇒ ::Google::Cloud::Config

Configure the google-cloud-beyond_corp-client_gateways library.

The following configuration parameters are supported:

  • credentials (type: String, Hash, Google::Auth::Credentials) - The path to the keyfile as a String, the contents of the keyfile as a Hash, or a Google::Auth::Credentials object.
  • lib_name (type: String) - The library name as recorded in instrumentation and logging.
  • lib_version (type: String) - The library version as recorded in instrumentation and logging.
  • interceptors (type: Array<GRPC::ClientInterceptor>) - An array of interceptors that are run before calls are executed.
  • timeout (type: Numeric) - Default timeout in seconds.
  • metadata (type: Hash{Symbol=>String}) - Additional headers to be sent with the call.
  • retry_policy (type: Hash) - The retry policy. The value is a hash with the following keys:
    • :initial_delay (type: Numeric) - The initial delay in seconds.
    • :max_delay (type: Numeric) - The max delay in seconds.
    • :multiplier (type: Numeric) - The incremental backoff multiplier.
    • :retry_codes (type: Array<String>) - The error codes that should trigger a retry.

Yields:

Returns:

  • (::Google::Cloud::Config) —

    The default configuration used by this library



117
118
119
120
121
 
# File 'lib/google/cloud/beyond_corp/client_gateways.rb', line 117

def self.configure
  yield ::Google::Cloud.configure.beyond_corp_client_gateways if block_given?

  ::Google::Cloud.configure.beyond_corp_client_gateways
end