Class: Google::Cloud::Compute::V1::Instances::Rest::Client

Inherits:

Object

Object
Google::Cloud::Compute::V1::Instances::Rest::Client

show all

Defined in:: lib/google/cloud/compute/v1/instances/rest/client.rb

Overview

REST client for the Instances service.

The Instances API.

Defined Under Namespace

Classes: Configuration

Instance Attribute Summary collapse

#zone_operations ⇒ ::Google::Cloud::Compute::V1::ZoneOperations::Rest::Client readonly
Get the associated client for long-running operations via ZoneOperations.

Class Method Summary collapse

.configure {|config| ... } ⇒ Client::Configuration
Configure the Instances Client class.

Instance Method Summary collapse

#add_access_config(request, options = nil) {|result, operation| ... } ⇒ ::Gapic::GenericLRO::Operation
Adds an access config to an instance's network interface.
#add_resource_policies(request, options = nil) {|result, operation| ... } ⇒ ::Gapic::GenericLRO::Operation
Adds existing resource policies to an instance.
#aggregated_list(request, options = nil) {|result, operation| ... } ⇒ ::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.
#attach_disk(request, options = nil) {|result, operation| ... } ⇒ ::Gapic::GenericLRO::Operation
Attaches an existing Disk resource to an instance.
#bulk_insert(request, options = nil) {|result, operation| ... } ⇒ ::Gapic::GenericLRO::Operation
Creates multiple instances.
#configure {|config| ... } ⇒ Client::Configuration
Configure the Instances Client instance.
#delete(request, options = nil) {|result, operation| ... } ⇒ ::Gapic::GenericLRO::Operation
Deletes the specified Instance resource.
#delete_access_config(request, options = nil) {|result, operation| ... } ⇒ ::Gapic::GenericLRO::Operation
Deletes an access config from an instance's network interface.
#detach_disk(request, options = nil) {|result, operation| ... } ⇒ ::Gapic::GenericLRO::Operation
Detaches a disk from an instance.
#get(request, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::Compute::V1::Instance
Returns the specified Instance resource.
#get_effective_firewalls(request, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::Compute::V1::InstancesGetEffectiveFirewallsResponse
Returns effective firewalls applied to an interface of the instance.
#get_guest_attributes(request, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::Compute::V1::GuestAttributes
Returns the specified guest attributes entry.
#get_iam_policy(request, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::Compute::V1::Policy
Gets the access control policy for a resource.
#get_screenshot(request, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::Compute::V1::Screenshot
Returns the screenshot from the specified instance.
#get_serial_port_output(request, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::Compute::V1::SerialPortOutput
Returns the last 1 MB of serial port output from the specified instance.
#get_shielded_instance_identity(request, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::Compute::V1::ShieldedInstanceIdentity
Returns the Shielded Instance Identity of an instance.
#initialize {|config| ... } ⇒ Client constructor
Create a new Instances REST client object.
#insert(request, options = nil) {|result, operation| ... } ⇒ ::Gapic::GenericLRO::Operation
Creates an instance resource in the specified project using the data included in the request.
#list(request, options = nil) {|result, operation| ... } ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Compute::V1::Instance>
Retrieves the list of instances contained within the specified zone.
#list_referrers(request, options = nil) {|result, operation| ... } ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Compute::V1::Reference>
Retrieves a list of resources that refer to the VM instance specified in the request.
#logger ⇒ Logger
The logger used for request/response debug logging.
#perform_maintenance(request, options = nil) {|result, operation| ... } ⇒ ::Gapic::GenericLRO::Operation
Perform a manual maintenance on the instance.
#remove_resource_policies(request, options = nil) {|result, operation| ... } ⇒ ::Gapic::GenericLRO::Operation
Removes resource policies from an instance.
#reset(request, options = nil) {|result, operation| ... } ⇒ ::Gapic::GenericLRO::Operation
Performs a reset on the instance.
#resume(request, options = nil) {|result, operation| ... } ⇒ ::Gapic::GenericLRO::Operation
Resumes an instance that was suspended using the instances().suspend method.
#send_diagnostic_interrupt(request, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::Compute::V1::SendDiagnosticInterruptInstanceResponse
Sends diagnostic interrupt to the instance.
#set_deletion_protection(request, options = nil) {|result, operation| ... } ⇒ ::Gapic::GenericLRO::Operation
Sets deletion protection on the instance.
#set_disk_auto_delete(request, options = nil) {|result, operation| ... } ⇒ ::Gapic::GenericLRO::Operation
Sets the auto-delete flag for a disk attached to an instance.
#set_iam_policy(request, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::Compute::V1::Policy
Sets the access control policy on the specified resource.
#set_labels(request, options = nil) {|result, operation| ... } ⇒ ::Gapic::GenericLRO::Operation
Sets labels on an instance.
#set_machine_resources(request, options = nil) {|result, operation| ... } ⇒ ::Gapic::GenericLRO::Operation
Changes the number and/or type of accelerator for a stopped instance to the values specified in the request.
#set_machine_type(request, options = nil) {|result, operation| ... } ⇒ ::Gapic::GenericLRO::Operation
Changes the machine type for a stopped instance to the machine type specified in the request.
#set_metadata(request, options = nil) {|result, operation| ... } ⇒ ::Gapic::GenericLRO::Operation
Sets metadata for the specified instance to the data included in the request.
#set_min_cpu_platform(request, options = nil) {|result, operation| ... } ⇒ ::Gapic::GenericLRO::Operation
Changes the minimum CPU platform that this instance should use.
#set_name(request, options = nil) {|result, operation| ... } ⇒ ::Gapic::GenericLRO::Operation
Sets name of an instance.
#set_scheduling(request, options = nil) {|result, operation| ... } ⇒ ::Gapic::GenericLRO::Operation
Sets an instance's scheduling options.
#set_security_policy(request, options = nil) {|result, operation| ... } ⇒ ::Gapic::GenericLRO::Operation
Sets the Google Cloud Armor security policy for the specified instance.
#set_service_account(request, options = nil) {|result, operation| ... } ⇒ ::Gapic::GenericLRO::Operation
Sets the service account on the instance.
#set_shielded_instance_integrity_policy(request, options = nil) {|result, operation| ... } ⇒ ::Gapic::GenericLRO::Operation
Sets the Shielded Instance integrity policy for an instance.
#set_tags(request, options = nil) {|result, operation| ... } ⇒ ::Gapic::GenericLRO::Operation
Sets network tags for the specified instance to the data included in the request.
#simulate_maintenance_event(request, options = nil) {|result, operation| ... } ⇒ ::Gapic::GenericLRO::Operation
Simulates a host maintenance event on a VM.
#start(request, options = nil) {|result, operation| ... } ⇒ ::Gapic::GenericLRO::Operation
Starts an instance that was stopped using the instances().stop method.
#start_with_encryption_key(request, options = nil) {|result, operation| ... } ⇒ ::Gapic::GenericLRO::Operation
Starts an instance that was stopped using the instances().stop method.
#stop(request, options = nil) {|result, operation| ... } ⇒ ::Gapic::GenericLRO::Operation
Stops a running instance, shutting it down cleanly, and allows you to restart the instance at a later time.
#suspend(request, options = nil) {|result, operation| ... } ⇒ ::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.
#test_iam_permissions(request, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::Compute::V1::TestPermissionsResponse
Returns permissions that a caller has on the specified resource.
#universe_domain ⇒ String
The effective universe domain.
#update(request, options = nil) {|result, operation| ... } ⇒ ::Gapic::GenericLRO::Operation
Updates an instance only if the necessary resources are available.
#update_access_config(request, options = nil) {|result, operation| ... } ⇒ ::Gapic::GenericLRO::Operation
Updates the specified access config from an instance's network interface with the data included in the request.
#update_display_device(request, options = nil) {|result, operation| ... } ⇒ ::Gapic::GenericLRO::Operation
Updates the Display config for a VM instance.
#update_network_interface(request, options = nil) {|result, operation| ... } ⇒ ::Gapic::GenericLRO::Operation
Updates an instance's network interface.
#update_shielded_instance_config(request, options = nil) {|result, operation| ... } ⇒ ::Gapic::GenericLRO::Operation
Updates the Shielded Instance config for an instance.

Constructor Details

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

Create a new Instances REST client object.

Examples:


# 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

Yields:

(config) —
Configure the Instances client.

Yield Parameters:

config (Client::Configuration)

# File 'lib/google/cloud/compute/v1/instances/rest/client.rb', line 251

def initialize
  # Create the configuration object
  @config = Configuration.new Client.configure

  # Yield the configuration if needed
  yield @config if block_given?

  # Create credentials
  credentials = @config.credentials
  # Use self-signed JWT if the endpoint is unchanged from default,
  # but only if the default endpoint does not have a region prefix.
  enable_self_signed_jwt = @config.endpoint.nil? ||
                           (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
                           !@config.endpoint.split(".").first.include?("-"))
  credentials ||= Credentials.default scope: @config.scope,
                                      enable_self_signed_jwt: enable_self_signed_jwt
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
    credentials = Credentials.new credentials, scope: @config.scope
  end

  @quota_project_id = @config.quota_project
  @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id

  @zone_operations = ::Google::Cloud::Compute::V1::ZoneOperations::Rest::Client.new do |config|
    config.credentials = credentials
    config.quota_project = @quota_project_id
    config.endpoint = @config.endpoint
    config.universe_domain = @config.universe_domain
  end

  @instances_stub = ::Google::Cloud::Compute::V1::Instances::Rest::ServiceStub.new(
    endpoint: @config.endpoint,
    endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
    universe_domain: @config.universe_domain,
    credentials: credentials,
    logger: @config.logger
  )

  @instances_stub.logger(stub: true)&.info do |entry|
    entry.set_system_name
    entry.set_service
    entry.message = "Created client for #{entry.service}"
    entry.set_credentials_fields credentials
    entry.set "customEndpoint", @config.endpoint if @config.endpoint
    entry.set "defaultTimeout", @config.timeout if @config.timeout
    entry.set "quotaProject", @quota_project_id if @quota_project_id
  end
end

Instance Attribute Details

#zone_operations ⇒ `::Google::Cloud::Compute::V1::ZoneOperations::Rest::Client` (readonly)

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

Returns:

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



305
306
307

# File 'lib/google/cloud/compute/v1/instances/rest/client.rb', line 305

def zone_operations
  @zone_operations
end

Class Method Details

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

Configure the Instances Client class.

See Configuration for a description of the configuration fields.

Examples:


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

Yields:

(config) —
Configure the Client client.

Yield Parameters:

config (Client::Configuration)

Returns:

(Client::Configuration)

# File 'lib/google/cloud/compute/v1/instances/rest/client.rb', line 63

def self.configure
  @configure ||= begin
    namespace = ["Google", "Cloud", "Compute", "V1"]
    parent_config = while namespace.any?
                      parent_name = namespace.join "::"
                      parent_const = const_get parent_name
                      break parent_const.configure if parent_const.respond_to? :configure
                      namespace.pop
                    end
    default_config = Client::Configuration.new parent_config

    default_config.rpcs.add_access_config.timeout = 600.0

    default_config.rpcs.add_resource_policies.timeout = 600.0

    default_config.rpcs.aggregated_list.timeout = 600.0
    default_config.rpcs.aggregated_list.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 14]
    }

    default_config.rpcs.attach_disk.timeout = 600.0

    default_config.rpcs.bulk_insert.timeout = 600.0

    default_config.rpcs.delete.timeout = 600.0

    default_config.rpcs.delete_access_config.timeout = 600.0

    default_config.rpcs.detach_disk.timeout = 600.0

    default_config.rpcs.get.timeout = 600.0
    default_config.rpcs.get.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 14]
    }

    default_config.rpcs.get_effective_firewalls.timeout = 600.0
    default_config.rpcs.get_effective_firewalls.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 14]
    }

    default_config.rpcs.get_guest_attributes.timeout = 600.0
    default_config.rpcs.get_guest_attributes.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 14]
    }

    default_config.rpcs.get_iam_policy.timeout = 600.0
    default_config.rpcs.get_iam_policy.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 14]
    }

    default_config.rpcs.get_screenshot.timeout = 600.0
    default_config.rpcs.get_screenshot.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 14]
    }

    default_config.rpcs.get_serial_port_output.timeout = 600.0
    default_config.rpcs.get_serial_port_output.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 14]
    }

    default_config.rpcs.get_shielded_instance_identity.timeout = 600.0
    default_config.rpcs.get_shielded_instance_identity.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 14]
    }

    default_config.rpcs.insert.timeout = 600.0

    default_config.rpcs.list.timeout = 600.0
    default_config.rpcs.list.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 14]
    }

    default_config.rpcs.list_referrers.timeout = 600.0
    default_config.rpcs.list_referrers.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 14]
    }

    default_config.rpcs.perform_maintenance.timeout = 600.0

    default_config.rpcs.remove_resource_policies.timeout = 600.0

    default_config.rpcs.reset.timeout = 600.0

    default_config.rpcs.resume.timeout = 600.0

    default_config.rpcs.send_diagnostic_interrupt.timeout = 600.0

    default_config.rpcs.set_deletion_protection.timeout = 600.0

    default_config.rpcs.set_disk_auto_delete.timeout = 600.0

    default_config.rpcs.set_iam_policy.timeout = 600.0

    default_config.rpcs.set_labels.timeout = 600.0

    default_config.rpcs.set_machine_resources.timeout = 600.0

    default_config.rpcs.set_machine_type.timeout = 600.0

    default_config.rpcs.set_metadata.timeout = 600.0

    default_config.rpcs.set_min_cpu_platform.timeout = 600.0

    default_config.rpcs.set_name.timeout = 600.0

    default_config.rpcs.set_scheduling.timeout = 600.0

    default_config.rpcs.set_security_policy.timeout = 600.0

    default_config.rpcs.set_service_account.timeout = 600.0

    default_config.rpcs.set_shielded_instance_integrity_policy.timeout = 600.0

    default_config.rpcs.set_tags.timeout = 600.0

    default_config.rpcs.simulate_maintenance_event.timeout = 600.0

    default_config.rpcs.start.timeout = 600.0

    default_config.rpcs.start_with_encryption_key.timeout = 600.0

    default_config.rpcs.stop.timeout = 600.0

    default_config.rpcs.suspend.timeout = 600.0

    default_config.rpcs.test_iam_permissions.timeout = 600.0

    default_config.rpcs.update.timeout = 600.0

    default_config.rpcs.update_access_config.timeout = 600.0

    default_config.rpcs.update_display_device.timeout = 600.0

    default_config.rpcs.update_network_interface.timeout = 600.0

    default_config.rpcs.update_shielded_instance_config.timeout = 600.0

    default_config
  end
  yield @configure if block_given?
  @configure
