Reference documentation and code samples for the Google Cloud Compute V1 API class Google::Cloud::Compute::V1::Instances::Rest::Client.
REST client for the Instances service.
The Instances API.
Inherits
- Object
Methods
.configure
def self.configure() { |config| ... } -> Client::Configuration
Configure the Instances Client class.
See Configuration for a description of the configuration fields.
- (config) — Configure the Client client.
- config (Client::Configuration)
# Modify the configuration for all Instances clients ::Google::Cloud::Compute::V1::Instances::Rest::Client.configure do |config| config.timeout = 10.0 end
#add_access_config
def add_access_config(request, options = nil) -> ::Gapic::GenericLRO::Operation
def add_access_config(access_config_resource: nil, instance: nil, network_interface: nil, project: nil, request_id: nil, zone: nil) -> ::Gapic::GenericLRO::Operation
Adds an access config to an instance's network interface.
def add_access_config(request, options = nil) -> ::Gapic::GenericLRO::Operation
add_access_config
via a request object, either of type
AddAccessConfigInstanceRequest or an equivalent Hash.
- request (::Google::Cloud::Compute::V1::AddAccessConfigInstanceRequest, ::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. Note: currently retry functionality is not implemented. While it is possible to set it using ::Gapic::CallOptions, it will not be applied
def add_access_config(access_config_resource: nil, instance: nil, network_interface: nil, project: nil, request_id: nil, zone: nil) -> ::Gapic::GenericLRO::Operation
add_access_config
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).
- access_config_resource (::Google::Cloud::Compute::V1::AccessConfig, ::Hash) — The body resource for this request
- instance (::String) — The instance name for this request.
- network_interface (::String) — The name of the network interface to add to this instance.
- 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.
- (result, response) — Access the result along with the Faraday response object
- result (::Gapic::GenericLRO::Operation)
- response (::Faraday::Response)
- (::Gapic::GenericLRO::Operation)
- (::Google::Cloud::Error) — if the REST call is aborted.
#add_resource_policies
def add_resource_policies(request, options = nil) -> ::Gapic::GenericLRO::Operation
def add_resource_policies(instance: nil, instances_add_resource_policies_request_resource: nil, project: nil, request_id: nil, zone: nil) -> ::Gapic::GenericLRO::Operation
Adds existing resource policies to an instance. You can only add one policy right now which will be applied to this instance for scheduling live migrations.
def add_resource_policies(request, options = nil) -> ::Gapic::GenericLRO::Operation
add_resource_policies
via a request object, either of type
AddResourcePoliciesInstanceRequest or an equivalent Hash.
- request (::Google::Cloud::Compute::V1::AddResourcePoliciesInstanceRequest, ::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. Note: currently retry functionality is not implemented. While it is possible to set it using ::Gapic::CallOptions, it will not be applied
def add_resource_policies(instance: nil, instances_add_resource_policies_request_resource: nil, project: nil, request_id: nil, zone: nil) -> ::Gapic::GenericLRO::Operation
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).
- instance (::String) — The instance name for this request.
- instances_add_resource_policies_request_resource (::Google::Cloud::Compute::V1::InstancesAddResourcePoliciesRequest, ::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.
- (result, response) — Access the result along with the Faraday response object
- result (::Gapic::GenericLRO::Operation)
- response (::Faraday::Response)
- (::Gapic::GenericLRO::Operation)
- (::Google::Cloud::Error) — if the REST call is aborted.
#aggregated_list
def aggregated_list(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::String, ::Google::Cloud::Compute::V1::InstancesScopedList>
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::InstancesScopedList>
Retrieves an aggregated list of all of the instances in your project across all regions and zones. The performance of this method degrades when a filter is specified on a project that has a very large number of instances.
def aggregated_list(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::String, ::Google::Cloud::Compute::V1::InstancesScopedList>
aggregated_list
via a request object, either of type
AggregatedListInstancesRequest or an equivalent Hash.
- request (::Google::Cloud::Compute::V1::AggregatedListInstancesRequest, ::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. Note: currently retry functionality is not implemented. While it is possible to set it using ::Gapic::CallOptions, it will not be applied
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::InstancesScopedList>
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).
-
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 namedexample-instance
by specifyingname != 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 withowner
label use:labels.owner:*
You can also filter nested fields. For example, you could specifyscheduling.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 anAND
expression. However, you can includeAND
andOR
expressions explicitly. For example:(cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true)
If you want to use a regular expression, use theeq
(equal) orne
(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 usename 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 anextPageToken
that can be used to get the next page of results in subsequent list requests. Acceptable values are0
to500
, 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 thecreationTimestamp
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 byname
orcreationTimestamp desc
is supported. -
page_token (::String) — Specifies a page token to use. Set
pageToken
to thenextPageToken
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.
- (result, response) — Access the result along with the Faraday response object
- result (::Gapic::Rest::PagedEnumerable<::String, ::Google::Cloud::Compute::V1::InstancesScopedList>)
- response (::Faraday::Response)
- (::Gapic::Rest::PagedEnumerable<::String, ::Google::Cloud::Compute::V1::InstancesScopedList>)
- (::Google::Cloud::Error) — if the REST call is aborted.
#attach_disk
def attach_disk(request, options = nil) -> ::Gapic::GenericLRO::Operation
def attach_disk(attached_disk_resource: nil, force_attach: nil, instance: nil, project: nil, request_id: nil, zone: nil) -> ::Gapic::GenericLRO::Operation
Attaches an existing Disk resource to an instance. You must first create the disk before you can attach it. It is not possible to create and attach a disk at the same time. For more information, read Adding a persistent disk to your instance.
def attach_disk(request, options = nil) -> ::Gapic::GenericLRO::Operation
attach_disk
via a request object, either of type
AttachDiskInstanceRequest or an equivalent Hash.
- request (::Google::Cloud::Compute::V1::AttachDiskInstanceRequest, ::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. Note: currently retry functionality is not implemented. While it is possible to set it using ::Gapic::CallOptions, it will not be applied
def attach_disk(attached_disk_resource: nil, force_attach: nil, instance: nil, project: nil, request_id: nil, zone: nil) -> ::Gapic::GenericLRO::Operation
attach_disk
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).
- attached_disk_resource (::Google::Cloud::Compute::V1::AttachedDisk, ::Hash) — The body resource for this request
- force_attach (::Boolean) — Whether to force attach the regional disk even if it's currently attached to another instance. If you try to force attach a zonal disk to an instance, you will receive an error.
- instance (::String) — The instance name 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.
- (result, response) — Access the result along with the Faraday response object
- result (::Gapic::GenericLRO::Operation)
- response (::Faraday::Response)
- (::Gapic::GenericLRO::Operation)
- (::Google::Cloud::Error) — if the REST call is aborted.
#bulk_insert
def bulk_insert(request, options = nil) -> ::Gapic::GenericLRO::Operation
def bulk_insert(bulk_insert_instance_resource_resource: nil, project: nil, request_id: nil, zone: nil) -> ::Gapic::GenericLRO::Operation
Creates multiple instances. Count specifies the number of instances to create. For more information, see About bulk creation of VMs.
def bulk_insert(request, options = nil) -> ::Gapic::GenericLRO::Operation
bulk_insert
via a request object, either of type
BulkInsertInstanceRequest or an equivalent Hash.
- request (::Google::Cloud::Compute::V1::BulkInsertInstanceRequest, ::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. Note: currently retry functionality is not implemented. While it is possible to set it using ::Gapic::CallOptions, it will not be applied
def bulk_insert(bulk_insert_instance_resource_resource: nil, project: nil, request_id: nil, zone: nil) -> ::Gapic::GenericLRO::Operation
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).
- bulk_insert_instance_resource_resource (::Google::Cloud::Compute::V1::BulkInsertInstanceResource, ::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.
- (result, response) — Access the result along with the Faraday response object
- result (::Gapic::GenericLRO::Operation)
- response (::Faraday::Response)
- (::Gapic::GenericLRO::Operation)
- (::Google::Cloud::Error) — if the REST call is aborted.
#configure
def configure() { |config| ... } -> Client::Configuration
Configure the Instances 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.
- (config) — Configure the Client client.
- config (Client::Configuration)
#delete
def delete(request, options = nil) -> ::Gapic::GenericLRO::Operation
def delete(instance: nil, project: nil, request_id: nil, zone: nil) -> ::Gapic::GenericLRO::Operation
Deletes the specified Instance resource. For more information, see Deleting an instance.
def delete(request, options = nil) -> ::Gapic::GenericLRO::Operation
delete
via a request object, either of type
DeleteInstanceRequest or an equivalent Hash.
- request (::Google::Cloud::Compute::V1::DeleteInstanceRequest, ::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. Note: currently retry functionality is not implemented. While it is possible to set it using ::Gapic::CallOptions, it will not be applied
def delete(instance: nil, project: nil, request_id: nil, zone: nil) -> ::Gapic::GenericLRO::Operation
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).
- instance (::String) — Name of the instance resource 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.
- (result, response) — Access the result along with the Faraday response object
- result (::Gapic::GenericLRO::Operation)
- response (::Faraday::Response)
- (::Gapic::GenericLRO::Operation)
- (::Google::Cloud::Error) — if the REST call is aborted.
#delete_access_config
def delete_access_config(request, options = nil) -> ::Gapic::GenericLRO::Operation
def delete_access_config(access_config: nil, instance: nil, network_interface: nil, project: nil, request_id: nil, zone: nil) -> ::Gapic::GenericLRO::Operation
Deletes an access config from an instance's network interface.
def delete_access_config(request, options = nil) -> ::Gapic::GenericLRO::Operation
delete_access_config
via a request object, either of type
DeleteAccessConfigInstanceRequest or an equivalent Hash.
- request (::Google::Cloud::Compute::V1::DeleteAccessConfigInstanceRequest, ::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. Note: currently retry functionality is not implemented. While it is possible to set it using ::Gapic::CallOptions, it will not be applied
def delete_access_config(access_config: nil, instance: nil, network_interface: nil, project: nil, request_id: nil, zone: nil) -> ::Gapic::GenericLRO::Operation
delete_access_config
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).
- access_config (::String) — The name of the access config to delete.
- instance (::String) — The instance name for this request.
- network_interface (::String) — The name of the network interface.
- 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.
- (result, response) — Access the result along with the Faraday response object
- result (::Gapic::GenericLRO::Operation)
- response (::Faraday::Response)
- (::Gapic::GenericLRO::Operation)
- (::Google::Cloud::Error) — if the REST call is aborted.
#detach_disk
def detach_disk(request, options = nil) -> ::Gapic::GenericLRO::Operation
def detach_disk(device_name: nil, instance: nil, project: nil, request_id: nil, zone: nil) -> ::Gapic::GenericLRO::Operation
Detaches a disk from an instance.
def detach_disk(request, options = nil) -> ::Gapic::GenericLRO::Operation
detach_disk
via a request object, either of type
DetachDiskInstanceRequest or an equivalent Hash.
- request (::Google::Cloud::Compute::V1::DetachDiskInstanceRequest, ::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. Note: currently retry functionality is not implemented. While it is possible to set it using ::Gapic::CallOptions, it will not be applied
def detach_disk(device_name: nil, instance: nil, project: nil, request_id: nil, zone: nil) -> ::Gapic::GenericLRO::Operation
detach_disk
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).
- device_name (::String) — The device name of the disk to detach. Make a get() request on the instance to view currently attached disks and device names.
- instance (::String) — Instance name 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.
- (result, response) — Access the result along with the Faraday response object
- result (::Gapic::GenericLRO::Operation)
- response (::Faraday::Response)
- (::Gapic::GenericLRO::Operation)
- (::Google::Cloud::Error) — if the REST call is aborted.
#get
def get(request, options = nil) -> ::Google::Cloud::Compute::V1::Instance
def get(instance: nil, project: nil, zone: nil) -> ::Google::Cloud::Compute::V1::Instance
Returns the specified Instance resource. Gets a list of available instances by making a list() request.
def get(request, options = nil) -> ::Google::Cloud::Compute::V1::Instance
get
via a request object, either of type
GetInstanceRequest or an equivalent Hash.
- request (::Google::Cloud::Compute::V1::GetInstanceRequest, ::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. Note: currently retry functionality is not implemented. While it is possible to set it using ::Gapic::CallOptions, it will not be applied
def get(instance: nil, project: nil, zone: nil) -> ::Google::Cloud::Compute::V1::Instance
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).
- instance (::String) — Name of the instance resource to return.
- project (::String) — Project ID for this request.
- zone (::String) — The name of the zone for this request.
- (result, response) — Access the result along with the Faraday response object
- result (::Google::Cloud::Compute::V1::Instance)
- response (::Faraday::Response)
- (::Google::Cloud::Error) — if the REST call is aborted.
#get_effective_firewalls
def get_effective_firewalls(request, options = nil) -> ::Google::Cloud::Compute::V1::InstancesGetEffectiveFirewallsResponse
def get_effective_firewalls(instance: nil, network_interface: nil, project: nil, zone: nil) -> ::Google::Cloud::Compute::V1::InstancesGetEffectiveFirewallsResponse
Returns effective firewalls applied to an interface of the instance.
def get_effective_firewalls(request, options = nil) -> ::Google::Cloud::Compute::V1::InstancesGetEffectiveFirewallsResponse
get_effective_firewalls
via a request object, either of type
GetEffectiveFirewallsInstanceRequest or an equivalent Hash.
- request (::Google::Cloud::Compute::V1::GetEffectiveFirewallsInstanceRequest, ::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. Note: currently retry functionality is not implemented. While it is possible to set it using ::Gapic::CallOptions, it will not be applied
def get_effective_firewalls(instance: nil, network_interface: nil, project: nil, zone: nil) -> ::Google::Cloud::Compute::V1::InstancesGetEffectiveFirewallsResponse
get_effective_firewalls
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).
- instance (::String) — Name of the instance scoping this request.
- network_interface (::String) — The name of the network interface to get the effective firewalls.
- project (::String) — Project ID for this request.
- zone (::String) — The name of the zone for this request.
- (result, response) — Access the result along with the Faraday response object
- result (::Google::Cloud::Compute::V1::InstancesGetEffectiveFirewallsResponse)
- response (::Faraday::Response)
- (::Google::Cloud::Error) — if the REST call is aborted.
#get_guest_attributes
def get_guest_attributes(request, options = nil) -> ::Google::Cloud::Compute::V1::GuestAttributes
def get_guest_attributes(instance: nil, project: nil, query_path: nil, variable_key: nil, zone: nil) -> ::Google::Cloud::Compute::V1::GuestAttributes
Returns the specified guest attributes entry.
def get_guest_attributes(request, options = nil) -> ::Google::Cloud::Compute::V1::GuestAttributes
get_guest_attributes
via a request object, either of type
GetGuestAttributesInstanceRequest or an equivalent Hash.
- request (::Google::Cloud::Compute::V1::GetGuestAttributesInstanceRequest, ::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. Note: currently retry functionality is not implemented. While it is possible to set it using ::Gapic::CallOptions, it will not be applied
def get_guest_attributes(instance: nil, project: nil, query_path: nil, variable_key: nil, zone: nil) -> ::Google::Cloud::Compute::V1::GuestAttributes
get_guest_attributes
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).
- instance (::String) — Name of the instance scoping this request.
- project (::String) — Project ID for this request.
- query_path (::String) — Specifies the guest attributes path to be queried.
- variable_key (::String) — Specifies the key for the guest attributes entry.
- zone (::String) — The name of the zone for this request.
- (result, response) — Access the result along with the Faraday response object
- result (::Google::Cloud::Compute::V1::GuestAttributes)
- response (::Faraday::Response)
- (::Google::Cloud::Error) — if the REST call is aborted.
#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.
def get_iam_policy(request, options = nil) -> ::Google::Cloud::Compute::V1::Policy
get_iam_policy
via a request object, either of type
GetIamPolicyInstanceRequest or an equivalent Hash.
- request (::Google::Cloud::Compute::V1::GetIamPolicyInstanceRequest, ::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. Note: currently retry functionality is not implemented. While it is possible to set it using ::Gapic::CallOptions, it will not be applied
def get_iam_policy(options_requested_policy_version: nil, project: nil, resource: nil, zone: nil) -> ::Google::Cloud::Compute::V1::Policy
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).
- 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.
- (result, response) — Access the result along with the Faraday response object
- result (::Google::Cloud::Compute::V1::Policy)
- response (::Faraday::Response)
- (::Google::Cloud::Error) — if the REST call is aborted.
#get_screenshot
def get_screenshot(request, options = nil) -> ::Google::Cloud::Compute::V1::Screenshot
def get_screenshot(instance: nil, project: nil, zone: nil) -> ::Google::Cloud::Compute::V1::Screenshot
Returns the screenshot from the specified instance.
def get_screenshot(request, options = nil) -> ::Google::Cloud::Compute::V1::Screenshot
get_screenshot
via a request object, either of type
GetScreenshotInstanceRequest or an equivalent Hash.
- request (::Google::Cloud::Compute::V1::GetScreenshotInstanceRequest, ::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. Note: currently retry functionality is not implemented. While it is possible to set it using ::Gapic::CallOptions, it will not be applied
def get_screenshot(instance: nil, project: nil, zone: nil) -> ::Google::Cloud::Compute::V1::Screenshot
get_screenshot
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).
- instance (::String) — Name of the instance scoping this request.
- project (::String) — Project ID for this request.
- zone (::String) — The name of the zone for this request.
- (result, response) — Access the result along with the Faraday response object
- result (::Google::Cloud::Compute::V1::Screenshot)
- response (::Faraday::Response)
- (::Google::Cloud::Error) — if the REST call is aborted.
#get_serial_port_output
def get_serial_port_output(request, options = nil) -> ::Google::Cloud::Compute::V1::SerialPortOutput
def get_serial_port_output(instance: nil, port: nil, project: nil, start: nil, zone: nil) -> ::Google::Cloud::Compute::V1::SerialPortOutput
Returns the last 1 MB of serial port output from the specified instance.
def get_serial_port_output(request, options = nil) -> ::Google::Cloud::Compute::V1::SerialPortOutput
get_serial_port_output
via a request object, either of type
GetSerialPortOutputInstanceRequest or an equivalent Hash.
- request (::Google::Cloud::Compute::V1::GetSerialPortOutputInstanceRequest, ::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. Note: currently retry functionality is not implemented. While it is possible to set it using ::Gapic::CallOptions, it will not be applied
def get_serial_port_output(instance: nil, port: nil, project: nil, start: nil, zone: nil) -> ::Google::Cloud::Compute::V1::SerialPortOutput
get_serial_port_output
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).
- instance (::String) — Name of the instance for this request.
- port (::Integer) — Specifies which COM or serial port to retrieve data from.
- project (::String) — Project ID for this request.
-
start (::Integer) — Specifies the starting byte position of the output to return. To start with the first byte of output to the specified port, omit this field or set it to
0
. If the output for that byte position is available, this field matches thestart
parameter sent with the request. If the amount of serial console output exceeds the size of the buffer (1 MB), the oldest output is discarded and is no longer available. If the requested start position refers to discarded output, the start position is adjusted to the oldest output still available, and the adjusted start position is returned as thestart
property value. You can also provide a negative start position, which translates to the most recent number of bytes written to the serial port. For example, -3 is interpreted as the most recent 3 bytes written to the serial console. - zone (::String) — The name of the zone for this request.
- (result, response) — Access the result along with the Faraday response object
- result (::Google::Cloud::Compute::V1::SerialPortOutput)
- response (::Faraday::Response)
- (::Google::Cloud::Error) — if the REST call is aborted.
#get_shielded_instance_identity
def get_shielded_instance_identity(request, options = nil) -> ::Google::Cloud::Compute::V1::ShieldedInstanceIdentity
def get_shielded_instance_identity(instance: nil, project: nil, zone: nil) -> ::Google::Cloud::Compute::V1::ShieldedInstanceIdentity
Returns the Shielded Instance Identity of an instance
def get_shielded_instance_identity(request, options = nil) -> ::Google::Cloud::Compute::V1::ShieldedInstanceIdentity
get_shielded_instance_identity
via a request object, either of type
GetShieldedInstanceIdentityInstanceRequest or an equivalent Hash.
- request (::Google::Cloud::Compute::V1::GetShieldedInstanceIdentityInstanceRequest, ::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. Note: currently retry functionality is not implemented. While it is possible to set it using ::Gapic::CallOptions, it will not be applied
def get_shielded_instance_identity(instance: nil, project: nil, zone: nil) -> ::Google::Cloud::Compute::V1::ShieldedInstanceIdentity
get_shielded_instance_identity
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).
- instance (::String) — Name or id of the instance scoping this request.
- project (::String) — Project ID for this request.
- zone (::String) — The name of the zone for this request.
- (result, response) — Access the result along with the Faraday response object
- result (::Google::Cloud::Compute::V1::ShieldedInstanceIdentity)
- response (::Faraday::Response)
- (::Google::Cloud::Error) — if the REST call is aborted.
#initialize
def initialize() { |config| ... } -> Client
Create a new Instances REST client object.
- (config) — Configure the Instances client.
- config (Client::Configuration)
- (Client) — a new instance of Client
# Create a client using the default configuration client = ::Google::Cloud::Compute::V1::Instances::Rest::Client.new # Create a client using a custom configuration client = ::Google::Cloud::Compute::V1::Instances::Rest::Client.new do |config| config.timeout = 10.0 end
#insert
def insert(request, options = nil) -> ::Gapic::GenericLRO::Operation
def insert(instance_resource: nil, project: nil, request_id: nil, source_instance_template: nil, source_machine_image: nil, zone: nil) -> ::Gapic::GenericLRO::Operation
Creates an instance resource in the specified project using the data included in the request.
def insert(request, options = nil) -> ::Gapic::GenericLRO::Operation
insert
via a request object, either of type
Google::Cloud::Compute::V1::InsertInstanceRequest or an equivalent Hash.
- request (::Google::Cloud::Compute::V1::InsertInstanceRequest, ::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. Note: currently retry functionality is not implemented. While it is possible to set it using ::Gapic::CallOptions, it will not be applied
def insert(instance_resource: nil, project: nil, request_id: nil, source_instance_template: nil, source_machine_image: nil, zone: nil) -> ::Gapic::GenericLRO::Operation
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).
- instance_resource (::Google::Cloud::Compute::V1::Instance, ::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_instance_template (::String) — Specifies instance template to create the instance. This field is optional. It can be a full or partial URL. For example, the following are all valid URLs to an instance template: - https://www.googleapis.com/compute/v1/projects/project /global/instanceTemplates/instanceTemplate - projects/project/global/instanceTemplates/instanceTemplate - global/instanceTemplates/instanceTemplate
- source_machine_image (::String) — Specifies the machine image to use to create the instance. This field is optional. It can be a full or partial URL. For example, the following are all valid URLs to a machine image: - https://www.googleapis.com/compute/v1/projects/project/global/global /machineImages/machineImage - projects/project/global/global/machineImages/machineImage - global/machineImages/machineImage
- zone (::String) — The name of the zone for this request.
- (result, response) — Access the result along with the Faraday response object
- result (::Gapic::GenericLRO::Operation)
- response (::Faraday::Response)
- (::Gapic::GenericLRO::Operation)
- (::Google::Cloud::Error) — if the REST call is aborted.
#list
def list(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Compute::V1::Instance>
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::Instance>
Retrieves the list of instances contained within the specified zone.
def list(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Compute::V1::Instance>
list
via a request object, either of type
ListInstancesRequest or an equivalent Hash.
- request (::Google::Cloud::Compute::V1::ListInstancesRequest, ::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. Note: currently retry functionality is not implemented. While it is possible to set it using ::Gapic::CallOptions, it will not be applied
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::Instance>
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).
-
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 namedexample-instance
by specifyingname != 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 withowner
label use:labels.owner:*
You can also filter nested fields. For example, you could specifyscheduling.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 anAND
expression. However, you can includeAND
andOR
expressions explicitly. For example:(cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true)
If you want to use a regular expression, use theeq
(equal) orne
(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 usename 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 anextPageToken
that can be used to get the next page of results in subsequent list requests. Acceptable values are0
to500
, 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 thecreationTimestamp
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 byname
orcreationTimestamp desc
is supported. -
page_token (::String) — Specifies a page token to use. Set
pageToken
to thenextPageToken
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.
- (result, response) — Access the result along with the Faraday response object
- result (::Gapic::Rest::PagedEnumerable<::Google::Cloud::Compute::V1::Instance>)
- response (::Faraday::Response)
- (::Gapic::Rest::PagedEnumerable<::Google::Cloud::Compute::V1::Instance>)
- (::Google::Cloud::Error) — if the REST call is aborted.
#list_referrers
def list_referrers(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Compute::V1::Reference>
def list_referrers(filter: nil, instance: 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::Reference>
Retrieves a list of resources that refer to the VM instance specified in the request. For example, if the VM instance is part of a managed or unmanaged instance group, the referrers list includes the instance group. For more information, read Viewing referrers to VM instances.
def list_referrers(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Compute::V1::Reference>
list_referrers
via a request object, either of type
ListReferrersInstancesRequest or an equivalent Hash.
- request (::Google::Cloud::Compute::V1::ListReferrersInstancesRequest, ::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. Note: currently retry functionality is not implemented. While it is possible to set it using ::Gapic::CallOptions, it will not be applied
def list_referrers(filter: nil, instance: 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::Reference>
list_referrers
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).
-
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 namedexample-instance
by specifyingname != 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 withowner
label use:labels.owner:*
You can also filter nested fields. For example, you could specifyscheduling.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 anAND
expression. However, you can includeAND
andOR
expressions explicitly. For example:(cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true)
If you want to use a regular expression, use theeq
(equal) orne
(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 usename ne .*instance
. - instance (::String) — Name of the target instance scoping this request, or '-' if the request should span over all instances in the container.
-
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 anextPageToken
that can be used to get the next page of results in subsequent list requests. Acceptable values are0
to500
, 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 thecreationTimestamp
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 byname
orcreationTimestamp desc
is supported. -
page_token (::String) — Specifies a page token to use. Set
pageToken
to thenextPageToken
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.
- (result, response) — Access the result along with the Faraday response object
- result (::Gapic::Rest::PagedEnumerable<::Google::Cloud::Compute::V1::Reference>)
- response (::Faraday::Response)
- (::Gapic::Rest::PagedEnumerable<::Google::Cloud::Compute::V1::Reference>)
- (::Google::Cloud::Error) — if the REST call is aborted.
#remove_resource_policies
def remove_resource_policies(request, options = nil) -> ::Gapic::GenericLRO::Operation
def remove_resource_policies(instance: nil, instances_remove_resource_policies_request_resource: nil, project: nil, request_id: nil, zone: nil) -> ::Gapic::GenericLRO::Operation
Removes resource policies from an instance.
def remove_resource_policies(request, options = nil) -> ::Gapic::GenericLRO::Operation
remove_resource_policies
via a request object, either of type
RemoveResourcePoliciesInstanceRequest or an equivalent Hash.
- request (::Google::Cloud::Compute::V1::RemoveResourcePoliciesInstanceRequest, ::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. Note: currently retry functionality is not implemented. While it is possible to set it using ::Gapic::CallOptions, it will not be applied
def remove_resource_policies(instance: nil, instances_remove_resource_policies_request_resource: nil, project: nil, request_id: nil, zone: nil) -> ::Gapic::GenericLRO::Operation
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).
- instance (::String) — The instance name for this request.
- instances_remove_resource_policies_request_resource (::Google::Cloud::Compute::V1::InstancesRemoveResourcePoliciesRequest, ::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.
- (result, response) — Access the result along with the Faraday response object
- result (::Gapic::GenericLRO::Operation)
- response (::Faraday::Response)
- (::Gapic::GenericLRO::Operation)
- (::Google::Cloud::Error) — if the REST call is aborted.
#reset
def reset(request, options = nil) -> ::Gapic::GenericLRO::Operation
def reset(instance: nil, project: nil, request_id: nil, zone: nil) -> ::Gapic::GenericLRO::Operation
Performs a reset on the instance. This is a hard reset. The VM does not do a graceful shutdown. For more information, see Resetting an instance.
def reset(request, options = nil) -> ::Gapic::GenericLRO::Operation
reset
via a request object, either of type
ResetInstanceRequest or an equivalent Hash.
- request (::Google::Cloud::Compute::V1::ResetInstanceRequest, ::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. Note: currently retry functionality is not implemented. While it is possible to set it using ::Gapic::CallOptions, it will not be applied
def reset(instance: nil, project: nil, request_id: nil, zone: nil) -> ::Gapic::GenericLRO::Operation
reset
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).
- instance (::String) — Name of the instance scoping 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.
- (result, response) — Access the result along with the Faraday response object
- result (::Gapic::GenericLRO::Operation)
- response (::Faraday::Response)
- (::Gapic::GenericLRO::Operation)
- (::Google::Cloud::Error) — if the REST call is aborted.
#resume
def resume(request, options = nil) -> ::Gapic::GenericLRO::Operation
def resume(instance: nil, project: nil, request_id: nil, zone: nil) -> ::Gapic::GenericLRO::Operation
Resumes an instance that was suspended using the instances().suspend method.
def resume(request, options = nil) -> ::Gapic::GenericLRO::Operation
resume
via a request object, either of type
ResumeInstanceRequest or an equivalent Hash.
- request (::Google::Cloud::Compute::V1::ResumeInstanceRequest, ::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. Note: currently retry functionality is not implemented. While it is possible to set it using ::Gapic::CallOptions, it will not be applied
def resume(instance: nil, project: nil, request_id: nil, zone: nil) -> ::Gapic::GenericLRO::Operation
resume
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).
- instance (::String) — Name of the instance resource to resume.
- 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.
- (result, response) — Access the result along with the Faraday response object
- result (::Gapic::GenericLRO::Operation)
- response (::Faraday::Response)
- (::Gapic::GenericLRO::Operation)
- (::Google::Cloud::Error) — if the REST call is aborted.
#send_diagnostic_interrupt
def send_diagnostic_interrupt(request, options = nil) -> ::Google::Cloud::Compute::V1::SendDiagnosticInterruptInstanceResponse
def send_diagnostic_interrupt(instance: nil, project: nil, zone: nil) -> ::Google::Cloud::Compute::V1::SendDiagnosticInterruptInstanceResponse
Sends diagnostic interrupt to the instance.
def send_diagnostic_interrupt(request, options = nil) -> ::Google::Cloud::Compute::V1::SendDiagnosticInterruptInstanceResponse
send_diagnostic_interrupt
via a request object, either of type
SendDiagnosticInterruptInstanceRequest or an equivalent Hash.
- request (::Google::Cloud::Compute::V1::SendDiagnosticInterruptInstanceRequest, ::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. Note: currently retry functionality is not implemented. While it is possible to set it using ::Gapic::CallOptions, it will not be applied
def send_diagnostic_interrupt(instance: nil, project: nil, zone: nil) -> ::Google::Cloud::Compute::V1::SendDiagnosticInterruptInstanceResponse
send_diagnostic_interrupt
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).
- instance (::String) — Name of the instance scoping this request.
- project (::String) — Project ID for this request.
- zone (::String) — The name of the zone for this request.
- (result, response) — Access the result along with the Faraday response object
- result (::Google::Cloud::Compute::V1::SendDiagnosticInterruptInstanceResponse)
- response (::Faraday::Response)
- (::Google::Cloud::Error) — if the REST call is aborted.
#set_deletion_protection
def set_deletion_protection(request, options = nil) -> ::Gapic::GenericLRO::Operation
def set_deletion_protection(deletion_protection: nil, project: nil, request_id: nil, resource: nil, zone: nil) -> ::Gapic::GenericLRO::Operation
Sets deletion protection on the instance.
def set_deletion_protection(request, options = nil) -> ::Gapic::GenericLRO::Operation
set_deletion_protection
via a request object, either of type
SetDeletionProtectionInstanceRequest or an equivalent Hash.
- request (::Google::Cloud::Compute::V1::SetDeletionProtectionInstanceRequest, ::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. Note: currently retry functionality is not implemented. While it is possible to set it using ::Gapic::CallOptions, it will not be applied
def set_deletion_protection(deletion_protection: nil, project: nil, request_id: nil, resource: nil, zone: nil) -> ::Gapic::GenericLRO::Operation
set_deletion_protection
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).
- deletion_protection (::Boolean) — Whether the resource should be protected against deletion.
- 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.
- (result, response) — Access the result along with the Faraday response object
- result (::Gapic::GenericLRO::Operation)
- response (::Faraday::Response)
- (::Gapic::GenericLRO::Operation)
- (::Google::Cloud::Error) — if the REST call is aborted.
#set_disk_auto_delete
def set_disk_auto_delete(request, options = nil) -> ::Gapic::GenericLRO::Operation
def set_disk_auto_delete(auto_delete: nil, device_name: nil, instance: nil, project: nil, request_id: nil, zone: nil) -> ::Gapic::GenericLRO::Operation
Sets the auto-delete flag for a disk attached to an instance.
def set_disk_auto_delete(request, options = nil) -> ::Gapic::GenericLRO::Operation
set_disk_auto_delete
via a request object, either of type
SetDiskAutoDeleteInstanceRequest or an equivalent Hash.
- request (::Google::Cloud::Compute::V1::SetDiskAutoDeleteInstanceRequest, ::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. Note: currently retry functionality is not implemented. While it is possible to set it using ::Gapic::CallOptions, it will not be applied
def set_disk_auto_delete(auto_delete: nil, device_name: nil, instance: nil, project: nil, request_id: nil, zone: nil) -> ::Gapic::GenericLRO::Operation
set_disk_auto_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).
- auto_delete (::Boolean) — Whether to auto-delete the disk when the instance is deleted.
- device_name (::String) — The device name of the disk to modify. Make a get() request on the instance to view currently attached disks and device names.
- instance (::String) — The instance name 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.
- (result, response) — Access the result along with the Faraday response object
- result (::Gapic::GenericLRO::Operation)
- response (::Faraday::Response)
- (::Gapic::GenericLRO::Operation)
- (::Google::Cloud::Error) — if the REST call is aborted.
#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.
def set_iam_policy(request, options = nil) -> ::Google::Cloud::Compute::V1::Policy
set_iam_policy
via a request object, either of type
SetIamPolicyInstanceRequest or an equivalent Hash.
- request (::Google::Cloud::Compute::V1::SetIamPolicyInstanceRequest, ::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. Note: currently retry functionality is not implemented. While it is possible to set it using ::Gapic::CallOptions, it will not be applied
def set_iam_policy(project: nil, resource: nil, zone: nil, zone_set_policy_request_resource: nil) -> ::Google::Cloud::Compute::V1::Policy
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).
- 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
- (result, response) — Access the result along with the Faraday response object
- result (::Google::Cloud::Compute::V1::Policy)
- response (::Faraday::Response)
- (::Google::Cloud::Error) — if the REST call is aborted.
#set_labels
def set_labels(request, options = nil) -> ::Gapic::GenericLRO::Operation
def set_labels(instance: nil, instances_set_labels_request_resource: nil, project: nil, request_id: nil, zone: nil) -> ::Gapic::GenericLRO::Operation
Sets labels on an instance. To learn more about labels, read the Labeling Resources documentation.
def set_labels(request, options = nil) -> ::Gapic::GenericLRO::Operation
set_labels
via a request object, either of type
SetLabelsInstanceRequest or an equivalent Hash.
- request (::Google::Cloud::Compute::V1::SetLabelsInstanceRequest, ::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. Note: currently retry functionality is not implemented. While it is possible to set it using ::Gapic::CallOptions, it will not be applied
def set_labels(instance: nil, instances_set_labels_request_resource: nil, project: nil, request_id: nil, zone: nil) -> ::Gapic::GenericLRO::Operation
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).
- instance (::String) — Name of the instance scoping this request.
- instances_set_labels_request_resource (::Google::Cloud::Compute::V1::InstancesSetLabelsRequest, ::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.
- (result, response) — Access the result along with the Faraday response object
- result (::Gapic::GenericLRO::Operation)
- response (::Faraday::Response)
- (::Gapic::GenericLRO::Operation)
- (::Google::Cloud::Error) — if the REST call is aborted.
#set_machine_resources
def set_machine_resources(request, options = nil) -> ::Gapic::GenericLRO::Operation
def set_machine_resources(instance: nil, instances_set_machine_resources_request_resource: nil, project: nil, request_id: nil, zone: nil) -> ::Gapic::GenericLRO::Operation
Changes the number and/or type of accelerator for a stopped instance to the values specified in the request.
def set_machine_resources(request, options = nil) -> ::Gapic::GenericLRO::Operation
set_machine_resources
via a request object, either of type
SetMachineResourcesInstanceRequest or an equivalent Hash.
- request (::Google::Cloud::Compute::V1::SetMachineResourcesInstanceRequest, ::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. Note: currently retry functionality is not implemented. While it is possible to set it using ::Gapic::CallOptions, it will not be applied
def set_machine_resources(instance: nil, instances_set_machine_resources_request_resource: nil, project: nil, request_id: nil, zone: nil) -> ::Gapic::GenericLRO::Operation
set_machine_resources
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).
- instance (::String) — Name of the instance scoping this request.
- instances_set_machine_resources_request_resource (::Google::Cloud::Compute::V1::InstancesSetMachineResourcesRequest, ::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.
- (result, response) — Access the result along with the Faraday response object
- result (::Gapic::GenericLRO::Operation)
- response (::Faraday::Response)
- (::Gapic::GenericLRO::Operation)
- (::Google::Cloud::Error) — if the REST call is aborted.
#set_machine_type
def set_machine_type(request, options = nil) -> ::Gapic::GenericLRO::Operation
def set_machine_type(instance: nil, instances_set_machine_type_request_resource: nil, project: nil, request_id: nil, zone: nil) -> ::Gapic::GenericLRO::Operation
Changes the machine type for a stopped instance to the machine type specified in the request.
def set_machine_type(request, options = nil) -> ::Gapic::GenericLRO::Operation
set_machine_type
via a request object, either of type
SetMachineTypeInstanceRequest or an equivalent Hash.
- request (::Google::Cloud::Compute::V1::SetMachineTypeInstanceRequest, ::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. Note: currently retry functionality is not implemented. While it is possible to set it using ::Gapic::CallOptions, it will not be applied
def set_machine_type(instance: nil, instances_set_machine_type_request_resource: nil, project: nil, request_id: nil, zone: nil) -> ::Gapic::GenericLRO::Operation
set_machine_type
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).
- instance (::String) — Name of the instance scoping this request.
- instances_set_machine_type_request_resource (::Google::Cloud::Compute::V1::InstancesSetMachineTypeRequest, ::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.
- (result, response) — Access the result along with the Faraday response object
- result (::Gapic::GenericLRO::Operation)
- response (::Faraday::Response)
- (::Gapic::GenericLRO::Operation)
- (::Google::Cloud::Error) — if the REST call is aborted.
#set_metadata
def set_metadata(request, options = nil) -> ::Gapic::GenericLRO::Operation
def set_metadata(instance: nil, metadata_resource: nil, project: nil, request_id: nil, zone: nil) -> ::Gapic::GenericLRO::Operation
Sets metadata for the specified instance to the data included in the request.
def set_metadata(request, options = nil) -> ::Gapic::GenericLRO::Operation
set_metadata
via a request object, either of type
SetMetadataInstanceRequest or an equivalent Hash.
- request (::Google::Cloud::Compute::V1::SetMetadataInstanceRequest, ::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. Note: currently retry functionality is not implemented. While it is possible to set it using ::Gapic::CallOptions, it will not be applied
def set_metadata(instance: nil, metadata_resource: nil, project: nil, request_id: nil, zone: nil) -> ::Gapic::GenericLRO::Operation
set_metadata
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).
- instance (::String) — Name of the instance scoping this request.
- metadata_resource (::Google::Cloud::Compute::V1::Metadata, ::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.
- (result, response) — Access the result along with the Faraday response object
- result (::Gapic::GenericLRO::Operation)
- response (::Faraday::Response)
- (::Gapic::GenericLRO::Operation)
- (::Google::Cloud::Error) — if the REST call is aborted.
#set_min_cpu_platform
def set_min_cpu_platform(request, options = nil) -> ::Gapic::GenericLRO::Operation
def set_min_cpu_platform(instance: nil, instances_set_min_cpu_platform_request_resource: nil, project: nil, request_id: nil, zone: nil) -> ::Gapic::GenericLRO::Operation
Changes the minimum CPU platform that this instance should use. This method can only be called on a stopped instance. For more information, read Specifying a Minimum CPU Platform.
def set_min_cpu_platform(request, options = nil) -> ::Gapic::GenericLRO::Operation
set_min_cpu_platform
via a request object, either of type
SetMinCpuPlatformInstanceRequest or an equivalent Hash.
- request (::Google::Cloud::Compute::V1::SetMinCpuPlatformInstanceRequest, ::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. Note: currently retry functionality is not implemented. While it is possible to set it using ::Gapic::CallOptions, it will not be applied
def set_min_cpu_platform(instance: nil, instances_set_min_cpu_platform_request_resource: nil, project: nil, request_id: nil, zone: nil) -> ::Gapic::GenericLRO::Operation
set_min_cpu_platform
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).
- instance (::String) — Name of the instance scoping this request.
- instances_set_min_cpu_platform_request_resource (::Google::Cloud::Compute::V1::InstancesSetMinCpuPlatformRequest, ::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.
- (result, response) — Access the result along with the Faraday response object
- result (::Gapic::GenericLRO::Operation)
- response (::Faraday::Response)
- (::Gapic::GenericLRO::Operation)
- (::Google::Cloud::Error) — if the REST call is aborted.
#set_scheduling
def set_scheduling(request, options = nil) -> ::Gapic::GenericLRO::Operation
def set_scheduling(instance: nil, project: nil, request_id: nil, scheduling_resource: nil, zone: nil) -> ::Gapic::GenericLRO::Operation
Sets an instance's scheduling options. You can only call this method on a stopped instance, that is, a VM instance that is in a TERMINATED
state. See Instance Life Cycle for more information on the possible instance states. For more information about setting scheduling options for a VM, see Set VM host maintenance policy.
def set_scheduling(request, options = nil) -> ::Gapic::GenericLRO::Operation
set_scheduling
via a request object, either of type
SetSchedulingInstanceRequest or an equivalent Hash.
- request (::Google::Cloud::Compute::V1::SetSchedulingInstanceRequest, ::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. Note: currently retry functionality is not implemented. While it is possible to set it using ::Gapic::CallOptions, it will not be applied
def set_scheduling(instance: nil, project: nil, request_id: nil, scheduling_resource: nil, zone: nil) -> ::Gapic::GenericLRO::Operation
set_scheduling
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).
- instance (::String) — Instance name 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).
- scheduling_resource (::Google::Cloud::Compute::V1::Scheduling, ::Hash) — The body resource for this request
- zone (::String) — The name of the zone for this request.
- (result, response) — Access the result along with the Faraday response object
- result (::Gapic::GenericLRO::Operation)
- response (::Faraday::Response)
- (::Gapic::GenericLRO::Operation)
- (::Google::Cloud::Error) — if the REST call is aborted.
#set_service_account
def set_service_account(request, options = nil) -> ::Gapic::GenericLRO::Operation
def set_service_account(instance: nil, instances_set_service_account_request_resource: nil, project: nil, request_id: nil, zone: nil) -> ::Gapic::GenericLRO::Operation
Sets the service account on the instance. For more information, read Changing the service account and access scopes for an instance.
def set_service_account(request, options = nil) -> ::Gapic::GenericLRO::Operation
set_service_account
via a request object, either of type
SetServiceAccountInstanceRequest or an equivalent Hash.
- request (::Google::Cloud::Compute::V1::SetServiceAccountInstanceRequest, ::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. Note: currently retry functionality is not implemented. While it is possible to set it using ::Gapic::CallOptions, it will not be applied
def set_service_account(instance: nil, instances_set_service_account_request_resource: nil, project: nil, request_id: nil, zone: nil) -> ::Gapic::GenericLRO::Operation
set_service_account
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).
- instance (::String) — Name of the instance resource to start.
- instances_set_service_account_request_resource (::Google::Cloud::Compute::V1::InstancesSetServiceAccountRequest, ::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.
- (result, response) — Access the result along with the Faraday response object
- result (::Gapic::GenericLRO::Operation)
- response (::Faraday::Response)
- (::Gapic::GenericLRO::Operation)
- (::Google::Cloud::Error) — if the REST call is aborted.
#set_shielded_instance_integrity_policy
def set_shielded_instance_integrity_policy(request, options = nil) -> ::Gapic::GenericLRO::Operation
def set_shielded_instance_integrity_policy(instance: nil, project: nil, request_id: nil, shielded_instance_integrity_policy_resource: nil, zone: nil) -> ::Gapic::GenericLRO::Operation
Sets the Shielded Instance integrity policy for an instance. You can only use this method on a running instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.
def set_shielded_instance_integrity_policy(request, options = nil) -> ::Gapic::GenericLRO::Operation
set_shielded_instance_integrity_policy
via a request object, either of type
SetShieldedInstanceIntegrityPolicyInstanceRequest or an equivalent Hash.
- request (::Google::Cloud::Compute::V1::SetShieldedInstanceIntegrityPolicyInstanceRequest, ::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. Note: currently retry functionality is not implemented. While it is possible to set it using ::Gapic::CallOptions, it will not be applied
def set_shielded_instance_integrity_policy(instance: nil, project: nil, request_id: nil, shielded_instance_integrity_policy_resource: nil, zone: nil) -> ::Gapic::GenericLRO::Operation
set_shielded_instance_integrity_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).
- instance (::String) — Name or id of the instance scoping 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).
- shielded_instance_integrity_policy_resource (::Google::Cloud::Compute::V1::ShieldedInstanceIntegrityPolicy, ::Hash) — The body resource for this request
- zone (::String) — The name of the zone for this request.
- (result, response) — Access the result along with the Faraday response object
- result (::Gapic::GenericLRO::Operation)
- response (::Faraday::Response)
- (::Gapic::GenericLRO::Operation)
- (::Google::Cloud::Error) — if the REST call is aborted.
#set_tags
def set_tags(request, options = nil) -> ::Gapic::GenericLRO::Operation
def set_tags(instance: nil, project: nil, request_id: nil, tags_resource: nil, zone: nil) -> ::Gapic::GenericLRO::Operation
Sets network tags for the specified instance to the data included in the request.
def set_tags(request, options = nil) -> ::Gapic::GenericLRO::Operation
set_tags
via a request object, either of type
SetTagsInstanceRequest or an equivalent Hash.
- request (::Google::Cloud::Compute::V1::SetTagsInstanceRequest, ::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. Note: currently retry functionality is not implemented. While it is possible to set it using ::Gapic::CallOptions, it will not be applied
def set_tags(instance: nil, project: nil, request_id: nil, tags_resource: nil, zone: nil) -> ::Gapic::GenericLRO::Operation
set_tags
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).
- instance (::String) — Name of the instance scoping 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).
- tags_resource (::Google::Cloud::Compute::V1::Tags, ::Hash) — The body resource for this request
- zone (::String) — The name of the zone for this request.
- (result, response) — Access the result along with the Faraday response object
- result (::Gapic::GenericLRO::Operation)
- response (::Faraday::Response)
- (::Gapic::GenericLRO::Operation)
- (::Google::Cloud::Error) — if the REST call is aborted.
#simulate_maintenance_event
def simulate_maintenance_event(request, options = nil) -> ::Gapic::GenericLRO::Operation
def simulate_maintenance_event(instance: nil, project: nil, zone: nil) -> ::Gapic::GenericLRO::Operation
Simulates a host maintenance event on a VM. For more information, see Simulate a host maintenance event.
def simulate_maintenance_event(request, options = nil) -> ::Gapic::GenericLRO::Operation
simulate_maintenance_event
via a request object, either of type
SimulateMaintenanceEventInstanceRequest or an equivalent Hash.
- request (::Google::Cloud::Compute::V1::SimulateMaintenanceEventInstanceRequest, ::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. Note: currently retry functionality is not implemented. While it is possible to set it using ::Gapic::CallOptions, it will not be applied
def simulate_maintenance_event(instance: nil, project: nil, zone: nil) -> ::Gapic::GenericLRO::Operation
simulate_maintenance_event
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).
- instance (::String) — Name of the instance scoping this request.
- project (::String) — Project ID for this request.
- zone (::String) — The name of the zone for this request.
- (result, response) — Access the result along with the Faraday response object
- result (::Gapic::GenericLRO::Operation)
- response (::Faraday::Response)
- (::Gapic::GenericLRO::Operation)
- (::Google::Cloud::Error) — if the REST call is aborted.
#start
def start(request, options = nil) -> ::Gapic::GenericLRO::Operation
def start(instance: nil, project: nil, request_id: nil, zone: nil) -> ::Gapic::GenericLRO::Operation
Starts an instance that was stopped using the instances().stop method. For more information, see Restart an instance.
def start(request, options = nil) -> ::Gapic::GenericLRO::Operation
start
via a request object, either of type
StartInstanceRequest or an equivalent Hash.
- request (::Google::Cloud::Compute::V1::StartInstanceRequest, ::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. Note: currently retry functionality is not implemented. While it is possible to set it using ::Gapic::CallOptions, it will not be applied
def start(instance: nil, project: nil, request_id: nil, zone: nil) -> ::Gapic::GenericLRO::Operation
start
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).
- instance (::String) — Name of the instance resource to start.
- 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.
- (result, response) — Access the result along with the Faraday response object
- result (::Gapic::GenericLRO::Operation)
- response (::Faraday::Response)
- (::Gapic::GenericLRO::Operation)
- (::Google::Cloud::Error) — if the REST call is aborted.
#start_with_encryption_key
def start_with_encryption_key(request, options = nil) -> ::Gapic::GenericLRO::Operation
def start_with_encryption_key(instance: nil, instances_start_with_encryption_key_request_resource: nil, project: nil, request_id: nil, zone: nil) -> ::Gapic::GenericLRO::Operation
Starts an instance that was stopped using the instances().stop method. For more information, see Restart an instance.
def start_with_encryption_key(request, options = nil) -> ::Gapic::GenericLRO::Operation
start_with_encryption_key
via a request object, either of type
StartWithEncryptionKeyInstanceRequest or an equivalent Hash.
- request (::Google::Cloud::Compute::V1::StartWithEncryptionKeyInstanceRequest, ::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. Note: currently retry functionality is not implemented. While it is possible to set it using ::Gapic::CallOptions, it will not be applied
def start_with_encryption_key(instance: nil, instances_start_with_encryption_key_request_resource: nil, project: nil, request_id: nil, zone: nil) -> ::Gapic::GenericLRO::Operation
start_with_encryption_key
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).
- instance (::String) — Name of the instance resource to start.
- instances_start_with_encryption_key_request_resource (::Google::Cloud::Compute::V1::InstancesStartWithEncryptionKeyRequest, ::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.
- (result, response) — Access the result along with the Faraday response object
- result (::Gapic::GenericLRO::Operation)
- response (::Faraday::Response)
- (::Gapic::GenericLRO::Operation)
- (::Google::Cloud::Error) — if the REST call is aborted.
#stop
def stop(request, options = nil) -> ::Gapic::GenericLRO::Operation
def stop(instance: nil, project: nil, request_id: nil, zone: nil) -> ::Gapic::GenericLRO::Operation
Stops a running instance, shutting it down cleanly, and allows you to restart the instance at a later time. Stopped instances do not incur VM usage charges while they are stopped. However, resources that the VM is using, such as persistent disks and static IP addresses, will continue to be charged until they are deleted. For more information, see Stopping an instance.
def stop(request, options = nil) -> ::Gapic::GenericLRO::Operation
stop
via a request object, either of type
StopInstanceRequest or an equivalent Hash.
- request (::Google::Cloud::Compute::V1::StopInstanceRequest, ::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. Note: currently retry functionality is not implemented. While it is possible to set it using ::Gapic::CallOptions, it will not be applied
def stop(instance: nil, project: nil, request_id: nil, zone: nil) -> ::Gapic::GenericLRO::Operation
stop
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).
- instance (::String) — Name of the instance resource to stop.
- 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.
- (result, response) — Access the result along with the Faraday response object
- result (::Gapic::GenericLRO::Operation)
- response (::Faraday::Response)
- (::Gapic::GenericLRO::Operation)
- (::Google::Cloud::Error) — if the REST call is aborted.
#suspend
def suspend(request, options = nil) -> ::Gapic::GenericLRO::Operation
def suspend(instance: nil, project: nil, request_id: nil, zone: nil) -> ::Gapic::GenericLRO::Operation
This method suspends a running instance, saving its state to persistent storage, and allows you to resume the instance at a later time. Suspended instances have no compute costs (cores or RAM), and incur only storage charges for the saved VM memory and localSSD data. Any charged resources the virtual machine was using, such as persistent disks and static IP addresses, will continue to be charged while the instance is suspended. For more information, see Suspending and resuming an instance.
def suspend(request, options = nil) -> ::Gapic::GenericLRO::Operation
suspend
via a request object, either of type
SuspendInstanceRequest or an equivalent Hash.
- request (::Google::Cloud::Compute::V1::SuspendInstanceRequest, ::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. Note: currently retry functionality is not implemented. While it is possible to set it using ::Gapic::CallOptions, it will not be applied
def suspend(instance: nil, project: nil, request_id: nil, zone: nil) -> ::Gapic::GenericLRO::Operation
suspend
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).
- instance (::String) — Name of the instance resource to suspend.
- 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.
- (result, response) — Access the result along with the Faraday response object
- result (::Gapic::GenericLRO::Operation)
- response (::Faraday::Response)
- (::Gapic::GenericLRO::Operation)
- (::Google::Cloud::Error) — if the REST call is aborted.
#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.
def test_iam_permissions(request, options = nil) -> ::Google::Cloud::Compute::V1::TestPermissionsResponse
test_iam_permissions
via a request object, either of type
TestIamPermissionsInstanceRequest or an equivalent Hash.
- request (::Google::Cloud::Compute::V1::TestIamPermissionsInstanceRequest, ::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. Note: currently retry functionality is not implemented. While it is possible to set it using ::Gapic::CallOptions, it will not be applied
def test_iam_permissions(project: nil, resource: nil, test_permissions_request_resource: nil, zone: nil) -> ::Google::Cloud::Compute::V1::TestPermissionsResponse
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).
- 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.
- (result, response) — Access the result along with the Faraday response object
- result (::Google::Cloud::Compute::V1::TestPermissionsResponse)
- response (::Faraday::Response)
- (::Google::Cloud::Error) — if the REST call is aborted.
#update
def update(request, options = nil) -> ::Gapic::GenericLRO::Operation
def update(instance: nil, instance_resource: nil, minimal_action: nil, most_disruptive_allowed_action: nil, project: nil, request_id: nil, zone: nil) -> ::Gapic::GenericLRO::Operation
Updates an instance only if the necessary resources are available. This method can update only a specific set of instance properties. See Updating a running instance for a list of updatable instance properties.
def update(request, options = nil) -> ::Gapic::GenericLRO::Operation
update
via a request object, either of type
UpdateInstanceRequest or an equivalent Hash.
- request (::Google::Cloud::Compute::V1::UpdateInstanceRequest, ::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. Note: currently retry functionality is not implemented. While it is possible to set it using ::Gapic::CallOptions, it will not be applied
def update(instance: nil, instance_resource: nil, minimal_action: nil, most_disruptive_allowed_action: nil, project: nil, request_id: nil, zone: nil) -> ::Gapic::GenericLRO::Operation
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).
- instance (::String) — Name of the instance resource to update.
- instance_resource (::Google::Cloud::Compute::V1::Instance, ::Hash) — The body resource for this request
- minimal_action (::String) — Specifies the action to take when updating an instance even if the updated properties do not require it. If not specified, then Compute Engine acts based on the minimum action that the updated properties require. Check the MinimalAction enum for the list of possible values.
- most_disruptive_allowed_action (::String) — Specifies the most disruptive action that can be taken on the instance as part of the update. Compute Engine returns an error if the instance properties require a more disruptive action as part of the instance update. Valid options from lowest to highest are NO_EFFECT, REFRESH, and RESTART. Check the MostDisruptiveAllowedAction enum for the list of possible values.
- 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.
- (result, response) — Access the result along with the Faraday response object
- result (::Gapic::GenericLRO::Operation)
- response (::Faraday::Response)
- (::Gapic::GenericLRO::Operation)
- (::Google::Cloud::Error) — if the REST call is aborted.
#update_access_config
def update_access_config(request, options = nil) -> ::Gapic::GenericLRO::Operation
def update_access_config(access_config_resource: nil, instance: nil, network_interface: nil, project: nil, request_id: nil, zone: nil) -> ::Gapic::GenericLRO::Operation
Updates the specified access config from an instance's network interface with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.
def update_access_config(request, options = nil) -> ::Gapic::GenericLRO::Operation
update_access_config
via a request object, either of type
UpdateAccessConfigInstanceRequest or an equivalent Hash.
- request (::Google::Cloud::Compute::V1::UpdateAccessConfigInstanceRequest, ::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. Note: currently retry functionality is not implemented. While it is possible to set it using ::Gapic::CallOptions, it will not be applied
def update_access_config(access_config_resource: nil, instance: nil, network_interface: nil, project: nil, request_id: nil, zone: nil) -> ::Gapic::GenericLRO::Operation
update_access_config
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).
- access_config_resource (::Google::Cloud::Compute::V1::AccessConfig, ::Hash) — The body resource for this request
- instance (::String) — The instance name for this request.
- network_interface (::String) — The name of the network interface where the access config is attached.
- 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.
- (result, response) — Access the result along with the Faraday response object
- result (::Gapic::GenericLRO::Operation)
- response (::Faraday::Response)
- (::Gapic::GenericLRO::Operation)
- (::Google::Cloud::Error) — if the REST call is aborted.
#update_display_device
def update_display_device(request, options = nil) -> ::Gapic::GenericLRO::Operation
def update_display_device(display_device_resource: nil, instance: nil, project: nil, request_id: nil, zone: nil) -> ::Gapic::GenericLRO::Operation
Updates the Display config for a VM instance. You can only use this method on a stopped VM instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.
def update_display_device(request, options = nil) -> ::Gapic::GenericLRO::Operation
update_display_device
via a request object, either of type
UpdateDisplayDeviceInstanceRequest or an equivalent Hash.
- request (::Google::Cloud::Compute::V1::UpdateDisplayDeviceInstanceRequest, ::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. Note: currently retry functionality is not implemented. While it is possible to set it using ::Gapic::CallOptions, it will not be applied
def update_display_device(display_device_resource: nil, instance: nil, project: nil, request_id: nil, zone: nil) -> ::Gapic::GenericLRO::Operation
update_display_device
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).
- display_device_resource (::Google::Cloud::Compute::V1::DisplayDevice, ::Hash) — The body resource for this request
- instance (::String) — Name of the instance scoping 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.
- (result, response) — Access the result along with the Faraday response object
- result (::Gapic::GenericLRO::Operation)
- response (::Faraday::Response)
- (::Gapic::GenericLRO::Operation)
- (::Google::Cloud::Error) — if the REST call is aborted.
#update_network_interface
def update_network_interface(request, options = nil) -> ::Gapic::GenericLRO::Operation
def update_network_interface(instance: nil, network_interface: nil, network_interface_resource: nil, project: nil, request_id: nil, zone: nil) -> ::Gapic::GenericLRO::Operation
Updates an instance's network interface. This method can only update an interface's alias IP range and attached network. See Modifying alias IP ranges for an existing instance for instructions on changing alias IP ranges. See Migrating a VM between networks for instructions on migrating an interface. This method follows PATCH semantics.
def update_network_interface(request, options = nil) -> ::Gapic::GenericLRO::Operation
update_network_interface
via a request object, either of type
UpdateNetworkInterfaceInstanceRequest or an equivalent Hash.
- request (::Google::Cloud::Compute::V1::UpdateNetworkInterfaceInstanceRequest, ::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. Note: currently retry functionality is not implemented. While it is possible to set it using ::Gapic::CallOptions, it will not be applied
def update_network_interface(instance: nil, network_interface: nil, network_interface_resource: nil, project: nil, request_id: nil, zone: nil) -> ::Gapic::GenericLRO::Operation
update_network_interface
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).
- instance (::String) — The instance name for this request.
- network_interface (::String) — The name of the network interface to update.
- network_interface_resource (::Google::Cloud::Compute::V1::NetworkInterface, ::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.
- (result, response) — Access the result along with the Faraday response object
- result (::Gapic::GenericLRO::Operation)
- response (::Faraday::Response)
- (::Gapic::GenericLRO::Operation)
- (::Google::Cloud::Error) — if the REST call is aborted.
#update_shielded_instance_config
def update_shielded_instance_config(request, options = nil) -> ::Gapic::GenericLRO::Operation
def update_shielded_instance_config(instance: nil, project: nil, request_id: nil, shielded_instance_config_resource: nil, zone: nil) -> ::Gapic::GenericLRO::Operation
Updates the Shielded Instance config for an instance. You can only use this method on a stopped instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.
def update_shielded_instance_config(request, options = nil) -> ::Gapic::GenericLRO::Operation
update_shielded_instance_config
via a request object, either of type
UpdateShieldedInstanceConfigInstanceRequest or an equivalent Hash.
- request (::Google::Cloud::Compute::V1::UpdateShieldedInstanceConfigInstanceRequest, ::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. Note: currently retry functionality is not implemented. While it is possible to set it using ::Gapic::CallOptions, it will not be applied
def update_shielded_instance_config(instance: nil, project: nil, request_id: nil, shielded_instance_config_resource: nil, zone: nil) -> ::Gapic::GenericLRO::Operation
update_shielded_instance_config
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).
- instance (::String) — Name or id of the instance scoping 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).
- shielded_instance_config_resource (::Google::Cloud::Compute::V1::ShieldedInstanceConfig, ::Hash) — The body resource for this request
- zone (::String) — The name of the zone for this request.
- (result, response) — Access the result along with the Faraday response object
- result (::Gapic::GenericLRO::Operation)
- response (::Faraday::Response)
- (::Gapic::GenericLRO::Operation)
- (::Google::Cloud::Error) — if the REST call is aborted.
#zone_operations
def zone_operations() -> ::Google::Cloud::Compute::V1::ZoneOperations::Rest::Client
Get the associated client for long-running operations via ZoneOperations.