Google Cloud Compute V1 API - Class Google::Cloud::Compute::V1::Disks::Rest::Client (v2.5.0)

Reference documentation and code samples for the Google Cloud Compute V1 API class Google::Cloud::Compute::V1::Disks::Rest::Client.

REST client for the Disks service.

The Disks API.

Inherits

Object

Methods

.configure

def self.configure() { |config| ... } -> Client::Configuration

Configure the Disks Client class.

See Configuration for a description of the configuration fields.

Yields

(config) — Configure the Client client.

Yield Parameter

config (Client::Configuration)

Returns

(Client::Configuration)

Example

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

#add_resource_policies

def add_resource_policies(request, options = nil) -> ::Gapic::GenericLRO::Operation
def add_resource_policies(disk: nil, disks_add_resource_policies_request_resource: nil, project: nil, request_id: nil, zone: nil) -> ::Gapic::GenericLRO::Operation

Adds existing resource policies to a disk. You can only add one policy which will be applied to this disk for scheduling snapshot creation.

Overloads

def add_resource_policies(request, options = nil) -> ::Gapic::GenericLRO::Operation

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

Parameters

request (::Google::Cloud::Compute::V1::AddResourcePoliciesDiskRequest, ::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) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def add_resource_policies(disk: nil, disks_add_resource_policies_request_resource: nil, project: nil, request_id: nil, zone: nil) -> ::Gapic::GenericLRO::Operation

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

Parameters

disk (::String) — The disk name for this request.
disks_add_resource_policies_request_resource (::Google::Cloud::Compute::V1::DisksAddResourcePoliciesRequest, ::Hash) — The body resource for this request
project (::String) — Project ID for this request.
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).
zone (::String) — The name of the zone for this request.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Gapic::GenericLRO::Operation)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Gapic::GenericLRO::Operation)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

Example

Basic example

require "google/cloud/compute/v1"

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

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

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

# The returned object is of type Google::Cloud::Compute::V1::Operation.
p result

#aggregated_list

def aggregated_list(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::String, ::Google::Cloud::Compute::V1::DisksScopedList>
def aggregated_list(filter: nil, include_all_scopes: nil, max_results: nil, order_by: nil, page_token: nil, project: nil, return_partial_success: nil) -> ::Gapic::Rest::PagedEnumerable<::String, ::Google::Cloud::Compute::V1::DisksScopedList>

Retrieves an aggregated list of persistent disks.

Overloads

def aggregated_list(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::String, ::Google::Cloud::Compute::V1::DisksScopedList>

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

Parameters

request (::Google::Cloud::Compute::V1::AggregatedListDisksRequest, ::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) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def aggregated_list(filter: nil, include_all_scopes: nil, max_results: nil, order_by: nil, page_token: nil, project: nil, return_partial_success: nil) -> ::Gapic::Rest::PagedEnumerable<::String, ::Google::Cloud::Compute::V1::DisksScopedList>

Pass arguments to aggregated_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).

Parameters

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.
include_all_scopes (::Boolean) — Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.
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)
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.
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.
project (::String) — Project ID for this request.
return_partial_success (::Boolean) — Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Gapic::Rest::PagedEnumerable<::String, ::Google::Cloud::Compute::V1::DisksScopedList>)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Gapic::Rest::PagedEnumerable<::String, ::Google::Cloud::Compute::V1::DisksScopedList>)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

Example

Basic example

require "google/cloud/compute/v1"

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

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

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

# The returned object is of type Google::Cloud::Compute::V1::DiskAggregatedList.
p result

#bulk_insert

def bulk_insert(request, options = nil) -> ::Gapic::GenericLRO::Operation
def bulk_insert(bulk_insert_disk_resource_resource: nil, project: nil, request_id: nil, zone: nil) -> ::Gapic::GenericLRO::Operation

Bulk create a set of disks.

Overloads

def bulk_insert(request, options = nil) -> ::Gapic::GenericLRO::Operation

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

Parameters

