Class: Google::Cloud::OsConfig::V1::OsConfigZonalService::Client

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

Overview

Client for the OsConfigZonalService service.

Zonal OS Config API

The OS Config service is the server-side component that allows users to manage package installations and patch jobs for Compute Engine VM instances.

Defined Under Namespace

Classes: Configuration

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Paths

#instance_os_policy_assignment_path, #instance_path, #inventory_path, #location_path, #os_policy_assignment_path, #os_policy_assignment_report_path, #vulnerability_report_path

Constructor Details

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

Create a new OsConfigZonalService client object.

Examples:


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

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

Yields:

  • (config) —

    Configure the OsConfigZonalService client.

Yield Parameters:



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
168
169
170
171
172
173
174
175
176
177
 
# File 'lib/google/cloud/os_config/v1/os_config_zonal_service/client.rb', line 132

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

  @operations_client = Operations.new do |config|
    config.credentials = credentials
    config.quota_project = @quota_project_id
    config.endpoint = @config.endpoint
    config.universe_domain = @config.universe_domain
  end

  @os_config_zonal_service_stub = ::Gapic::ServiceStub.new(
    ::Google::Cloud::OsConfig::V1::OsConfigZonalService::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

Instance Attribute Details

#operations_client ⇒ ::Google::Cloud::OsConfig::V1::OsConfigZonalService::Operations (readonly)

Get the associated client for long-running operations.

Returns:



184
185
186
 
# File 'lib/google/cloud/os_config/v1/os_config_zonal_service/client.rb', line 184

def operations_client
  @operations_client
end

Class Method Details

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

Configure the OsConfigZonalService Client class.

See Configuration for a description of the configuration fields.

Examples:


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

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



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

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

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

Configure the OsConfigZonalService 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:



102
103
104
105
 
# File 'lib/google/cloud/os_config/v1/os_config_zonal_service/client.rb', line 102

def configure
  yield @config if block_given?
  @config
end

#create_os_policy_assignment(request, options = nil) ⇒ ::Gapic::Operation #create_os_policy_assignment(parent: nil, os_policy_assignment: nil, os_policy_assignment_id: nil) ⇒ ::Gapic::Operation

Create an OS policy assignment.

This method also creates the first revision of the OS policy assignment.

This method returns a long running operation (LRO) that contains the rollout details. The rollout can be cancelled by cancelling the LRO.

For more information, see Method: projects.locations.osPolicyAssignments.operations.cancel.

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::OsConfigZonalService::Client.new

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

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

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

Overloads:

  • #create_os_policy_assignment(request, options = nil) ⇒ ::Gapic::Operation

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

    Parameters:

    • request (::Google::Cloud::OsConfig::V1::CreateOSPolicyAssignmentRequest, ::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_os_policy_assignment(parent: nil, os_policy_assignment: nil, os_policy_assignment_id: nil) ⇒ ::Gapic::Operation

    Pass arguments to create_os_policy_assignment 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 resource name in the form: projects/{project}/locations/{location}

    • os_policy_assignment (::Google::Cloud::OsConfig::V1::OSPolicyAssignment, ::Hash) (defaults to: nil) —

      Required. The OS policy assignment to be created.

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

      Required. The logical name of the OS policy assignment in the project with the following restrictions:

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

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)

Returns:

  • (::Gapic::Operation)

Raises:

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

    if the RPC is aborted.



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
289
290
291
292
293
294
295
296
297
298
299
300
 
# File 'lib/google/cloud/os_config/v1/os_config_zonal_service/client.rb', line 259

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

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

  # 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_os_policy_assignment.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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-api-version"] = API_VERSION unless API_VERSION.empty?
  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_os_policy_assignment.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.create_os_policy_assignment.retry_policy

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

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

#delete_os_policy_assignment(request, options = nil) ⇒ ::Gapic::Operation #delete_os_policy_assignment(name: nil) ⇒ ::Gapic::Operation

Delete the OS policy assignment.

This method creates a new revision of the OS policy assignment.

This method returns a long running operation (LRO) that contains the rollout details. The rollout can be cancelled by cancelling the LRO.

If the LRO completes and is not cancelled, all revisions associated with the OS policy assignment are deleted.

For more information, see Method: projects.locations.osPolicyAssignments.operations.cancel.

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::OsConfigZonalService::Client.new

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

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

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

Overloads:

  • #delete_os_policy_assignment(request, options = nil) ⇒ ::Gapic::Operation

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

    Parameters:

    • request (::Google::Cloud::OsConfig::V1::DeleteOSPolicyAssignmentRequest, ::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_os_policy_assignment(name: nil) ⇒ ::Gapic::Operation

    Pass arguments to delete_os_policy_assignment 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 name of the OS policy assignment to be deleted

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)

Returns:

  • (::Gapic::Operation)

Raises:

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

    if the RPC is aborted.



758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
 
# File 'lib/google/cloud/os_config/v1/os_config_zonal_service/client.rb', line 758

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

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

  # 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_os_policy_assignment.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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-api-version"] = API_VERSION unless API_VERSION.empty?
  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_os_policy_assignment.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.delete_os_policy_assignment.retry_policy

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

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

#get_inventory(request, options = nil) ⇒ ::Google::Cloud::OsConfig::V1::Inventory #get_inventory(name: nil, view: nil) ⇒ ::Google::Cloud::OsConfig::V1::Inventory

Get inventory data for the specified VM instance. If the VM has no associated inventory, the message NOT_FOUND is returned.

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::OsConfigZonalService::Client.new

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

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

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

Overloads:

  • #get_inventory(request, options = nil) ⇒ ::Google::Cloud::OsConfig::V1::Inventory

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

    Parameters:

    • request (::Google::Cloud::OsConfig::V1::GetInventoryRequest, ::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_inventory(name: nil, view: nil) ⇒ ::Google::Cloud::OsConfig::V1::Inventory

    Pass arguments to get_inventory 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. API resource name for inventory resource.

      Format: projects/{project}/locations/{location}/instances/{instance}/inventory

      For {project}, either project-number or project-id can be provided. For {instance}, either Compute Engine instance-id or instance-name can be provided.

    • view (::Google::Cloud::OsConfig::V1::InventoryView) (defaults to: nil) —

      Inventory view indicating what information should be included in the inventory resource. If unspecified, the default view is BASIC.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



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
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
 
# File 'lib/google/cloud/os_config/v1/os_config_zonal_service/client.rb', line 1072

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

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

  # 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_inventory.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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-api-version"] = API_VERSION unless API_VERSION.empty?
  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_inventory.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_inventory.retry_policy

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

  @os_config_zonal_service_stub.call_rpc :get_inventory, 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_os_policy_assignment(request, options = nil) ⇒ ::Google::Cloud::OsConfig::V1::OSPolicyAssignment #get_os_policy_assignment(name: nil) ⇒ ::Google::Cloud::OsConfig::V1::OSPolicyAssignment

Retrieve an existing OS policy assignment.

This method always returns the latest revision. In order to retrieve a previous revision of the assignment, also provide the revision ID in the name parameter.

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::OsConfigZonalService::Client.new

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

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

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

Overloads:

  • #get_os_policy_assignment(request, options = nil) ⇒ ::Google::Cloud::OsConfig::V1::OSPolicyAssignment

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

    Parameters:

    • request (::Google::Cloud::OsConfig::V1::GetOSPolicyAssignmentRequest, ::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_os_policy_assignment(name: nil) ⇒ ::Google::Cloud::OsConfig::V1::OSPolicyAssignment

    Pass arguments to get_os_policy_assignment 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 OS policy assignment.

      Format: projects/{project}/locations/{location}/osPolicyAssignments/{os_policy_assignment}@{revisionId}

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



458
459
460
461
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
497
498
 
# File 'lib/google/cloud/os_config/v1/os_config_zonal_service/client.rb', line 458

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

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

  # 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_os_policy_assignment.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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-api-version"] = API_VERSION unless API_VERSION.empty?
  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_os_policy_assignment.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_os_policy_assignment.retry_policy

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

  @os_config_zonal_service_stub.call_rpc :get_os_policy_assignment, 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_os_policy_assignment_report(request, options = nil) ⇒ ::Google::Cloud::OsConfig::V1::OSPolicyAssignmentReport #get_os_policy_assignment_report(name: nil) ⇒ ::Google::Cloud::OsConfig::V1::OSPolicyAssignmentReport

Get the OS policy asssignment report for the specified Compute Engine VM instance.

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::OsConfigZonalService::Client.new

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

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

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

Overloads:

  • #get_os_policy_assignment_report(request, options = nil) ⇒ ::Google::Cloud::OsConfig::V1::OSPolicyAssignmentReport

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

    Parameters:

    • request (::Google::Cloud::OsConfig::V1::GetOSPolicyAssignmentReportRequest, ::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_os_policy_assignment_report(name: nil) ⇒ ::Google::Cloud::OsConfig::V1::OSPolicyAssignmentReport

    Pass arguments to get_os_policy_assignment_report 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. API resource name for OS policy assignment report.

      Format: /projects/{project}/locations/{location}/instances/{instance}/osPolicyAssignments/{assignment}/report

      For {project}, either project-number or project-id can be provided. For {instance_id}, either Compute Engine instance-id or instance-name can be provided. For {assignment_id}, the OSPolicyAssignment id must be provided.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



854
855
856
857
858
859
860
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_zonal_service/client.rb', line 854

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

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

  # 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_os_policy_assignment_report.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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-api-version"] = API_VERSION unless API_VERSION.empty?
  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_os_policy_assignment_report.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_os_policy_assignment_report.retry_policy

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

  @os_config_zonal_service_stub.call_rpc :get_os_policy_assignment_report, 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_vulnerability_report(request, options = nil) ⇒ ::Google::Cloud::OsConfig::V1::VulnerabilityReport #get_vulnerability_report(name: nil) ⇒ ::Google::Cloud::OsConfig::V1::VulnerabilityReport

Gets the vulnerability report for the specified VM instance. Only VMs with inventory data have vulnerability reports associated with them.

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::OsConfigZonalService::Client.new

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

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

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

Overloads:

  • #get_vulnerability_report(request, options = nil) ⇒ ::Google::Cloud::OsConfig::V1::VulnerabilityReport

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

    Parameters:

    • request (::Google::Cloud::OsConfig::V1::GetVulnerabilityReportRequest, ::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_vulnerability_report(name: nil) ⇒ ::Google::Cloud::OsConfig::V1::VulnerabilityReport

    Pass arguments to get_vulnerability_report 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. API resource name for vulnerability resource.

      Format: projects/{project}/locations/{location}/instances/{instance}/vulnerabilityReport

      For {project}, either project-number or project-id can be provided. For {instance}, either Compute Engine instance-id or instance-name can be provided.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
 
# File 'lib/google/cloud/os_config/v1/os_config_zonal_service/client.rb', line 1273

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

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

  # 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_vulnerability_report.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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-api-version"] = API_VERSION unless API_VERSION.empty?
  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_vulnerability_report.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_vulnerability_report.retry_policy

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

  @os_config_zonal_service_stub.call_rpc :get_vulnerability_report, 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_inventories(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::OsConfig::V1::Inventory> #list_inventories(parent: nil, view: nil, page_size: nil, page_token: nil, filter: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::OsConfig::V1::Inventory>

List inventory data for all VM instances in the specified zone.

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::OsConfigZonalService::Client.new

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

# Call the list_inventories method.
result = client.list_inventories 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::Inventory.
  p item
end

Overloads:

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

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

    Parameters:

    • request (::Google::Cloud::OsConfig::V1::ListInventoriesRequest, ::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_inventories(parent: nil, view: nil, page_size: nil, page_token: nil, filter: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::OsConfig::V1::Inventory>

    Pass arguments to list_inventories 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 resource name.

      Format: projects/{project}/locations/{location}/instances/-

      For {project}, either project-number or project-id can be provided.

    • view (::Google::Cloud::OsConfig::V1::InventoryView) (defaults to: nil) —

      Inventory view indicating what information should be included in the inventory resource. If unspecified, the default view is BASIC.

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

      The maximum number of results to return.

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

      A pagination token returned from a previous call to ListInventories 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 a Inventory API resource to be included in the response.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
 
# File 'lib/google/cloud/os_config/v1/os_config_zonal_service/client.rb', line 1178

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

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

  # 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_inventories.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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-api-version"] = API_VERSION unless API_VERSION.empty?
  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_inventories.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_inventories.retry_policy

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

  @os_config_zonal_service_stub.call_rpc :list_inventories, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @os_config_zonal_service_stub, :list_inventories, 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_os_policy_assignment_reports(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::OsConfig::V1::OSPolicyAssignmentReport> #list_os_policy_assignment_reports(parent: nil, page_size: nil, filter: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::OsConfig::V1::OSPolicyAssignmentReport>

List OS policy asssignment reports for all Compute Engine VM instances in the specified zone.

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::OsConfigZonalService::Client.new

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

# Call the list_os_policy_assignment_reports method.
result = client.list_os_policy_assignment_reports 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::OSPolicyAssignmentReport.
  p item
end

Overloads:

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

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

    Parameters:

    • request (::Google::Cloud::OsConfig::V1::ListOSPolicyAssignmentReportsRequest, ::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_os_policy_assignment_reports(parent: nil, page_size: nil, filter: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::OsConfig::V1::OSPolicyAssignmentReport>

    Pass arguments to list_os_policy_assignment_reports 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 resource name.

      Format: projects/{project}/locations/{location}/instances/{instance}/osPolicyAssignments/{assignment}/reports

      For {project}, either project-number or project-id can be provided. For {instance}, either instance-name, instance-id, or - can be provided. If '-' is provided, the response will include OSPolicyAssignmentReports for all instances in the project/location. For {assignment}, either assignment-id or - can be provided. If '-' is provided, the response will include OSPolicyAssignmentReports for all OSPolicyAssignments in the project/location. Either {instance} or {assignment} must be -.

      For example: projects/{project}/locations/{location}/instances/{instance}/osPolicyAssignments/-/reports returns all reports for the instance projects/{project}/locations/{location}/instances/-/osPolicyAssignments/{assignment-id}/reports returns all the reports for the given assignment across all instances. projects/{project}/locations/{location}/instances/-/osPolicyAssignments/-/reports returns all the reports for all assignments across all instances.

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

      The maximum number of results to return.

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

      If provided, this field specifies the criteria that must be met by the OSPolicyAssignmentReport API resource that is included in the response.

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

      A pagination token returned from a previous call to the ListOSPolicyAssignmentReports method 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.



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
1010
1011
1012
1013
1014
1015
 
# File 'lib/google/cloud/os_config/v1/os_config_zonal_service/client.rb', line 974

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

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

  # 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_os_policy_assignment_reports.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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-api-version"] = API_VERSION unless API_VERSION.empty?
  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_os_policy_assignment_reports.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_os_policy_assignment_reports.retry_policy

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

  @os_config_zonal_service_stub.call_rpc :list_os_policy_assignment_reports, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @os_config_zonal_service_stub, :list_os_policy_assignment_reports, 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_os_policy_assignment_revisions(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::OsConfig::V1::OSPolicyAssignment> #list_os_policy_assignment_revisions(name: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::OsConfig::V1::OSPolicyAssignment>

List the OS policy assignment revisions for a given OS policy assignment.

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::OsConfigZonalService::Client.new

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

# Call the list_os_policy_assignment_revisions method.
result = client.list_os_policy_assignment_revisions 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::OSPolicyAssignment.
  p item
end

Overloads:

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

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

    Parameters:

    • request (::Google::Cloud::OsConfig::V1::ListOSPolicyAssignmentRevisionsRequest, ::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_os_policy_assignment_revisions(name: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::OsConfig::V1::OSPolicyAssignment>

    Pass arguments to list_os_policy_assignment_revisions 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 name of the OS policy assignment to list revisions for.

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

      The maximum number of revisions to return.

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

      A pagination token returned from a previous call to ListOSPolicyAssignmentRevisions 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.



653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
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
 
# File 'lib/google/cloud/os_config/v1/os_config_zonal_service/client.rb', line 653

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

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

  # 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_os_policy_assignment_revisions.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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-api-version"] = API_VERSION unless API_VERSION.empty?
  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.list_os_policy_assignment_revisions.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_os_policy_assignment_revisions.retry_policy

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

  @os_config_zonal_service_stub.call_rpc :list_os_policy_assignment_revisions, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @os_config_zonal_service_stub, :list_os_policy_assignment_revisions, 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_os_policy_assignments(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::OsConfig::V1::OSPolicyAssignment> #list_os_policy_assignments(parent: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::OsConfig::V1::OSPolicyAssignment>

List the OS policy assignments under the parent resource.

For each OS policy assignment, the latest revision is returned.

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::OsConfigZonalService::Client.new

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

# Call the list_os_policy_assignments method.
result = client.list_os_policy_assignments 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::OSPolicyAssignment.
  p item
end

Overloads:

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

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

    Parameters:

    • request (::Google::Cloud::OsConfig::V1::ListOSPolicyAssignmentsRequest, ::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_os_policy_assignments(parent: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::OsConfig::V1::OSPolicyAssignment>

    Pass arguments to list_os_policy_assignments 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 resource name.

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

      The maximum number of assignments to return.

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

      A pagination token returned from a previous call to ListOSPolicyAssignments 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.



556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
 
# File 'lib/google/cloud/os_config/v1/os_config_zonal_service/client.rb', line 556

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

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

  # 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_os_policy_assignments.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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-api-version"] = API_VERSION unless API_VERSION.empty?
  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_os_policy_assignments.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_os_policy_assignments.retry_policy

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

  @os_config_zonal_service_stub.call_rpc :list_os_policy_assignments, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @os_config_zonal_service_stub, :list_os_policy_assignments, 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_vulnerability_reports(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::OsConfig::V1::VulnerabilityReport> #list_vulnerability_reports(parent: nil, page_size: nil, page_token: nil, filter: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::OsConfig::V1::VulnerabilityReport>

List vulnerability reports for all VM instances in the specified zone.

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::OsConfigZonalService::Client.new

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

# Call the list_vulnerability_reports method.
result = client.list_vulnerability_reports 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::VulnerabilityReport.
  p item
end

Overloads:

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

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

    Parameters:

    • request (::Google::Cloud::OsConfig::V1::ListVulnerabilityReportsRequest, ::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_vulnerability_reports(parent: nil, page_size: nil, page_token: nil, filter: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::OsConfig::V1::VulnerabilityReport>

    Pass arguments to list_vulnerability_reports 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 resource name.

      Format: projects/{project}/locations/{location}/instances/-

      For {project}, either project-number or project-id can be provided.

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

      The maximum number of results to return.

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

      A pagination token returned from a previous call to ListVulnerabilityReports 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 a vulnerabilityReport API resource to be included in the response.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
 
# File 'lib/google/cloud/os_config/v1/os_config_zonal_service/client.rb', line 1376

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

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

  # 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_vulnerability_reports.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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-api-version"] = API_VERSION unless API_VERSION.empty?
  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_vulnerability_reports.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_vulnerability_reports.retry_policy

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

  @os_config_zonal_service_stub.call_rpc :list_vulnerability_reports, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @os_config_zonal_service_stub, :list_vulnerability_reports, 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

#universe_domain ⇒ String

The effective universe domain

Returns:

  • (String) 


112
113
114
 
# File 'lib/google/cloud/os_config/v1/os_config_zonal_service/client.rb', line 112

def universe_domain
  @os_config_zonal_service_stub.universe_domain
end

#update_os_policy_assignment(request, options = nil) ⇒ ::Gapic::Operation #update_os_policy_assignment(os_policy_assignment: nil, update_mask: nil) ⇒ ::Gapic::Operation

Update an existing OS policy assignment.

This method creates a new revision of the OS policy assignment.

This method returns a long running operation (LRO) that contains the rollout details. The rollout can be cancelled by cancelling the LRO.

For more information, see Method: projects.locations.osPolicyAssignments.operations.cancel.

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::OsConfigZonalService::Client.new

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

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

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

Overloads:

  • #update_os_policy_assignment(request, options = nil) ⇒ ::Gapic::Operation

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

    Parameters:

    • request (::Google::Cloud::OsConfig::V1::UpdateOSPolicyAssignmentRequest, ::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_os_policy_assignment(os_policy_assignment: nil, update_mask: nil) ⇒ ::Gapic::Operation

    Pass arguments to update_os_policy_assignment 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:

  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)

Returns:

  • (::Gapic::Operation)

Raises:

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

    if the RPC is aborted.



364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
 
# File 'lib/google/cloud/os_config/v1/os_config_zonal_service/client.rb', line 364

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

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

  # 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_os_policy_assignment.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.os_policy_assignment&.name
    header_params["os_policy_assignment.name"] = request.os_policy_assignment.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_os_policy_assignment.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.update_os_policy_assignment.retry_policy

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

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