end

Instance Method Details

#add_access_config(request, options = nil) ⇒ `::Gapic::GenericLRO::Operation` #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.

Examples:

Basic example

require "google/cloud/compute/v1"

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

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

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

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

Overloads:

#add_access_config(request, options = nil) ⇒ ::Gapic::GenericLRO::Operation

Pass arguments to add_access_config via a request object, either of type AddAccessConfigInstanceRequest or an equivalent Hash.
Parameters:
- 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) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#add_access_config(access_config_resource: nil, instance: nil, network_interface: nil, project: nil, request_id: nil, zone: nil) ⇒ ::Gapic::GenericLRO::Operation

Pass arguments to 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).
Parameters:
- access_config_resource (::Google::Cloud::Compute::V1::AccessConfig, ::Hash) (defaults to: nil) —
  The body resource for this request
- instance (::String) (defaults to: nil) —
  The instance name for this request.
- network_interface (::String) (defaults to: nil) —
  The name of the network interface to add to this instance.
- project (::String) (defaults to: nil) —
  Project ID for this request.
- request_id (::String) (defaults to: nil) —
  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) (defaults to: nil) —
  The name of the zone for this request.

Yields:

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

Yield Parameters:

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

Returns:

(::Gapic::GenericLRO::Operation)

Raises:

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

# File 'lib/google/cloud/compute/v1/instances/rest/client.rb', line 371

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Compute::V1::AddAccessConfigInstanceRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.add_access_config.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Compute::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.add_access_config.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.add_access_config.retry_policy

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

  @instances_stub.add_access_config request, options do |result, response|
    result = ::Google::Cloud::Compute::V1::ZoneOperations::Rest::NonstandardLro.create_operation(
      operation: result,
      client: zone_operations,
      request_values: {
        "project" => request.project,
        "zone" => request.zone
      },
      options: options
    )
    yield result, response if block_given?
    throw :response, result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#add_resource_policies(request, options = nil) ⇒ `::Gapic::GenericLRO::Operation` #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.

Examples:

Basic example

require "google/cloud/compute/v1"

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

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

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

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

Overloads:

#add_resource_policies(request, options = nil) ⇒ ::Gapic::GenericLRO::Operation

Pass arguments to add_resource_policies via a request object, either of type AddResourcePoliciesInstanceRequest or an equivalent Hash.
Parameters:
- 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) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#add_resource_policies(instance: nil, instances_add_resource_policies_request_resource: nil, project: nil, request_id: nil, zone: nil) ⇒ ::Gapic::GenericLRO::Operation

Pass arguments to add_resource_policies via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- instance (::String) (defaults to: nil) —
  The instance name for this request.
- instances_add_resource_policies_request_resource (::Google::Cloud::Compute::V1::InstancesAddResourcePoliciesRequest, ::Hash) (defaults to: nil) —
  The body resource for this request
- project (::String) (defaults to: nil) —
  Project ID for this request.
- request_id (::String) (defaults to: nil) —
  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) (defaults to: nil) —
  The name of the zone for this request.

Yields:

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

Yield Parameters:

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

Returns:

(::Gapic::GenericLRO::Operation)

Raises:

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

# File 'lib/google/cloud/compute/v1/instances/rest/client.rb', line 467

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Compute::V1::AddResourcePoliciesInstanceRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.add_resource_policies.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Compute::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.add_resource_policies.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.add_resource_policies.retry_policy

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

  @instances_stub.add_resource_policies request, options do |result, response|
    result = ::Google::Cloud::Compute::V1::ZoneOperations::Rest::NonstandardLro.create_operation(
      operation: result,
      client: zone_operations,
      request_values: {
        "project" => request.project,
        "zone" => request.zone
      },
      options: options
    )
    yield result, response if block_given?
    throw :response, result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#aggregated_list(request, options = nil) ⇒ `::Gapic::Rest::PagedEnumerable<::String, ::Google::Cloud::Compute::V1::InstancesScopedList>` #aggregated_list(filter: nil, include_all_scopes: nil, max_results: nil, order_by: nil, page_token: nil, project: nil, return_partial_success: nil, service_project_number: 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. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

Examples:

Basic example

require "google/cloud/compute/v1"

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

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

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

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

Overloads:

#aggregated_list(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::String, ::Google::Cloud::Compute::V1::InstancesScopedList>

Pass arguments to aggregated_list via a request object, either of type AggregatedListInstancesRequest or an equivalent Hash.
Parameters:
- 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) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#aggregated_list(filter: nil, include_all_scopes: nil, max_results: nil, order_by: nil, page_token: nil, project: nil, return_partial_success: nil, service_project_number: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::String, ::Google::Cloud::Compute::V1::InstancesScopedList>

Pass arguments to aggregated_list via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- filter (::String) (defaults to: nil) —
  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. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either =, !=, >, <, <=, >= or :. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example: (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.
- include_all_scopes (::Boolean) (defaults to: nil) —
  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) (defaults to: nil) —
  The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)
- order_by (::String) (defaults to: nil) —
  Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.
- page_token (::String) (defaults to: nil) —
  Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
- project (::String) (defaults to: nil) —
  Project ID for this request.
- return_partial_success (::Boolean) (defaults to: nil) —
  Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.
- service_project_number (::Integer) (defaults to: nil) —
  The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.

Yields:

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

Yield Parameters:

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

Returns:

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

Raises:

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

# File 'lib/google/cloud/compute/v1/instances/rest/client.rb', line 569

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Compute::V1::AggregatedListInstancesRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.aggregated_list.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Compute::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.aggregated_list.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.aggregated_list.retry_policy

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

  @instances_stub.aggregated_list request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @instances_stub, :aggregated_list, "items", request, result, options
    yield result, operation if block_given?
    throw :response, result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#attach_disk(request, options = nil) ⇒ `::Gapic::GenericLRO::Operation` #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.

Examples:

Basic example

require "google/cloud/compute/v1"

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

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

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

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

Overloads:

#attach_disk(request, options = nil) ⇒ ::Gapic::GenericLRO::Operation

Pass arguments to attach_disk via a request object, either of type AttachDiskInstanceRequest or an equivalent Hash.
Parameters:
- 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) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#attach_disk(attached_disk_resource: nil, force_attach: nil, instance: nil, project: nil, request_id: nil, zone: nil) ⇒ ::Gapic::GenericLRO::Operation

Pass arguments to 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).
Parameters:
- attached_disk_resource (::Google::Cloud::Compute::V1::AttachedDisk, ::Hash) (defaults to: nil) —
  The body resource for this request
- force_attach (::Boolean) (defaults to: nil) —
  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) (defaults to: nil) —
  The instance name for this request.
- project (::String) (defaults to: nil) —
  Project ID for this request.
- request_id (::String) (defaults to: nil) —
  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) (defaults to: nil) —
  The name of the zone for this request.

Yields:

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

Yield Parameters:

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

Returns:

(::Gapic::GenericLRO::Operation)

Raises:

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

# File 'lib/google/cloud/compute/v1/instances/rest/client.rb', line 659

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Compute::V1::AttachDiskInstanceRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.attach_disk.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Compute::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.attach_disk.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.attach_disk.retry_policy

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

  @instances_stub.attach_disk request, options do |result, response|
    result = ::Google::Cloud::Compute::V1::ZoneOperations::Rest::NonstandardLro.create_operation(
      operation: result,
      client: zone_operations,
      request_values: {
        "project" => request.project,
        "zone" => request.zone
      },
      options: options
    )
    yield result, response if block_given?
    throw :response, result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#bulk_insert(request, options = nil) ⇒ `::Gapic::GenericLRO::Operation` #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.

Examples:

Basic example

require "google/cloud/compute/v1"

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

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

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

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

Overloads:

#bulk_insert(request, options = nil) ⇒ ::Gapic::GenericLRO::Operation

Pass arguments to bulk_insert via a request object, either of type BulkInsertInstanceRequest or an equivalent Hash.
Parameters:
- 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) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#bulk_insert(bulk_insert_instance_resource_resource: nil, project: nil, request_id: nil, zone: nil) ⇒ ::Gapic::GenericLRO::Operation

Pass arguments to bulk_insert via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- bulk_insert_instance_resource_resource (::Google::Cloud::Compute::V1::BulkInsertInstanceResource, ::Hash) (defaults to: nil) —
  The body resource for this request
- project (::String) (defaults to: nil) —
  Project ID for this request.
- request_id (::String) (defaults to: nil) —
  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) (defaults to: nil) —
  The name of the zone for this request.

Yields:

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

Yield Parameters:

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

Returns:

(::Gapic::GenericLRO::Operation)

Raises:

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

# File 'lib/google/cloud/compute/v1/instances/rest/client.rb', line 753

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Compute::V1::BulkInsertInstanceRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.bulk_insert.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Compute::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.bulk_insert.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.bulk_insert.retry_policy

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

  @instances_stub.bulk_insert request, options do |result, response|
    result = ::Google::Cloud::Compute::V1::ZoneOperations::Rest::NonstandardLro.create_operation(
      operation: result,
      client: zone_operations,
      request_values: {
        "project" => request.project,
        "zone" => request.zone
      },
      options: options
    )
    yield result, response if block_given?
    throw :response, result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#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 configure.

See Configuration for a description of the configuration fields.

Yields:

(config) —
Configure the Client client.

Yield Parameters:

config (Client::Configuration)

Returns:

(Client::Configuration)

# File 'lib/google/cloud/compute/v1/instances/rest/client.rb', line 221

def configure
  yield @config if block_given?
  @config
end

#delete(request, options = nil) ⇒ `::Gapic::GenericLRO::Operation` #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.

Examples:

Basic example

require "google/cloud/compute/v1"

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

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

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

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

Overloads:

#delete(request, options = nil) ⇒ ::Gapic::GenericLRO::Operation

Pass arguments to delete via a request object, either of type DeleteInstanceRequest or an equivalent Hash.
Parameters:
- 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) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#delete(instance: nil, project: nil, request_id: nil, zone: nil) ⇒ ::Gapic::GenericLRO::Operation

Pass arguments to delete via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- instance (::String) (defaults to: nil) —
  Name of the instance resource to delete.
- project (::String) (defaults to: nil) —
  Project ID for this request.
- request_id (::String) (defaults to: nil) —
  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) (defaults to: nil) —
  The name of the zone for this request.

Yields:

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

Yield Parameters:

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

Returns:

(::Gapic::GenericLRO::Operation)

Raises:

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

# File 'lib/google/cloud/compute/v1/instances/rest/client.rb', line 847

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Compute::V1::DeleteInstanceRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.delete.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Compute::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.delete.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.delete.retry_policy

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

  @instances_stub.delete request, options do |result, response|
    result = ::Google::Cloud::Compute::V1::ZoneOperations::Rest::NonstandardLro.create_operation(
      operation: result,
      client: zone_operations,
      request_values: {
        "project" => request.project,
        "zone" => request.zone
      },
      options: options
    )
    yield result, response if block_given?
    throw :response, result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#delete_access_config(request, options = nil) ⇒ `::Gapic::GenericLRO::Operation` #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.

Examples:

Basic example

require "google/cloud/compute/v1"

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

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

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

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

Overloads:

#delete_access_config(request, options = nil) ⇒ ::Gapic::GenericLRO::Operation

Pass arguments to delete_access_config via a request object, either of type DeleteAccessConfigInstanceRequest or an equivalent Hash.
Parameters:
- 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) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#delete_access_config(access_config: nil, instance: nil, network_interface: nil, project: nil, request_id: nil, zone: nil) ⇒ ::Gapic::GenericLRO::Operation

Pass arguments to 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).
Parameters:
- access_config (::String) (defaults to: nil) —
  The name of the access config to delete.
- instance (::String) (defaults to: nil) —
  The instance name for this request.
- network_interface (::String) (defaults to: nil) —
  The name of the network interface.
- project (::String) (defaults to: nil) —
  Project ID for this request.
- request_id (::String) (defaults to: nil) —
  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) (defaults to: nil) —
  The name of the zone for this request.

Yields:

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

Yield Parameters:

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

Returns:

(::Gapic::GenericLRO::Operation)

Raises:

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

# File 'lib/google/cloud/compute/v1/instances/rest/client.rb', line 945

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Compute::V1::DeleteAccessConfigInstanceRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.delete_access_config.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Compute::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.delete_access_config.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.delete_access_config.retry_policy

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

  @instances_stub.delete_access_config request, options do |result, response|
    result = ::Google::Cloud::Compute::V1::ZoneOperations::Rest::NonstandardLro.create_operation(
      operation: result,
      client: zone_operations,
      request_values: {
        "project" => request.project,
        "zone" => request.zone
      },
      options: options
    )
    yield result, response if block_given?
    throw :response, result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#detach_disk(request, options = nil) ⇒ `::Gapic::GenericLRO::Operation` #detach_disk(device_name: nil, instance: nil, project: nil, request_id: nil, zone: nil) ⇒ `::Gapic::GenericLRO::Operation`

Detaches a disk from an instance.

Examples:

Basic example

require "google/cloud/compute/v1"

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

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

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

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

Overloads:

#detach_disk(request, options = nil) ⇒ ::Gapic::GenericLRO::Operation

Pass arguments to detach_disk via a request object, either of type DetachDiskInstanceRequest or an equivalent Hash.
Parameters:
- 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) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#detach_disk(device_name: nil, instance: nil, project: nil, request_id: nil, zone: nil) ⇒ ::Gapic::GenericLRO::Operation

Pass arguments to 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).
Parameters:
- device_name (::String) (defaults to: nil) —
  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) (defaults to: nil) —
  Instance name for this request.
- project (::String) (defaults to: nil) —
  Project ID for this request.
- request_id (::String) (defaults to: nil) —
  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) (defaults to: nil) —
  The name of the zone for this request.

Yields:

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

Yield Parameters:

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

Returns:

(::Gapic::GenericLRO::Operation)

Raises:

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

