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.

Raises an exception if the currently installed versioned client gem for the given API version does not support the ClientGatewaysService service. You can determine whether the method will succeed by calling client_gateways_service_available?.

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.



83
84
85
86
87
88
89
90
91
92
 
# File 'lib/google/cloud/beyond_corp/client_gateways.rb', line 83

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

.client_gateways_service_available?(version: :v1) ⇒ boolean

Determines whether the ClientGatewaysService service is supported by the current client. If true, you can retrieve a client object by calling client_gateways_service. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the ClientGatewaysService service, or if the versioned client gem needs an update to support the ClientGatewaysService service.

Parameters:

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

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

Returns:

  • (boolean) —

    Whether the service is available.



105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/google/cloud/beyond_corp/client_gateways.rb', line 105

def self.client_gateways_service_available? version: :v1
  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
  return false unless package_name
  service_module = Google::Cloud::BeyondCorp::ClientGateways.const_get package_name
  return false unless service_module.const_defined? :ClientGatewaysService
  service_module = service_module.const_get :ClientGatewaysService
  service_module.const_defined? :Client
rescue ::LoadError
  false
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



148
149
150
151
152
 
# File 'lib/google/cloud/beyond_corp/client_gateways.rb', line 148

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

  ::Google::Cloud.configure.beyond_corp_client_gateways
end