Cloud OS Config API - Module Google::Cloud::OsConfig (v1.7.1)

Reference documentation and code samples for the Cloud OS Config API module Google::Cloud::OsConfig.

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

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

About OsConfigService

OS Config API

The OS Config service is a server-side component that you can use to manage package installations and patch jobs for virtual machine instances.

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

Create a new client object for OsConfigZonalService.

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

About OsConfigZonalService

Zonal OS Config API

The OS Config service is the server-side component that allows users to manage package installations and patch jobs for Compute Engine VM instances.

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

value: "1.7.1"