# File 'lib/google/cloud/compute/v1/instances/rest/client.rb', line 1041

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Compute::V1::DetachDiskInstanceRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.detach_disk.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Compute::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.detach_disk.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.detach_disk.retry_policy

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

  @instances_stub.detach_disk request, options do |result, response|
    result = ::Google::Cloud::Compute::V1::ZoneOperations::Rest::NonstandardLro.create_operation(
      operation: result,
      client: zone_operations,
      request_values: {
        "project" => request.project,
        "zone" => request.zone
      },
      options: options
    )
    yield result, response if block_given?
    throw :response, result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get(request, options = nil) ⇒ `::Google::Cloud::Compute::V1::Instance` #get(instance: nil, project: nil, zone: nil) ⇒ `::Google::Cloud::Compute::V1::Instance`

Returns the specified Instance resource.

Examples:

Basic example

require "google/cloud/compute/v1"

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

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

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

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

Overloads:

#get(request, options = nil) ⇒ ::Google::Cloud::Compute::V1::Instance

Pass arguments to get via a request object, either of type GetInstanceRequest or an equivalent Hash.
Parameters:
- 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) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#get(instance: nil, project: nil, zone: nil) ⇒ ::Google::Cloud::Compute::V1::Instance

Pass arguments to get via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- instance (::String) (defaults to: nil) —
  Name of the instance resource to return.
- project (::String) (defaults to: nil) —
  Project ID for this request.
- zone (::String) (defaults to: nil) —
  The name of the zone for this request.

Yields:

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

Yield Parameters:

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

Returns:

(::Google::Cloud::Compute::V1::Instance)

Raises:

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

# File 'lib/google/cloud/compute/v1/instances/rest/client.rb', line 1133

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Compute::V1::GetInstanceRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.get.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Compute::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.get.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.get.retry_policy

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

  @instances_stub.get request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_effective_firewalls(request, options = nil) ⇒ `::Google::Cloud::Compute::V1::InstancesGetEffectiveFirewallsResponse` #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.

Examples:

Basic example

require "google/cloud/compute/v1"

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

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

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

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

Overloads:

#get_effective_firewalls(request, options = nil) ⇒ ::Google::Cloud::Compute::V1::InstancesGetEffectiveFirewallsResponse

Pass arguments to get_effective_firewalls via a request object, either of type GetEffectiveFirewallsInstanceRequest or an equivalent Hash.
Parameters:
- 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) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#get_effective_firewalls(instance: nil, network_interface: nil, project: nil, zone: nil) ⇒ ::Google::Cloud::Compute::V1::InstancesGetEffectiveFirewallsResponse

Pass arguments to 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).
Parameters:
- instance (::String) (defaults to: nil) —
  Name of the instance scoping this request.
- network_interface (::String) (defaults to: nil) —
  The name of the network interface to get the effective firewalls.
- project (::String) (defaults to: nil) —
  Project ID for this request.
- zone (::String) (defaults to: nil) —
  The name of the zone for this request.

Yields:

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

Yield Parameters:

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

Returns:

(::Google::Cloud::Compute::V1::InstancesGetEffectiveFirewallsResponse)

Raises:

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

# File 'lib/google/cloud/compute/v1/instances/rest/client.rb', line 1217

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Compute::V1::GetEffectiveFirewallsInstanceRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.get_effective_firewalls.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Compute::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.get_effective_firewalls.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.get_effective_firewalls.retry_policy

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

  @instances_stub.get_effective_firewalls request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_guest_attributes(request, options = nil) ⇒ `::Google::Cloud::Compute::V1::GuestAttributes` #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.

Examples:

Basic example

require "google/cloud/compute/v1"

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

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

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

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

Overloads:

#get_guest_attributes(request, options = nil) ⇒ ::Google::Cloud::Compute::V1::GuestAttributes

Pass arguments to get_guest_attributes via a request object, either of type GetGuestAttributesInstanceRequest or an equivalent Hash.
Parameters:
- 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) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#get_guest_attributes(instance: nil, project: nil, query_path: nil, variable_key: nil, zone: nil) ⇒ ::Google::Cloud::Compute::V1::GuestAttributes

Pass arguments to 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).
Parameters:
- instance (::String) (defaults to: nil) —
  Name of the instance scoping this request.
- project (::String) (defaults to: nil) —
  Project ID for this request.
- query_path (::String) (defaults to: nil) —
  Specifies the guest attributes path to be queried.
- variable_key (::String) (defaults to: nil) —
  Specifies the key for the guest attributes entry.
- zone (::String) (defaults to: nil) —
  The name of the zone for this request.

Yields:

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

Yield Parameters:

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

Returns:

(::Google::Cloud::Compute::V1::GuestAttributes)

Raises:

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

# File 'lib/google/cloud/compute/v1/instances/rest/client.rb', line 1303

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Compute::V1::GetGuestAttributesInstanceRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.get_guest_attributes.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Compute::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.get_guest_attributes.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.get_guest_attributes.retry_policy

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

  @instances_stub.get_guest_attributes request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_iam_policy(request, options = nil) ⇒ `::Google::Cloud::Compute::V1::Policy` #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.

Examples:

Basic example

require "google/cloud/compute/v1"

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

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

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

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

Overloads:

#get_iam_policy(request, options = nil) ⇒ ::Google::Cloud::Compute::V1::Policy

Pass arguments to get_iam_policy via a request object, either of type GetIamPolicyInstanceRequest or an equivalent Hash.
Parameters:
- 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) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#get_iam_policy(options_requested_policy_version: nil, project: nil, resource: nil, zone: nil) ⇒ ::Google::Cloud::Compute::V1::Policy

Pass arguments to get_iam_policy via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- options_requested_policy_version (::Integer) (defaults to: nil) —
  Requested IAM Policy version.
- project (::String) (defaults to: nil) —
  Project ID for this request.
- resource (::String) (defaults to: nil) —
  Name or id of the resource for this request.
- zone (::String) (defaults to: nil) —
  The name of the zone for this request.

Yields:

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

Yield Parameters:

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

Returns:

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

Raises:

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

# File 'lib/google/cloud/compute/v1/instances/rest/client.rb', line 1387

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Compute::V1::GetIamPolicyInstanceRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.get_iam_policy.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Compute::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.get_iam_policy.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.get_iam_policy.retry_policy

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

  @instances_stub.get_iam_policy request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_screenshot(request, options = nil) ⇒ `::Google::Cloud::Compute::V1::Screenshot` #get_screenshot(instance: nil, project: nil, zone: nil) ⇒ `::Google::Cloud::Compute::V1::Screenshot`

Returns the screenshot from the specified instance.

Examples:

Basic example

require "google/cloud/compute/v1"

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

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

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

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

Overloads:

#get_screenshot(request, options = nil) ⇒ ::Google::Cloud::Compute::V1::Screenshot

Pass arguments to get_screenshot via a request object, either of type GetScreenshotInstanceRequest or an equivalent Hash.
Parameters:
- 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) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#get_screenshot(instance: nil, project: nil, zone: nil) ⇒ ::Google::Cloud::Compute::V1::Screenshot

Pass arguments to 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).
Parameters:
- instance (::String) (defaults to: nil) —
  Name of the instance scoping this request.
- project (::String) (defaults to: nil) —
  Project ID for this request.
- zone (::String) (defaults to: nil) —
  The name of the zone for this request.

Yields:

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

Yield Parameters:

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

Returns:

(::Google::Cloud::Compute::V1::Screenshot)

Raises:

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

# File 'lib/google/cloud/compute/v1/instances/rest/client.rb', line 1469

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Compute::V1::GetScreenshotInstanceRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.get_screenshot.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Compute::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.get_screenshot.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.get_screenshot.retry_policy

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

  @instances_stub.get_screenshot request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_serial_port_output(request, options = nil) ⇒ `::Google::Cloud::Compute::V1::SerialPortOutput` #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.

Examples:

Basic example

require "google/cloud/compute/v1"

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

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

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

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

Overloads:

#get_serial_port_output(request, options = nil) ⇒ ::Google::Cloud::Compute::V1::SerialPortOutput

Pass arguments to get_serial_port_output via a request object, either of type GetSerialPortOutputInstanceRequest or an equivalent Hash.
Parameters:
- 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) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#get_serial_port_output(instance: nil, port: nil, project: nil, start: nil, zone: nil) ⇒ ::Google::Cloud::Compute::V1::SerialPortOutput

Pass arguments to 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).
Parameters:
- instance (::String) (defaults to: nil) —
  Name of the instance for this request.
- port (::Integer) (defaults to: nil) —
  Specifies which COM or serial port to retrieve data from.
- project (::String) (defaults to: nil) —
  Project ID for this request.
- start (::Integer) (defaults to: nil) —
  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 the start 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 the start 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. Note that the negative start is bounded by the retained buffer size, and the returned serial console output will not exceed the max buffer size.
- zone (::String) (defaults to: nil) —
  The name of the zone for this request.

Yields:

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

Yield Parameters:

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

Returns:

(::Google::Cloud::Compute::V1::SerialPortOutput)

Raises:

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

# File 'lib/google/cloud/compute/v1/instances/rest/client.rb', line 1555

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Compute::V1::GetSerialPortOutputInstanceRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.get_serial_port_output.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Compute::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.get_serial_port_output.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.get_serial_port_output.retry_policy

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

  @instances_stub.get_serial_port_output request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_shielded_instance_identity(request, options = nil) ⇒ `::Google::Cloud::Compute::V1::ShieldedInstanceIdentity` #get_shielded_instance_identity(instance: nil, project: nil, zone: nil) ⇒ `::Google::Cloud::Compute::V1::ShieldedInstanceIdentity`

Returns the Shielded Instance Identity of an instance

Examples:

Basic example

require "google/cloud/compute/v1"

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

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

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

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

Overloads:

#get_shielded_instance_identity(request, options = nil) ⇒ ::Google::Cloud::Compute::V1::ShieldedInstanceIdentity

Pass arguments to get_shielded_instance_identity via a request object, either of type GetShieldedInstanceIdentityInstanceRequest or an equivalent Hash.
Parameters:
- 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) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#get_shielded_instance_identity(instance: nil, project: nil, zone: nil) ⇒ ::Google::Cloud::Compute::V1::ShieldedInstanceIdentity

Pass arguments to 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).
Parameters:
- instance (::String) (defaults to: nil) —
  Name or id of the instance scoping this request.
- project (::String) (defaults to: nil) —
  Project ID for this request.
- zone (::String) (defaults to: nil) —
  The name of the zone for this request.

Yields:

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

Yield Parameters:

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

Returns:

(::Google::Cloud::Compute::V1::ShieldedInstanceIdentity)

Raises:

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

# File 'lib/google/cloud/compute/v1/instances/rest/client.rb', line 1637

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Compute::V1::GetShieldedInstanceIdentityInstanceRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.get_shielded_instance_identity.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Compute::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.get_shielded_instance_identity.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.get_shielded_instance_identity.retry_policy

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

  @instances_stub.get_shielded_instance_identity request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#insert(request, options = nil) ⇒ `::Gapic::GenericLRO::Operation` #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.

Examples:

Basic example

require "google/cloud/compute/v1"

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

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

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

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

Overloads:

#insert(request, options = nil) ⇒ ::Gapic::GenericLRO::Operation

Pass arguments to insert via a request object, either of type Google::Cloud::Compute::V1::InsertInstanceRequest or an equivalent Hash.
Parameters:
- 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) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#insert(instance_resource: nil, project: nil, request_id: nil, source_instance_template: nil, source_machine_image: nil, zone: nil) ⇒ ::Gapic::GenericLRO::Operation

Pass arguments to insert via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- instance_resource (::Google::Cloud::Compute::V1::Instance, ::Hash) (defaults to: nil) —
  The body resource for this request
- project (::String) (defaults to: nil) —
  Project ID for this request.
- request_id (::String) (defaults to: nil) —
  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) (defaults to: nil) —
  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) (defaults to: nil) —
  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) (defaults to: nil) —
  The name of the zone for this request.

Yields:

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

Yield Parameters:

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

Returns:

(::Gapic::GenericLRO::Operation)

Raises:

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

# File 'lib/google/cloud/compute/v1/instances/rest/client.rb', line 1725

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Compute::V1::InsertInstanceRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.insert.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Compute::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.insert.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.insert.retry_policy

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

  @instances_stub.insert request, options do |result, response|
    result = ::Google::Cloud::Compute::V1::ZoneOperations::Rest::NonstandardLro.create_operation(
      operation: result,
      client: zone_operations,
      request_values: {
        "project" => request.project,
        "zone" => request.zone
      },
      options: options
    )
    yield result, response if block_given?
    throw :response, result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list(request, options = nil) ⇒ `::Gapic::Rest::PagedEnumerable<::Google::Cloud::Compute::V1::Instance>` #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.

Examples:

Basic example

require "google/cloud/compute/v1"

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

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

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

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

Overloads:

#list(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Compute::V1::Instance>

Pass arguments to list via a request object, either of type ListInstancesRequest or an equivalent Hash.
Parameters:
- 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) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#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>

Pass arguments to list via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- filter (::String) (defaults to: nil) —
  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. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either =, !=, >, <, <=, >= or :. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example: (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.
- max_results (::Integer) (defaults to: nil) —
  The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)
- order_by (::String) (defaults to: nil) —
  Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.
- page_token (::String) (defaults to: nil) —
  Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
- project (::String) (defaults to: nil) —
  Project ID for this request.
- return_partial_success (::Boolean) (defaults to: nil) —
  Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.
- zone (::String) (defaults to: nil) —
  The name of the zone for this request.

Yields:

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

Yield Parameters:

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

Returns:

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

Raises:

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

# File 'lib/google/cloud/compute/v1/instances/rest/client.rb', line 1825

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Compute::V1::ListInstancesRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.list.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Compute::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.list.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.list.retry_policy

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

  @instances_stub.list request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @instances_stub, :list, "items", request, result, options
    yield result, operation if block_given?
    throw :response, result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_referrers(request, options = nil) ⇒ `::Gapic::Rest::PagedEnumerable<::Google::Cloud::Compute::V1::Reference>` #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.

Examples:

Basic example

require "google/cloud/compute/v1"

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

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

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

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

Overloads:

#list_referrers(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Compute::V1::Reference>

Pass arguments to list_referrers via a request object, either of type ListReferrersInstancesRequest or an equivalent Hash.
Parameters:
- 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) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#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>

