Module: Google::Cloud::BeyondCorp::AppConnections

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

Class Method Summary collapse

Class Method Details

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

Create a new client object for AppConnectionsService.

By default, this returns an instance of Google::Cloud::BeyondCorp::AppConnections::V1::AppConnectionsService::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 AppConnectionsService 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 AppConnectionsService service. You can determine whether the method will succeed by calling app_connections_service_available?.

About AppConnectionsService

API Overview:

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

Data Model:

The AppConnectionsService exposes the following resources:

  • AppConnections, named as follows: projects/{project_id}/locations/{location_id}/appConnections/{app_connection_id}.

The AppConnectionsService service provides methods to manage (create/read/update/delete) BeyondCorp AppConnections.

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.



86
87
88
89
90
91
92
93
94
95
 
# File 'lib/google/cloud/beyond_corp/app_connections.rb', line 86

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

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

.app_connections_service_available?(version: :v1) ⇒ boolean

Determines whether the AppConnectionsService service is supported by the current client. If true, you can retrieve a client object by calling app_connections_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 AppConnectionsService service, or if the versioned client gem needs an update to support the AppConnectionsService 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.



108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'lib/google/cloud/beyond_corp/app_connections.rb', line 108

def self.app_connections_service_available? version: :v1
  require "google/cloud/beyond_corp/app_connections/#{version.to_s.downcase}"
  package_name = Google::Cloud::BeyondCorp::AppConnections
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  return false unless package_name
  service_module = Google::Cloud::BeyondCorp::AppConnections.const_get package_name
  return false unless service_module.const_defined? :AppConnectionsService
  service_module = service_module.const_get :AppConnectionsService
  service_module.const_defined? :Client
rescue ::LoadError
  false
end

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

Configure the google-cloud-beyond_corp-app_connections 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



151
152
153
154
155
 
# File 'lib/google/cloud/beyond_corp/app_connections.rb', line 151

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

  ::Google::Cloud.configure.beyond_corp_app_connections
end