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

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

Overview

REST 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 REST client object.

Examples:


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

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

Yields:

  • (config) —

    Configure the OsConfigService client.

Yield Parameters:



119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'lib/google/cloud/os_config/v1/os_config_service/rest/client.rb', line 119

def initialize
  # 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 == Client.configure.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 = ::Google::Cloud::OsConfig::V1::OsConfigService::Rest::ServiceStub.new endpoint: @config.endpoint, credentials: credentials
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::Rest::Client.configure do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



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

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.

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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



318
319
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
 
# File 'lib/google/cloud/os_config/v1/os_config_service/rest/client.rb', line 318

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
  call_metadata = @config.rpcs.cancel_patch_job.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.cancel_patch_job.timeout,
                         metadata:     call_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.cancel_patch_job request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => 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:



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

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.

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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
 
# File 'lib/google/cloud/os_config/v1/os_config_service/rest/client.rb', line 536

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
  call_metadata = @config.rpcs.create_patch_deployment.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.create_patch_deployment.timeout,
                         metadata:     call_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.create_patch_deployment request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => 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.

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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
 
# File 'lib/google/cloud/os_config/v1/os_config_service/rest/client.rb', line 732

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
  call_metadata = @config.rpcs.delete_patch_deployment.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.delete_patch_deployment.timeout,
                         metadata:     call_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.delete_patch_deployment request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => 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.

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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
 
# File 'lib/google/cloud/os_config/v1/os_config_service/rest/client.rb', line 192

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
  call_metadata = @config.rpcs.execute_patch_job.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.execute_patch_job.timeout,
                         metadata:     call_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.execute_patch_job request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => 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.

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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



599
600
601
602
603
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
 
# File 'lib/google/cloud/os_config/v1/os_config_service/rest/client.rb', line 599

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
  call_metadata = @config.rpcs.get_patch_deployment.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.get_patch_deployment.timeout,
                         metadata:     call_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.get_patch_deployment request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => 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.

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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
 
# File 'lib/google/cloud/os_config/v1/os_config_service/rest/client.rb', line 255

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
  call_metadata = @config.rpcs.get_patch_job.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.get_patch_job.timeout,
                         metadata:     call_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.get_patch_job request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

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

Get a page of OS Config patch deployments.

Overloads:

  • #list_patch_deployments(request, options = nil) ⇒ ::Gapic::Rest::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::Rest::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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
 
# File 'lib/google/cloud/os_config/v1/os_config_service/rest/client.rb', line 668

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
  call_metadata = @config.rpcs.list_patch_deployments.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.list_patch_deployments.timeout,
                         metadata:     call_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.list_patch_deployments request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @os_config_service_stub, :list_patch_deployments, "patch_deployments", request, result, options
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

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

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

Overloads:

  • #list_patch_job_instance_details(request, options = nil) ⇒ ::Gapic::Rest::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::Rest::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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
 
# File 'lib/google/cloud/os_config/v1/os_config_service/rest/client.rb', line 462

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
  call_metadata = @config.rpcs.list_patch_job_instance_details.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.list_patch_job_instance_details.timeout,
                         metadata:     call_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.list_patch_job_instance_details request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @os_config_service_stub, :list_patch_job_instance_details, "patch_job_instance_details", request, result, options
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

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

Get a list of patch jobs.

Overloads:

  • #list_patch_jobs(request, options = nil) ⇒ ::Gapic::Rest::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::Rest::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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
 
# File 'lib/google/cloud/os_config/v1/os_config_service/rest/client.rb', line 389

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
  call_metadata = @config.rpcs.list_patch_jobs.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.list_patch_jobs.timeout,
                         metadata:     call_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.list_patch_jobs request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @os_config_service_stub, :list_patch_jobs, "patch_jobs", request, result, options
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => 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.

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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
 
# File 'lib/google/cloud/os_config/v1/os_config_service/rest/client.rb', line 861

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
  call_metadata = @config.rpcs.pause_patch_deployment.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.pause_patch_deployment.timeout,
                         metadata:     call_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.pause_patch_deployment request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => 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.

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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
 
# File 'lib/google/cloud/os_config/v1/os_config_service/rest/client.rb', line 925

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
  call_metadata = @config.rpcs.resume_patch_deployment.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.resume_patch_deployment.timeout,
                         metadata:     call_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.resume_patch_deployment request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
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.

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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



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
827
828
829
830
 
# File 'lib/google/cloud/os_config/v1/os_config_service/rest/client.rb', line 797

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
  call_metadata = @config.rpcs.update_patch_deployment.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.update_patch_deployment.timeout,
                         metadata:     call_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.update_patch_deployment request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end