Pass arguments to 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).
Parameters:
- filter (::String) (defaults to: nil) —
  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. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either =, !=, >, <, <=, >= or :. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example: (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use name ne .*instance. You cannot combine constraints on multiple fields using regular expressions.
- instance (::String) (defaults to: nil) —
  Name of the target instance scoping this request, or '-' if the request should span over all instances in the container.
- max_results (::Integer) (defaults to: nil) —
  The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)
- order_by (::String) (defaults to: nil) —
  Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.
- page_token (::String) (defaults to: nil) —
  Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
- project (::String) (defaults to: nil) —
  Project ID for this request.
- return_partial_success (::Boolean) (defaults to: nil) —
  Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.
- zone (::String) (defaults to: nil) —
  The name of the zone for this request.

Yields:

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

Yield Parameters:

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

Returns:

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

Raises:

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

# File 'lib/google/cloud/compute/v1/instances/rest/client.rb', line 1919

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Compute::V1::ListReferrersInstancesRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.list_referrers.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Compute::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.list_referrers.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.list_referrers.retry_policy

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

  @instances_stub.list_referrers request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @instances_stub, :list_referrers, "items", request, result, options
    yield result, operation if block_given?
    throw :response, result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#logger ⇒ `Logger`

The logger used for request/response debug logging.

Returns:

(Logger)



312
313
314

# File 'lib/google/cloud/compute/v1/instances/rest/client.rb', line 312

def logger
  @instances_stub.logger
end

#perform_maintenance(request, options = nil) ⇒ `::Gapic::GenericLRO::Operation` #perform_maintenance(instance: nil, project: nil, request_id: nil, zone: nil) ⇒ `::Gapic::GenericLRO::Operation`

Perform a manual maintenance on the instance.

Examples:

Basic example

require "google/cloud/compute/v1"

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

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

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

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

Overloads:

#perform_maintenance(request, options = nil) ⇒ ::Gapic::GenericLRO::Operation

Pass arguments to perform_maintenance via a request object, either of type PerformMaintenanceInstanceRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::Compute::V1::PerformMaintenanceInstanceRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#perform_maintenance(instance: nil, project: nil, request_id: nil, zone: nil) ⇒ ::Gapic::GenericLRO::Operation

Pass arguments to perform_maintenance via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- instance (::String) (defaults to: nil) —
  Name of the instance scoping this request.
- project (::String) (defaults to: nil) —
  Project ID for this request.
- request_id (::String) (defaults to: nil) —
  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) (defaults to: nil) —
  The name of the zone for this request.

Yields:

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

Yield Parameters:

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

Returns:

(::Gapic::GenericLRO::Operation)

Raises:

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

# File 'lib/google/cloud/compute/v1/instances/rest/client.rb', line 2005

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Compute::V1::PerformMaintenanceInstanceRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.perform_maintenance.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Compute::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.perform_maintenance.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.perform_maintenance.retry_policy

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

  @instances_stub.perform_maintenance request, options do |result, response|
    result = ::Google::Cloud::Compute::V1::ZoneOperations::Rest::NonstandardLro.create_operation(
      operation: result,
      client: zone_operations,
      request_values: {
        "project" => request.project,
        "zone" => request.zone
      },
      options: options
    )
    yield result, response if block_given?
    throw :response, result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#remove_resource_policies(request, options = nil) ⇒ `::Gapic::GenericLRO::Operation` #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.

Examples:

Basic example

require "google/cloud/compute/v1"

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

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

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

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

Overloads:

#remove_resource_policies(request, options = nil) ⇒ ::Gapic::GenericLRO::Operation

Pass arguments to remove_resource_policies via a request object, either of type RemoveResourcePoliciesInstanceRequest or an equivalent Hash.
Parameters:
- 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) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#remove_resource_policies(instance: nil, instances_remove_resource_policies_request_resource: nil, project: nil, request_id: nil, zone: nil) ⇒ ::Gapic::GenericLRO::Operation

Pass arguments to remove_resource_policies via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- instance (::String) (defaults to: nil) —
  The instance name for this request.
- instances_remove_resource_policies_request_resource (::Google::Cloud::Compute::V1::InstancesRemoveResourcePoliciesRequest, ::Hash) (defaults to: nil) —
  The body resource for this request
- project (::String) (defaults to: nil) —
  Project ID for this request.
- request_id (::String) (defaults to: nil) —
  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) (defaults to: nil) —
  The name of the zone for this request.

Yields:

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

Yield Parameters:

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

Returns:

(::Gapic::GenericLRO::Operation)

Raises:

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

# File 'lib/google/cloud/compute/v1/instances/rest/client.rb', line 2101

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Compute::V1::RemoveResourcePoliciesInstanceRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.remove_resource_policies.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Compute::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.remove_resource_policies.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.remove_resource_policies.retry_policy

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

  @instances_stub.remove_resource_policies request, options do |result, response|
    result = ::Google::Cloud::Compute::V1::ZoneOperations::Rest::NonstandardLro.create_operation(
      operation: result,
      client: zone_operations,
      request_values: {
        "project" => request.project,
        "zone" => request.zone
      },
      options: options
    )
    yield result, response if block_given?
    throw :response, result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#reset(request, options = nil) ⇒ `::Gapic::GenericLRO::Operation` #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.

Examples:

Basic example

require "google/cloud/compute/v1"

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

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

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

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

Overloads:

#reset(request, options = nil) ⇒ ::Gapic::GenericLRO::Operation

Pass arguments to reset via a request object, either of type ResetInstanceRequest or an equivalent Hash.
Parameters:
- 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) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#reset(instance: nil, project: nil, request_id: nil, zone: nil) ⇒ ::Gapic::GenericLRO::Operation

Pass arguments to 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).
Parameters:
- instance (::String) (defaults to: nil) —
  Name of the instance scoping this request.
- project (::String) (defaults to: nil) —
  Project ID for this request.
- request_id (::String) (defaults to: nil) —
  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) (defaults to: nil) —
  The name of the zone for this request.

Yields:

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

Yield Parameters:

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

Returns:

(::Gapic::GenericLRO::Operation)

Raises:

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

# File 'lib/google/cloud/compute/v1/instances/rest/client.rb', line 2195

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Compute::V1::ResetInstanceRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.reset.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Compute::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.reset.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.reset.retry_policy

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

  @instances_stub.reset request, options do |result, response|
    result = ::Google::Cloud::Compute::V1::ZoneOperations::Rest::NonstandardLro.create_operation(
      operation: result,
      client: zone_operations,
      request_values: {
        "project" => request.project,
        "zone" => request.zone
      },
      options: options
    )
    yield result, response if block_given?
    throw :response, result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#resume(request, options = nil) ⇒ `::Gapic::GenericLRO::Operation` #resume(instance: nil, project: nil, request_id: nil, zone: nil) ⇒ `::Gapic::GenericLRO::Operation`

Resumes an instance that was suspended using the instances().suspend method.

Examples:

Basic example

require "google/cloud/compute/v1"

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

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

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

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

Overloads:

#resume(request, options = nil) ⇒ ::Gapic::GenericLRO::Operation

Pass arguments to resume via a request object, either of type ResumeInstanceRequest or an equivalent Hash.
Parameters:
- 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) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#resume(instance: nil, project: nil, request_id: nil, zone: nil) ⇒ ::Gapic::GenericLRO::Operation

Pass arguments to 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).
Parameters:
- instance (::String) (defaults to: nil) —
  Name of the instance resource to resume.
- project (::String) (defaults to: nil) —
  Project ID for this request.
- request_id (::String) (defaults to: nil) —
  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) (defaults to: nil) —
  The name of the zone for this request.

Yields:

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

Yield Parameters:

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

Returns:

(::Gapic::GenericLRO::Operation)

Raises:

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

# File 'lib/google/cloud/compute/v1/instances/rest/client.rb', line 2289

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Compute::V1::ResumeInstanceRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.resume.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Compute::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.resume.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.resume.retry_policy

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

  @instances_stub.resume request, options do |result, response|
    result = ::Google::Cloud::Compute::V1::ZoneOperations::Rest::NonstandardLro.create_operation(
      operation: result,
      client: zone_operations,
      request_values: {
        "project" => request.project,
        "zone" => request.zone
      },
      options: options
    )
    yield result, response if block_given?
    throw :response, result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#send_diagnostic_interrupt(request, options = nil) ⇒ `::Google::Cloud::Compute::V1::SendDiagnosticInterruptInstanceResponse` #send_diagnostic_interrupt(instance: nil, project: nil, zone: nil) ⇒ `::Google::Cloud::Compute::V1::SendDiagnosticInterruptInstanceResponse`

Sends diagnostic interrupt to the instance.

Examples:

Basic example

require "google/cloud/compute/v1"

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

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

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

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

Overloads:

#send_diagnostic_interrupt(request, options = nil) ⇒ ::Google::Cloud::Compute::V1::SendDiagnosticInterruptInstanceResponse

Pass arguments to send_diagnostic_interrupt via a request object, either of type SendDiagnosticInterruptInstanceRequest or an equivalent Hash.
Parameters:
- 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) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#send_diagnostic_interrupt(instance: nil, project: nil, zone: nil) ⇒ ::Google::Cloud::Compute::V1::SendDiagnosticInterruptInstanceResponse

Pass arguments to 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).
Parameters:
- instance (::String) (defaults to: nil) —
  Name of the instance scoping this request.
- project (::String) (defaults to: nil) —
  Project ID for this request.
- zone (::String) (defaults to: nil) —
  The name of the zone for this request.

Yields:

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

Yield Parameters:

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

Returns:

(::Google::Cloud::Compute::V1::SendDiagnosticInterruptInstanceResponse)

Raises:

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

# File 'lib/google/cloud/compute/v1/instances/rest/client.rb', line 2381

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Compute::V1::SendDiagnosticInterruptInstanceRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.send_diagnostic_interrupt.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Compute::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.send_diagnostic_interrupt.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.send_diagnostic_interrupt.retry_policy

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

  @instances_stub.send_diagnostic_interrupt request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#set_deletion_protection(request, options = nil) ⇒ `::Gapic::GenericLRO::Operation` #set_deletion_protection(deletion_protection: nil, project: nil, request_id: nil, resource: nil, zone: nil) ⇒ `::Gapic::GenericLRO::Operation`

Sets deletion protection on the instance.

Examples:

Basic example

require "google/cloud/compute/v1"

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

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

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

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

Overloads:

#set_deletion_protection(request, options = nil) ⇒ ::Gapic::GenericLRO::Operation

Pass arguments to set_deletion_protection via a request object, either of type SetDeletionProtectionInstanceRequest or an equivalent Hash.
Parameters:
- 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) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#set_deletion_protection(deletion_protection: nil, project: nil, request_id: nil, resource: nil, zone: nil) ⇒ ::Gapic::GenericLRO::Operation

Pass arguments to 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).
Parameters:
- deletion_protection (::Boolean) (defaults to: nil) —
  Whether the resource should be protected against deletion.
- project (::String) (defaults to: nil) —
  Project ID for this request.
- request_id (::String) (defaults to: nil) —
  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) (defaults to: nil) —
  Name or id of the resource for this request.
- zone (::String) (defaults to: nil) —
  The name of the zone for this request.

Yields:

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

Yield Parameters:

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

Returns:

(::Gapic::GenericLRO::Operation)

Raises:

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

# File 'lib/google/cloud/compute/v1/instances/rest/client.rb', line 2467

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Compute::V1::SetDeletionProtectionInstanceRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.set_deletion_protection.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Compute::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.set_deletion_protection.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.set_deletion_protection.retry_policy

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

  @instances_stub.set_deletion_protection request, options do |result, response|
    result = ::Google::Cloud::Compute::V1::ZoneOperations::Rest::NonstandardLro.create_operation(
      operation: result,
      client: zone_operations,
      request_values: {
        "project" => request.project,
        "zone" => request.zone
      },
      options: options
    )
    yield result, response if block_given?
    throw :response, result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#set_disk_auto_delete(request, options = nil) ⇒ `::Gapic::GenericLRO::Operation` #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.

Examples:

Basic example

require "google/cloud/compute/v1"

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

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

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

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

Overloads:

#set_disk_auto_delete(request, options = nil) ⇒ ::Gapic::GenericLRO::Operation

Pass arguments to set_disk_auto_delete via a request object, either of type SetDiskAutoDeleteInstanceRequest or an equivalent Hash.
Parameters:
- 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) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#set_disk_auto_delete(auto_delete: nil, device_name: nil, instance: nil, project: nil, request_id: nil, zone: nil) ⇒ ::Gapic::GenericLRO::Operation

Pass arguments to 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).
Parameters:
- auto_delete (::Boolean) (defaults to: nil) —
  Whether to auto-delete the disk when the instance is deleted.
- device_name (::String) (defaults to: nil) —
  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) (defaults to: nil) —
  The instance name for this request.
- project (::String) (defaults to: nil) —
  Project ID for this request.
- request_id (::String) (defaults to: nil) —
  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) (defaults to: nil) —
  The name of the zone for this request.

Yields:

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

Yield Parameters:

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

Returns:

(::Gapic::GenericLRO::Operation)

Raises:

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

# File 'lib/google/cloud/compute/v1/instances/rest/client.rb', line 2565

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Compute::V1::SetDiskAutoDeleteInstanceRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.set_disk_auto_delete.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Compute::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.set_disk_auto_delete.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.set_disk_auto_delete.retry_policy

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

  @instances_stub.set_disk_auto_delete request, options do |result, response|
    result = ::Google::Cloud::Compute::V1::ZoneOperations::Rest::NonstandardLro.create_operation(
      operation: result,
      client: zone_operations,
      request_values: {
        "project" => request.project,
        "zone" => request.zone
      },
      options: options
    )
    yield result, response if block_given?
    throw :response, result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#set_iam_policy(request, options = nil) ⇒ `::Google::Cloud::Compute::V1::Policy` #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.

Examples:

Basic example

require "google/cloud/compute/v1"

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

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

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

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

Overloads:

#set_iam_policy(request, options = nil) ⇒ ::Google::Cloud::Compute::V1::Policy

Pass arguments to set_iam_policy via a request object, either of type SetIamPolicyInstanceRequest or an equivalent Hash.
Parameters:
- 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) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#set_iam_policy(project: nil, resource: nil, zone: nil, zone_set_policy_request_resource: nil) ⇒ ::Google::Cloud::Compute::V1::Policy