request (::Google::Cloud::Compute::V1::BulkInsertDiskRequest, ::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) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def bulk_insert(bulk_insert_disk_resource_resource: nil, project: nil, request_id: nil, zone: nil) -> ::Gapic::GenericLRO::Operation

Pass arguments to bulk_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).

Parameters

bulk_insert_disk_resource_resource (::Google::Cloud::Compute::V1::BulkInsertDiskResource, ::Hash) — The body resource for this request
project (::String) — Project ID for this request.
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).
zone (::String) — The name of the zone for this request.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Gapic::GenericLRO::Operation)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Gapic::GenericLRO::Operation)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

Example

Basic example

require "google/cloud/compute/v1"

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

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

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

# The returned object is of type Google::Cloud::Compute::V1::Operation.
p result

#configure

def configure() { |config| ... } -> Client::Configuration

Configure the Disks 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 Configuration for a description of the configuration fields.

Yields

(config) — Configure the Client client.

Yield Parameter

config (Client::Configuration)

Returns

(Client::Configuration)

#create_snapshot

def create_snapshot(request, options = nil) -> ::Gapic::GenericLRO::Operation
def create_snapshot(disk: nil, guest_flush: nil, project: nil, request_id: nil, snapshot_resource: nil, zone: nil) -> ::Gapic::GenericLRO::Operation

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.

Overloads

def create_snapshot(request, options = nil) -> ::Gapic::GenericLRO::Operation

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

Parameters

request (::Google::Cloud::Compute::V1::CreateSnapshotDiskRequest, ::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) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def create_snapshot(disk: nil, guest_flush: nil, project: nil, request_id: nil, snapshot_resource: nil, zone: nil) -> ::Gapic::GenericLRO::Operation

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

Parameters

disk (::String) — Name of the persistent disk to snapshot.
guest_flush (::Boolean) — [Input Only] Whether to attempt an application consistent snapshot by informing the OS to prepare for the snapshot process.
project (::String) — Project ID for this request.
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).
snapshot_resource (::Google::Cloud::Compute::V1::Snapshot, ::Hash) — The body resource for this request
zone (::String) — The name of the zone for this request.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Gapic::GenericLRO::Operation)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Gapic::GenericLRO::Operation)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

Example

Basic example

require "google/cloud/compute/v1"

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

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

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

# The returned object is of type Google::Cloud::Compute::V1::Operation.
p result

#delete

def delete(request, options = nil) -> ::Gapic::GenericLRO::Operation
def delete(disk: nil, project: nil, request_id: nil, zone: nil) -> ::Gapic::GenericLRO::Operation

Deletes the specified persistent disk. Deleting a disk removes 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.

Overloads

def delete(request, options = nil) -> ::Gapic::GenericLRO::Operation

Pass arguments to delete via a request object, either of type Google::Cloud::Compute::V1::DeleteDiskRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::Compute::V1::DeleteDiskRequest, ::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) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def delete(disk: nil, project: nil, request_id: nil, zone: nil) -> ::Gapic::GenericLRO::Operation

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

Parameters

disk (::String) — Name of the persistent disk to delete.
project (::String) — Project ID for this request.
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).
zone (::String) — The name of the zone for this request.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Gapic::GenericLRO::Operation)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Gapic::GenericLRO::Operation)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

Example

Basic example

require "google/cloud/compute/v1"

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

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

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

# The returned object is of type Google::Cloud::Compute::V1::Operation.
p result

#get

def get(request, options = nil) -> ::Google::Cloud::Compute::V1::Disk
def get(disk: nil, project: nil, zone: nil) -> ::Google::Cloud::Compute::V1::Disk

Returns the specified persistent disk.

Overloads

def get(request, options = nil) -> ::Google::Cloud::Compute::V1::Disk

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

Parameters

request (::Google::Cloud::Compute::V1::GetDiskRequest, ::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) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def get(disk: nil, project: nil, zone: nil) -> ::Google::Cloud::Compute::V1::Disk

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

Parameters

