module Google::Cloud::OsConfig
Constants
- VERSION
Public Class Methods
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 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.
@return [::Google::Cloud::Config] The default configuration used by this library
# File lib/google/cloud/os_config.rb, line 141 def self.configure yield ::Google::Cloud.configure.os_config if block_given? ::Google::Cloud.configure.os_config end
Create a new client object for OsConfigService.
By default, this returns an instance of [Google::Cloud::OsConfig::V1::OsConfigService::Client](googleapis.dev/ruby/google-cloud-os_config-v1/latest/Google/Cloud/OsConfig/V1/OsConfigService/Client.html) for version V1 of the API. However, you can specify 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.
## 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.
@param version [::String, ::Symbol] The API version to connect to. Optional.
Defaults to `:v1`.
@return [OsConfigService::Client] A client object for the specified version.
# File lib/google/cloud/os_config.rb, line 69 def self.os_config_service version: :v1, &block require "google/cloud/os_config/#{version.to_s.downcase}" package_name = Google::Cloud::OsConfig .constants .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") } .first package_module = Google::Cloud::OsConfig.const_get package_name package_module.const_get(:OsConfigService).const_get(:Client).new(&block) end
Create a new client object for OsConfigZonalService.
By default, this returns an instance of [Google::Cloud::OsConfig::V1::OsConfigZonalService::Client](googleapis.dev/ruby/google-cloud-os_config-v1/latest/Google/Cloud/OsConfig/V1/OsConfigZonalService/Client.html) for version V1 of the API. However, you can specify 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.
## 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.
@param version [::String, ::Symbol] The API version to connect to. Optional.
Defaults to `:v1`.
@return [OsConfigZonalService::Client] A client object for the specified version.
# File lib/google/cloud/os_config.rb, line 102 def self.os_config_zonal_service version: :v1, &block require "google/cloud/os_config/#{version.to_s.downcase}" package_name = Google::Cloud::OsConfig .constants .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") } .first package_module = Google::Cloud::OsConfig.const_get package_name package_module.const_get(:OsConfigZonalService).const_get(:Client).new(&block) end