Pass arguments to set_iam_policy via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- project (::String) (defaults to: nil) —
  Project ID for this request.
- resource (::String) (defaults to: nil) —
  Name or id of the resource for this request.
- zone (::String) (defaults to: nil) —
  The name of the zone for this request.
- zone_set_policy_request_resource (::Google::Cloud::Compute::V1::ZoneSetPolicyRequest, ::Hash) (defaults to: nil) —
  The body resource for this request

Yields:

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

Yield Parameters:

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

Returns:

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

Raises:

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

# File 'lib/google/cloud/compute/v1/instances/rest/client.rb', line 2659

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Compute::V1::SetIamPolicyInstanceRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.set_iam_policy.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Compute::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.set_iam_policy.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.set_iam_policy.retry_policy

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

  @instances_stub.set_iam_policy request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#set_labels(request, options = nil) ⇒ `::Gapic::GenericLRO::Operation` #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.

Examples:

Basic example

require "google/cloud/compute/v1"

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

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

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

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

Overloads:

#set_labels(request, options = nil) ⇒ ::Gapic::GenericLRO::Operation

Pass arguments to set_labels via a request object, either of type SetLabelsInstanceRequest or an equivalent Hash.
Parameters:
- 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) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#set_labels(instance: nil, instances_set_labels_request_resource: nil, project: nil, request_id: nil, zone: nil) ⇒ ::Gapic::GenericLRO::Operation

Pass arguments to set_labels via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- instance (::String) (defaults to: nil) —
  Name of the instance scoping this request.
- instances_set_labels_request_resource (::Google::Cloud::Compute::V1::InstancesSetLabelsRequest, ::Hash) (defaults to: nil) —
  The body resource for this request
- project (::String) (defaults to: nil) —
  Project ID for this request.
- request_id (::String) (defaults to: nil) —
  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) (defaults to: nil) —
  The name of the zone for this request.

Yields:

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

Yield Parameters:

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

Returns:

(::Gapic::GenericLRO::Operation)

Raises:

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

# File 'lib/google/cloud/compute/v1/instances/rest/client.rb', line 2745

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Compute::V1::SetLabelsInstanceRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.set_labels.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Compute::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.set_labels.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.set_labels.retry_policy

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

  @instances_stub.set_labels request, options do |result, response|
    result = ::Google::Cloud::Compute::V1::ZoneOperations::Rest::NonstandardLro.create_operation(
      operation: result,
      client: zone_operations,
      request_values: {
        "project" => request.project,
        "zone" => request.zone
      },
      options: options
    )
    yield result, response if block_given?
    throw :response, result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#set_machine_resources(request, options = nil) ⇒ `::Gapic::GenericLRO::Operation` #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.

Examples:

Basic example

require "google/cloud/compute/v1"

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

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

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

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

Overloads:

#set_machine_resources(request, options = nil) ⇒ ::Gapic::GenericLRO::Operation

Pass arguments to set_machine_resources via a request object, either of type SetMachineResourcesInstanceRequest or an equivalent Hash.
Parameters:
- 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) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#set_machine_resources(instance: nil, instances_set_machine_resources_request_resource: nil, project: nil, request_id: nil, zone: nil) ⇒ ::Gapic::GenericLRO::Operation

Pass arguments to 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).
Parameters:
- instance (::String) (defaults to: nil) —
  Name of the instance scoping this request.
- instances_set_machine_resources_request_resource (::Google::Cloud::Compute::V1::InstancesSetMachineResourcesRequest, ::Hash) (defaults to: nil) —
  The body resource for this request
- project (::String) (defaults to: nil) —
  Project ID for this request.
- request_id (::String) (defaults to: nil) —
  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) (defaults to: nil) —
  The name of the zone for this request.

Yields:

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

Yield Parameters:

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

Returns:

(::Gapic::GenericLRO::Operation)

Raises:

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

# File 'lib/google/cloud/compute/v1/instances/rest/client.rb', line 2841

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Compute::V1::SetMachineResourcesInstanceRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.set_machine_resources.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Compute::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.set_machine_resources.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.set_machine_resources.retry_policy

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

  @instances_stub.set_machine_resources request, options do |result, response|
    result = ::Google::Cloud::Compute::V1::ZoneOperations::Rest::NonstandardLro.create_operation(
      operation: result,
      client: zone_operations,
      request_values: {
        "project" => request.project,
        "zone" => request.zone
      },
      options: options
    )
    yield result, response if block_given?
    throw :response, result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#set_machine_type(request, options = nil) ⇒ `::Gapic::GenericLRO::Operation` #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.

Examples:

Basic example

require "google/cloud/compute/v1"

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

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

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

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

Overloads:

#set_machine_type(request, options = nil) ⇒ ::Gapic::GenericLRO::Operation

Pass arguments to set_machine_type via a request object, either of type SetMachineTypeInstanceRequest or an equivalent Hash.
Parameters:
- 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) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#set_machine_type(instance: nil, instances_set_machine_type_request_resource: nil, project: nil, request_id: nil, zone: nil) ⇒ ::Gapic::GenericLRO::Operation

Pass arguments to 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).
Parameters:
- instance (::String) (defaults to: nil) —
  Name of the instance scoping this request.
- instances_set_machine_type_request_resource (::Google::Cloud::Compute::V1::InstancesSetMachineTypeRequest, ::Hash) (defaults to: nil) —
  The body resource for this request
- project (::String) (defaults to: nil) —
  Project ID for this request.
- request_id (::String) (defaults to: nil) —
  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) (defaults to: nil) —
  The name of the zone for this request.

Yields:

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

Yield Parameters:

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

Returns:

(::Gapic::GenericLRO::Operation)

Raises:

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

# File 'lib/google/cloud/compute/v1/instances/rest/client.rb', line 2937

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Compute::V1::SetMachineTypeInstanceRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.set_machine_type.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Compute::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.set_machine_type.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.set_machine_type.retry_policy

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

  @instances_stub.set_machine_type request, options do |result, response|
    result = ::Google::Cloud::Compute::V1::ZoneOperations::Rest::NonstandardLro.create_operation(
      operation: result,
      client: zone_operations,
      request_values: {
        "project" => request.project,
        "zone" => request.zone
      },
      options: options
    )
    yield result, response if block_given?
    throw :response, result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#set_metadata(request, options = nil) ⇒ `::Gapic::GenericLRO::Operation` #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.

Examples:

Basic example

require "google/cloud/compute/v1"

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

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

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

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

Overloads:

#set_metadata(request, options = nil) ⇒ ::Gapic::GenericLRO::Operation

Pass arguments to set_metadata via a request object, either of type SetMetadataInstanceRequest or an equivalent Hash.
Parameters:
- 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) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#set_metadata(instance: nil, metadata_resource: nil, project: nil, request_id: nil, zone: nil) ⇒ ::Gapic::GenericLRO::Operation

Pass arguments to 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).
Parameters:
- instance (::String) (defaults to: nil) —
  Name of the instance scoping this request.
- metadata_resource (::Google::Cloud::Compute::V1::Metadata, ::Hash) (defaults to: nil) —
  The body resource for this request
- project (::String) (defaults to: nil) —
  Project ID for this request.
- request_id (::String) (defaults to: nil) —
  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) (defaults to: nil) —
  The name of the zone for this request.

Yields:

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

Yield Parameters:

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

Returns:

(::Gapic::GenericLRO::Operation)

Raises:

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

# File 'lib/google/cloud/compute/v1/instances/rest/client.rb', line 3033

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Compute::V1::SetMetadataInstanceRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.set_metadata.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Compute::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.set_metadata.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.set_metadata.retry_policy

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

  @instances_stub.set_metadata request, options do |result, response|
    result = ::Google::Cloud::Compute::V1::ZoneOperations::Rest::NonstandardLro.create_operation(
      operation: result,
      client: zone_operations,
      request_values: {
        "project" => request.project,
        "zone" => request.zone
      },
      options: options
    )
    yield result, response if block_given?
    throw :response, result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#set_min_cpu_platform(request, options = nil) ⇒ `::Gapic::GenericLRO::Operation` #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.

Examples:

Basic example

require "google/cloud/compute/v1"

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

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

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

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

Overloads:

#set_min_cpu_platform(request, options = nil) ⇒ ::Gapic::GenericLRO::Operation

Pass arguments to set_min_cpu_platform via a request object, either of type SetMinCpuPlatformInstanceRequest or an equivalent Hash.
Parameters:
- 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) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#set_min_cpu_platform(instance: nil, instances_set_min_cpu_platform_request_resource: nil, project: nil, request_id: nil, zone: nil) ⇒ ::Gapic::GenericLRO::Operation

Pass arguments to 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).
Parameters:
- instance (::String) (defaults to: nil) —
  Name of the instance scoping this request.
- instances_set_min_cpu_platform_request_resource (::Google::Cloud::Compute::V1::InstancesSetMinCpuPlatformRequest, ::Hash) (defaults to: nil) —
  The body resource for this request
- project (::String) (defaults to: nil) —
  Project ID for this request.
- request_id (::String) (defaults to: nil) —
  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) (defaults to: nil) —
  The name of the zone for this request.

Yields:

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

Yield Parameters:

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

Returns:

(::Gapic::GenericLRO::Operation)

Raises:

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

# File 'lib/google/cloud/compute/v1/instances/rest/client.rb', line 3129

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Compute::V1::SetMinCpuPlatformInstanceRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.set_min_cpu_platform.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Compute::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.set_min_cpu_platform.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.set_min_cpu_platform.retry_policy

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

  @instances_stub.set_min_cpu_platform request, options do |result, response|
    result = ::Google::Cloud::Compute::V1::ZoneOperations::Rest::NonstandardLro.create_operation(
      operation: result,
      client: zone_operations,
      request_values: {
        "project" => request.project,
        "zone" => request.zone
      },
      options: options
    )
    yield result, response if block_given?
    throw :response, result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#set_name(request, options = nil) ⇒ `::Gapic::GenericLRO::Operation` #set_name(instance: nil, instances_set_name_request_resource: nil, project: nil, request_id: nil, zone: nil) ⇒ `::Gapic::GenericLRO::Operation`

Sets name of an instance.

Examples:

Basic example

require "google/cloud/compute/v1"

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

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

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

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

Overloads:

#set_name(request, options = nil) ⇒ ::Gapic::GenericLRO::Operation

Pass arguments to set_name via a request object, either of type SetNameInstanceRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::Compute::V1::SetNameInstanceRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#set_name(instance: nil, instances_set_name_request_resource: nil, project: nil, request_id: nil, zone: nil) ⇒ ::Gapic::GenericLRO::Operation

Pass arguments to set_name via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- instance (::String) (defaults to: nil) —
  The instance name for this request.
- instances_set_name_request_resource (::Google::Cloud::Compute::V1::InstancesSetNameRequest, ::Hash) (defaults to: nil) —
  The body resource for this request
- project (::String) (defaults to: nil) —
  Project ID for this request.
- request_id (::String) (defaults to: nil) —
  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) (defaults to: nil) —
  The name of the zone for this request.

Yields:

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

Yield Parameters:

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

Returns:

(::Gapic::GenericLRO::Operation)

Raises:

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

# File 'lib/google/cloud/compute/v1/instances/rest/client.rb', line 3225

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Compute::V1::SetNameInstanceRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.set_name.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Compute::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.set_name.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.set_name.retry_policy

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

  @instances_stub.set_name request, options do |result, response|
    result = ::Google::Cloud::Compute::V1::ZoneOperations::Rest::NonstandardLro.create_operation(
      operation: result,
      client: zone_operations,
      request_values: {
        "project" => request.project,
        "zone" => request.zone
      },
      options: options
    )
    yield result, response if block_given?
    throw :response, result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#set_scheduling(request, options = nil) ⇒ `::Gapic::GenericLRO::Operation` #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.

Examples:

Basic example

require "google/cloud/compute/v1"

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

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

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

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

Overloads:

#set_scheduling(request, options = nil) ⇒ ::Gapic::GenericLRO::Operation

Pass arguments to set_scheduling via a request object, either of type SetSchedulingInstanceRequest or an equivalent Hash.
Parameters:
- 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) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#set_scheduling(instance: nil, project: nil, request_id: nil, scheduling_resource: nil, zone: nil) ⇒ ::Gapic::GenericLRO::Operation

Pass arguments to 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).
Parameters:
- instance (::String) (defaults to: nil) —
  Instance name for this request.
- project (::String) (defaults to: nil) —
  Project ID for this request.
- request_id (::String) (defaults to: nil) —
  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) (defaults to: nil) —
  The body resource for this request
- zone (::String) (defaults to: nil) —
  The name of the zone for this request.

Yields:

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

Yield Parameters:

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

Returns:

(::Gapic::GenericLRO::Operation)

Raises:

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

# File 'lib/google/cloud/compute/v1/instances/rest/client.rb', line 3321

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Compute::V1::SetSchedulingInstanceRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.set_scheduling.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Compute::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.set_scheduling.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.set_scheduling.retry_policy

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

  @instances_stub.set_scheduling request, options do |result, response|
    result = ::Google::Cloud::Compute::V1::ZoneOperations::Rest::NonstandardLro.create_operation(
      operation: result,
      client: zone_operations,
      request_values: {
        "project" => request.project,
        "zone" => request.zone
      },
      options: options
    )
    yield result, response if block_given?
    throw :response, result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#set_security_policy(request, options = nil) ⇒ `::Gapic::GenericLRO::Operation` #set_security_policy(instance: nil, instances_set_security_policy_request_resource: nil, project: nil, request_id: nil, zone: nil) ⇒ `::Gapic::GenericLRO::Operation`

Sets the Google Cloud Armor security policy for the specified instance. For more information, see Google Cloud Armor Overview

Examples:

Basic example

require "google/cloud/compute/v1"

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

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

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

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

Overloads:

#set_security_policy(request, options = nil) ⇒ ::Gapic::GenericLRO::Operation

Pass arguments to set_security_policy via a request object, either of type SetSecurityPolicyInstanceRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::Compute::V1::SetSecurityPolicyInstanceRequest, ::Hash) —
  A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#set_security_policy(instance: nil, instances_set_security_policy_request_resource: nil, project: nil, request_id: nil, zone: nil) ⇒ ::Gapic::GenericLRO::Operation

