Class: Google::Cloud::OsConfig::V1::OsConfigService::Client

Inherits:
Object
  • Object
show all
Includes:
Paths
Defined in:
lib/google/cloud/os_config/v1/os_config_service/client.rb

Overview

Client for the OsConfigService service.

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.

Defined Under Namespace

Classes: Configuration

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Paths

#patch_deployment_path, #patch_job_path, #project_path

Constructor Details

#initialize {|config| ... } ⇒ Client

Create a new OsConfigService client object.

Examples:


# Create a client using the default configuration
client = ::Google::Cloud::OsConfig::V1::OsConfigService::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::OsConfig::V1::OsConfigService::Client.new do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the OsConfigService client.

Yield Parameters:



129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
 
# File 'lib/google/cloud/os_config/v1/os_config_service/client.rb', line 129

def initialize
  # These require statements are intentionally placed here to initialize
  # the gRPC module only when it's required.
  # See https://github.com/googleapis/toolkit/issues/446
  require "gapic/grpc"
  require "google/cloud/osconfig/v1/osconfig_service_services_pb"

  # Create the configuration object
  @config = Configuration.new Client.configure

  # Yield the configuration if needed
  yield @config if block_given?

  # Create credentials
  credentials = @config.credentials
  # Use self-signed JWT if the endpoint is unchanged from default,
  # but only if the default endpoint does not have a region prefix.
  enable_self_signed_jwt = @config.endpoint.nil? ||
                           (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
                           !@config.endpoint.split(".").first.include?("-"))
  credentials ||= Credentials.default scope: @config.scope,
                                      enable_self_signed_jwt: enable_self_signed_jwt
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
    credentials = Credentials.new credentials, scope: @config.scope
  end
  @quota_project_id = @config.quota_project
  @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id

  @os_config_service_stub = ::Gapic::ServiceStub.new(
    ::Google::Cloud::OsConfig::V1::OsConfigService::Stub,
    credentials: credentials,
    endpoint: @config.endpoint,
    endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
    universe_domain: @config.universe_domain,
    channel_args: @config.channel_args,
    interceptors: @config.interceptors,
    channel_pool_config: @config.channel_pool
  )
end

Class Method Details

.configure {|config| ... } ⇒ Client::Configuration

Configure the OsConfigService Client class.

See Configuration for a description of the configuration fields.

Examples:


# Modify the configuration for all OsConfigService clients
::Google::Cloud::OsConfig::V1::OsConfigService::Client.configure do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/google/cloud/os_config/v1/os_config_service/client.rb', line 62

