class Google::Cloud::OsConfig::V1::OsConfigService::Client
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.
Attributes
@private
Public Class Methods
Configure the OsConfigService
Client
class.
See {::Google::Cloud::OsConfig::V1::OsConfigService::Client::Configuration} for a description of the configuration fields.
@example
# Modify the configuration for all OsConfigService clients ::Google::Cloud::OsConfig::V1::OsConfigService::Client.configure do |config| config.timeout = 10.0 end
@yield [config] Configure the Client
client. @yieldparam config [Client::Configuration]
@return [Client::Configuration]
# File lib/google/cloud/os_config/v1/os_config_service/client.rb, line 59 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
Create a new OsConfigService
client object.
@example
# 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
@yield [config] Configure the OsConfigService
client. @yieldparam config [Client::Configuration]
# File lib/google/cloud/os_config/v1/os_config_service/client.rb, line 117 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 == 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 = ::Gapic::ServiceStub.new( ::Google::Cloud::OsConfig::V1::OsConfigService::Stub, credentials: credentials, endpoint: @config.endpoint, channel_args: @config.channel_args, interceptors: @config.interceptors ) end
Public Instance Methods
Cancel a patch job. The patch job must be active. Canceled patch jobs cannot be restarted.
@overload cancel_patch_job
(request, options = nil)
Pass arguments to `cancel_patch_job` via a request object, either of type {::Google::Cloud::OsConfig::V1::CancelPatchJobRequest} or an equivalent Hash. @param 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. @param options [::Gapic::CallOptions, ::Hash] Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
@overload cancel_patch_job
(name: nil)
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). @param name [::String] Required. Name of the patch in the form `projects/*/patchJobs/*`
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::OsConfig::V1::PatchJob] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Google::Cloud::OsConfig::V1::PatchJob]
@raise [::Google::Cloud::Error] if the RPC is aborted.
# File lib/google/cloud/os_config/v1/os_config_service/client.rb, line 341 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 = { "name" => request.name } 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 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 {Client.configure}.
See {::Google::Cloud::OsConfig::V1::OsConfigService::Client::Configuration} for a description of the configuration fields.
@yield [config] Configure the Client
client. @yieldparam config [Client::Configuration]
@return [Client::Configuration]
# File lib/google/cloud/os_config/v1/os_config_service/client.rb, line 96 def configure yield @config if block_given? @config end
Create an OS Config patch deployment.
@overload create_patch_deployment
(request, options = nil)
Pass arguments to `create_patch_deployment` via a request object, either of type {::Google::Cloud::OsConfig::V1::CreatePatchDeploymentRequest} or an equivalent Hash. @param 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. @param options [::Gapic::CallOptions, ::Hash] Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
@overload create_patch_deployment
(parent: nil, patch_deployment_id: nil, patch_deployment: nil)
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). @param parent [::String] Required. The project to apply this patch deployment to in the form `projects/*`. @param patch_deployment_id [::String] 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. @param patch_deployment [::Google::Cloud::OsConfig::V1::PatchDeployment, ::Hash] Required. The patch deployment to create.
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::OsConfig::V1::PatchDeployment] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Google::Cloud::OsConfig::V1::PatchDeployment]
@raise [::Google::Cloud::Error] if the RPC is aborted.
# File lib/google/cloud/os_config/v1/os_config_service/client.rb, line 577 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 = { "parent" => request.parent } 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 an OS Config patch deployment.
@overload delete_patch_deployment
(request, options = nil)
Pass arguments to `delete_patch_deployment` via a request object, either of type {::Google::Cloud::OsConfig::V1::DeletePatchDeploymentRequest} or an equivalent Hash. @param 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. @param options [::Gapic::CallOptions, ::Hash] Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
@overload delete_patch_deployment
(name: nil)
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). @param name [::String] Required. The resource name of the patch deployment in the form `projects/*/patchDeployments/*`.
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Protobuf::Empty] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Google::Protobuf::Empty]
@raise [::Google::Cloud::Error] if the RPC is aborted.
# File lib/google/cloud/os_config/v1/os_config_service/client.rb, line 791 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 = { "name" => request.name } 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
Patch VM instances by creating and running a patch job.
@overload execute_patch_job
(request, options = nil)
Pass arguments to `execute_patch_job` via a request object, either of type {::Google::Cloud::OsConfig::V1::ExecutePatchJobRequest} or an equivalent Hash. @param 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. @param options [::Gapic::CallOptions, ::Hash] Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
@overload execute_patch_job
(parent: nil, description: nil, instance_filter: nil, patch_config: nil, duration: nil, dry_run: nil, display_name: nil, rollout: nil)
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). @param parent [::String] Required. The project in which to run this patch in the form `projects/*` @param description [::String] Description of the patch job. Length of the description is limited to 1024 characters. @param instance_filter [::Google::Cloud::OsConfig::V1::PatchInstanceFilter, ::Hash] Required. Instances to patch, either explicitly or filtered by some criteria such as zone or labels. @param patch_config [::Google::Cloud::OsConfig::V1::PatchConfig, ::Hash] Patch configuration being applied. If omitted, instances are patched using the default configurations. @param duration [::Google::Protobuf::Duration, ::Hash] Duration of the patch job. After the duration ends, the patch job times out. @param dry_run [::Boolean] If this patch is a dry-run only, instances are contacted but will do nothing. @param display_name [::String] Display name for this patch job. This does not have to be unique. @param rollout [::Google::Cloud::OsConfig::V1::PatchRollout, ::Hash] Rollout strategy of the patch job.
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::OsConfig::V1::PatchJob] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Google::Cloud::OsConfig::V1::PatchJob]
@raise [::Google::Cloud::Error] if the RPC is aborted.
# File lib/google/cloud/os_config/v1/os_config_service/client.rb, line 203 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 = { "parent" => request.parent } 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 an OS Config patch deployment.
@overload get_patch_deployment
(request, options = nil)
Pass arguments to `get_patch_deployment` via a request object, either of type {::Google::Cloud::OsConfig::V1::GetPatchDeploymentRequest} or an equivalent Hash. @param 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. @param options [::Gapic::CallOptions, ::Hash] Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
@overload get_patch_deployment
(name: nil)
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). @param name [::String] Required. The resource name of the patch deployment in the form `projects/*/patchDeployments/*`.
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::OsConfig::V1::PatchDeployment] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Google::Cloud::OsConfig::V1::PatchDeployment]
@raise [::Google::Cloud::Error] if the RPC is aborted.
# File lib/google/cloud/os_config/v1/os_config_service/client.rb, line 646 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 = { "name" => request.name } 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 the patch job. This can be used to track the progress of an ongoing patch job or review the details of completed jobs.
@overload get_patch_job
(request, options = nil)
Pass arguments to `get_patch_job` via a request object, either of type {::Google::Cloud::OsConfig::V1::GetPatchJobRequest} or an equivalent Hash. @param 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. @param options [::Gapic::CallOptions, ::Hash] Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
@overload get_patch_job
(name: nil)
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). @param name [::String] Required. Name of the patch in the form `projects/*/patchJobs/*`
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::OsConfig::V1::PatchJob] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Google::Cloud::OsConfig::V1::PatchJob]
@raise [::Google::Cloud::Error] if the RPC is aborted.
# File lib/google/cloud/os_config/v1/os_config_service/client.rb, line 272 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 = { "name" => request.name } 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
Get a page of OS Config patch deployments.
@overload list_patch_deployments
(request, options = nil)
Pass arguments to `list_patch_deployments` via a request object, either of type {::Google::Cloud::OsConfig::V1::ListPatchDeploymentsRequest} or an equivalent Hash. @param 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. @param options [::Gapic::CallOptions, ::Hash] Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
@overload list_patch_deployments
(parent: nil, page_size: nil, page_token: nil)
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). @param parent [::String] Required. The resource name of the parent in the form `projects/*`. @param page_size [::Integer] Optional. The maximum number of patch deployments to return. Default is 100. @param page_token [::String] Optional. A pagination token returned from a previous call to ListPatchDeployments that indicates where this listing should continue from.
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::OsConfig::V1::PatchDeployment>] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Gapic::PagedEnumerable<::Google::Cloud::OsConfig::V1::PatchDeployment>]
@raise [::Google::Cloud::Error] if the RPC is aborted.
# File lib/google/cloud/os_config/v1/os_config_service/client.rb, line 721 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 = { "parent" => request.parent } 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
Get a list of instance details for a given patch job.
@overload list_patch_job_instance_details
(request, options = nil)
Pass arguments to `list_patch_job_instance_details` via a request object, either of type {::Google::Cloud::OsConfig::V1::ListPatchJobInstanceDetailsRequest} or an equivalent Hash. @param 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. @param options [::Gapic::CallOptions, ::Hash] Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
@overload list_patch_job_instance_details
(parent: nil, page_size: nil, page_token: nil, filter: nil)
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). @param parent [::String] Required. The parent for the instances are in the form of `projects/*/patchJobs/*`. @param page_size [::Integer] The maximum number of instance details records to return. Default is 100. @param page_token [::String] A pagination token returned from a previous call that indicates where this listing should continue from. @param filter [::String] A filter expression that filters results listed in the response. This field supports filtering results by instance zone, name, state, or `failure_reason`.
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::OsConfig::V1::PatchJobInstanceDetails>] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Gapic::PagedEnumerable<::Google::Cloud::OsConfig::V1::PatchJobInstanceDetails>]
@raise [::Google::Cloud::Error] if the RPC is aborted.
# File lib/google/cloud/os_config/v1/os_config_service/client.rb, line 497 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 = { "parent" => request.parent } 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
Get a list of patch jobs.
@overload list_patch_jobs
(request, options = nil)
Pass arguments to `list_patch_jobs` via a request object, either of type {::Google::Cloud::OsConfig::V1::ListPatchJobsRequest} or an equivalent Hash. @param 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. @param options [::Gapic::CallOptions, ::Hash] Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
@overload list_patch_jobs
(parent: nil, page_size: nil, page_token: nil, filter: nil)
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). @param parent [::String] Required. In the form of `projects/*` @param page_size [::Integer] The maximum number of instance status to return. @param page_token [::String] A pagination token returned from a previous call that indicates where this listing should continue from. @param filter [::String] 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.
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::OsConfig::V1::PatchJob>] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Gapic::PagedEnumerable<::Google::Cloud::OsConfig::V1::PatchJob>]
@raise [::Google::Cloud::Error] if the RPC is aborted.
# File lib/google/cloud/os_config/v1/os_config_service/client.rb, line 418 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 = { "parent" => request.parent } 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