Pass arguments to set_security_policy via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- instance (::String) (defaults to: nil) —
  Name of the Instance resource to which the security policy should be set. The name should conform to RFC1035.
- instances_set_security_policy_request_resource (::Google::Cloud::Compute::V1::InstancesSetSecurityPolicyRequest, ::Hash) (defaults to: nil) —
  The body resource for this request
- project (::String) (defaults to: nil) —
  Project ID for this request.
- request_id (::String) (defaults to: nil) —
  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) (defaults to: nil) —
  Name of the zone scoping this request.

Yields:

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

Yield Parameters:

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

Returns:

(::Gapic::GenericLRO::Operation)

Raises:

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

# File 'lib/google/cloud/compute/v1/instances/rest/client.rb', line 3417

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Compute::V1::SetSecurityPolicyInstanceRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.set_security_policy.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Compute::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.set_security_policy.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.set_security_policy.retry_policy

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

  @instances_stub.set_security_policy request, options do |result, response|
    result = ::Google::Cloud::Compute::V1::ZoneOperations::Rest::NonstandardLro.create_operation(
      operation: result,
      client: zone_operations,
      request_values: {
        "project" => request.project,
        "zone" => request.zone
      },
      options: options
    )
    yield result, response if block_given?
    throw :response, result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#set_service_account(request, options = nil) ⇒ `::Gapic::GenericLRO::Operation` #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.

Examples:

Basic example

require "google/cloud/compute/v1"

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

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

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

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

Overloads:

#set_service_account(request, options = nil) ⇒ ::Gapic::GenericLRO::Operation

Pass arguments to set_service_account via a request object, either of type SetServiceAccountInstanceRequest or an equivalent Hash.
Parameters:
- 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) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#set_service_account(instance: nil, instances_set_service_account_request_resource: nil, project: nil, request_id: nil, zone: nil) ⇒ ::Gapic::GenericLRO::Operation

Pass arguments to 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).
Parameters:
- instance (::String) (defaults to: nil) —
  Name of the instance resource to start.
- instances_set_service_account_request_resource (::Google::Cloud::Compute::V1::InstancesSetServiceAccountRequest, ::Hash) (defaults to: nil) —
  The body resource for this request
- project (::String) (defaults to: nil) —
  Project ID for this request.
- request_id (::String) (defaults to: nil) —
  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) (defaults to: nil) —
  The name of the zone for this request.

Yields:

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

Yield Parameters:

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

Returns:

(::Gapic::GenericLRO::Operation)

Raises:

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

# File 'lib/google/cloud/compute/v1/instances/rest/client.rb', line 3513

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Compute::V1::SetServiceAccountInstanceRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.set_service_account.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Compute::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.set_service_account.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.set_service_account.retry_policy

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

  @instances_stub.set_service_account request, options do |result, response|
    result = ::Google::Cloud::Compute::V1::ZoneOperations::Rest::NonstandardLro.create_operation(
      operation: result,
      client: zone_operations,
      request_values: {
        "project" => request.project,
        "zone" => request.zone
      },
      options: options
    )
    yield result, response if block_given?
    throw :response, result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#set_shielded_instance_integrity_policy(request, options = nil) ⇒ `::Gapic::GenericLRO::Operation` #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.

Examples:

Basic example

require "google/cloud/compute/v1"

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

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

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

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

Overloads:

#set_shielded_instance_integrity_policy(request, options = nil) ⇒ ::Gapic::GenericLRO::Operation

Pass arguments to set_shielded_instance_integrity_policy via a request object, either of type SetShieldedInstanceIntegrityPolicyInstanceRequest or an equivalent Hash.
Parameters:
- 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) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#set_shielded_instance_integrity_policy(instance: nil, project: nil, request_id: nil, shielded_instance_integrity_policy_resource: nil, zone: nil) ⇒ ::Gapic::GenericLRO::Operation

Pass arguments to 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).
Parameters:
- instance (::String) (defaults to: nil) —
  Name or id of the instance scoping this request.
- project (::String) (defaults to: nil) —
  Project ID for this request.
- request_id (::String) (defaults to: nil) —
  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) (defaults to: nil) —
  The body resource for this request
- zone (::String) (defaults to: nil) —
  The name of the zone for this request.

Yields:

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

Yield Parameters:

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

Returns:

(::Gapic::GenericLRO::Operation)

Raises:

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

# File 'lib/google/cloud/compute/v1/instances/rest/client.rb', line 3609

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Compute::V1::SetShieldedInstanceIntegrityPolicyInstanceRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.set_shielded_instance_integrity_policy.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Compute::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.set_shielded_instance_integrity_policy.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.set_shielded_instance_integrity_policy.retry_policy

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

  @instances_stub.set_shielded_instance_integrity_policy request, options do |result, response|
    result = ::Google::Cloud::Compute::V1::ZoneOperations::Rest::NonstandardLro.create_operation(
      operation: result,
      client: zone_operations,
      request_values: {
        "project" => request.project,
        "zone" => request.zone
      },
      options: options
    )
    yield result, response if block_given?
    throw :response, result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#set_tags(request, options = nil) ⇒ `::Gapic::GenericLRO::Operation` #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.

Examples:

Basic example

require "google/cloud/compute/v1"

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

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

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

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

Overloads:

#set_tags(request, options = nil) ⇒ ::Gapic::GenericLRO::Operation

Pass arguments to set_tags via a request object, either of type SetTagsInstanceRequest or an equivalent Hash.
Parameters:
- 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) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#set_tags(instance: nil, project: nil, request_id: nil, tags_resource: nil, zone: nil) ⇒ ::Gapic::GenericLRO::Operation

Pass arguments to 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).
Parameters:
- instance (::String) (defaults to: nil) —
  Name of the instance scoping this request.
- project (::String) (defaults to: nil) —
  Project ID for this request.
- request_id (::String) (defaults to: nil) —
  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) (defaults to: nil) —
  The body resource for this request
- zone (::String) (defaults to: nil) —
  The name of the zone for this request.

Yields:

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

Yield Parameters:

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

Returns:

(::Gapic::GenericLRO::Operation)

Raises:

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

# File 'lib/google/cloud/compute/v1/instances/rest/client.rb', line 3705

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Compute::V1::SetTagsInstanceRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.set_tags.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Compute::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.set_tags.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.set_tags.retry_policy

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

  @instances_stub.set_tags request, options do |result, response|
    result = ::Google::Cloud::Compute::V1::ZoneOperations::Rest::NonstandardLro.create_operation(
      operation: result,
      client: zone_operations,
      request_values: {
        "project" => request.project,
        "zone" => request.zone
      },
      options: options
    )
    yield result, response if block_given?
    throw :response, result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#simulate_maintenance_event(request, options = nil) ⇒ `::Gapic::GenericLRO::Operation` #simulate_maintenance_event(instance: nil, project: nil, request_id: nil, with_extended_notifications: nil, zone: nil) ⇒ `::Gapic::GenericLRO::Operation`

Simulates a host maintenance event on a VM. For more information, see Simulate a host maintenance event.

Examples:

Basic example

require "google/cloud/compute/v1"

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

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

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

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

Overloads:

#simulate_maintenance_event(request, options = nil) ⇒ ::Gapic::GenericLRO::Operation

Pass arguments to simulate_maintenance_event via a request object, either of type SimulateMaintenanceEventInstanceRequest or an equivalent Hash.
Parameters:
- 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) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#simulate_maintenance_event(instance: nil, project: nil, request_id: nil, with_extended_notifications: nil, zone: nil) ⇒ ::Gapic::GenericLRO::Operation

Pass arguments to 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).
Parameters:
- instance (::String) (defaults to: nil) —
  Name of the instance scoping this request.
- project (::String) (defaults to: nil) —
  Project ID for this request.
- request_id (::String) (defaults to: nil) —
  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).
- with_extended_notifications (::Boolean) (defaults to: nil) —
  Determines whether the customers receive notifications before migration. Only applicable to SF vms.
- zone (::String) (defaults to: nil) —
  The name of the zone for this request.

Yields:

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

Yield Parameters:

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

Returns:

(::Gapic::GenericLRO::Operation)

Raises:

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

# File 'lib/google/cloud/compute/v1/instances/rest/client.rb', line 3801

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Compute::V1::SimulateMaintenanceEventInstanceRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.simulate_maintenance_event.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Compute::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.simulate_maintenance_event.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.simulate_maintenance_event.retry_policy

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

  @instances_stub.simulate_maintenance_event request, options do |result, response|
    result = ::Google::Cloud::Compute::V1::ZoneOperations::Rest::NonstandardLro.create_operation(
      operation: result,
      client: zone_operations,
      request_values: {
        "project" => request.project,
        "zone" => request.zone
      },
      options: options
    )
    yield result, response if block_given?
    throw :response, result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#start(request, options = nil) ⇒ `::Gapic::GenericLRO::Operation` #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.

Examples:

Basic example

require "google/cloud/compute/v1"

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

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

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

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

Overloads:

#start(request, options = nil) ⇒ ::Gapic::GenericLRO::Operation

Pass arguments to start via a request object, either of type StartInstanceRequest or an equivalent Hash.
Parameters:
- 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) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#start(instance: nil, project: nil, request_id: nil, zone: nil) ⇒ ::Gapic::GenericLRO::Operation

Pass arguments to 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).
Parameters:
- instance (::String) (defaults to: nil) —
  Name of the instance resource to start.
- project (::String) (defaults to: nil) —
  Project ID for this request.
- request_id (::String) (defaults to: nil) —
  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) (defaults to: nil) —
  The name of the zone for this request.

Yields:

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

Yield Parameters:

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

Returns:

(::Gapic::GenericLRO::Operation)

Raises:

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

# File 'lib/google/cloud/compute/v1/instances/rest/client.rb', line 3895

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Compute::V1::StartInstanceRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.start.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Compute::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.start.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.start.retry_policy

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

  @instances_stub.start request, options do |result, response|
    result = ::Google::Cloud::Compute::V1::ZoneOperations::Rest::NonstandardLro.create_operation(
      operation: result,
      client: zone_operations,
      request_values: {
        "project" => request.project,
        "zone" => request.zone
      },
      options: options
    )
    yield result, response if block_given?
    throw :response, result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#start_with_encryption_key(request, options = nil) ⇒ `::Gapic::GenericLRO::Operation` #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.

Examples:

Basic example

require "google/cloud/compute/v1"

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

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

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

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

Overloads:

#start_with_encryption_key(request, options = nil) ⇒ ::Gapic::GenericLRO::Operation

Pass arguments to start_with_encryption_key via a request object, either of type StartWithEncryptionKeyInstanceRequest or an equivalent Hash.
Parameters:
- 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) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#start_with_encryption_key(instance: nil, instances_start_with_encryption_key_request_resource: nil, project: nil, request_id: nil, zone: nil) ⇒ ::Gapic::GenericLRO::Operation

Pass arguments to 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).
Parameters:
- instance (::String) (defaults to: nil) —
  Name of the instance resource to start.
- instances_start_with_encryption_key_request_resource (::Google::Cloud::Compute::V1::InstancesStartWithEncryptionKeyRequest, ::Hash) (defaults to: nil) —
  The body resource for this request
- project (::String) (defaults to: nil) —
  Project ID for this request.
- request_id (::String) (defaults to: nil) —
  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) (defaults to: nil) —
  The name of the zone for this request.

Yields:

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

Yield Parameters:

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

Returns:

(::Gapic::GenericLRO::Operation)

Raises:

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

# File 'lib/google/cloud/compute/v1/instances/rest/client.rb', line 3991

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Compute::V1::StartWithEncryptionKeyInstanceRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.start_with_encryption_key.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Compute::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.start_with_encryption_key.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.start_with_encryption_key.retry_policy

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

  @instances_stub.start_with_encryption_key request, options do |result, response|
    result = ::Google::Cloud::Compute::V1::ZoneOperations::Rest::NonstandardLro.create_operation(
      operation: result,
      client: zone_operations,
      request_values: {
        "project" => request.project,
        "zone" => request.zone
      },
      options: options
    )
    yield result, response if block_given?
    throw :response, result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#stop(request, options = nil) ⇒ `::Gapic::GenericLRO::Operation` #stop(discard_local_ssd: nil, 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.

Examples:

Basic example

require "google/cloud/compute/v1"

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

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

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

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

Overloads:

#stop(request, options = nil) ⇒ ::Gapic::GenericLRO::Operation

Pass arguments to stop via a request object, either of type StopInstanceRequest or an equivalent Hash.
Parameters:
- 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) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#stop(discard_local_ssd: nil, instance: nil, project: nil, request_id: nil, zone: nil) ⇒ ::Gapic::GenericLRO::Operation

Pass arguments to 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).
Parameters:
- discard_local_ssd (::Boolean) (defaults to: nil) —
  This property is required if the instance has any attached Local SSD disks. If false, Local SSD data will be preserved when the instance is suspended. If true, the contents of any attached Local SSD disks will be discarded.
- instance (::String) (defaults to: nil) —
  Name of the instance resource to stop.
- project (::String) (defaults to: nil) —
  Project ID for this request.
- request_id (::String) (defaults to: nil) —
  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) (defaults to: nil) —
  The name of the zone for this request.

Yields:

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

Yield Parameters:

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

Returns:

(::Gapic::GenericLRO::Operation)

Raises:

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

# File 'lib/google/cloud/compute/v1/instances/rest/client.rb', line 4087

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Compute::V1::StopInstanceRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.stop.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Compute::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.stop.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.stop.retry_policy

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

  @instances_stub.stop request, options do |result, response|
    result = ::Google::Cloud::Compute::V1::ZoneOperations::Rest::NonstandardLro.create_operation(
      operation: result,
      client: zone_operations,
      request_values: {
        "project" => request.project,
        "zone" => request.zone
      },
      options: options
    )
    yield result, response if block_given?
    throw :response, result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#suspend(request, options = nil) ⇒ `::Gapic::GenericLRO::Operation` #suspend(discard_local_ssd: nil, 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.

Examples:

Basic example

require "google/cloud/compute/v1"

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

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

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

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

Overloads:

#suspend(request, options = nil) ⇒ ::Gapic::GenericLRO::Operation

Pass arguments to suspend via a request object, either of type SuspendInstanceRequest or an equivalent Hash.
Parameters:
- 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) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#suspend(discard_local_ssd: nil, instance: nil, project: nil, request_id: nil, zone: nil) ⇒ ::Gapic::GenericLRO::Operation

