class Google::Cloud::Compute::V1::RegionDisks::Rest::Client
REST client for the RegionDisks
service.
The RegionDisks
API.
Attributes
@private
Get the associated client for long-running operations via RegionOperations
.
@return [::Google::Cloud::Compute::V1::RegionOperations::Rest::Client]
Public Class Methods
Configure the RegionDisks
Client
class.
See {::Google::Cloud::Compute::V1::RegionDisks::Rest::Client::Configuration} for a description of the configuration fields.
@example
# Modify the configuration for all RegionDisks clients ::Google::Cloud::Compute::V1::RegionDisks::Rest::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/compute/v1/region_disks/rest/client.rb, line 57 def self.configure @configure ||= begin namespace = ["Google", "Cloud", "Compute", "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.rpcs.add_resource_policies.timeout = 600.0 default_config.rpcs.create_snapshot.timeout = 600.0 default_config.rpcs.delete.timeout = 600.0 default_config.rpcs.get.timeout = 600.0 default_config.rpcs.get.retry_policy = { initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 14] } default_config.rpcs.get_iam_policy.timeout = 600.0 default_config.rpcs.get_iam_policy.retry_policy = { initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 14] } default_config.rpcs.insert.timeout = 600.0 default_config.rpcs.list.timeout = 600.0 default_config.rpcs.list.retry_policy = { initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 14] } default_config.rpcs.remove_resource_policies.timeout = 600.0 default_config.rpcs.resize.timeout = 600.0 default_config.rpcs.set_iam_policy.timeout = 600.0 default_config.rpcs.set_labels.timeout = 600.0 default_config.rpcs.test_iam_permissions.timeout = 600.0 default_config end yield @configure if block_given? @configure end
Create a new RegionDisks
REST client object.
@example
# Create a client using the default configuration client = ::Google::Cloud::Compute::V1::RegionDisks::Rest::Client.new # Create a client using a custom configuration client = ::Google::Cloud::Compute::V1::RegionDisks::Rest::Client.new do |config| config.timeout = 10.0 end
@yield [config] Configure the RegionDisks
client. @yieldparam config [Client::Configuration]
# File lib/google/cloud/compute/v1/region_disks/rest/client.rb, line 143 def initialize # Create the configuration object @config = Configuration.new Client.configure # Yield the configuration if needed yield @config if block_given? # Create credentials credentials = @config.credentials credentials ||= Credentials.default scope: @config.scope if credentials.is_a?(::String) || credentials.is_a?(::Hash) credentials = Credentials.new credentials, scope: @config.scope end @region_operations = ::Google::Cloud::Compute::V1::RegionOperations::Rest::Client.new do |config| config.credentials = credentials config.endpoint = @config.endpoint end @region_disks_stub = ::Google::Cloud::Compute::V1::RegionDisks::Rest::ServiceStub.new endpoint: @config.endpoint, credentials: credentials end
Public Instance Methods
Adds existing resource policies to a regional disk. You can only add one policy which will be applied to this disk for scheduling snapshot creation.
@overload add_resource_policies
(request, options = nil)
Pass arguments to `add_resource_policies` via a request object, either of type {::Google::Cloud::Compute::V1::AddResourcePoliciesRegionDiskRequest} or an equivalent Hash. @param request [::Google::Cloud::Compute::V1::AddResourcePoliciesRegionDiskRequest, ::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. Note: currently retry functionality is not implemented. While it is possible to set it using ::Gapic::CallOptions, it will not be applied
@overload add_resource_policies
(disk: nil, project: nil, region: nil, region_disks_add_resource_policies_request_resource: nil, request_id: nil)
Pass arguments to `add_resource_policies` 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 disk [::String] The disk name for this request. @param project [::String] Project ID for this request. @param region [::String] The name of the region for this request. @param region_disks_add_resource_policies_request_resource [::Google::Cloud::Compute::V1::RegionDisksAddResourcePoliciesRequest, ::Hash] The body resource for this request @param request_id [::String] An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
@yield [result, response] Access the result along with the Faraday response object @yieldparam result [::Gapic::GenericLRO::Operation] @yieldparam response [::Faraday::Response]
@return [::Gapic::GenericLRO::Operation]
@raise [::Google::Cloud::Error] if the REST call is aborted.
# File lib/google/cloud/compute/v1/region_disks/rest/client.rb, line 211 def add_resource_policies request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Compute::V1::AddResourcePoliciesRegionDiskRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults call_metadata = @config.rpcs.add_resource_policies.metadata.to_h # Set x-goog-api-client header call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Compute::V1::VERSION, transports_version_send: [:rest] options.apply_defaults timeout: @config.rpcs.add_resource_policies.timeout, metadata: call_metadata options.apply_defaults timeout: @config.timeout, metadata: @config.metadata @region_disks_stub.add_resource_policies request, options do |result, response| result = ::Google::Cloud::Compute::V1::RegionOperations::Rest::NonstandardLro.create_operation( operation: result, client: region_operations, request_values: { "project" => request.project, "region" => request.region }, options: options ) yield result, response if block_given? return result end rescue ::Faraday::Error => e begin raise ::Gapic::Rest::Error.wrap_faraday_error e rescue ::Gapic::Rest::Error => gapic_error raise ::Google::Cloud::Error.from_error gapic_error end end
Configure the RegionDisks
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::Compute::V1::RegionDisks::Rest::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/compute/v1/region_disks/rest/client.rb, line 122 def configure yield @config if block_given? @config end
Creates a snapshot of a specified persistent disk. For regular snapshot creation, consider using snapshots.insert instead, as that method supports more features, such as creating snapshots in a project different from the source disk project.
@overload create_snapshot
(request, options = nil)
Pass arguments to `create_snapshot` via a request object, either of type {::Google::Cloud::Compute::V1::CreateSnapshotRegionDiskRequest} or an equivalent Hash. @param request [::Google::Cloud::Compute::V1::CreateSnapshotRegionDiskRequest, ::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. Note: currently retry functionality is not implemented. While it is possible to set it using ::Gapic::CallOptions, it will not be applied
@overload create_snapshot
(disk: nil, project: nil, region: nil, request_id: nil, snapshot_resource: nil)
Pass arguments to `create_snapshot` 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 disk [::String] Name of the regional persistent disk to snapshot. @param project [::String] Project ID for this request. @param region [::String] Name of the region for this request. @param request_id [::String] An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). @param snapshot_resource [::Google::Cloud::Compute::V1::Snapshot, ::Hash] The body resource for this request
@yield [result, response] Access the result along with the Faraday response object @yieldparam result [::Gapic::GenericLRO::Operation] @yieldparam response [::Faraday::Response]
@return [::Gapic::GenericLRO::Operation]
@raise [::Google::Cloud::Error] if the REST call is aborted.
# File lib/google/cloud/compute/v1/region_disks/rest/client.rb, line 292 def create_snapshot request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Compute::V1::CreateSnapshotRegionDiskRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults call_metadata = @config.rpcs.create_snapshot.metadata.to_h # Set x-goog-api-client header call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Compute::V1::VERSION, transports_version_send: [:rest] options.apply_defaults timeout: @config.rpcs.create_snapshot.timeout, metadata: call_metadata options.apply_defaults timeout: @config.timeout, metadata: @config.metadata @region_disks_stub.create_snapshot request, options do |result, response| result = ::Google::Cloud::Compute::V1::RegionOperations::Rest::NonstandardLro.create_operation( operation: result, client: region_operations, request_values: { "project" => request.project, "region" => request.region }, options: options ) yield result, response if block_given? return result end rescue ::Faraday::Error => e begin raise ::Gapic::Rest::Error.wrap_faraday_error e rescue ::Gapic::Rest::Error => gapic_error raise ::Google::Cloud::Error.from_error gapic_error end end
Deletes the specified regional persistent disk. Deleting a regional disk removes all the replicas of its data permanently and is irreversible. However, deleting a disk does not delete any snapshots previously made from the disk. You must separately delete snapshots.
@overload delete(request, options = nil)
Pass arguments to `delete` via a request object, either of type {::Google::Cloud::Compute::V1::DeleteRegionDiskRequest} or an equivalent Hash. @param request [::Google::Cloud::Compute::V1::DeleteRegionDiskRequest, ::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. Note: currently retry functionality is not implemented. While it is possible to set it using ::Gapic::CallOptions, it will not be applied
@overload delete(disk: nil, project: nil, region: nil, request_id: nil)
Pass arguments to `delete` 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 disk [::String] Name of the regional persistent disk to delete. @param project [::String] Project ID for this request. @param region [::String] Name of the region for this request. @param request_id [::String] An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
@yield [result, response] Access the result along with the Faraday response object @yieldparam result [::Gapic::GenericLRO::Operation] @yieldparam response [::Faraday::Response]
@return [::Gapic::GenericLRO::Operation]
@raise [::Google::Cloud::Error] if the REST call is aborted.
# File lib/google/cloud/compute/v1/region_disks/rest/client.rb, line 371 def delete request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Compute::V1::DeleteRegionDiskRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults call_metadata = @config.rpcs.delete.metadata.to_h # Set x-goog-api-client header call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Compute::V1::VERSION, transports_version_send: [:rest] options.apply_defaults timeout: @config.rpcs.delete.timeout, metadata: call_metadata options.apply_defaults timeout: @config.timeout, metadata: @config.metadata @region_disks_stub.delete request, options do |result, response| result = ::Google::Cloud::Compute::V1::RegionOperations::Rest::NonstandardLro.create_operation( operation: result, client: region_operations, request_values: { "project" => request.project, "region" => request.region }, options: options ) yield result, response if block_given? return result end rescue ::Faraday::Error => e begin raise ::Gapic::Rest::Error.wrap_faraday_error e rescue ::Gapic::Rest::Error => gapic_error raise ::Google::Cloud::Error.from_error gapic_error end end
Returns a specified regional persistent disk.
@overload get(request, options = nil)
Pass arguments to `get` via a request object, either of type {::Google::Cloud::Compute::V1::GetRegionDiskRequest} or an equivalent Hash. @param request [::Google::Cloud::Compute::V1::GetRegionDiskRequest, ::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. Note: currently retry functionality is not implemented. While it is possible to set it using ::Gapic::CallOptions, it will not be applied
@overload get(disk: nil, project: nil, region: nil)
Pass arguments to `get` 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 disk [::String] Name of the regional persistent disk to return. @param project [::String] Project ID for this request. @param region [::String] Name of the region for this request.
@yield [result, response] Access the result along with the Faraday response object @yieldparam result [::Google::Cloud::Compute::V1::Disk] @yieldparam response [::Faraday::Response]
@return [::Google::Cloud::Compute::V1::Disk]
@raise [::Google::Cloud::Error] if the REST call is aborted.
# File lib/google/cloud/compute/v1/region_disks/rest/client.rb, line 448 def get request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Compute::V1::GetRegionDiskRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults call_metadata = @config.rpcs.get.metadata.to_h # Set x-goog-api-client header call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Compute::V1::VERSION, transports_version_send: [:rest] options.apply_defaults timeout: @config.rpcs.get.timeout, metadata: call_metadata options.apply_defaults timeout: @config.timeout, metadata: @config.metadata @region_disks_stub.get request, options do |result, response| yield result, response if block_given? return result end rescue ::Faraday::Error => e begin raise ::Gapic::Rest::Error.wrap_faraday_error e rescue ::Gapic::Rest::Error => gapic_error raise ::Google::Cloud::Error.from_error gapic_error end end
Gets the access control policy for a resource. May be empty if no such policy or resource exists.
@overload get_iam_policy
(request, options = nil)
Pass arguments to `get_iam_policy` via a request object, either of type {::Google::Cloud::Compute::V1::GetIamPolicyRegionDiskRequest} or an equivalent Hash. @param request [::Google::Cloud::Compute::V1::GetIamPolicyRegionDiskRequest, ::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. Note: currently retry functionality is not implemented. While it is possible to set it using ::Gapic::CallOptions, it will not be applied
@overload get_iam_policy
(options_requested_policy_version: nil, project: nil, region: nil, resource: nil)
Pass arguments to `get_iam_policy` 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 options_requested_policy_version [::Integer] Requested IAM Policy version. @param project [::String] Project ID for this request. @param region [::String] The name of the region for this request. @param resource [::String] Name or id of the resource for this request.
@yield [result, response] Access the result along with the Faraday response object @yieldparam result [::Google::Cloud::Compute::V1::Policy] @yieldparam response [::Faraday::Response]
@return [::Google::Cloud::Compute::V1::Policy]
@raise [::Google::Cloud::Error] if the REST call is aborted.
# File lib/google/cloud/compute/v1/region_disks/rest/client.rb, line 518 def get_iam_policy request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Compute::V1::GetIamPolicyRegionDiskRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults call_metadata = @config.rpcs.get_iam_policy.metadata.to_h # Set x-goog-api-client header call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Compute::V1::VERSION, transports_version_send: [:rest] options.apply_defaults timeout: @config.rpcs.get_iam_policy.timeout, metadata: call_metadata options.apply_defaults timeout: @config.timeout, metadata: @config.metadata @region_disks_stub.get_iam_policy request, options do |result, response| yield result, response if block_given? return result end rescue ::Faraday::Error => e begin raise ::Gapic::Rest::Error.wrap_faraday_error e rescue ::Gapic::Rest::Error => gapic_error raise ::Google::Cloud::Error.from_error gapic_error end end
Creates a persistent regional disk in the specified project using the data included in the request.
@overload insert(request, options = nil)
Pass arguments to `insert` via a request object, either of type {::Google::Cloud::Compute::V1::InsertRegionDiskRequest} or an equivalent Hash. @param request [::Google::Cloud::Compute::V1::InsertRegionDiskRequest, ::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. Note: currently retry functionality is not implemented. While it is possible to set it using ::Gapic::CallOptions, it will not be applied
@overload insert(disk_resource: nil, project: nil, region: nil, request_id: nil, source_image: nil)
Pass arguments to `insert` 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 disk_resource [::Google::Cloud::Compute::V1::Disk, ::Hash] The body resource for this request @param project [::String] Project ID for this request. @param region [::String] Name of the region for this request. @param request_id [::String] An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). @param source_image [::String] Source image to restore onto a disk. This field is optional.
@yield [result, response] Access the result along with the Faraday response object @yieldparam result [::Gapic::GenericLRO::Operation] @yieldparam response [::Faraday::Response]
@return [::Gapic::GenericLRO::Operation]
@raise [::Google::Cloud::Error] if the REST call is aborted.
# File lib/google/cloud/compute/v1/region_disks/rest/client.rb, line 590 def insert request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Compute::V1::InsertRegionDiskRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults call_metadata = @config.rpcs.insert.metadata.to_h # Set x-goog-api-client header call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Compute::V1::VERSION, transports_version_send: [:rest] options.apply_defaults timeout: @config.rpcs.insert.timeout, metadata: call_metadata options.apply_defaults timeout: @config.timeout, metadata: @config.metadata @region_disks_stub.insert request, options do |result, response| result = ::Google::Cloud::Compute::V1::RegionOperations::Rest::NonstandardLro.create_operation( operation: result, client: region_operations, request_values: { "project" => request.project, "region" => request.region }, options: options ) yield result, response if block_given? return result end rescue ::Faraday::Error => e begin raise ::Gapic::Rest::Error.wrap_faraday_error e rescue ::Gapic::Rest::Error => gapic_error raise ::Google::Cloud::Error.from_error gapic_error end end
Retrieves the list of persistent disks contained within the specified region.
@overload list(request, options = nil)
Pass arguments to `list` via a request object, either of type {::Google::Cloud::Compute::V1::ListRegionDisksRequest} or an equivalent Hash. @param request [::Google::Cloud::Compute::V1::ListRegionDisksRequest, ::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. Note: currently retry functionality is not implemented. While it is possible to set it using ::Gapic::CallOptions, it will not be applied
@overload list(filter: nil, max_results: nil, order_by: nil, page_token: nil, project: nil, region: nil, return_partial_success: nil)
Pass arguments to `list` 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 filter [::String] A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. @param max_results [::Integer] The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) @param order_by [::String] Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. @param page_token [::String] Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. @param project [::String] Project ID for this request. @param region [::String] Name of the region for this request. @param return_partial_success [::Boolean] Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.
@yield [result, response] Access the result along with the Faraday response object @yieldparam result [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Compute::V1::Disk>] @yieldparam response [::Faraday::Response]
@return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Compute::V1::Disk>]
@raise [::Google::Cloud::Error] if the REST call is aborted.
# File lib/google/cloud/compute/v1/region_disks/rest/client.rb, line 675 def list request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Compute::V1::ListRegionDisksRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults call_metadata = @config.rpcs.list.metadata.to_h # Set x-goog-api-client header call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Compute::V1::VERSION, transports_version_send: [:rest] options.apply_defaults timeout: @config.rpcs.list.timeout, metadata: call_metadata options.apply_defaults timeout: @config.timeout, metadata: @config.metadata @region_disks_stub.list request, options do |result, response| result = ::Gapic::Rest::PagedEnumerable.new @region_disks_stub, :list, "items", request, result, options yield result, response if block_given? return result end rescue ::Faraday::Error => e begin raise ::Gapic::Rest::Error.wrap_faraday_error e rescue ::Gapic::Rest::Error => gapic_error raise ::Google::Cloud::Error.from_error gapic_error end end
Removes resource policies from a regional disk.
@overload remove_resource_policies
(request, options = nil)
Pass arguments to `remove_resource_policies` via a request object, either of type {::Google::Cloud::Compute::V1::RemoveResourcePoliciesRegionDiskRequest} or an equivalent Hash. @param request [::Google::Cloud::Compute::V1::RemoveResourcePoliciesRegionDiskRequest, ::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. Note: currently retry functionality is not implemented. While it is possible to set it using ::Gapic::CallOptions, it will not be applied
@overload remove_resource_policies
(disk: nil, project: nil, region: nil, region_disks_remove_resource_policies_request_resource: nil, request_id: nil)
Pass arguments to `remove_resource_policies` 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 disk [::String] The disk name for this request. @param project [::String] Project ID for this request. @param region [::String] The name of the region for this request. @param region_disks_remove_resource_policies_request_resource [::Google::Cloud::Compute::V1::RegionDisksRemoveResourcePoliciesRequest, ::Hash] The body resource for this request @param request_id [::String] An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
@yield [result, response] Access the result along with the Faraday response object @yieldparam result [::Gapic::GenericLRO::Operation] @yieldparam response [::Faraday::Response]
@return [::Gapic::GenericLRO::Operation]
@raise [::Google::Cloud::Error] if the REST call is aborted.
# File lib/google/cloud/compute/v1/region_disks/rest/client.rb, line 748 def remove_resource_policies request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Compute::V1::RemoveResourcePoliciesRegionDiskRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults call_metadata = @config.rpcs.remove_resource_policies.metadata.to_h # Set x-goog-api-client header call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Compute::V1::VERSION, transports_version_send: [:rest] options.apply_defaults timeout: @config.rpcs.remove_resource_policies.timeout, metadata: call_metadata options.apply_defaults timeout: @config.timeout, metadata: @config.metadata @region_disks_stub.remove_resource_policies request, options do |result, response| result = ::Google::Cloud::Compute::V1::RegionOperations::Rest::NonstandardLro.create_operation( operation: result, client: region_operations, request_values: { "project" => request.project, "region" => request.region }, options: options ) yield result, response if block_given? return result end rescue ::Faraday::Error => e begin raise ::Gapic::Rest::Error.wrap_faraday_error e rescue ::Gapic::Rest::Error => gapic_error raise ::Google::Cloud::Error.from_error gapic_error end end
Resizes the specified regional persistent disk.
@overload resize(request, options = nil)
Pass arguments to `resize` via a request object, either of type {::Google::Cloud::Compute::V1::ResizeRegionDiskRequest} or an equivalent Hash. @param request [::Google::Cloud::Compute::V1::ResizeRegionDiskRequest, ::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. Note: currently retry functionality is not implemented. While it is possible to set it using ::Gapic::CallOptions, it will not be applied
@overload resize(disk: nil, project: nil, region: nil, region_disks_resize_request_resource: nil, request_id: nil)
Pass arguments to `resize` 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 disk [::String] Name of the regional persistent disk. @param project [::String] The project ID for this request. @param region [::String] Name of the region for this request. @param region_disks_resize_request_resource [::Google::Cloud::Compute::V1::RegionDisksResizeRequest, ::Hash] The body resource for this request @param request_id [::String] An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
@yield [result, response] Access the result along with the Faraday response object @yieldparam result [::Gapic::GenericLRO::Operation] @yieldparam response [::Faraday::Response]
@return [::Gapic::GenericLRO::Operation]
@raise [::Google::Cloud::Error] if the REST call is aborted.
# File lib/google/cloud/compute/v1/region_disks/rest/client.rb, line 829 def resize request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Compute::V1::ResizeRegionDiskRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults call_metadata = @config.rpcs.resize.metadata.to_h # Set x-goog-api-client header call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Compute::V1::VERSION, transports_version_send: [:rest] options.apply_defaults timeout: @config.rpcs.resize.timeout, metadata: call_metadata options.apply_defaults timeout: @config.timeout, metadata: @config.metadata @region_disks_stub.resize request, options do |result, response| result = ::Google::Cloud::Compute::V1::RegionOperations::Rest::NonstandardLro.create_operation( operation: result, client: region_operations, request_values: { "project" => request.project, "region" => request.region }, options: options ) yield result, response if block_given? return result end rescue ::Faraday::Error => e begin raise ::Gapic::Rest::Error.wrap_faraday_error e rescue ::Gapic::Rest::Error => gapic_error raise ::Google::Cloud::Error.from_error gapic_error end end
Sets the access control policy on the specified resource. Replaces any existing policy.
@overload set_iam_policy
(request, options = nil)
Pass arguments to `set_iam_policy` via a request object, either of type {::Google::Cloud::Compute::V1::SetIamPolicyRegionDiskRequest} or an equivalent Hash. @param request [::Google::Cloud::Compute::V1::SetIamPolicyRegionDiskRequest, ::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. Note: currently retry functionality is not implemented. While it is possible to set it using ::Gapic::CallOptions, it will not be applied
@overload set_iam_policy
(project: nil, region: nil, region_set_policy_request_resource: nil, resource: nil)
Pass arguments to `set_iam_policy` 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 project [::String] Project ID for this request. @param region [::String] The name of the region for this request. @param region_set_policy_request_resource [::Google::Cloud::Compute::V1::RegionSetPolicyRequest, ::Hash] The body resource for this request @param resource [::String] Name or id of the resource for this request.
@yield [result, response] Access the result along with the Faraday response object @yieldparam result [::Google::Cloud::Compute::V1::Policy] @yieldparam response [::Faraday::Response]
@return [::Google::Cloud::Compute::V1::Policy]
@raise [::Google::Cloud::Error] if the REST call is aborted.
# File lib/google/cloud/compute/v1/region_disks/rest/client.rb, line 908 def set_iam_policy request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Compute::V1::SetIamPolicyRegionDiskRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults call_metadata = @config.rpcs.set_iam_policy.metadata.to_h # Set x-goog-api-client header call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Compute::V1::VERSION, transports_version_send: [:rest] options.apply_defaults timeout: @config.rpcs.set_iam_policy.timeout, metadata: call_metadata options.apply_defaults timeout: @config.timeout, metadata: @config.metadata @region_disks_stub.set_iam_policy request, options do |result, response| yield result, response if block_given? return result end rescue ::Faraday::Error => e begin raise ::Gapic::Rest::Error.wrap_faraday_error e rescue ::Gapic::Rest::Error => gapic_error raise ::Google::Cloud::Error.from_error gapic_error end end
Sets the labels on the target regional disk.
@overload set_labels
(request, options = nil)
Pass arguments to `set_labels` via a request object, either of type {::Google::Cloud::Compute::V1::SetLabelsRegionDiskRequest} or an equivalent Hash. @param request [::Google::Cloud::Compute::V1::SetLabelsRegionDiskRequest, ::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. Note: currently retry functionality is not implemented. While it is possible to set it using ::Gapic::CallOptions, it will not be applied
@overload set_labels
(project: nil, region: nil, region_set_labels_request_resource: nil, request_id: nil, resource: nil)
Pass arguments to `set_labels` 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 project [::String] Project ID for this request. @param region [::String] The region for this request. @param region_set_labels_request_resource [::Google::Cloud::Compute::V1::RegionSetLabelsRequest, ::Hash] The body resource for this request @param request_id [::String] An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). @param resource [::String] Name or id of the resource for this request.
@yield [result, response] Access the result along with the Faraday response object @yieldparam result [::Gapic::GenericLRO::Operation] @yieldparam response [::Faraday::Response]
@return [::Gapic::GenericLRO::Operation]
@raise [::Google::Cloud::Error] if the REST call is aborted.
# File lib/google/cloud/compute/v1/region_disks/rest/client.rb, line 980 def set_labels request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Compute::V1::SetLabelsRegionDiskRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults call_metadata = @config.rpcs.set_labels.metadata.to_h # Set x-goog-api-client header call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Compute::V1::VERSION, transports_version_send: [:rest] options.apply_defaults timeout: @config.rpcs.set_labels.timeout, metadata: call_metadata options.apply_defaults timeout: @config.timeout, metadata: @config.metadata @region_disks_stub.set_labels request, options do |result, response| result = ::Google::Cloud::Compute::V1::RegionOperations::Rest::NonstandardLro.create_operation( operation: result, client: region_operations, request_values: { "project" => request.project, "region" => request.region }, options: options ) yield result, response if block_given? return result end rescue ::Faraday::Error => e begin raise ::Gapic::Rest::Error.wrap_faraday_error e rescue ::Gapic::Rest::Error => gapic_error raise ::Google::Cloud::Error.from_error gapic_error end end
Returns permissions that a caller has on the specified resource.
@overload test_iam_permissions
(request, options = nil)
Pass arguments to `test_iam_permissions` via a request object, either of type {::Google::Cloud::Compute::V1::TestIamPermissionsRegionDiskRequest} or an equivalent Hash. @param request [::Google::Cloud::Compute::V1::TestIamPermissionsRegionDiskRequest, ::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. Note: currently retry functionality is not implemented. While it is possible to set it using ::Gapic::CallOptions, it will not be applied
@overload test_iam_permissions
(project: nil, region: nil, resource: nil, test_permissions_request_resource: nil)
Pass arguments to `test_iam_permissions` 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 project [::String] Project ID for this request. @param region [::String] The name of the region for this request. @param resource [::String] Name or id of the resource for this request. @param test_permissions_request_resource [::Google::Cloud::Compute::V1::TestPermissionsRequest, ::Hash] The body resource for this request
@yield [result, response] Access the result along with the Faraday response object @yieldparam result [::Google::Cloud::Compute::V1::TestPermissionsResponse] @yieldparam response [::Faraday::Response]
@return [::Google::Cloud::Compute::V1::TestPermissionsResponse]
@raise [::Google::Cloud::Error] if the REST call is aborted.
# File lib/google/cloud/compute/v1/region_disks/rest/client.rb, line 1059 def test_iam_permissions request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Compute::V1::TestIamPermissionsRegionDiskRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults call_metadata = @config.rpcs.test_iam_permissions.metadata.to_h # Set x-goog-api-client header call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Compute::V1::VERSION, transports_version_send: [:rest] options.apply_defaults timeout: @config.rpcs.test_iam_permissions.timeout, metadata: call_metadata options.apply_defaults timeout: @config.timeout, metadata: @config.metadata @region_disks_stub.test_iam_permissions request, options do |result, response| yield result, response if block_given? return result end rescue ::Faraday::Error => e begin raise ::Gapic::Rest::Error.wrap_faraday_error e rescue ::Gapic::Rest::Error => gapic_error raise ::Google::Cloud::Error.from_error gapic_error end end