Telco Automation API - Module Google::Cloud::TelcoAutomation (v2.0.1)

Reference documentation and code samples for the Telco Automation API module Google::Cloud::TelcoAutomation.

Configure the google-cloud-telco_automation 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.

Create a new client object for TelcoAutomation.

By default, this returns an instance of Google::Cloud::TelcoAutomation::V1::TelcoAutomation::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 TelcoAutomation service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

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

About TelcoAutomation

TelcoAutomation Service manages the control plane cluster a.k.a. Orchestration Cluster (GKE cluster with config controller) of TNA. It also exposes blueprint APIs which manages the lifecycle of blueprints that control the infrastructure setup (e.g GDCE clusters) and deployment of network functions.

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

value: "2.0.1"