Pass arguments to 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).
Parameters:
- discard_local_ssd (::Boolean) (defaults to: nil) —
  This property is required if the instance has any attached Local SSD disks. If false, Local SSD data will be preserved when the instance is suspended. If true, the contents of any attached Local SSD disks will be discarded.
- instance (::String) (defaults to: nil) —
  Name of the instance resource to suspend.
- project (::String) (defaults to: nil) —
  Project ID for this request.
- request_id (::String) (defaults to: nil) —
  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) (defaults to: nil) —
  The name of the zone for this request.

Yields:

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

Yield Parameters:

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

Returns:

(::Gapic::GenericLRO::Operation)

Raises:

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

# File 'lib/google/cloud/compute/v1/instances/rest/client.rb', line 4183

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Compute::V1::SuspendInstanceRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.suspend.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Compute::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.suspend.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.suspend.retry_policy

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

  @instances_stub.suspend request, options do |result, response|
    result = ::Google::Cloud::Compute::V1::ZoneOperations::Rest::NonstandardLro.create_operation(
      operation: result,
      client: zone_operations,
      request_values: {
        "project" => request.project,
        "zone" => request.zone
      },
      options: options
    )
    yield result, response if block_given?
    throw :response, result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#test_iam_permissions(request, options = nil) ⇒ `::Google::Cloud::Compute::V1::TestPermissionsResponse` #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.

Examples:

Basic example

require "google/cloud/compute/v1"

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

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

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

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

Overloads:

#test_iam_permissions(request, options = nil) ⇒ ::Google::Cloud::Compute::V1::TestPermissionsResponse

Pass arguments to test_iam_permissions via a request object, either of type TestIamPermissionsInstanceRequest or an equivalent Hash.
Parameters:
- 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) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#test_iam_permissions(project: nil, resource: nil, test_permissions_request_resource: nil, zone: nil) ⇒ ::Google::Cloud::Compute::V1::TestPermissionsResponse

Pass arguments to test_iam_permissions via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- project (::String) (defaults to: nil) —
  Project ID for this request.
- resource (::String) (defaults to: nil) —
  Name or id of the resource for this request.
- test_permissions_request_resource (::Google::Cloud::Compute::V1::TestPermissionsRequest, ::Hash) (defaults to: nil) —
  The body resource for this request
- zone (::String) (defaults to: nil) —
  The name of the zone for this request.

Yields:

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

Yield Parameters:

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

Returns:

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

Raises:

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

# File 'lib/google/cloud/compute/v1/instances/rest/client.rb', line 4277

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Compute::V1::TestIamPermissionsInstanceRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.test_iam_permissions.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Compute::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.test_iam_permissions.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.test_iam_permissions.retry_policy

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

  @instances_stub.test_iam_permissions request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#universe_domain ⇒ `String`

The effective universe domain

Returns:

(String)



231
232
233

# File 'lib/google/cloud/compute/v1/instances/rest/client.rb', line 231

def universe_domain
  @instances_stub.universe_domain
end

#update(request, options = nil) ⇒ `::Gapic::GenericLRO::Operation` #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.

Examples:

Basic example

require "google/cloud/compute/v1"

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

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

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

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

Overloads:

#update(request, options = nil) ⇒ ::Gapic::GenericLRO::Operation

Pass arguments to update via a request object, either of type UpdateInstanceRequest or an equivalent Hash.
Parameters:
- 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) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#update(instance: nil, instance_resource: nil, minimal_action: nil, most_disruptive_allowed_action: nil, project: nil, request_id: nil, zone: nil) ⇒ ::Gapic::GenericLRO::Operation

Pass arguments to update via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters:
- instance (::String) (defaults to: nil) —
  Name of the instance resource to update.
- instance_resource (::Google::Cloud::Compute::V1::Instance, ::Hash) (defaults to: nil) —
  The body resource for this request
- minimal_action (::String) (defaults to: nil) —
  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) (defaults to: nil) —
  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) (defaults to: nil) —
  Project ID for this request.
- request_id (::String) (defaults to: nil) —
  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) (defaults to: nil) —
  The name of the zone for this request.

Yields:

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

Yield Parameters:

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

Returns:

(::Gapic::GenericLRO::Operation)

Raises:

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

# File 'lib/google/cloud/compute/v1/instances/rest/client.rb', line 4369

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Compute::V1::UpdateInstanceRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.update.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Compute::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.update.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.update.retry_policy

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

  @instances_stub.update request, options do |result, response|
    result = ::Google::Cloud::Compute::V1::ZoneOperations::Rest::NonstandardLro.create_operation(
      operation: result,
      client: zone_operations,
      request_values: {
        "project" => request.project,
        "zone" => request.zone
      },
      options: options
    )
    yield result, response if block_given?
    throw :response, result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#update_access_config(request, options = nil) ⇒ `::Gapic::GenericLRO::Operation` #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.

Examples:

Basic example

require "google/cloud/compute/v1"

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

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

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

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

Overloads:

#update_access_config(request, options = nil) ⇒ ::Gapic::GenericLRO::Operation

Pass arguments to update_access_config via a request object, either of type UpdateAccessConfigInstanceRequest or an equivalent Hash.
Parameters:
- 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) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#update_access_config(access_config_resource: nil, instance: nil, network_interface: nil, project: nil, request_id: nil, zone: nil) ⇒ ::Gapic::GenericLRO::Operation

Pass arguments to 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).
Parameters:
- access_config_resource (::Google::Cloud::Compute::V1::AccessConfig, ::Hash) (defaults to: nil) —
  The body resource for this request
- instance (::String) (defaults to: nil) —
  The instance name for this request.
- network_interface (::String) (defaults to: nil) —
  The name of the network interface where the access config is attached.
- project (::String) (defaults to: nil) —
  Project ID for this request.
- request_id (::String) (defaults to: nil) —
  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) (defaults to: nil) —
  The name of the zone for this request.

Yields:

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

Yield Parameters:

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

Returns:

(::Gapic::GenericLRO::Operation)

Raises:

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

# File 'lib/google/cloud/compute/v1/instances/rest/client.rb', line 4467

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Compute::V1::UpdateAccessConfigInstanceRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.update_access_config.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Compute::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.update_access_config.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.update_access_config.retry_policy

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

  @instances_stub.update_access_config request, options do |result, response|
    result = ::Google::Cloud::Compute::V1::ZoneOperations::Rest::NonstandardLro.create_operation(
      operation: result,
      client: zone_operations,
      request_values: {
        "project" => request.project,
        "zone" => request.zone
      },
      options: options
    )
    yield result, response if block_given?
    throw :response, result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#update_display_device(request, options = nil) ⇒ `::Gapic::GenericLRO::Operation` #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.

Examples:

Basic example

require "google/cloud/compute/v1"

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

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

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

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

Overloads:

#update_display_device(request, options = nil) ⇒ ::Gapic::GenericLRO::Operation

Pass arguments to update_display_device via a request object, either of type UpdateDisplayDeviceInstanceRequest or an equivalent Hash.
Parameters:
- 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) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#update_display_device(display_device_resource: nil, instance: nil, project: nil, request_id: nil, zone: nil) ⇒ ::Gapic::GenericLRO::Operation

Pass arguments to 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).
Parameters:
- display_device_resource (::Google::Cloud::Compute::V1::DisplayDevice, ::Hash) (defaults to: nil) —
  The body resource for this request
- instance (::String) (defaults to: nil) —
  Name of the instance scoping this request.
- project (::String) (defaults to: nil) —
  Project ID for this request.
- request_id (::String) (defaults to: nil) —
  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) (defaults to: nil) —
  The name of the zone for this request.

Yields:

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

Yield Parameters:

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

Returns:

(::Gapic::GenericLRO::Operation)

Raises:

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

# File 'lib/google/cloud/compute/v1/instances/rest/client.rb', line 4563

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Compute::V1::UpdateDisplayDeviceInstanceRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.update_display_device.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Compute::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.update_display_device.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.update_display_device.retry_policy

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

  @instances_stub.update_display_device request, options do |result, response|
    result = ::Google::Cloud::Compute::V1::ZoneOperations::Rest::NonstandardLro.create_operation(
      operation: result,
      client: zone_operations,
      request_values: {
        "project" => request.project,
        "zone" => request.zone
      },
      options: options
    )
    yield result, response if block_given?
    throw :response, result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#update_network_interface(request, options = nil) ⇒ `::Gapic::GenericLRO::Operation` #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.

Examples:

Basic example

require "google/cloud/compute/v1"

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

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

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

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

Overloads:

#update_network_interface(request, options = nil) ⇒ ::Gapic::GenericLRO::Operation

Pass arguments to update_network_interface via a request object, either of type UpdateNetworkInterfaceInstanceRequest or an equivalent Hash.
Parameters:
- 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) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#update_network_interface(instance: nil, network_interface: nil, network_interface_resource: nil, project: nil, request_id: nil, zone: nil) ⇒ ::Gapic::GenericLRO::Operation

Pass arguments to 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).
Parameters:
- instance (::String) (defaults to: nil) —
  The instance name for this request.
- network_interface (::String) (defaults to: nil) —
  The name of the network interface to update.
- network_interface_resource (::Google::Cloud::Compute::V1::NetworkInterface, ::Hash) (defaults to: nil) —
  The body resource for this request
- project (::String) (defaults to: nil) —
  Project ID for this request.
- request_id (::String) (defaults to: nil) —
  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) (defaults to: nil) —
  The name of the zone for this request.

Yields:

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

Yield Parameters:

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

Returns:

(::Gapic::GenericLRO::Operation)

Raises:

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

# File 'lib/google/cloud/compute/v1/instances/rest/client.rb', line 4661

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Compute::V1::UpdateNetworkInterfaceInstanceRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.update_network_interface.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Compute::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.update_network_interface.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.update_network_interface.retry_policy

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

  @instances_stub.update_network_interface request, options do |result, response|
    result = ::Google::Cloud::Compute::V1::ZoneOperations::Rest::NonstandardLro.create_operation(
      operation: result,
      client: zone_operations,
      request_values: {
        "project" => request.project,
        "zone" => request.zone
      },
      options: options
    )
    yield result, response if block_given?
    throw :response, result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#update_shielded_instance_config(request, options = nil) ⇒ `::Gapic::GenericLRO::Operation` #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.

Examples:

Basic example

require "google/cloud/compute/v1"

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

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

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

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

Overloads:

#update_shielded_instance_config(request, options = nil) ⇒ ::Gapic::GenericLRO::Operation

Pass arguments to update_shielded_instance_config via a request object, either of type UpdateShieldedInstanceConfigInstanceRequest or an equivalent Hash.
Parameters:
- 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) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#update_shielded_instance_config(instance: nil, project: nil, request_id: nil, shielded_instance_config_resource: nil, zone: nil) ⇒ ::Gapic::GenericLRO::Operation

Pass arguments to 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).
Parameters:
- instance (::String) (defaults to: nil) —
  Name or id of the instance scoping this request.
- project (::String) (defaults to: nil) —
  Project ID for this request.
- request_id (::String) (defaults to: nil) —
  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) (defaults to: nil) —
  The body resource for this request
- zone (::String) (defaults to: nil) —
  The name of the zone for this request.

Yields:

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

Yield Parameters:

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

Returns:

(::Gapic::GenericLRO::Operation)

Raises:

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

# File 'lib/google/cloud/compute/v1/instances/rest/client.rb', line 4757

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Compute::V1::UpdateShieldedInstanceConfigInstanceRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.update_shielded_instance_config.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Compute::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.update_shielded_instance_config.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.update_shielded_instance_config.retry_policy

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

  @instances_stub.update_shielded_instance_config request, options do |result, response|
    result = ::Google::Cloud::Compute::V1::ZoneOperations::Rest::NonstandardLro.create_operation(
      operation: result,
      client: zone_operations,
      request_values: {
        "project" => request.project,
        "zone" => request.zone
      },
      options: options
    )
    yield result, response if block_given?
    throw :response, result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

Class: Google::Cloud::Compute::V1::Instances::Rest::Client

Overview

Defined Under Namespace

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

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

Examples:

Instance Attribute Details

#zone_operations ⇒ ::Google::Cloud::Compute::V1::ZoneOperations::Rest::Client (readonly)

Class Method Details

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

Examples:

Instance Method Details

#add_access_config(request, options = nil) ⇒ ::Gapic::GenericLRO::Operation #add_access_config(access_config_resource: nil, instance: nil, network_interface: nil, project: nil, request_id: nil, zone: nil) ⇒ ::Gapic::GenericLRO::Operation

Examples:

Basic example

#add_resource_policies(request, options = nil) ⇒ ::Gapic::GenericLRO::Operation #add_resource_policies(instance: nil, instances_add_resource_policies_request_resource: nil, project: nil, request_id: nil, zone: nil) ⇒ ::Gapic::GenericLRO::Operation

Examples:

Basic example

Examples:

Basic example

#attach_disk(request, options = nil) ⇒ ::Gapic::GenericLRO::Operation #attach_disk(attached_disk_resource: nil, force_attach: nil, instance: nil, project: nil, request_id: nil, zone: nil) ⇒ ::Gapic::GenericLRO::Operation

Examples:

Basic example

#bulk_insert(request, options = nil) ⇒ ::Gapic::GenericLRO::Operation #bulk_insert(bulk_insert_instance_resource_resource: nil, project: nil, request_id: nil, zone: nil) ⇒ ::Gapic::GenericLRO::Operation

Examples:

Basic example

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

#delete(request, options = nil) ⇒ ::Gapic::GenericLRO::Operation #delete(instance: nil, project: nil, request_id: nil, zone: nil) ⇒ ::Gapic::GenericLRO::Operation

Examples:

Basic example

#delete_access_config(request, options = nil) ⇒ ::Gapic::GenericLRO::Operation #delete_access_config(access_config: nil, instance: nil, network_interface: nil, project: nil, request_id: nil, zone: nil) ⇒ ::Gapic::GenericLRO::Operation

Examples:

Basic example

#detach_disk(request, options = nil) ⇒ ::Gapic::GenericLRO::Operation #detach_disk(device_name: nil, instance: nil, project: nil, request_id: nil, zone: nil) ⇒ ::Gapic::GenericLRO::Operation

Examples:

Basic example

#get(request, options = nil) ⇒ ::Google::Cloud::Compute::V1::Instance #get(instance: nil, project: nil, zone: nil) ⇒ ::Google::Cloud::Compute::V1::Instance