disk (::String) — Name of the persistent disk to return.
project (::String) — Project ID for this request.
zone (::String) — The name of the zone for this request.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Google::Cloud::Compute::V1::Disk)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::Compute::V1::Disk)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

Example

Basic example

require "google/cloud/compute/v1"

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

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

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

# The returned object is of type Google::Cloud::Compute::V1::Disk.
p result

#get_iam_policy

def get_iam_policy(request, options = nil) -> ::Google::Cloud::Compute::V1::Policy
def get_iam_policy(options_requested_policy_version: nil, project: nil, resource: nil, zone: nil) -> ::Google::Cloud::Compute::V1::Policy

Gets the access control policy for a resource. May be empty if no such policy or resource exists.

Overloads

def get_iam_policy(request, options = nil) -> ::Google::Cloud::Compute::V1::Policy

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

Parameters

request (::Google::Cloud::Compute::V1::GetIamPolicyDiskRequest, ::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) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def get_iam_policy(options_requested_policy_version: nil, project: nil, resource: nil, zone: nil) -> ::Google::Cloud::Compute::V1::Policy

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

Parameters

options_requested_policy_version (::Integer) — Requested IAM Policy version.
project (::String) — Project ID for this request.
resource (::String) — Name or id of the resource for this request.
zone (::String) — The name of the zone for this request.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Google::Cloud::Compute::V1::Policy)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::Compute::V1::Policy)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

Example

Basic example

require "google/cloud/compute/v1"

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

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

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

# The returned object is of type Google::Cloud::Compute::V1::Policy.
p result

#initialize

def initialize() { |config| ... } -> Client

Create a new Disks REST client object.

Yields

(config) — Configure the Disks client.

Yield Parameter

config (Client::Configuration)

Returns

(Client) — a new instance of Client

Example

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

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

#insert

def insert(request, options = nil) -> ::Gapic::GenericLRO::Operation
def insert(disk_resource: nil, project: nil, request_id: nil, source_image: nil, zone: nil) -> ::Gapic::GenericLRO::Operation

Creates a persistent disk in the specified project using the data in the request. You can create a disk from a source (sourceImage, sourceSnapshot, or sourceDisk) or create an empty 500 GB data disk by omitting all properties. You can also create a disk that is larger than the default size by specifying the sizeGb property.

Overloads

def insert(request, options = nil) -> ::Gapic::GenericLRO::Operation

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

Parameters

request (::Google::Cloud::Compute::V1::InsertDiskRequest, ::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) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def insert(disk_resource: nil, project: nil, request_id: nil, source_image: nil, zone: nil) -> ::Gapic::GenericLRO::Operation

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

Parameters

disk_resource (::Google::Cloud::Compute::V1::Disk, ::Hash) — The body resource for this request
project (::String) — Project ID for this request.
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).
source_image (::String) — Source image to restore onto a disk. This field is optional.
zone (::String) — The name of the zone for this request.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Gapic::GenericLRO::Operation)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Gapic::GenericLRO::Operation)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

Example

Basic example

require "google/cloud/compute/v1"

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

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

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

# The returned object is of type Google::Cloud::Compute::V1::Operation.
p result

#list

