BeyondCorp API - Module Google::Cloud::BeyondCorp::ClientGateways (v0.1.0)

Reference documentation and code samples for the BeyondCorp API module Google::Cloud::BeyondCorp::ClientGateways.



def self.client_gateways_service(version: :v1, &block) -> ClientGatewaysService::Client

Create a new client object for ClientGatewaysService.

By default, this returns an instance of Google::Cloud::BeyondCorp::ClientGateways::V1::ClientGatewaysService::Client for version V1 of the API. However, you can specify 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 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}.
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
  • (ClientGatewaysService::Client) — A client object for the specified version.


def self.configure() -> ::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 gRPC 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.
  • (::Google::Cloud.configure.beyond_corp_client_gateways)
  • (::Google::Cloud::Config) — The default configuration used by this library