Examples:

Basic example

#get_effective_firewalls(request, options = nil) ⇒ ::Google::Cloud::Compute::V1::InstancesGetEffectiveFirewallsResponse #get_effective_firewalls(instance: nil, network_interface: nil, project: nil, zone: nil) ⇒ ::Google::Cloud::Compute::V1::InstancesGetEffectiveFirewallsResponse

Examples:

Basic example

#get_guest_attributes(request, options = nil) ⇒ ::Google::Cloud::Compute::V1::GuestAttributes #get_guest_attributes(instance: nil, project: nil, query_path: nil, variable_key: nil, zone: nil) ⇒ ::Google::Cloud::Compute::V1::GuestAttributes

Examples:

Basic example

#get_iam_policy(request, options = nil) ⇒ ::Google::Cloud::Compute::V1::Policy #get_iam_policy(options_requested_policy_version: nil, project: nil, resource: nil, zone: nil) ⇒ ::Google::Cloud::Compute::V1::Policy

Examples:

Basic example

#get_screenshot(request, options = nil) ⇒ ::Google::Cloud::Compute::V1::Screenshot #get_screenshot(instance: nil, project: nil, zone: nil) ⇒ ::Google::Cloud::Compute::V1::Screenshot

Examples:

Basic example

#get_serial_port_output(request, options = nil) ⇒ ::Google::Cloud::Compute::V1::SerialPortOutput #get_serial_port_output(instance: nil, port: nil, project: nil, start: nil, zone: nil) ⇒ ::Google::Cloud::Compute::V1::SerialPortOutput

Examples:

Basic example

#get_shielded_instance_identity(request, options = nil) ⇒ ::Google::Cloud::Compute::V1::ShieldedInstanceIdentity #get_shielded_instance_identity(instance: nil, project: nil, zone: nil) ⇒ ::Google::Cloud::Compute::V1::ShieldedInstanceIdentity

Examples:

Basic example

#insert(request, options = nil) ⇒ ::Gapic::GenericLRO::Operation #insert(instance_resource: nil, project: nil, request_id: nil, source_instance_template: nil, source_machine_image: nil, zone: nil) ⇒ ::Gapic::GenericLRO::Operation

Examples:

Basic example

Examples:

Basic example

Examples:

Basic example

#logger ⇒ Logger

#perform_maintenance(request, options = nil) ⇒ ::Gapic::GenericLRO::Operation #perform_maintenance(instance: nil, project: nil, request_id: nil, zone: nil) ⇒ ::Gapic::GenericLRO::Operation

Examples:

Basic example

#remove_resource_policies(request, options = nil) ⇒ ::Gapic::GenericLRO::Operation #remove_resource_policies(instance: nil, instances_remove_resource_policies_request_resource: nil, project: nil, request_id: nil, zone: nil) ⇒ ::Gapic::GenericLRO::Operation

Examples:

Basic example

#reset(request, options = nil) ⇒ ::Gapic::GenericLRO::Operation #reset(instance: nil, project: nil, request_id: nil, zone: nil) ⇒ ::Gapic::GenericLRO::Operation

Examples:

Basic example

#resume(request, options = nil) ⇒ ::Gapic::GenericLRO::Operation #resume(instance: nil, project: nil, request_id: nil, zone: nil) ⇒ ::Gapic::GenericLRO::Operation

Examples:

Basic example

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

#zone_operations ⇒ `::Google::Cloud::Compute::V1::ZoneOperations::Rest::Client` (readonly)

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

#add_access_config(request, options = nil) ⇒ `::Gapic::GenericLRO::Operation` #add_access_config(access_config_resource: nil, instance: nil, network_interface: nil, project: nil, request_id: nil, zone: nil) ⇒ `::Gapic::GenericLRO::Operation`

#add_resource_policies(request, options = nil) ⇒ `::Gapic::GenericLRO::Operation` #add_resource_policies(instance: nil, instances_add_resource_policies_request_resource: nil, project: nil, request_id: nil, zone: nil) ⇒ `::Gapic::GenericLRO::Operation`

#attach_disk(request, options = nil) ⇒ `::Gapic::GenericLRO::Operation` #attach_disk(attached_disk_resource: nil, force_attach: nil, instance: nil, project: nil, request_id: nil, zone: nil) ⇒ `::Gapic::GenericLRO::Operation`

#bulk_insert(request, options = nil) ⇒ `::Gapic::GenericLRO::Operation` #bulk_insert(bulk_insert_instance_resource_resource: nil, project: nil, request_id: nil, zone: nil) ⇒ `::Gapic::GenericLRO::Operation`

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

#delete(request, options = nil) ⇒ `::Gapic::GenericLRO::Operation` #delete(instance: nil, project: nil, request_id: nil, zone: nil) ⇒ `::Gapic::GenericLRO::Operation`

#delete_access_config(request, options = nil) ⇒ `::Gapic::GenericLRO::Operation` #delete_access_config(access_config: nil, instance: nil, network_interface: nil, project: nil, request_id: nil, zone: nil) ⇒ `::Gapic::GenericLRO::Operation`

#detach_disk(request, options = nil) ⇒ `::Gapic::GenericLRO::Operation` #detach_disk(device_name: nil, instance: nil, project: nil, request_id: nil, zone: nil) ⇒ `::Gapic::GenericLRO::Operation`

#get(request, options = nil) ⇒ `::Google::Cloud::Compute::V1::Instance` #get(instance: nil, project: nil, zone: nil) ⇒ `::Google::Cloud::Compute::V1::Instance`

#get_effective_firewalls(request, options = nil) ⇒ `::Google::Cloud::Compute::V1::InstancesGetEffectiveFirewallsResponse` #get_effective_firewalls(instance: nil, network_interface: nil, project: nil, zone: nil) ⇒ `::Google::Cloud::Compute::V1::InstancesGetEffectiveFirewallsResponse`

#get_guest_attributes(request, options = nil) ⇒ `::Google::Cloud::Compute::V1::GuestAttributes` #get_guest_attributes(instance: nil, project: nil, query_path: nil, variable_key: nil, zone: nil) ⇒ `::Google::Cloud::Compute::V1::GuestAttributes`

#get_iam_policy(request, options = nil) ⇒ `::Google::Cloud::Compute::V1::Policy` #get_iam_policy(options_requested_policy_version: nil, project: nil, resource: nil, zone: nil) ⇒ `::Google::Cloud::Compute::V1::Policy`

#get_screenshot(request, options = nil) ⇒ `::Google::Cloud::Compute::V1::Screenshot` #get_screenshot(instance: nil, project: nil, zone: nil) ⇒ `::Google::Cloud::Compute::V1::Screenshot`

#get_serial_port_output(request, options = nil) ⇒ `::Google::Cloud::Compute::V1::SerialPortOutput` #get_serial_port_output(instance: nil, port: nil, project: nil, start: nil, zone: nil) ⇒ `::Google::Cloud::Compute::V1::SerialPortOutput`

#get_shielded_instance_identity(request, options = nil) ⇒ `::Google::Cloud::Compute::V1::ShieldedInstanceIdentity` #get_shielded_instance_identity(instance: nil, project: nil, zone: nil) ⇒ `::Google::Cloud::Compute::V1::ShieldedInstanceIdentity`

#insert(request, options = nil) ⇒ `::Gapic::GenericLRO::Operation` #insert(instance_resource: nil, project: nil, request_id: nil, source_instance_template: nil, source_machine_image: nil, zone: nil) ⇒ `::Gapic::GenericLRO::Operation`

#logger ⇒ `Logger`

#perform_maintenance(request, options = nil) ⇒ `::Gapic::GenericLRO::Operation` #perform_maintenance(instance: nil, project: nil, request_id: nil, zone: nil) ⇒ `::Gapic::GenericLRO::Operation`

#remove_resource_policies(request, options = nil) ⇒ `::Gapic::GenericLRO::Operation` #remove_resource_policies(instance: nil, instances_remove_resource_policies_request_resource: nil, project: nil, request_id: nil, zone: nil) ⇒ `::Gapic::GenericLRO::Operation`

#reset(request, options = nil) ⇒ `::Gapic::GenericLRO::Operation` #reset(instance: nil, project: nil, request_id: nil, zone: nil) ⇒ `::Gapic::GenericLRO::Operation`

#resume(request, options = nil) ⇒ `::Gapic::GenericLRO::Operation` #resume(instance: nil, project: nil, request_id: nil, zone: nil) ⇒ `::Gapic::GenericLRO::Operation`

#send_diagnostic_interrupt(request, options = nil) ⇒ `::Google::Cloud::Compute::V1::SendDiagnosticInterruptInstanceResponse` #send_diagnostic_interrupt(instance: nil, project: nil, zone: nil) ⇒ `::Google::Cloud::Compute::V1::SendDiagnosticInterruptInstanceResponse`

#set_deletion_protection(request, options = nil) ⇒ `::Gapic::GenericLRO::Operation` #set_deletion_protection(deletion_protection: nil, project: nil, request_id: nil, resource: nil, zone: nil) ⇒ `::Gapic::GenericLRO::Operation`

#set_disk_auto_delete(request, options = nil) ⇒ `::Gapic::GenericLRO::Operation` #set_disk_auto_delete(auto_delete: nil, device_name: nil, instance: nil, project: nil, request_id: nil, zone: nil) ⇒ `::Gapic::GenericLRO::Operation`

#set_iam_policy(request, options = nil) ⇒ `::Google::Cloud::Compute::V1::Policy` #set_iam_policy(project: nil, resource: nil, zone: nil, zone_set_policy_request_resource: nil) ⇒ `::Google::Cloud::Compute::V1::Policy`

#set_labels(request, options = nil) ⇒ `::Gapic::GenericLRO::Operation` #set_labels(instance: nil, instances_set_labels_request_resource: nil, project: nil, request_id: nil, zone: nil) ⇒ `::Gapic::GenericLRO::Operation`

#set_machine_resources(request, options = nil) ⇒ `::Gapic::GenericLRO::Operation` #set_machine_resources(instance: nil, instances_set_machine_resources_request_resource: nil, project: nil, request_id: nil, zone: nil) ⇒ `::Gapic::GenericLRO::Operation`

#set_machine_type(request, options = nil) ⇒ `::Gapic::GenericLRO::Operation` #set_machine_type(instance: nil, instances_set_machine_type_request_resource: nil, project: nil, request_id: nil, zone: nil) ⇒ `::Gapic::GenericLRO::Operation`

#set_metadata(request, options = nil) ⇒ `::Gapic::GenericLRO::Operation` #set_metadata(instance: nil, metadata_resource: nil, project: nil, request_id: nil, zone: nil) ⇒ `::Gapic::GenericLRO::Operation`

#set_min_cpu_platform(request, options = nil) ⇒ `::Gapic::GenericLRO::Operation` #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_name(request, options = nil) ⇒ `::Gapic::GenericLRO::Operation` #set_name(instance: nil, instances_set_name_request_resource: nil, project: nil, request_id: nil, zone: nil) ⇒ `::Gapic::GenericLRO::Operation`

#set_scheduling(request, options = nil) ⇒ `::Gapic::GenericLRO::Operation` #set_scheduling(instance: nil, project: nil, request_id: nil, scheduling_resource: nil, zone: nil) ⇒ `::Gapic::GenericLRO::Operation`

#set_security_policy(request, options = nil) ⇒ `::Gapic::GenericLRO::Operation` #set_security_policy(instance: nil, instances_set_security_policy_request_resource: nil, project: nil, request_id: nil, zone: nil) ⇒ `::Gapic::GenericLRO::Operation`

#set_service_account(request, options = nil) ⇒ `::Gapic::GenericLRO::Operation` #set_service_account(instance: nil, instances_set_service_account_request_resource: nil, project: nil, request_id: nil, zone: nil) ⇒ `::Gapic::GenericLRO::Operation`

#set_shielded_instance_integrity_policy(request, options = nil) ⇒ `::Gapic::GenericLRO::Operation` #set_shielded_instance_integrity_policy(instance: nil, project: nil, request_id: nil, shielded_instance_integrity_policy_resource: nil, zone: nil) ⇒ `::Gapic::GenericLRO::Operation`

#set_tags(request, options = nil) ⇒ `::Gapic::GenericLRO::Operation` #set_tags(instance: nil, project: nil, request_id: nil, tags_resource: nil, zone: nil) ⇒ `::Gapic::GenericLRO::Operation`

#simulate_maintenance_event(request, options = nil) ⇒ `::Gapic::GenericLRO::Operation` #simulate_maintenance_event(instance: nil, project: nil, request_id: nil, with_extended_notifications: nil, zone: nil) ⇒ `::Gapic::GenericLRO::Operation`

#start(request, options = nil) ⇒ `::Gapic::GenericLRO::Operation` #start(instance: nil, project: nil, request_id: nil, zone: nil) ⇒ `::Gapic::GenericLRO::Operation`

#start_with_encryption_key(request, options = nil) ⇒ `::Gapic::GenericLRO::Operation` #start_with_encryption_key(instance: nil, instances_start_with_encryption_key_request_resource: nil, project: nil, request_id: nil, zone: nil) ⇒ `::Gapic::GenericLRO::Operation`

#stop(request, options = nil) ⇒ `::Gapic::GenericLRO::Operation` #stop(discard_local_ssd: nil, instance: nil, project: nil, request_id: nil, zone: nil) ⇒ `::Gapic::GenericLRO::Operation`

#suspend(request, options = nil) ⇒ `::Gapic::GenericLRO::Operation` #suspend(discard_local_ssd: nil, instance: nil, project: nil, request_id: nil, zone: nil) ⇒ `::Gapic::GenericLRO::Operation`

#test_iam_permissions(request, options = nil) ⇒ `::Google::Cloud::Compute::V1::TestPermissionsResponse` #test_iam_permissions(project: nil, resource: nil, test_permissions_request_resource: nil, zone: nil) ⇒ `::Google::Cloud::Compute::V1::TestPermissionsResponse`

#universe_domain ⇒ `String`

#update(request, options = nil) ⇒ `::Gapic::GenericLRO::Operation` #update(instance: nil, instance_resource: nil, minimal_action: nil, most_disruptive_allowed_action: nil, project: nil, request_id: nil, zone: nil) ⇒ `::Gapic::GenericLRO::Operation`