def list(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Compute::V1::Disk>
def list(filter: nil, max_results: nil, order_by: nil, page_token: nil, project: nil, return_partial_success: nil, zone: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Compute::V1::Disk>

Retrieves a list of persistent disks contained within the specified zone.

Overloads

def list(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Compute::V1::Disk>

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

Parameters

request (::Google::Cloud::Compute::V1::ListDisksRequest, ::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) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def list(filter: nil, max_results: nil, order_by: nil, page_token: nil, project: nil, return_partial_success: nil, zone: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Compute::V1::Disk>

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

Parameters

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.
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)
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.
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.
project (::String) — Project ID for this request.
return_partial_success (::Boolean) — Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.
zone (::String) — The name of the zone for this request.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Gapic::Rest::PagedEnumerable<::Google::Cloud::Compute::V1::Disk>)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Gapic::Rest::PagedEnumerable<::Google::Cloud::Compute::V1::Disk>)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

Example

Basic example

require "google/cloud/compute/v1"

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

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

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

# The returned object is of type Google::Cloud::Compute::V1::DiskList.
p result

#remove_resource_policies

def remove_resource_policies(request, options = nil) -> ::Gapic::GenericLRO::Operation
def remove_resource_policies(disk: nil, disks_remove_resource_policies_request_resource: nil, project: nil, request_id: nil, zone: nil) -> ::Gapic::GenericLRO::Operation

Removes resource policies from a disk.

Overloads

def remove_resource_policies(request, options = nil) -> ::Gapic::GenericLRO::Operation

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

Parameters

request (::Google::Cloud::Compute::V1::RemoveResourcePoliciesDiskRequest, ::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) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def remove_resource_policies(disk: nil, disks_remove_resource_policies_request_resource: nil, project: nil, request_id: nil, zone: nil) -> ::Gapic::GenericLRO::Operation

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

Parameters

disk (::String) — The disk name for this request.
disks_remove_resource_policies_request_resource (::Google::Cloud::Compute::V1::DisksRemoveResourcePoliciesRequest, ::Hash) — The body resource for this request
project (::String) — Project ID for this request.
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).
zone (::String) — The name of the zone for this request.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Gapic::GenericLRO::Operation)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Gapic::GenericLRO::Operation)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

Example

Basic example

require "google/cloud/compute/v1"

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

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

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

# The returned object is of type Google::Cloud::Compute::V1::Operation.
p result

#resize

def resize(request, options = nil) -> ::Gapic::GenericLRO::Operation
def resize(disk: nil, disks_resize_request_resource: nil, project: nil, request_id: nil, zone: nil) -> ::Gapic::GenericLRO::Operation

Resizes the specified persistent disk. You can only increase the size of the disk.

Overloads

def resize(request, options = nil) -> ::Gapic::GenericLRO::Operation

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

Parameters

request (::Google::Cloud::Compute::V1::ResizeDiskRequest, ::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) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def resize(disk: nil, disks_resize_request_resource: nil, project: nil, request_id: nil, zone: nil) -> ::Gapic::GenericLRO::Operation

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

Parameters

disk (::String) — The name of the persistent disk.
disks_resize_request_resource (::Google::Cloud::Compute::V1::DisksResizeRequest, ::Hash) — The body resource for this request
project (::String) — Project ID for this request.
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).
zone (::String) — The name of the zone for this request.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Gapic::GenericLRO::Operation)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Gapic::GenericLRO::Operation)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

Example

Basic example

require "google/cloud/compute/v1"

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

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

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

# The returned object is of type Google::Cloud::Compute::V1::Operation.
p result

#set_iam_policy

def set_iam_policy(request, options = nil) -> ::Google::Cloud::Compute::V1::Policy
def set_iam_policy(project: nil, resource: nil, zone: nil, zone_set_policy_request_resource: nil) -> ::Google::Cloud::Compute::V1::Policy

Sets the access control policy on the specified resource. Replaces any existing policy.

Overloads

def set_iam_policy(request, options = nil) -> ::Google::Cloud::Compute::V1::Policy

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

Parameters

request (::Google::Cloud::Compute::V1::SetIamPolicyDiskRequest, ::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) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def set_iam_policy(project: nil, resource: nil, zone: nil, zone_set_policy_request_resource: nil) -> ::Google::Cloud::Compute::V1::Policy

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

Parameters

project (::String) — Project ID for this request.
resource (::String) — Name or id of the resource for this request.
zone (::String) — The name of the zone for this request.
zone_set_policy_request_resource (::Google::Cloud::Compute::V1::ZoneSetPolicyRequest, ::Hash) — The body resource for this request

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Google::Cloud::Compute::V1::Policy)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::Compute::V1::Policy)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

Example

Basic example

require "google/cloud/compute/v1"

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

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

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

# The returned object is of type Google::Cloud::Compute::V1::Policy.
p result

#set_labels