def self.configure
  @configure ||= begin
    namespace = ["Google", "Cloud", "OsConfig", "V1"]
    parent_config = while namespace.any?
                      parent_name = namespace.join "::"
                      parent_const = const_get parent_name
                      break parent_const.configure if parent_const.respond_to? :configure
                      namespace.pop
                    end
    default_config = Client::Configuration.new parent_config

    default_config.timeout = 60.0
    default_config.retry_policy = {
      initial_delay: 1.0, max_delay: 60.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config
  end
  yield @configure if block_given?
  @configure
end

Instance Method Details

#cancel_patch_job(request, options = nil) ⇒ ::Google::Cloud::OsConfig::V1::PatchJob #cancel_patch_job(name: nil) ⇒ ::Google::Cloud::OsConfig::V1::PatchJob

Cancel a patch job. The patch job must be active. Canceled patch jobs cannot be restarted.

Examples:

Basic example

require "google/cloud/os_config/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::OsConfig::V1::OsConfigService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::OsConfig::V1::CancelPatchJobRequest.new

# Call the cancel_patch_job method.
result = client.cancel_patch_job request

# The returned object is of type Google::Cloud::OsConfig::V1::PatchJob.
p result

Overloads:

  • #cancel_patch_job(request, options = nil) ⇒ ::Google::Cloud::OsConfig::V1::PatchJob

    Pass arguments to cancel_patch_job via a request object, either of type CancelPatchJobRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::OsConfig::V1::CancelPatchJobRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #cancel_patch_job(name: nil) ⇒ ::Google::Cloud::OsConfig::V1::PatchJob

    Pass arguments to cancel_patch_job via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. Name of the patch in the form projects/*/patchJobs/*

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
 
# File 'lib/google/cloud/os_config/v1/os_config_service/client.rb', line 406

def cancel_patch_job request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::OsConfig::V1::CancelPatchJobRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.cancel_patch_job.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::OsConfig::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.cancel_patch_job.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.cancel_patch_job.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @os_config_service_stub.call_rpc :cancel_patch_job, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#configure {|config| ... } ⇒ Client::Configuration

Configure the OsConfigService Client instance.

The configuration is set to the derived mode, meaning that values can be changed, but structural changes (adding new fields, etc.) are not allowed. Structural changes should be made on configure.

See Configuration for a description of the configuration fields.

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



99
100
101
102
 
# File 'lib/google/cloud/os_config/v1/os_config_service/client.rb', line 99

def configure
  yield @config if block_given?
  @config
end

#create_patch_deployment(request, options = nil) ⇒ ::Google::Cloud::OsConfig::V1::PatchDeployment #create_patch_deployment(parent: nil, patch_deployment_id: nil, patch_deployment: nil) ⇒ ::Google::Cloud::OsConfig::V1::PatchDeployment

Create an OS Config patch deployment.

Examples:

Basic example

require "google/cloud/os_config/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::OsConfig::V1::OsConfigService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::OsConfig::V1::CreatePatchDeploymentRequest.new

# Call the create_patch_deployment method.
result = client.create_patch_deployment request

# The returned object is of type Google::Cloud::OsConfig::V1::PatchDeployment.
p result

Overloads:

  • #create_patch_deployment(request, options = nil) ⇒ ::Google::Cloud::OsConfig::V1::PatchDeployment

    Pass arguments to create_patch_deployment via a request object, either of type CreatePatchDeploymentRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::OsConfig::V1::CreatePatchDeploymentRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #create_patch_deployment(parent: nil, patch_deployment_id: nil, patch_deployment: nil) ⇒ ::Google::Cloud::OsConfig::V1::PatchDeployment

    Pass arguments to create_patch_deployment via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • parent (::String) (defaults to: nil) —

      Required. The project to apply this patch deployment to in the form projects/*.

    • patch_deployment_id (::String) (defaults to: nil) —

      Required. A name for the patch deployment in the project. When creating a name the following rules apply:

      • Must contain only lowercase letters, numbers, and hyphens.
      • Must start with a letter.
      • Must be between 1-63 characters.
      • Must end with a number or a letter.
      • Must be unique within the project.
    • patch_deployment (::Google::Cloud::OsConfig::V1::PatchDeployment, ::Hash) (defaults to: nil) —

      Required. The patch deployment to create.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
 
# File 'lib/google/cloud/os_config/v1/os_config_service/client.rb', line 701

def create_patch_deployment request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::OsConfig::V1::CreatePatchDeploymentRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.create_patch_deployment.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::OsConfig::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.create_patch_deployment.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.create_patch_deployment.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @os_config_service_stub.call_rpc :create_patch_deployment, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#delete_patch_deployment(request, options = nil) ⇒ ::Google::Protobuf::Empty #delete_patch_deployment(name: nil) ⇒ ::Google::Protobuf::Empty

Delete an OS Config patch deployment.

Examples:

Basic example

require "google/cloud/os_config/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::OsConfig::V1::OsConfigService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::OsConfig::V1::DeletePatchDeploymentRequest.new

# Call the delete_patch_deployment method.
result = client.delete_patch_deployment request

# The returned object is of type Google::Protobuf::Empty.
p result

Overloads:

  • #delete_patch_deployment(request, options = nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to delete_patch_deployment via a request object, either of type DeletePatchDeploymentRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::OsConfig::V1::DeletePatchDeploymentRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #delete_patch_deployment(name: nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to delete_patch_deployment via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. The resource name of the patch deployment in the form projects/*/patchDeployments/*.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
 
# File 'lib/google/cloud/os_config/v1/os_config_service/client.rb', line 970

def delete_patch_deployment request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::OsConfig::V1::DeletePatchDeploymentRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.delete_patch_deployment.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::OsConfig::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.delete_patch_deployment.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.delete_patch_deployment.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @os_config_service_stub.call_rpc :delete_patch_deployment, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#execute_patch_job(request, options = nil) ⇒ ::Google::Cloud::OsConfig::V1::PatchJob #execute_patch_job(parent: nil, description: nil, instance_filter: nil, patch_config: nil, duration: nil, dry_run: nil, display_name: nil, rollout: nil) ⇒ ::Google::Cloud::OsConfig::V1::PatchJob

Patch VM instances by creating and running a patch job.

Examples:

Basic example

require "google/cloud/os_config/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::OsConfig::V1::OsConfigService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::OsConfig::V1::ExecutePatchJobRequest.new

# Call the execute_patch_job method.
result = client.execute_patch_job request

# The returned object is of type Google::Cloud::OsConfig::V1::PatchJob.
p result

Overloads:

  • #execute_patch_job(request, options = nil) ⇒ ::Google::Cloud::OsConfig::V1::PatchJob

    Pass arguments to execute_patch_job via a request object, either of type ExecutePatchJobRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::OsConfig::V1::ExecutePatchJobRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #execute_patch_job(parent: nil, description: nil, instance_filter: nil, patch_config: nil, duration: nil, dry_run: nil, display_name: nil, rollout: nil) ⇒ ::Google::Cloud::OsConfig::V1::PatchJob

    Pass arguments to execute_patch_job via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • parent (::String) (defaults to: nil) —

      Required. The project in which to run this patch in the form projects/*

    • description (::String) (defaults to: nil) —

      Description of the patch job. Length of the description is limited to 1024 characters.

    • instance_filter (::Google::Cloud::OsConfig::V1::PatchInstanceFilter, ::Hash) (defaults to: nil) —

      Required. Instances to patch, either explicitly or filtered by some criteria such as zone or labels.

    • patch_config (::Google::Cloud::OsConfig::V1::PatchConfig, ::Hash) (defaults to: nil) —

      Patch configuration being applied. If omitted, instances are patched using the default configurations.

    • duration (::Google::Protobuf::Duration, ::Hash) (defaults to: nil) —

      Duration of the patch job. After the duration ends, the patch job times out.

    • dry_run (::Boolean) (defaults to: nil) —

      If this patch is a dry-run only, instances are contacted but will do nothing.

    • display_name (::String) (defaults to: nil) —

      Display name for this patch job. This does not have to be unique.

    • rollout (::Google::Cloud::OsConfig::V1::PatchRollout, ::Hash) (defaults to: nil) —

      Rollout strategy of the patch job.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
 
# File 'lib/google/cloud/os_config/v1/os_config_service/client.rb', line 234

def execute_patch_job request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::OsConfig::V1::ExecutePatchJobRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.execute_patch_job.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::OsConfig::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.execute_patch_job.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.execute_patch_job.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @os_config_service_stub.call_rpc :execute_patch_job, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_patch_deployment(request, options = nil) ⇒ ::Google::Cloud::OsConfig::V1::PatchDeployment #get_patch_deployment(name: nil) ⇒ ::Google::Cloud::OsConfig::V1::PatchDeployment

Get an OS Config patch deployment.

Examples:

Basic example

require "google/cloud/os_config/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::OsConfig::V1::OsConfigService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::OsConfig::V1::GetPatchDeploymentRequest.new

# Call the get_patch_deployment method.
result = client.get_patch_deployment request

# The returned object is of type Google::Cloud::OsConfig::V1::PatchDeployment.
p result

Overloads:

  • #get_patch_deployment(request, options = nil) ⇒ ::Google::Cloud::OsConfig::V1::PatchDeployment

    Pass arguments to get_patch_deployment via a request object, either of type GetPatchDeploymentRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::OsConfig::V1::GetPatchDeploymentRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #get_patch_deployment(name: nil) ⇒ ::Google::Cloud::OsConfig::V1::PatchDeployment

    Pass arguments to get_patch_deployment via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. The resource name of the patch deployment in the form projects/*/patchDeployments/*.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
 
# File 'lib/google/cloud/os_config/v1/os_config_service/client.rb', line 787

def get_patch_deployment request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::OsConfig::V1::GetPatchDeploymentRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.get_patch_deployment.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::OsConfig::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.get_patch_deployment.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_patch_deployment.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @os_config_service_stub.call_rpc :get_patch_deployment, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_patch_job(request, options = nil) ⇒ ::Google::Cloud::OsConfig::V1::PatchJob #get_patch_job(name: nil) ⇒ ::Google::Cloud::OsConfig::V1::PatchJob

Get the patch job. This can be used to track the progress of an ongoing patch job or review the details of completed jobs.

Examples:

Basic example

require "google/cloud/os_config/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::OsConfig::V1::OsConfigService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::OsConfig::V1::GetPatchJobRequest.new

# Call the get_patch_job method.
result = client.get_patch_job request

# The returned object is of type Google::Cloud::OsConfig::V1::PatchJob.
p result

Overloads:

  • #get_patch_job(request, options = nil) ⇒ ::Google::Cloud::OsConfig::V1::PatchJob

    Pass arguments to get_patch_job via a request object, either of type GetPatchJobRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::OsConfig::V1::GetPatchJobRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #get_patch_job(name: nil) ⇒ ::Google::Cloud::OsConfig::V1::PatchJob

    Pass arguments to get_patch_job via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. Name of the patch in the form projects/*/patchJobs/*

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
 
# File 'lib/google/cloud/os_config/v1/os_config_service/client.rb', line 320

def get_patch_job request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::OsConfig::V1::GetPatchJobRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.get_patch_job.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::OsConfig::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.get_patch_job.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_patch_job.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @os_config_service_stub.call_rpc :get_patch_job, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_patch_deployments(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::OsConfig::V1::PatchDeployment> #list_patch_deployments(parent: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::OsConfig::V1::PatchDeployment>

Get a page of OS Config patch deployments.

Examples:

Basic example

require "google/cloud/os_config/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::OsConfig::V1::OsConfigService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::OsConfig::V1::ListPatchDeploymentsRequest.new

# Call the list_patch_deployments method.
result = client.list_patch_deployments request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::OsConfig::V1::PatchDeployment.
  p item
end

Overloads:

  • #list_patch_deployments(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::OsConfig::V1::PatchDeployment>

    Pass arguments to list_patch_deployments via a request object, either of type ListPatchDeploymentsRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::OsConfig::V1::ListPatchDeploymentsRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #list_patch_deployments(parent: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::OsConfig::V1::PatchDeployment>

    Pass arguments to list_patch_deployments via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • parent (::String) (defaults to: nil) —

      Required. The resource name of the parent in the form projects/*.

    • page_size (::Integer) (defaults to: nil) —

      Optional. The maximum number of patch deployments to return. Default is 100.

    • page_token (::String) (defaults to: nil) —

      Optional. A pagination token returned from a previous call to ListPatchDeployments that indicates where this listing should continue from.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
 
# File 'lib/google/cloud/os_config/v1/os_config_service/client.rb', line 883

def list_patch_deployments request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::OsConfig::V1::ListPatchDeploymentsRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.list_patch_deployments.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::OsConfig::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.list_patch_deployments.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_patch_deployments.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @os_config_service_stub.call_rpc :list_patch_deployments, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @os_config_service_stub, :list_patch_deployments, request, response, operation, options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_patch_job_instance_details(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::OsConfig::V1::PatchJobInstanceDetails> #list_patch_job_instance_details(parent: nil, page_size: nil, page_token: nil, filter: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::OsConfig::V1::PatchJobInstanceDetails>

Get a list of instance details for a given patch job.

Examples:

Basic example

require "google/cloud/os_config/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::OsConfig::V1::OsConfigService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::OsConfig::V1::ListPatchJobInstanceDetailsRequest.new

# Call the list_patch_job_instance_details method.
result = client.list_patch_job_instance_details request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::OsConfig::V1::PatchJobInstanceDetails.
  p item
end

Overloads:

  • #list_patch_job_instance_details(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::OsConfig::V1::PatchJobInstanceDetails>

    Pass arguments to list_patch_job_instance_details via a request object, either of type ListPatchJobInstanceDetailsRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::OsConfig::V1::ListPatchJobInstanceDetailsRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #list_patch_job_instance_details(parent: nil, page_size: nil, page_token: nil, filter: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::OsConfig::V1::PatchJobInstanceDetails>

    Pass arguments to list_patch_job_instance_details via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • parent (::String) (defaults to: nil) —

      Required. The parent for the instances are in the form of projects/*/patchJobs/*.

    • page_size (::Integer) (defaults to: nil) —

      The maximum number of instance details records to return. Default is 100.

    • page_token (::String) (defaults to: nil) —

      A pagination token returned from a previous call that indicates where this listing should continue from.

    • filter (::String) (defaults to: nil) —

      A filter expression that filters results listed in the response. This field supports filtering results by instance zone, name, state, or failure_reason.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
 
# File 'lib/google/cloud/os_config/v1/os_config_service/client.rb', line 604

def list_patch_job_instance_details request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::OsConfig::V1::ListPatchJobInstanceDetailsRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.list_patch_job_instance_details.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::OsConfig::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.list_patch_job_instance_details.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_patch_job_instance_details.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @os_config_service_stub.call_rpc :list_patch_job_instance_details, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @os_config_service_stub, :list_patch_job_instance_details, request, response, operation, options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_patch_jobs(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::OsConfig::V1::PatchJob> #list_patch_jobs(parent: nil, page_size: nil, page_token: nil, filter: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::OsConfig::V1::PatchJob>

Get a list of patch jobs.

Examples:

Basic example

require "google/cloud/os_config/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::OsConfig::V1::OsConfigService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::OsConfig::V1::ListPatchJobsRequest.new

# Call the list_patch_jobs method.
result = client.list_patch_jobs request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::OsConfig::V1::PatchJob.
  p item
end

Overloads:

  • #list_patch_jobs(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::OsConfig::V1::PatchJob>

    Pass arguments to list_patch_jobs via a request object, either of type ListPatchJobsRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::OsConfig::V1::ListPatchJobsRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #list_patch_jobs(parent: nil, page_size: nil, page_token: nil, filter: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::OsConfig::V1::PatchJob>

    Pass arguments to list_patch_jobs via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • parent (::String) (defaults to: nil) —

      Required. In the form of projects/*

    • page_size (::Integer) (defaults to: nil) —

      The maximum number of instance status to return.

    • page_token (::String) (defaults to: nil) —

      A pagination token returned from a previous call that indicates where this listing should continue from.

    • filter (::String) (defaults to: nil) —

      If provided, this field specifies the criteria that must be met by patch jobs to be included in the response. Currently, filtering is only available on the patch_deployment field.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
 
# File 'lib/google/cloud/os_config/v1/os_config_service/client.rb', line 504

def list_patch_jobs request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::OsConfig::V1::ListPatchJobsRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.list_patch_jobs.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::OsConfig::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.list_patch_jobs.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_patch_jobs.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @os_config_service_stub.call_rpc :list_patch_jobs, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @os_config_service_stub, :list_patch_jobs, request, response, operation, options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#pause_patch_deployment(request, options = nil) ⇒ ::Google::Cloud::OsConfig::V1::PatchDeployment #pause_patch_deployment(name: nil) ⇒ ::Google::Cloud::OsConfig::V1::PatchDeployment

Change state of patch deployment to "PAUSED". Patch deployment in paused state doesn't generate patch jobs.

Examples:

Basic example

require "google/cloud/os_config/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::OsConfig::V1::OsConfigService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::OsConfig::V1::PausePatchDeploymentRequest.new

# Call the pause_patch_deployment method.
result = client.pause_patch_deployment request

# The returned object is of type Google::Cloud::OsConfig::V1::PatchDeployment.
p result

Overloads:

  • #pause_patch_deployment(request, options = nil) ⇒ ::Google::Cloud::OsConfig::V1::PatchDeployment

    Pass arguments to pause_patch_deployment via a request object, either of type PausePatchDeploymentRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::OsConfig::V1::PausePatchDeploymentRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #pause_patch_deployment(name: nil) ⇒ ::Google::Cloud::OsConfig::V1::PatchDeployment

    Pass arguments to pause_patch_deployment via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. The resource name of the patch deployment in the form projects/*/patchDeployments/*.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
 
# File 'lib/google/cloud/os_config/v1/os_config_service/client.rb', line 1145

def pause_patch_deployment request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::OsConfig::V1::PausePatchDeploymentRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.pause_patch_deployment.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::OsConfig::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.pause_patch_deployment.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.pause_patch_deployment.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @os_config_service_stub.call_rpc :pause_patch_deployment, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#resume_patch_deployment(request, options = nil) ⇒ ::Google::Cloud::OsConfig::V1::PatchDeployment #resume_patch_deployment(name: nil) ⇒ ::Google::Cloud::OsConfig::V1::PatchDeployment

Change state of patch deployment back to "ACTIVE". Patch deployment in active state continues to generate patch jobs.

Examples:

Basic example

require "google/cloud/os_config/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::OsConfig::V1::OsConfigService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::OsConfig::V1::ResumePatchDeploymentRequest.new

# Call the resume_patch_deployment method.
result = client.resume_patch_deployment request

# The returned object is of type Google::Cloud::OsConfig::V1::PatchDeployment.
p result

Overloads:

  • #resume_patch_deployment(request, options = nil) ⇒ ::Google::Cloud::OsConfig::V1::PatchDeployment

    Pass arguments to resume_patch_deployment via a request object, either of type ResumePatchDeploymentRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::OsConfig::V1::ResumePatchDeploymentRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #resume_patch_deployment(name: nil) ⇒ ::Google::Cloud::OsConfig::V1::PatchDeployment

    Pass arguments to resume_patch_deployment via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. The resource name of the patch deployment in the form projects/*/patchDeployments/*.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
 
# File 'lib/google/cloud/os_config/v1/os_config_service/client.rb', line 1232

def resume_patch_deployment request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::OsConfig::V1::ResumePatchDeploymentRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.resume_patch_deployment.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::OsConfig::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.resume_patch_deployment.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.resume_patch_deployment.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @os_config_service_stub.call_rpc :resume_patch_deployment, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#universe_domain ⇒ String

The effective universe domain

Returns:

  • (String) 


109
110
111
 
# File 'lib/google/cloud/os_config/v1/os_config_service/client.rb', line 109

def universe_domain
  @os_config_service_stub.universe_domain
end

#update_patch_deployment(request, options = nil) ⇒ ::Google::Cloud::OsConfig::V1::PatchDeployment #update_patch_deployment(patch_deployment: nil, update_mask: nil) ⇒ ::Google::Cloud::OsConfig::V1::PatchDeployment

Update an OS Config patch deployment.

Examples:

Basic example

require "google/cloud/os_config/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::OsConfig::V1::OsConfigService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::OsConfig::V1::UpdatePatchDeploymentRequest.new

# Call the update_patch_deployment method.
result = client.update_patch_deployment request

# The returned object is of type Google::Cloud::OsConfig::V1::PatchDeployment.
p result

Overloads:

  • #update_patch_deployment(request, options = nil) ⇒ ::Google::Cloud::OsConfig::V1::PatchDeployment

    Pass arguments to update_patch_deployment via a request object, either of type UpdatePatchDeploymentRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::OsConfig::V1::UpdatePatchDeploymentRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #update_patch_deployment(patch_deployment: nil, update_mask: nil) ⇒ ::Google::Cloud::OsConfig::V1::PatchDeployment

    Pass arguments to update_patch_deployment via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
 
# File 'lib/google/cloud/os_config/v1/os_config_service/client.rb', line 1058

def update_patch_deployment request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::OsConfig::V1::UpdatePatchDeploymentRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.update_patch_deployment.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::OsConfig::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.patch_deployment&.name
    header_params["patch_deployment.name"] = request.patch_deployment.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.update_patch_deployment.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.update_patch_deployment.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @os_config_service_stub.call_rpc :update_patch_deployment, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end