Module: Google::Cloud::OsConfig

Defined in:
lib/google/cloud/os_config.rb,
lib/google/cloud/os_config/version.rb

Constant Summary collapse

VERSION = 
"1.7.2"

Class Method Summary collapse

Class Method Details

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

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.

Yields:

Returns:

  • (::Google::Cloud::Config) —

    The default configuration used by this library



222
223
224
225
226
 
# File 'lib/google/cloud/os_config.rb', line 222

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

  ::Google::Cloud.configure.os_config
end

.os_config_service(version: :v1, transport: :grpc, &block) ⇒ ::Object

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 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.

Parameters:

  • version (::String, ::Symbol) (defaults to: :v1) —

    The API version to connect to. Optional. Defaults to :v1.

  • transport (:grpc, :rest) (defaults to: :grpc) —

    The transport to use. Defaults to :grpc.

Returns:

  • (::Object) —

    A client object for the specified version.



78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/google/cloud/os_config.rb', line 78

def self.os_config_service version: :v1, transport: :grpc, &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
  service_module = Google::Cloud::OsConfig.const_get(package_name).const_get(:OsConfigService)
  service_module = service_module.const_get(:Rest) if transport == :rest
  service_module.const_get(:Client).new(&block)
end

.os_config_service_available?(version: :v1, transport: :grpc) ⇒ boolean

Determines whether the OsConfigService service is supported by the current client. If true, you can retrieve a client object by calling 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.

Parameters:

  • version (::String, ::Symbol) (defaults to: :v1) —

    The API version to connect to. Optional. Defaults to :v1.

  • transport (:grpc, :rest) (defaults to: :grpc) —

    The transport to use. Defaults to :grpc.

Returns:

  • (boolean) —

    Whether the service is available.



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/google/cloud/os_config.rb', line 102

def self.os_config_service_available? version: :v1, transport: :grpc
  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
  return false unless package_name
  service_module = Google::Cloud::OsConfig.const_get package_name
  return false unless service_module.const_defined? :OsConfigService
  service_module = service_module.const_get :OsConfigService
  if transport == :rest
    return false unless service_module.const_defined? :Rest
    service_module = service_module.const_get :Rest
  end
  service_module.const_defined? :Client
rescue ::LoadError
  false
end

.os_config_zonal_service(version: :v1, transport: :grpc, &block) ⇒ ::Object

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 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.

Parameters:

  • version (::String, ::Symbol) (defaults to: :v1) —

    The API version to connect to. Optional. Defaults to :v1.

  • transport (:grpc, :rest) (defaults to: :grpc) —

    The transport to use. Defaults to :grpc.

Returns:

  • (::Object) —

    A client object for the specified version.



151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/google/cloud/os_config.rb', line 151

def self.os_config_zonal_service version: :v1, transport: :grpc, &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
  service_module = Google::Cloud::OsConfig.const_get(package_name).const_get(:OsConfigZonalService)
  service_module = service_module.const_get(:Rest) if transport == :rest
  service_module.const_get(:Client).new(&block)
end

.os_config_zonal_service_available?(version: :v1, transport: :grpc) ⇒ boolean

Determines whether the OsConfigZonalService service is supported by the current client. If true, you can retrieve a client object by calling 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.

Parameters:

  • version (::String, ::Symbol) (defaults to: :v1) —

    The API version to connect to. Optional. Defaults to :v1.

  • transport (:grpc, :rest) (defaults to: :grpc) —

    The transport to use. Defaults to :grpc.

Returns:

  • (boolean) —

    Whether the service is available.



175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
 
# File 'lib/google/cloud/os_config.rb', line 175

def self.os_config_zonal_service_available? version: :v1, transport: :grpc
  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
  return false unless package_name
  service_module = Google::Cloud::OsConfig.const_get package_name
  return false unless service_module.const_defined? :OsConfigZonalService
  service_module = service_module.const_get :OsConfigZonalService
  if transport == :rest
    return false unless service_module.const_defined? :Rest
    service_module = service_module.const_get :Rest
  end
  service_module.const_defined? :Client
rescue ::LoadError
  false
end