def set_labels(request, options = nil) -> ::Gapic::GenericLRO::Operation
def set_labels(project: nil, request_id: nil, resource: nil, zone: nil, zone_set_labels_request_resource: nil) -> ::Gapic::GenericLRO::Operation

Sets the labels on a disk. To learn more about labels, read the Labeling Resources documentation.

Overloads

def set_labels(request, options = nil) -> ::Gapic::GenericLRO::Operation

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

Parameters

request (::Google::Cloud::Compute::V1::SetLabelsDiskRequest, ::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) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def set_labels(project: nil, request_id: nil, resource: nil, zone: nil, zone_set_labels_request_resource: nil) -> ::Gapic::GenericLRO::Operation

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

Parameters

project (::String) — Project ID for this request.
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).
resource (::String) — Name or id of the resource for this request.
zone (::String) — The name of the zone for this request.
zone_set_labels_request_resource (::Google::Cloud::Compute::V1::ZoneSetLabelsRequest, ::Hash) — The body resource for this request

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Gapic::GenericLRO::Operation)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Gapic::GenericLRO::Operation)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

Example

Basic example

require "google/cloud/compute/v1"

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

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

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

# The returned object is of type Google::Cloud::Compute::V1::Operation.
p result

#start_async_replication

def start_async_replication(request, options = nil) -> ::Gapic::GenericLRO::Operation
def start_async_replication(disk: nil, disks_start_async_replication_request_resource: nil, project: nil, request_id: nil, zone: nil) -> ::Gapic::GenericLRO::Operation

Starts asynchronous replication. Must be invoked on the primary disk.

Overloads

def start_async_replication(request, options = nil) -> ::Gapic::GenericLRO::Operation

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

Parameters

request (::Google::Cloud::Compute::V1::StartAsyncReplicationDiskRequest, ::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) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def start_async_replication(disk: nil, disks_start_async_replication_request_resource: nil, project: nil, request_id: nil, zone: nil) -> ::Gapic::GenericLRO::Operation

Pass arguments to start_async_replication 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

disk (::String) — The name of the persistent disk.
disks_start_async_replication_request_resource (::Google::Cloud::Compute::V1::DisksStartAsyncReplicationRequest, ::Hash) — The body resource for this request
project (::String) — Project ID for this request.
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).
zone (::String) — The name of the zone for this request.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Gapic::GenericLRO::Operation)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Gapic::GenericLRO::Operation)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

Example

Basic example

require "google/cloud/compute/v1"

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

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

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

# The returned object is of type Google::Cloud::Compute::V1::Operation.
p result

#stop_async_replication

def stop_async_replication(request, options = nil) -> ::Gapic::GenericLRO::Operation
def stop_async_replication(disk: nil, project: nil, request_id: nil, zone: nil) -> ::Gapic::GenericLRO::Operation

Stops asynchronous replication. Can be invoked either on the primary or on the secondary disk.

Overloads

def stop_async_replication(request, options = nil) -> ::Gapic::GenericLRO::Operation

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

Parameters

request (::Google::Cloud::Compute::V1::StopAsyncReplicationDiskRequest, ::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) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def stop_async_replication(disk: nil, project: nil, request_id: nil, zone: nil) -> ::Gapic::GenericLRO::Operation

Pass arguments to stop_async_replication 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

disk (::String) — The name of the persistent disk.
project (::String) — Project ID for this request.
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).
zone (::String) — The name of the zone for this request.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Gapic::GenericLRO::Operation)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Gapic::GenericLRO::Operation)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

Example

Basic example

require "google/cloud/compute/v1"

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

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

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

# The returned object is of type Google::Cloud::Compute::V1::Operation.
p result

#stop_group_async_replication

def stop_group_async_replication(request, options = nil) -> ::Gapic::GenericLRO::Operation
def stop_group_async_replication(disks_stop_group_async_replication_resource_resource: nil, project: nil, request_id: nil, zone: nil) -> ::Gapic::GenericLRO::Operation

Stops asynchronous replication for a consistency group of disks. Can be invoked either in the primary or secondary scope.

Overloads

def stop_group_async_replication(request, options = nil) -> ::Gapic::GenericLRO::Operation

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

Parameters

request (::Google::Cloud::Compute::V1::StopGroupAsyncReplicationDiskRequest, ::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) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def stop_group_async_replication(disks_stop_group_async_replication_resource_resource: nil, project: nil, request_id: nil, zone: nil) -> ::Gapic::GenericLRO::Operation

Pass arguments to stop_group_async_replication 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

disks_stop_group_async_replication_resource_resource (::Google::Cloud::Compute::V1::DisksStopGroupAsyncReplicationResource, ::Hash) — The body resource for this request
project (::String) — Project ID for this request.
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).
zone (::String) — The name of the zone for this request. This must be the zone of the primary or secondary disks in the consistency group.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Gapic::GenericLRO::Operation)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Gapic::GenericLRO::Operation)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

Example

Basic example

require "google/cloud/compute/v1"

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

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

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

# The returned object is of type Google::Cloud::Compute::V1::Operation.
p result

#test_iam_permissions

def test_iam_permissions(request, options = nil) -> ::Google::Cloud::Compute::V1::TestPermissionsResponse
def test_iam_permissions(project: nil, resource: nil, test_permissions_request_resource: nil, zone: nil) -> ::Google::Cloud::Compute::V1::TestPermissionsResponse

Returns permissions that a caller has on the specified resource.

Overloads

def test_iam_permissions(request, options = nil) -> ::Google::Cloud::Compute::V1::TestPermissionsResponse

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

Parameters

request (::Google::Cloud::Compute::V1::TestIamPermissionsDiskRequest, ::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) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def test_iam_permissions(project: nil, resource: nil, test_permissions_request_resource: nil, zone: nil) -> ::Google::Cloud::Compute::V1::TestPermissionsResponse

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

Parameters

project (::String) — Project ID for this request.
resource (::String) — Name or id of the resource for this request.
test_permissions_request_resource (::Google::Cloud::Compute::V1::TestPermissionsRequest, ::Hash) — The body resource for this request
zone (::String) — The name of the zone for this request.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Google::Cloud::Compute::V1::TestPermissionsResponse)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::Compute::V1::TestPermissionsResponse)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

Example

Basic example

require "google/cloud/compute/v1"

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

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

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

# The returned object is of type Google::Cloud::Compute::V1::TestPermissionsResponse.
p result

#update

def update(request, options = nil) -> ::Gapic::GenericLRO::Operation
def update(disk: nil, disk_resource: nil, paths: nil, project: nil, request_id: nil, update_mask: nil, zone: nil) -> ::Gapic::GenericLRO::Operation

Updates the specified disk with the data included in the request. The update is performed only on selected fields included as part of update-mask. Only the following fields can be modified: user_license.

Overloads

def update(request, options = nil) -> ::Gapic::GenericLRO::Operation

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

Parameters

request (::Google::Cloud::Compute::V1::UpdateDiskRequest, ::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) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def update(disk: nil, disk_resource: nil, paths: nil, project: nil, request_id: nil, update_mask: nil, zone: nil) -> ::Gapic::GenericLRO::Operation

Pass arguments to update 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

disk (::String) — The disk name for this request.
disk_resource (::Google::Cloud::Compute::V1::Disk, ::Hash) — The body resource for this request
paths (::String)
project (::String) — Project ID for this request.
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).
update_mask (::String) — update_mask indicates fields to be updated as part of this request.
zone (::String) — The name of the zone for this request.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Gapic::GenericLRO::Operation)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Gapic::GenericLRO::Operation)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

Example

Basic example

require "google/cloud/compute/v1"

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

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

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

# The returned object is of type Google::Cloud::Compute::V1::Operation.
p result

#zone_operations

def zone_operations() -> ::Google::Cloud::Compute::V1::ZoneOperations::Rest::Client

Get the associated client for long-running operations via ZoneOperations.

Returns

(::Google::Cloud::Compute::V1::ZoneOperations::Rest::Client)