Class: Google::Cloud::Compute::V1::Instance

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/compute/v1/compute.rb

Overview

Represents an Instance resource. An instance is a virtual machine that is hosted on Google Cloud Platform. For more information, read Virtual Machine Instances.

Defined Under Namespace

Modules: KeyRevocationActionType, PrivateIpv6GoogleAccess, Status Classes: LabelsEntry

Instance Attribute Summary collapse

Instance Attribute Details

#advanced_machine_features::Google::Cloud::Compute::V1::AdvancedMachineFeatures

Returns Controls for advanced machine-related behavior features.

Returns:



13474
13475
13476
13477
13478
13479
13480
13481
13482
13483
13484
13485
13486
13487
13488
13489
13490
13491
13492
13493
13494
13495
13496
13497
13498
13499
13500
13501
13502
13503
13504
13505
13506
13507
13508
13509
13510
13511
13512
13513
13514
13515
13516
13517
13518
13519
13520
13521
13522
13523
13524
13525
13526
13527
13528
13529
13530
13531
13532
13533
13534
13535
13536
13537
13538
13539
13540
13541
13542
13543
13544
13545
13546
13547
13548
13549
13550
13551
13552
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 13474

class Instance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # KeyRevocationActionType of the instance. Supported options are "STOP" and "NONE". The default value is "NONE" if it is not specified.
  module KeyRevocationActionType
    # A value indicating that the enum field is not set.
    UNDEFINED_KEY_REVOCATION_ACTION_TYPE = 0

    # Default value. This value is unused.
    KEY_REVOCATION_ACTION_TYPE_UNSPECIFIED = 467_110_106

    # Indicates user chose no operation.
    NONE = 2_402_104

    # Indicates user chose to opt for VM shutdown on key revocation.
    STOP = 2_555_906
  end

  # The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default.
  module PrivateIpv6GoogleAccess
    # A value indicating that the enum field is not set.
    UNDEFINED_PRIVATE_IPV6_GOOGLE_ACCESS = 0

    # Bidirectional private IPv6 access to/from Google services. If specified, the subnetwork who is attached to the instance's default network interface will be assigned an internal IPv6 prefix if it doesn't have before.
    ENABLE_BIDIRECTIONAL_ACCESS_TO_GOOGLE = 427_975_994

    # Outbound private IPv6 access from VMs in this subnet to Google services. If specified, the subnetwork who is attached to the instance's default network interface will be assigned an internal IPv6 prefix if it doesn't have before.
    ENABLE_OUTBOUND_VM_ACCESS_TO_GOOGLE = 288_210_263

    # Each network interface inherits PrivateIpv6GoogleAccess from its subnetwork.
    INHERIT_FROM_SUBNETWORK = 530_256_959
  end

  # [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, REPAIRING, and TERMINATED. For more information about the status of the instance, see Instance life cycle.
  module Status
    # A value indicating that the enum field is not set.
    UNDEFINED_STATUS = 0

    # The instance is halted and we are performing tear down tasks like network deprogramming, releasing quota, IP, tearing down disks etc.
    DEPROVISIONING = 428_935_662

    # Resources are being allocated for the instance.
    PROVISIONING = 290_896_621

    # The instance is in repair.
    REPAIRING = 413_483_285

    # The instance is running.
    RUNNING = 121_282_975

    # All required resources have been allocated and the instance is being started.
    STAGING = 431_072_283

    # The instance has stopped successfully.
    STOPPED = 444_276_141

    # The instance is currently stopping (either being deleted or killed).
    STOPPING = 350_791_796

    # The instance has suspended.
    SUSPENDED = 51_223_995

    # The instance is suspending.
    SUSPENDING = 514_206_246

    # The instance has stopped (either by explicit action or underlying failure).
    TERMINATED = 250_018_339
  end
end

#can_ip_forward::Boolean

Returns Allows this instance to send and receive packets with non-matching destination or source IPs. This is required if you plan to use this instance to forward routes. For more information, see Enabling IP Forwarding .

Returns:

  • (::Boolean)

    Allows this instance to send and receive packets with non-matching destination or source IPs. This is required if you plan to use this instance to forward routes. For more information, see Enabling IP Forwarding .



13474
13475
13476
13477
13478
13479
13480
13481
13482
13483
13484
13485
13486
13487
13488
13489
13490
13491
13492
13493
13494
13495
13496
13497
13498
13499
13500
13501
13502
13503
13504
13505
13506
13507
13508
13509
13510
13511
13512
13513
13514
13515
13516
13517
13518
13519
13520
13521
13522
13523
13524
13525
13526
13527
13528
13529
13530
13531
13532
13533
13534
13535
13536
13537
13538
13539
13540
13541
13542
13543
13544
13545
13546
13547
13548
13549
13550
13551
13552
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 13474

class Instance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # KeyRevocationActionType of the instance. Supported options are "STOP" and "NONE". The default value is "NONE" if it is not specified.
  module KeyRevocationActionType
    # A value indicating that the enum field is not set.
    UNDEFINED_KEY_REVOCATION_ACTION_TYPE = 0

    # Default value. This value is unused.
    KEY_REVOCATION_ACTION_TYPE_UNSPECIFIED = 467_110_106

    # Indicates user chose no operation.
    NONE = 2_402_104

    # Indicates user chose to opt for VM shutdown on key revocation.
    STOP = 2_555_906
  end

  # The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default.
  module PrivateIpv6GoogleAccess
    # A value indicating that the enum field is not set.
    UNDEFINED_PRIVATE_IPV6_GOOGLE_ACCESS = 0

    # Bidirectional private IPv6 access to/from Google services. If specified, the subnetwork who is attached to the instance's default network interface will be assigned an internal IPv6 prefix if it doesn't have before.
    ENABLE_BIDIRECTIONAL_ACCESS_TO_GOOGLE = 427_975_994

    # Outbound private IPv6 access from VMs in this subnet to Google services. If specified, the subnetwork who is attached to the instance's default network interface will be assigned an internal IPv6 prefix if it doesn't have before.
    ENABLE_OUTBOUND_VM_ACCESS_TO_GOOGLE = 288_210_263

    # Each network interface inherits PrivateIpv6GoogleAccess from its subnetwork.
    INHERIT_FROM_SUBNETWORK = 530_256_959
  end

  # [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, REPAIRING, and TERMINATED. For more information about the status of the instance, see Instance life cycle.
  module Status
    # A value indicating that the enum field is not set.
    UNDEFINED_STATUS = 0

    # The instance is halted and we are performing tear down tasks like network deprogramming, releasing quota, IP, tearing down disks etc.
    DEPROVISIONING = 428_935_662

    # Resources are being allocated for the instance.
    PROVISIONING = 290_896_621

    # The instance is in repair.
    REPAIRING = 413_483_285

    # The instance is running.
    RUNNING = 121_282_975

    # All required resources have been allocated and the instance is being started.
    STAGING = 431_072_283

    # The instance has stopped successfully.
    STOPPED = 444_276_141

    # The instance is currently stopping (either being deleted or killed).
    STOPPING = 350_791_796

    # The instance has suspended.
    SUSPENDED = 51_223_995

    # The instance is suspending.
    SUSPENDING = 514_206_246

    # The instance has stopped (either by explicit action or underlying failure).
    TERMINATED = 250_018_339
  end
end

#confidential_instance_config::Google::Cloud::Compute::V1::ConfidentialInstanceConfig



13474
13475
13476
13477
13478
13479
13480
13481
13482
13483
13484
13485
13486
13487
13488
13489
13490
13491
13492
13493
13494
13495
13496
13497
13498
13499
13500
13501
13502
13503
13504
13505
13506
13507
13508
13509
13510
13511
13512
13513
13514
13515
13516
13517
13518
13519
13520
13521
13522
13523
13524
13525
13526
13527
13528
13529
13530
13531
13532
13533
13534
13535
13536
13537
13538
13539
13540
13541
13542
13543
13544
13545
13546
13547
13548
13549
13550
13551
13552
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 13474

class Instance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # KeyRevocationActionType of the instance. Supported options are "STOP" and "NONE". The default value is "NONE" if it is not specified.
  module KeyRevocationActionType
    # A value indicating that the enum field is not set.
    UNDEFINED_KEY_REVOCATION_ACTION_TYPE = 0

    # Default value. This value is unused.
    KEY_REVOCATION_ACTION_TYPE_UNSPECIFIED = 467_110_106

    # Indicates user chose no operation.
    NONE = 2_402_104

    # Indicates user chose to opt for VM shutdown on key revocation.
    STOP = 2_555_906
  end

  # The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default.
  module PrivateIpv6GoogleAccess
    # A value indicating that the enum field is not set.
    UNDEFINED_PRIVATE_IPV6_GOOGLE_ACCESS = 0

    # Bidirectional private IPv6 access to/from Google services. If specified, the subnetwork who is attached to the instance's default network interface will be assigned an internal IPv6 prefix if it doesn't have before.
    ENABLE_BIDIRECTIONAL_ACCESS_TO_GOOGLE = 427_975_994

    # Outbound private IPv6 access from VMs in this subnet to Google services. If specified, the subnetwork who is attached to the instance's default network interface will be assigned an internal IPv6 prefix if it doesn't have before.
    ENABLE_OUTBOUND_VM_ACCESS_TO_GOOGLE = 288_210_263

    # Each network interface inherits PrivateIpv6GoogleAccess from its subnetwork.
    INHERIT_FROM_SUBNETWORK = 530_256_959
  end

  # [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, REPAIRING, and TERMINATED. For more information about the status of the instance, see Instance life cycle.
  module Status
    # A value indicating that the enum field is not set.
    UNDEFINED_STATUS = 0

    # The instance is halted and we are performing tear down tasks like network deprogramming, releasing quota, IP, tearing down disks etc.
    DEPROVISIONING = 428_935_662

    # Resources are being allocated for the instance.
    PROVISIONING = 290_896_621

    # The instance is in repair.
    REPAIRING = 413_483_285

    # The instance is running.
    RUNNING = 121_282_975

    # All required resources have been allocated and the instance is being started.
    STAGING = 431_072_283

    # The instance has stopped successfully.
    STOPPED = 444_276_141

    # The instance is currently stopping (either being deleted or killed).
    STOPPING = 350_791_796

    # The instance has suspended.
    SUSPENDED = 51_223_995

    # The instance is suspending.
    SUSPENDING = 514_206_246

    # The instance has stopped (either by explicit action or underlying failure).
    TERMINATED = 250_018_339
  end
end

#cpu_platform::String

Returns [Output Only] The CPU platform used by this instance.

Returns:

  • (::String)

    [Output Only] The CPU platform used by this instance.



13474
13475
13476
13477
13478
13479
13480
13481
13482
13483
13484
13485
13486
13487
13488
13489
13490
13491
13492
13493
13494
13495
13496
13497
13498
13499
13500
13501
13502
13503
13504
13505
13506
13507
13508
13509
13510
13511
13512
13513
13514
13515
13516
13517
13518
13519
13520
13521
13522
13523
13524
13525
13526
13527
13528
13529
13530
13531
13532
13533
13534
13535
13536
13537
13538
13539
13540
13541
13542
13543
13544
13545
13546
13547
13548
13549
13550
13551
13552
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 13474

class Instance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # KeyRevocationActionType of the instance. Supported options are "STOP" and "NONE". The default value is "NONE" if it is not specified.
  module KeyRevocationActionType
    # A value indicating that the enum field is not set.
    UNDEFINED_KEY_REVOCATION_ACTION_TYPE = 0

    # Default value. This value is unused.
    KEY_REVOCATION_ACTION_TYPE_UNSPECIFIED = 467_110_106

    # Indicates user chose no operation.
    NONE = 2_402_104

    # Indicates user chose to opt for VM shutdown on key revocation.
    STOP = 2_555_906
  end

  # The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default.
  module PrivateIpv6GoogleAccess
    # A value indicating that the enum field is not set.
    UNDEFINED_PRIVATE_IPV6_GOOGLE_ACCESS = 0

    # Bidirectional private IPv6 access to/from Google services. If specified, the subnetwork who is attached to the instance's default network interface will be assigned an internal IPv6 prefix if it doesn't have before.
    ENABLE_BIDIRECTIONAL_ACCESS_TO_GOOGLE = 427_975_994

    # Outbound private IPv6 access from VMs in this subnet to Google services. If specified, the subnetwork who is attached to the instance's default network interface will be assigned an internal IPv6 prefix if it doesn't have before.
    ENABLE_OUTBOUND_VM_ACCESS_TO_GOOGLE = 288_210_263

    # Each network interface inherits PrivateIpv6GoogleAccess from its subnetwork.
    INHERIT_FROM_SUBNETWORK = 530_256_959
  end

  # [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, REPAIRING, and TERMINATED. For more information about the status of the instance, see Instance life cycle.
  module Status
    # A value indicating that the enum field is not set.
    UNDEFINED_STATUS = 0

    # The instance is halted and we are performing tear down tasks like network deprogramming, releasing quota, IP, tearing down disks etc.
    DEPROVISIONING = 428_935_662

    # Resources are being allocated for the instance.
    PROVISIONING = 290_896_621

    # The instance is in repair.
    REPAIRING = 413_483_285

    # The instance is running.
    RUNNING = 121_282_975

    # All required resources have been allocated and the instance is being started.
    STAGING = 431_072_283

    # The instance has stopped successfully.
    STOPPED = 444_276_141

    # The instance is currently stopping (either being deleted or killed).
    STOPPING = 350_791_796

    # The instance has suspended.
    SUSPENDED = 51_223_995

    # The instance is suspending.
    SUSPENDING = 514_206_246

    # The instance has stopped (either by explicit action or underlying failure).
    TERMINATED = 250_018_339
  end
end

#creation_timestamp::String

Returns [Output Only] Creation timestamp in RFC3339 text format.

Returns:

  • (::String)

    [Output Only] Creation timestamp in RFC3339 text format.



13474
13475
13476
13477
13478
13479
13480
13481
13482
13483
13484
13485
13486
13487
13488
13489
13490
13491
13492
13493
13494
13495
13496
13497
13498
13499
13500
13501
13502
13503
13504
13505
13506
13507
13508
13509
13510
13511
13512
13513
13514
13515
13516
13517
13518
13519
13520
13521
13522
13523
13524
13525
13526
13527
13528
13529
13530
13531
13532
13533
13534
13535
13536
13537
13538
13539
13540
13541
13542
13543
13544
13545
13546
13547
13548
13549
13550
13551
13552
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 13474

class Instance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # KeyRevocationActionType of the instance. Supported options are "STOP" and "NONE". The default value is "NONE" if it is not specified.
  module KeyRevocationActionType
    # A value indicating that the enum field is not set.
    UNDEFINED_KEY_REVOCATION_ACTION_TYPE = 0

    # Default value. This value is unused.
    KEY_REVOCATION_ACTION_TYPE_UNSPECIFIED = 467_110_106

    # Indicates user chose no operation.
    NONE = 2_402_104

    # Indicates user chose to opt for VM shutdown on key revocation.
    STOP = 2_555_906
  end

  # The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default.
  module PrivateIpv6GoogleAccess
    # A value indicating that the enum field is not set.
    UNDEFINED_PRIVATE_IPV6_GOOGLE_ACCESS = 0

    # Bidirectional private IPv6 access to/from Google services. If specified, the subnetwork who is attached to the instance's default network interface will be assigned an internal IPv6 prefix if it doesn't have before.
    ENABLE_BIDIRECTIONAL_ACCESS_TO_GOOGLE = 427_975_994

    # Outbound private IPv6 access from VMs in this subnet to Google services. If specified, the subnetwork who is attached to the instance's default network interface will be assigned an internal IPv6 prefix if it doesn't have before.
    ENABLE_OUTBOUND_VM_ACCESS_TO_GOOGLE = 288_210_263

    # Each network interface inherits PrivateIpv6GoogleAccess from its subnetwork.
    INHERIT_FROM_SUBNETWORK = 530_256_959
  end

  # [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, REPAIRING, and TERMINATED. For more information about the status of the instance, see Instance life cycle.
  module Status
    # A value indicating that the enum field is not set.
    UNDEFINED_STATUS = 0

    # The instance is halted and we are performing tear down tasks like network deprogramming, releasing quota, IP, tearing down disks etc.
    DEPROVISIONING = 428_935_662

    # Resources are being allocated for the instance.
    PROVISIONING = 290_896_621

    # The instance is in repair.
    REPAIRING = 413_483_285

    # The instance is running.
    RUNNING = 121_282_975

    # All required resources have been allocated and the instance is being started.
    STAGING = 431_072_283

    # The instance has stopped successfully.
    STOPPED = 444_276_141

    # The instance is currently stopping (either being deleted or killed).
    STOPPING = 350_791_796

    # The instance has suspended.
    SUSPENDED = 51_223_995

    # The instance is suspending.
    SUSPENDING = 514_206_246

    # The instance has stopped (either by explicit action or underlying failure).
    TERMINATED = 250_018_339
  end
end

#deletion_protection::Boolean

Returns Whether the resource should be protected against deletion.

Returns:

  • (::Boolean)

    Whether the resource should be protected against deletion.



13474
13475
13476
13477
13478
13479
13480
13481
13482
13483
13484
13485
13486
13487
13488
13489
13490
13491
13492
13493
13494
13495
13496
13497
13498
13499
13500
13501
13502
13503
13504
13505
13506
13507
13508
13509
13510
13511
13512
13513
13514
13515
13516
13517
13518
13519
13520
13521
13522
13523
13524
13525
13526
13527
13528
13529
13530
13531
13532
13533
13534
13535
13536
13537
13538
13539
13540
13541
13542
13543
13544
13545
13546
13547
13548
13549
13550
13551
13552
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 13474

class Instance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # KeyRevocationActionType of the instance. Supported options are "STOP" and "NONE". The default value is "NONE" if it is not specified.
  module KeyRevocationActionType
    # A value indicating that the enum field is not set.
    UNDEFINED_KEY_REVOCATION_ACTION_TYPE = 0

    # Default value. This value is unused.
    KEY_REVOCATION_ACTION_TYPE_UNSPECIFIED = 467_110_106

    # Indicates user chose no operation.
    NONE = 2_402_104

    # Indicates user chose to opt for VM shutdown on key revocation.
    STOP = 2_555_906
  end

  # The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default.
  module PrivateIpv6GoogleAccess
    # A value indicating that the enum field is not set.
    UNDEFINED_PRIVATE_IPV6_GOOGLE_ACCESS = 0

    # Bidirectional private IPv6 access to/from Google services. If specified, the subnetwork who is attached to the instance's default network interface will be assigned an internal IPv6 prefix if it doesn't have before.
    ENABLE_BIDIRECTIONAL_ACCESS_TO_GOOGLE = 427_975_994

    # Outbound private IPv6 access from VMs in this subnet to Google services. If specified, the subnetwork who is attached to the instance's default network interface will be assigned an internal IPv6 prefix if it doesn't have before.
    ENABLE_OUTBOUND_VM_ACCESS_TO_GOOGLE = 288_210_263

    # Each network interface inherits PrivateIpv6GoogleAccess from its subnetwork.
    INHERIT_FROM_SUBNETWORK = 530_256_959
  end

  # [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, REPAIRING, and TERMINATED. For more information about the status of the instance, see Instance life cycle.
  module Status
    # A value indicating that the enum field is not set.
    UNDEFINED_STATUS = 0

    # The instance is halted and we are performing tear down tasks like network deprogramming, releasing quota, IP, tearing down disks etc.
    DEPROVISIONING = 428_935_662

    # Resources are being allocated for the instance.
    PROVISIONING = 290_896_621

    # The instance is in repair.
    REPAIRING = 413_483_285

    # The instance is running.
    RUNNING = 121_282_975

    # All required resources have been allocated and the instance is being started.
    STAGING = 431_072_283

    # The instance has stopped successfully.
    STOPPED = 444_276_141

    # The instance is currently stopping (either being deleted or killed).
    STOPPING = 350_791_796

    # The instance has suspended.
    SUSPENDED = 51_223_995

    # The instance is suspending.
    SUSPENDING = 514_206_246

    # The instance has stopped (either by explicit action or underlying failure).
    TERMINATED = 250_018_339
  end
end

#description::String

Returns An optional description of this resource. Provide this property when you create the resource.

Returns:

  • (::String)

    An optional description of this resource. Provide this property when you create the resource.



13474
13475
13476
13477
13478
13479
13480
13481
13482
13483
13484
13485
13486
13487
13488
13489
13490
13491
13492
13493
13494
13495
13496
13497
13498
13499
13500
13501
13502
13503
13504
13505
13506
13507
13508
13509
13510
13511
13512
13513
13514
13515
13516
13517
13518
13519
13520
13521
13522
13523
13524
13525
13526
13527
13528
13529
13530
13531
13532
13533
13534
13535
13536
13537
13538
13539
13540
13541
13542
13543
13544
13545
13546
13547
13548
13549
13550
13551
13552
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 13474

class Instance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # KeyRevocationActionType of the instance. Supported options are "STOP" and "NONE". The default value is "NONE" if it is not specified.
  module KeyRevocationActionType
    # A value indicating that the enum field is not set.
    UNDEFINED_KEY_REVOCATION_ACTION_TYPE = 0

    # Default value. This value is unused.
    KEY_REVOCATION_ACTION_TYPE_UNSPECIFIED = 467_110_106

    # Indicates user chose no operation.
    NONE = 2_402_104

    # Indicates user chose to opt for VM shutdown on key revocation.
    STOP = 2_555_906
  end

  # The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default.
  module PrivateIpv6GoogleAccess
    # A value indicating that the enum field is not set.
    UNDEFINED_PRIVATE_IPV6_GOOGLE_ACCESS = 0

    # Bidirectional private IPv6 access to/from Google services. If specified, the subnetwork who is attached to the instance's default network interface will be assigned an internal IPv6 prefix if it doesn't have before.
    ENABLE_BIDIRECTIONAL_ACCESS_TO_GOOGLE = 427_975_994

    # Outbound private IPv6 access from VMs in this subnet to Google services. If specified, the subnetwork who is attached to the instance's default network interface will be assigned an internal IPv6 prefix if it doesn't have before.
    ENABLE_OUTBOUND_VM_ACCESS_TO_GOOGLE = 288_210_263

    # Each network interface inherits PrivateIpv6GoogleAccess from its subnetwork.
    INHERIT_FROM_SUBNETWORK = 530_256_959
  end

  # [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, REPAIRING, and TERMINATED. For more information about the status of the instance, see Instance life cycle.
  module Status
    # A value indicating that the enum field is not set.
    UNDEFINED_STATUS = 0

    # The instance is halted and we are performing tear down tasks like network deprogramming, releasing quota, IP, tearing down disks etc.
    DEPROVISIONING = 428_935_662

    # Resources are being allocated for the instance.
    PROVISIONING = 290_896_621

    # The instance is in repair.
    REPAIRING = 413_483_285

    # The instance is running.
    RUNNING = 121_282_975

    # All required resources have been allocated and the instance is being started.
    STAGING = 431_072_283

    # The instance has stopped successfully.
    STOPPED = 444_276_141

    # The instance is currently stopping (either being deleted or killed).
    STOPPING = 350_791_796

    # The instance has suspended.
    SUSPENDED = 51_223_995

    # The instance is suspending.
    SUSPENDING = 514_206_246

    # The instance has stopped (either by explicit action or underlying failure).
    TERMINATED = 250_018_339
  end
end

#disks::Array<::Google::Cloud::Compute::V1::AttachedDisk>

Returns Array of disks associated with this instance. Persistent disks must be created before you can assign them.

Returns:



13474
13475
13476
13477
13478
13479
13480
13481
13482
13483
13484
13485
13486
13487
13488
13489
13490
13491
13492
13493
13494
13495
13496
13497
13498
13499
13500
13501
13502
13503
13504
13505
13506
13507
13508
13509
13510
13511
13512
13513
13514
13515
13516
13517
13518
13519
13520
13521
13522
13523
13524
13525
13526
13527
13528
13529
13530
13531
13532
13533
13534
13535
13536
13537
13538
13539
13540
13541
13542
13543
13544
13545
13546
13547
13548
13549
13550
13551
13552
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 13474

class Instance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # KeyRevocationActionType of the instance. Supported options are "STOP" and "NONE". The default value is "NONE" if it is not specified.
  module KeyRevocationActionType
    # A value indicating that the enum field is not set.
    UNDEFINED_KEY_REVOCATION_ACTION_TYPE = 0

    # Default value. This value is unused.
    KEY_REVOCATION_ACTION_TYPE_UNSPECIFIED = 467_110_106

    # Indicates user chose no operation.
    NONE = 2_402_104

    # Indicates user chose to opt for VM shutdown on key revocation.
    STOP = 2_555_906
  end

  # The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default.
  module PrivateIpv6GoogleAccess
    # A value indicating that the enum field is not set.
    UNDEFINED_PRIVATE_IPV6_GOOGLE_ACCESS = 0

    # Bidirectional private IPv6 access to/from Google services. If specified, the subnetwork who is attached to the instance's default network interface will be assigned an internal IPv6 prefix if it doesn't have before.
    ENABLE_BIDIRECTIONAL_ACCESS_TO_GOOGLE = 427_975_994

    # Outbound private IPv6 access from VMs in this subnet to Google services. If specified, the subnetwork who is attached to the instance's default network interface will be assigned an internal IPv6 prefix if it doesn't have before.
    ENABLE_OUTBOUND_VM_ACCESS_TO_GOOGLE = 288_210_263

    # Each network interface inherits PrivateIpv6GoogleAccess from its subnetwork.
    INHERIT_FROM_SUBNETWORK = 530_256_959
  end

  # [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, REPAIRING, and TERMINATED. For more information about the status of the instance, see Instance life cycle.
  module Status
    # A value indicating that the enum field is not set.
    UNDEFINED_STATUS = 0

    # The instance is halted and we are performing tear down tasks like network deprogramming, releasing quota, IP, tearing down disks etc.
    DEPROVISIONING = 428_935_662

    # Resources are being allocated for the instance.
    PROVISIONING = 290_896_621

    # The instance is in repair.
    REPAIRING = 413_483_285

    # The instance is running.
    RUNNING = 121_282_975

    # All required resources have been allocated and the instance is being started.
    STAGING = 431_072_283

    # The instance has stopped successfully.
    STOPPED = 444_276_141

    # The instance is currently stopping (either being deleted or killed).
    STOPPING = 350_791_796

    # The instance has suspended.
    SUSPENDED = 51_223_995

    # The instance is suspending.
    SUSPENDING = 514_206_246

    # The instance has stopped (either by explicit action or underlying failure).
    TERMINATED = 250_018_339
  end
end

#display_device::Google::Cloud::Compute::V1::DisplayDevice

Returns Enables display device for the instance.

Returns:



13474
13475
13476
13477
13478
13479
13480
13481
13482
13483
13484
13485
13486
13487
13488
13489
13490
13491
13492
13493
13494
13495
13496
13497
13498
13499
13500
13501
13502
13503
13504
13505
13506
13507
13508
13509
13510
13511
13512
13513
13514
13515
13516
13517
13518
13519
13520
13521
13522
13523
13524
13525
13526
13527
13528
13529
13530
13531
13532
13533
13534
13535
13536
13537
13538
13539
13540
13541
13542
13543
13544
13545
13546
13547
13548
13549
13550
13551
13552
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 13474

class Instance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # KeyRevocationActionType of the instance. Supported options are "STOP" and "NONE". The default value is "NONE" if it is not specified.
  module KeyRevocationActionType
    # A value indicating that the enum field is not set.
    UNDEFINED_KEY_REVOCATION_ACTION_TYPE = 0

    # Default value. This value is unused.
    KEY_REVOCATION_ACTION_TYPE_UNSPECIFIED = 467_110_106

    # Indicates user chose no operation.
    NONE = 2_402_104

    # Indicates user chose to opt for VM shutdown on key revocation.
    STOP = 2_555_906
  end

  # The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default.
  module PrivateIpv6GoogleAccess
    # A value indicating that the enum field is not set.
    UNDEFINED_PRIVATE_IPV6_GOOGLE_ACCESS = 0

    # Bidirectional private IPv6 access to/from Google services. If specified, the subnetwork who is attached to the instance's default network interface will be assigned an internal IPv6 prefix if it doesn't have before.
    ENABLE_BIDIRECTIONAL_ACCESS_TO_GOOGLE = 427_975_994

    # Outbound private IPv6 access from VMs in this subnet to Google services. If specified, the subnetwork who is attached to the instance's default network interface will be assigned an internal IPv6 prefix if it doesn't have before.
    ENABLE_OUTBOUND_VM_ACCESS_TO_GOOGLE = 288_210_263

    # Each network interface inherits PrivateIpv6GoogleAccess from its subnetwork.
    INHERIT_FROM_SUBNETWORK = 530_256_959
  end

  # [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, REPAIRING, and TERMINATED. For more information about the status of the instance, see Instance life cycle.
  module Status
    # A value indicating that the enum field is not set.
    UNDEFINED_STATUS = 0

    # The instance is halted and we are performing tear down tasks like network deprogramming, releasing quota, IP, tearing down disks etc.
    DEPROVISIONING = 428_935_662

    # Resources are being allocated for the instance.
    PROVISIONING = 290_896_621

    # The instance is in repair.
    REPAIRING = 413_483_285

    # The instance is running.
    RUNNING = 121_282_975

    # All required resources have been allocated and the instance is being started.
    STAGING = 431_072_283

    # The instance has stopped successfully.
    STOPPED = 444_276_141

    # The instance is currently stopping (either being deleted or killed).
    STOPPING = 350_791_796

    # The instance has suspended.
    SUSPENDED = 51_223_995

    # The instance is suspending.
    SUSPENDING = 514_206_246

    # The instance has stopped (either by explicit action or underlying failure).
    TERMINATED = 250_018_339
  end
end

#fingerprint::String

Returns Specifies a fingerprint for this resource, which is essentially a hash of the instance's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update the instance. You must always provide an up-to-date fingerprint hash in order to update the instance. To see the latest fingerprint, make get() request to the instance.

Returns:

  • (::String)

    Specifies a fingerprint for this resource, which is essentially a hash of the instance's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update the instance. You must always provide an up-to-date fingerprint hash in order to update the instance. To see the latest fingerprint, make get() request to the instance.



13474
13475
13476
13477
13478
13479
13480
13481
13482
13483
13484
13485
13486
13487
13488
13489
13490
13491
13492
13493
13494
13495
13496
13497
13498
13499
13500
13501
13502
13503
13504
13505
13506
13507
13508
13509
13510
13511
13512
13513
13514
13515
13516
13517
13518
13519
13520
13521
13522
13523
13524
13525
13526
13527
13528
13529
13530
13531
13532
13533
13534
13535
13536
13537
13538
13539
13540
13541
13542
13543
13544
13545
13546
13547
13548
13549
13550
13551
13552
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 13474

class Instance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # KeyRevocationActionType of the instance. Supported options are "STOP" and "NONE". The default value is "NONE" if it is not specified.
  module KeyRevocationActionType
    # A value indicating that the enum field is not set.
    UNDEFINED_KEY_REVOCATION_ACTION_TYPE = 0

    # Default value. This value is unused.
    KEY_REVOCATION_ACTION_TYPE_UNSPECIFIED = 467_110_106

    # Indicates user chose no operation.
    NONE = 2_402_104

    # Indicates user chose to opt for VM shutdown on key revocation.
    STOP = 2_555_906
  end

  # The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default.
  module PrivateIpv6GoogleAccess
    # A value indicating that the enum field is not set.
    UNDEFINED_PRIVATE_IPV6_GOOGLE_ACCESS = 0

    # Bidirectional private IPv6 access to/from Google services. If specified, the subnetwork who is attached to the instance's default network interface will be assigned an internal IPv6 prefix if it doesn't have before.
    ENABLE_BIDIRECTIONAL_ACCESS_TO_GOOGLE = 427_975_994

    # Outbound private IPv6 access from VMs in this subnet to Google services. If specified, the subnetwork who is attached to the instance's default network interface will be assigned an internal IPv6 prefix if it doesn't have before.
    ENABLE_OUTBOUND_VM_ACCESS_TO_GOOGLE = 288_210_263

    # Each network interface inherits PrivateIpv6GoogleAccess from its subnetwork.
    INHERIT_FROM_SUBNETWORK = 530_256_959
  end

  # [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, REPAIRING, and TERMINATED. For more information about the status of the instance, see Instance life cycle.
  module Status
    # A value indicating that the enum field is not set.
    UNDEFINED_STATUS = 0

    # The instance is halted and we are performing tear down tasks like network deprogramming, releasing quota, IP, tearing down disks etc.
    DEPROVISIONING = 428_935_662

    # Resources are being allocated for the instance.
    PROVISIONING = 290_896_621

    # The instance is in repair.
    REPAIRING = 413_483_285

    # The instance is running.
    RUNNING = 121_282_975

    # All required resources have been allocated and the instance is being started.
    STAGING = 431_072_283

    # The instance has stopped successfully.
    STOPPED = 444_276_141

    # The instance is currently stopping (either being deleted or killed).
    STOPPING = 350_791_796

    # The instance has suspended.
    SUSPENDED = 51_223_995

    # The instance is suspending.
    SUSPENDING = 514_206_246

    # The instance has stopped (either by explicit action or underlying failure).
    TERMINATED = 250_018_339
  end
end

#guest_accelerators::Array<::Google::Cloud::Compute::V1::AcceleratorConfig>

Returns A list of the type and count of accelerator cards attached to the instance.

Returns:



13474
13475
13476
13477
13478
13479
13480
13481
13482
13483
13484
13485
13486
13487
13488
13489
13490
13491
13492
13493
13494
13495
13496
13497
13498
13499
13500
13501
13502
13503
13504
13505
13506
13507
13508
13509
13510
13511
13512
13513
13514
13515
13516
13517
13518
13519
13520
13521
13522
13523
13524
13525
13526
13527
13528
13529
13530
13531
13532
13533
13534
13535
13536
13537
13538
13539
13540
13541
13542
13543
13544
13545
13546
13547
13548
13549
13550
13551
13552
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 13474

class Instance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # KeyRevocationActionType of the instance. Supported options are "STOP" and "NONE". The default value is "NONE" if it is not specified.
  module KeyRevocationActionType
    # A value indicating that the enum field is not set.
    UNDEFINED_KEY_REVOCATION_ACTION_TYPE = 0

    # Default value. This value is unused.
    KEY_REVOCATION_ACTION_TYPE_UNSPECIFIED = 467_110_106

    # Indicates user chose no operation.
    NONE = 2_402_104

    # Indicates user chose to opt for VM shutdown on key revocation.
    STOP = 2_555_906
  end

  # The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default.
  module PrivateIpv6GoogleAccess
    # A value indicating that the enum field is not set.
    UNDEFINED_PRIVATE_IPV6_GOOGLE_ACCESS = 0

    # Bidirectional private IPv6 access to/from Google services. If specified, the subnetwork who is attached to the instance's default network interface will be assigned an internal IPv6 prefix if it doesn't have before.
    ENABLE_BIDIRECTIONAL_ACCESS_TO_GOOGLE = 427_975_994

    # Outbound private IPv6 access from VMs in this subnet to Google services. If specified, the subnetwork who is attached to the instance's default network interface will be assigned an internal IPv6 prefix if it doesn't have before.
    ENABLE_OUTBOUND_VM_ACCESS_TO_GOOGLE = 288_210_263

    # Each network interface inherits PrivateIpv6GoogleAccess from its subnetwork.
    INHERIT_FROM_SUBNETWORK = 530_256_959
  end

  # [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, REPAIRING, and TERMINATED. For more information about the status of the instance, see Instance life cycle.
  module Status
    # A value indicating that the enum field is not set.
    UNDEFINED_STATUS = 0

    # The instance is halted and we are performing tear down tasks like network deprogramming, releasing quota, IP, tearing down disks etc.
    DEPROVISIONING = 428_935_662

    # Resources are being allocated for the instance.
    PROVISIONING = 290_896_621

    # The instance is in repair.
    REPAIRING = 413_483_285

    # The instance is running.
    RUNNING = 121_282_975

    # All required resources have been allocated and the instance is being started.
    STAGING = 431_072_283

    # The instance has stopped successfully.
    STOPPED = 444_276_141

    # The instance is currently stopping (either being deleted or killed).
    STOPPING = 350_791_796

    # The instance has suspended.
    SUSPENDED = 51_223_995

    # The instance is suspending.
    SUSPENDING = 514_206_246

    # The instance has stopped (either by explicit action or underlying failure).
    TERMINATED = 250_018_339
  end
end

#hostname::String

Returns Specifies the hostname of the instance. The specified hostname must be RFC1035 compliant. If hostname is not specified, the default hostname is [INSTANCE_NAME].c.[PROJECT_ID].internal when using the global DNS, and [INSTANCE_NAME].[ZONE].c.[PROJECT_ID].internal when using zonal DNS.

Returns:

  • (::String)

    Specifies the hostname of the instance. The specified hostname must be RFC1035 compliant. If hostname is not specified, the default hostname is [INSTANCE_NAME].c.[PROJECT_ID].internal when using the global DNS, and [INSTANCE_NAME].[ZONE].c.[PROJECT_ID].internal when using zonal DNS.



13474
13475
13476
13477
13478
13479
13480
13481
13482
13483
13484
13485
13486
13487
13488
13489
13490
13491
13492
13493
13494
13495
13496
13497
13498
13499
13500
13501
13502
13503
13504
13505
13506
13507
13508
13509
13510
13511
13512
13513
13514
13515
13516
13517
13518
13519
13520
13521
13522
13523
13524
13525
13526
13527
13528
13529
13530
13531
13532
13533
13534
13535
13536
13537
13538
13539
13540
13541
13542
13543
13544
13545
13546
13547
13548
13549
13550
13551
13552
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 13474

class Instance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # KeyRevocationActionType of the instance. Supported options are "STOP" and "NONE". The default value is "NONE" if it is not specified.
  module KeyRevocationActionType
    # A value indicating that the enum field is not set.
    UNDEFINED_KEY_REVOCATION_ACTION_TYPE = 0

    # Default value. This value is unused.
    KEY_REVOCATION_ACTION_TYPE_UNSPECIFIED = 467_110_106

    # Indicates user chose no operation.
    NONE = 2_402_104

    # Indicates user chose to opt for VM shutdown on key revocation.
    STOP = 2_555_906
  end

  # The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default.
  module PrivateIpv6GoogleAccess
    # A value indicating that the enum field is not set.
    UNDEFINED_PRIVATE_IPV6_GOOGLE_ACCESS = 0

    # Bidirectional private IPv6 access to/from Google services. If specified, the subnetwork who is attached to the instance's default network interface will be assigned an internal IPv6 prefix if it doesn't have before.
    ENABLE_BIDIRECTIONAL_ACCESS_TO_GOOGLE = 427_975_994

    # Outbound private IPv6 access from VMs in this subnet to Google services. If specified, the subnetwork who is attached to the instance's default network interface will be assigned an internal IPv6 prefix if it doesn't have before.
    ENABLE_OUTBOUND_VM_ACCESS_TO_GOOGLE = 288_210_263

    # Each network interface inherits PrivateIpv6GoogleAccess from its subnetwork.
    INHERIT_FROM_SUBNETWORK = 530_256_959
  end

  # [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, REPAIRING, and TERMINATED. For more information about the status of the instance, see Instance life cycle.
  module Status
    # A value indicating that the enum field is not set.
    UNDEFINED_STATUS = 0

    # The instance is halted and we are performing tear down tasks like network deprogramming, releasing quota, IP, tearing down disks etc.
    DEPROVISIONING = 428_935_662

    # Resources are being allocated for the instance.
    PROVISIONING = 290_896_621

    # The instance is in repair.
    REPAIRING = 413_483_285

    # The instance is running.
    RUNNING = 121_282_975

    # All required resources have been allocated and the instance is being started.
    STAGING = 431_072_283

    # The instance has stopped successfully.
    STOPPED = 444_276_141

    # The instance is currently stopping (either being deleted or killed).
    STOPPING = 350_791_796

    # The instance has suspended.
    SUSPENDED = 51_223_995

    # The instance is suspending.
    SUSPENDING = 514_206_246

    # The instance has stopped (either by explicit action or underlying failure).
    TERMINATED = 250_018_339
  end
end

#id::Integer

Returns [Output Only] The unique identifier for the resource. This identifier is defined by the server.

Returns:

  • (::Integer)

    [Output Only] The unique identifier for the resource. This identifier is defined by the server.



13474
13475
13476
13477
13478
13479
13480
13481
13482
13483
13484
13485
13486
13487
13488
13489
13490
13491
13492
13493
13494
13495
13496
13497
13498
13499
13500
13501
13502
13503
13504
13505
13506
13507
13508
13509
13510
13511
13512
13513
13514
13515
13516
13517
13518
13519
13520
13521
13522
13523
13524
13525
13526
13527
13528
13529
13530
13531
13532
13533
13534
13535
13536
13537
13538
13539
13540
13541
13542
13543
13544
13545
13546
13547
13548
13549
13550
13551
13552
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 13474

class Instance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # KeyRevocationActionType of the instance. Supported options are "STOP" and "NONE". The default value is "NONE" if it is not specified.
  module KeyRevocationActionType
    # A value indicating that the enum field is not set.
    UNDEFINED_KEY_REVOCATION_ACTION_TYPE = 0

    # Default value. This value is unused.
    KEY_REVOCATION_ACTION_TYPE_UNSPECIFIED = 467_110_106

    # Indicates user chose no operation.
    NONE = 2_402_104

    # Indicates user chose to opt for VM shutdown on key revocation.
    STOP = 2_555_906
  end

  # The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default.
  module PrivateIpv6GoogleAccess
    # A value indicating that the enum field is not set.
    UNDEFINED_PRIVATE_IPV6_GOOGLE_ACCESS = 0

    # Bidirectional private IPv6 access to/from Google services. If specified, the subnetwork who is attached to the instance's default network interface will be assigned an internal IPv6 prefix if it doesn't have before.
    ENABLE_BIDIRECTIONAL_ACCESS_TO_GOOGLE = 427_975_994

    # Outbound private IPv6 access from VMs in this subnet to Google services. If specified, the subnetwork who is attached to the instance's default network interface will be assigned an internal IPv6 prefix if it doesn't have before.
    ENABLE_OUTBOUND_VM_ACCESS_TO_GOOGLE = 288_210_263

    # Each network interface inherits PrivateIpv6GoogleAccess from its subnetwork.
    INHERIT_FROM_SUBNETWORK = 530_256_959
  end

  # [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, REPAIRING, and TERMINATED. For more information about the status of the instance, see Instance life cycle.
  module Status
    # A value indicating that the enum field is not set.
    UNDEFINED_STATUS = 0

    # The instance is halted and we are performing tear down tasks like network deprogramming, releasing quota, IP, tearing down disks etc.
    DEPROVISIONING = 428_935_662

    # Resources are being allocated for the instance.
    PROVISIONING = 290_896_621

    # The instance is in repair.
    REPAIRING = 413_483_285

    # The instance is running.
    RUNNING = 121_282_975

    # All required resources have been allocated and the instance is being started.
    STAGING = 431_072_283

    # The instance has stopped successfully.
    STOPPED = 444_276_141

    # The instance is currently stopping (either being deleted or killed).
    STOPPING = 350_791_796

    # The instance has suspended.
    SUSPENDED = 51_223_995

    # The instance is suspending.
    SUSPENDING = 514_206_246

    # The instance has stopped (either by explicit action or underlying failure).
    TERMINATED = 250_018_339
  end
end

#instance_encryption_key::Google::Cloud::Compute::V1::CustomerEncryptionKey

Returns Encrypts suspended data for an instance with a customer-managed encryption key. If you are creating a new instance, this field will encrypt the local SSD and in-memory contents of the instance during the suspend operation. If you do not provide an encryption key when creating the instance, then the local SSD and in-memory contents will be encrypted using an automatically generated key during the suspend operation.

Returns:

  • (::Google::Cloud::Compute::V1::CustomerEncryptionKey)

    Encrypts suspended data for an instance with a customer-managed encryption key. If you are creating a new instance, this field will encrypt the local SSD and in-memory contents of the instance during the suspend operation. If you do not provide an encryption key when creating the instance, then the local SSD and in-memory contents will be encrypted using an automatically generated key during the suspend operation.



13474
13475
13476
13477
13478
13479
13480
13481
13482
13483
13484
13485
13486
13487
13488
13489
13490
13491
13492
13493
13494
13495
13496
13497
13498
13499
13500
13501
13502
13503
13504
13505
13506
13507
13508
13509
13510
13511
13512
13513
13514
13515
13516
13517
13518
13519
13520
13521
13522
13523
13524
13525
13526
13527
13528
13529
13530
13531
13532
13533
13534
13535
13536
13537
13538
13539
13540
13541
13542
13543
13544
13545
13546
13547
13548
13549
13550
13551
13552
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 13474

class Instance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # KeyRevocationActionType of the instance. Supported options are "STOP" and "NONE". The default value is "NONE" if it is not specified.
  module KeyRevocationActionType
    # A value indicating that the enum field is not set.
    UNDEFINED_KEY_REVOCATION_ACTION_TYPE = 0

    # Default value. This value is unused.
    KEY_REVOCATION_ACTION_TYPE_UNSPECIFIED = 467_110_106

    # Indicates user chose no operation.
    NONE = 2_402_104

    # Indicates user chose to opt for VM shutdown on key revocation.
    STOP = 2_555_906
  end

  # The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default.
  module PrivateIpv6GoogleAccess
    # A value indicating that the enum field is not set.
    UNDEFINED_PRIVATE_IPV6_GOOGLE_ACCESS = 0

    # Bidirectional private IPv6 access to/from Google services. If specified, the subnetwork who is attached to the instance's default network interface will be assigned an internal IPv6 prefix if it doesn't have before.
    ENABLE_BIDIRECTIONAL_ACCESS_TO_GOOGLE = 427_975_994

    # Outbound private IPv6 access from VMs in this subnet to Google services. If specified, the subnetwork who is attached to the instance's default network interface will be assigned an internal IPv6 prefix if it doesn't have before.
    ENABLE_OUTBOUND_VM_ACCESS_TO_GOOGLE = 288_210_263

    # Each network interface inherits PrivateIpv6GoogleAccess from its subnetwork.
    INHERIT_FROM_SUBNETWORK = 530_256_959
  end

  # [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, REPAIRING, and TERMINATED. For more information about the status of the instance, see Instance life cycle.
  module Status
    # A value indicating that the enum field is not set.
    UNDEFINED_STATUS = 0

    # The instance is halted and we are performing tear down tasks like network deprogramming, releasing quota, IP, tearing down disks etc.
    DEPROVISIONING = 428_935_662

    # Resources are being allocated for the instance.
    PROVISIONING = 290_896_621

    # The instance is in repair.
    REPAIRING = 413_483_285

    # The instance is running.
    RUNNING = 121_282_975

    # All required resources have been allocated and the instance is being started.
    STAGING = 431_072_283

    # The instance has stopped successfully.
    STOPPED = 444_276_141

    # The instance is currently stopping (either being deleted or killed).
    STOPPING = 350_791_796

    # The instance has suspended.
    SUSPENDED = 51_223_995

    # The instance is suspending.
    SUSPENDING = 514_206_246

    # The instance has stopped (either by explicit action or underlying failure).
    TERMINATED = 250_018_339
  end
end

#key_revocation_action_type::String

Returns KeyRevocationActionType of the instance. Supported options are "STOP" and "NONE". The default value is "NONE" if it is not specified. Check the KeyRevocationActionType enum for the list of possible values.

Returns:

  • (::String)

    KeyRevocationActionType of the instance. Supported options are "STOP" and "NONE". The default value is "NONE" if it is not specified. Check the KeyRevocationActionType enum for the list of possible values.



13474
13475
13476
13477
13478
13479
13480
13481
13482
13483
13484
13485
13486
13487
13488
13489
13490
13491
13492
13493
13494
13495
13496
13497
13498
13499
13500
13501
13502
13503
13504
13505
13506
13507
13508
13509
13510
13511
13512
13513
13514
13515
13516
13517
13518
13519
13520
13521
13522
13523
13524
13525
13526
13527
13528
13529
13530
13531
13532
13533
13534
13535
13536
13537
13538
13539
13540
13541
13542
13543
13544
13545
13546
13547
13548
13549
13550
13551
13552
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 13474

class Instance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # KeyRevocationActionType of the instance. Supported options are "STOP" and "NONE". The default value is "NONE" if it is not specified.
  module KeyRevocationActionType
    # A value indicating that the enum field is not set.
    UNDEFINED_KEY_REVOCATION_ACTION_TYPE = 0

    # Default value. This value is unused.
    KEY_REVOCATION_ACTION_TYPE_UNSPECIFIED = 467_110_106

    # Indicates user chose no operation.
    NONE = 2_402_104

    # Indicates user chose to opt for VM shutdown on key revocation.
    STOP = 2_555_906
  end

  # The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default.
  module PrivateIpv6GoogleAccess
    # A value indicating that the enum field is not set.
    UNDEFINED_PRIVATE_IPV6_GOOGLE_ACCESS = 0

    # Bidirectional private IPv6 access to/from Google services. If specified, the subnetwork who is attached to the instance's default network interface will be assigned an internal IPv6 prefix if it doesn't have before.
    ENABLE_BIDIRECTIONAL_ACCESS_TO_GOOGLE = 427_975_994

    # Outbound private IPv6 access from VMs in this subnet to Google services. If specified, the subnetwork who is attached to the instance's default network interface will be assigned an internal IPv6 prefix if it doesn't have before.
    ENABLE_OUTBOUND_VM_ACCESS_TO_GOOGLE = 288_210_263

    # Each network interface inherits PrivateIpv6GoogleAccess from its subnetwork.
    INHERIT_FROM_SUBNETWORK = 530_256_959
  end

  # [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, REPAIRING, and TERMINATED. For more information about the status of the instance, see Instance life cycle.
  module Status
    # A value indicating that the enum field is not set.
    UNDEFINED_STATUS = 0

    # The instance is halted and we are performing tear down tasks like network deprogramming, releasing quota, IP, tearing down disks etc.
    DEPROVISIONING = 428_935_662

    # Resources are being allocated for the instance.
    PROVISIONING = 290_896_621

    # The instance is in repair.
    REPAIRING = 413_483_285

    # The instance is running.
    RUNNING = 121_282_975

    # All required resources have been allocated and the instance is being started.
    STAGING = 431_072_283

    # The instance has stopped successfully.
    STOPPED = 444_276_141

    # The instance is currently stopping (either being deleted or killed).
    STOPPING = 350_791_796

    # The instance has suspended.
    SUSPENDED = 51_223_995

    # The instance is suspending.
    SUSPENDING = 514_206_246

    # The instance has stopped (either by explicit action or underlying failure).
    TERMINATED = 250_018_339
  end
end

#kind::String

Returns [Output Only] Type of the resource. Always compute#instance for instances.

Returns:

  • (::String)

    [Output Only] Type of the resource. Always compute#instance for instances.



13474
13475
13476
13477
13478
13479
13480
13481
13482
13483
13484
13485
13486
13487
13488
13489
13490
13491
13492
13493
13494
13495
13496
13497
13498
13499
13500
13501
13502
13503
13504
13505
13506
13507
13508
13509
13510
13511
13512
13513
13514
13515
13516
13517
13518
13519
13520
13521
13522
13523
13524
13525
13526
13527
13528
13529
13530
13531
13532
13533
13534
13535
13536
13537
13538
13539
13540
13541
13542
13543
13544
13545
13546
13547
13548
13549
13550
13551
13552
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 13474

class Instance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # KeyRevocationActionType of the instance. Supported options are "STOP" and "NONE". The default value is "NONE" if it is not specified.
  module KeyRevocationActionType
    # A value indicating that the enum field is not set.
    UNDEFINED_KEY_REVOCATION_ACTION_TYPE = 0

    # Default value. This value is unused.
    KEY_REVOCATION_ACTION_TYPE_UNSPECIFIED = 467_110_106

    # Indicates user chose no operation.
    NONE = 2_402_104

    # Indicates user chose to opt for VM shutdown on key revocation.
    STOP = 2_555_906
  end

  # The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default.
  module PrivateIpv6GoogleAccess
    # A value indicating that the enum field is not set.
    UNDEFINED_PRIVATE_IPV6_GOOGLE_ACCESS = 0

    # Bidirectional private IPv6 access to/from Google services. If specified, the subnetwork who is attached to the instance's default network interface will be assigned an internal IPv6 prefix if it doesn't have before.
    ENABLE_BIDIRECTIONAL_ACCESS_TO_GOOGLE = 427_975_994

    # Outbound private IPv6 access from VMs in this subnet to Google services. If specified, the subnetwork who is attached to the instance's default network interface will be assigned an internal IPv6 prefix if it doesn't have before.
    ENABLE_OUTBOUND_VM_ACCESS_TO_GOOGLE = 288_210_263

    # Each network interface inherits PrivateIpv6GoogleAccess from its subnetwork.
    INHERIT_FROM_SUBNETWORK = 530_256_959
  end

  # [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, REPAIRING, and TERMINATED. For more information about the status of the instance, see Instance life cycle.
  module Status
    # A value indicating that the enum field is not set.
    UNDEFINED_STATUS = 0

    # The instance is halted and we are performing tear down tasks like network deprogramming, releasing quota, IP, tearing down disks etc.
    DEPROVISIONING = 428_935_662

    # Resources are being allocated for the instance.
    PROVISIONING = 290_896_621

    # The instance is in repair.
    REPAIRING = 413_483_285

    # The instance is running.
    RUNNING = 121_282_975

    # All required resources have been allocated and the instance is being started.
    STAGING = 431_072_283

    # The instance has stopped successfully.
    STOPPED = 444_276_141

    # The instance is currently stopping (either being deleted or killed).
    STOPPING = 350_791_796

    # The instance has suspended.
    SUSPENDED = 51_223_995

    # The instance is suspending.
    SUSPENDING = 514_206_246

    # The instance has stopped (either by explicit action or underlying failure).
    TERMINATED = 250_018_339
  end
end

#label_fingerprint::String

Returns A fingerprint for this request, which is essentially a hash of the label's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels. To see the latest fingerprint, make get() request to the instance.

Returns:

  • (::String)

    A fingerprint for this request, which is essentially a hash of the label's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels. To see the latest fingerprint, make get() request to the instance.



13474
13475
13476
13477
13478
13479
13480
13481
13482
13483
13484
13485
13486
13487
13488
13489
13490
13491
13492
13493
13494
13495
13496
13497
13498
13499
13500
13501
13502
13503
13504
13505
13506
13507
13508
13509
13510
13511
13512
13513
13514
13515
13516
13517
13518
13519
13520
13521
13522
13523
13524
13525
13526
13527
13528
13529
13530
13531
13532
13533
13534
13535
13536
13537
13538
13539
13540
13541
13542
13543
13544
13545
13546
13547
13548
13549
13550
13551
13552
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 13474

class Instance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # KeyRevocationActionType of the instance. Supported options are "STOP" and "NONE". The default value is "NONE" if it is not specified.
  module KeyRevocationActionType
    # A value indicating that the enum field is not set.
    UNDEFINED_KEY_REVOCATION_ACTION_TYPE = 0

    # Default value. This value is unused.
    KEY_REVOCATION_ACTION_TYPE_UNSPECIFIED = 467_110_106

    # Indicates user chose no operation.
    NONE = 2_402_104

    # Indicates user chose to opt for VM shutdown on key revocation.
    STOP = 2_555_906
  end

  # The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default.
  module PrivateIpv6GoogleAccess
    # A value indicating that the enum field is not set.
    UNDEFINED_PRIVATE_IPV6_GOOGLE_ACCESS = 0

    # Bidirectional private IPv6 access to/from Google services. If specified, the subnetwork who is attached to the instance's default network interface will be assigned an internal IPv6 prefix if it doesn't have before.
    ENABLE_BIDIRECTIONAL_ACCESS_TO_GOOGLE = 427_975_994

    # Outbound private IPv6 access from VMs in this subnet to Google services. If specified, the subnetwork who is attached to the instance's default network interface will be assigned an internal IPv6 prefix if it doesn't have before.
    ENABLE_OUTBOUND_VM_ACCESS_TO_GOOGLE = 288_210_263

    # Each network interface inherits PrivateIpv6GoogleAccess from its subnetwork.
    INHERIT_FROM_SUBNETWORK = 530_256_959
  end

  # [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, REPAIRING, and TERMINATED. For more information about the status of the instance, see Instance life cycle.
  module Status
    # A value indicating that the enum field is not set.
    UNDEFINED_STATUS = 0

    # The instance is halted and we are performing tear down tasks like network deprogramming, releasing quota, IP, tearing down disks etc.
    DEPROVISIONING = 428_935_662

    # Resources are being allocated for the instance.
    PROVISIONING = 290_896_621

    # The instance is in repair.
    REPAIRING = 413_483_285

    # The instance is running.
    RUNNING = 121_282_975

    # All required resources have been allocated and the instance is being started.
    STAGING = 431_072_283

    # The instance has stopped successfully.
    STOPPED = 444_276_141

    # The instance is currently stopping (either being deleted or killed).
    STOPPING = 350_791_796

    # The instance has suspended.
    SUSPENDED = 51_223_995

    # The instance is suspending.
    SUSPENDING = 514_206_246

    # The instance has stopped (either by explicit action or underlying failure).
    TERMINATED = 250_018_339
  end
end

#labels::Google::Protobuf::Map{::String => ::String}

Returns Labels to apply to this instance. These can be later modified by the setLabels method.

Returns:

  • (::Google::Protobuf::Map{::String => ::String})

    Labels to apply to this instance. These can be later modified by the setLabels method.



13474
13475
13476
13477
13478
13479
13480
13481
13482
13483
13484
13485
13486
13487
13488
13489
13490
13491
13492
13493
13494
13495
13496
13497
13498
13499
13500
13501
13502
13503
13504
13505
13506
13507
13508
13509
13510
13511
13512
13513
13514
13515
13516
13517
13518
13519
13520
13521
13522
13523
13524
13525
13526
13527
13528
13529
13530
13531
13532
13533
13534
13535
13536
13537
13538
13539
13540
13541
13542
13543
13544
13545
13546
13547
13548
13549
13550
13551
13552
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 13474

class Instance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # KeyRevocationActionType of the instance. Supported options are "STOP" and "NONE". The default value is "NONE" if it is not specified.
  module KeyRevocationActionType
    # A value indicating that the enum field is not set.
    UNDEFINED_KEY_REVOCATION_ACTION_TYPE = 0

    # Default value. This value is unused.
    KEY_REVOCATION_ACTION_TYPE_UNSPECIFIED = 467_110_106

    # Indicates user chose no operation.
    NONE = 2_402_104

    # Indicates user chose to opt for VM shutdown on key revocation.
    STOP = 2_555_906
  end

  # The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default.
  module PrivateIpv6GoogleAccess
    # A value indicating that the enum field is not set.
    UNDEFINED_PRIVATE_IPV6_GOOGLE_ACCESS = 0

    # Bidirectional private IPv6 access to/from Google services. If specified, the subnetwork who is attached to the instance's default network interface will be assigned an internal IPv6 prefix if it doesn't have before.
    ENABLE_BIDIRECTIONAL_ACCESS_TO_GOOGLE = 427_975_994

    # Outbound private IPv6 access from VMs in this subnet to Google services. If specified, the subnetwork who is attached to the instance's default network interface will be assigned an internal IPv6 prefix if it doesn't have before.
    ENABLE_OUTBOUND_VM_ACCESS_TO_GOOGLE = 288_210_263

    # Each network interface inherits PrivateIpv6GoogleAccess from its subnetwork.
    INHERIT_FROM_SUBNETWORK = 530_256_959
  end

  # [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, REPAIRING, and TERMINATED. For more information about the status of the instance, see Instance life cycle.
  module Status
    # A value indicating that the enum field is not set.
    UNDEFINED_STATUS = 0

    # The instance is halted and we are performing tear down tasks like network deprogramming, releasing quota, IP, tearing down disks etc.
    DEPROVISIONING = 428_935_662

    # Resources are being allocated for the instance.
    PROVISIONING = 290_896_621

    # The instance is in repair.
    REPAIRING = 413_483_285

    # The instance is running.
    RUNNING = 121_282_975

    # All required resources have been allocated and the instance is being started.
    STAGING = 431_072_283

    # The instance has stopped successfully.
    STOPPED = 444_276_141

    # The instance is currently stopping (either being deleted or killed).
    STOPPING = 350_791_796

    # The instance has suspended.
    SUSPENDED = 51_223_995

    # The instance is suspending.
    SUSPENDING = 514_206_246

    # The instance has stopped (either by explicit action or underlying failure).
    TERMINATED = 250_018_339
  end
end

#last_start_timestamp::String

Returns [Output Only] Last start timestamp in RFC3339 text format.

Returns:

  • (::String)

    [Output Only] Last start timestamp in RFC3339 text format.



13474
13475
13476
13477
13478
13479
13480
13481
13482
13483
13484
13485
13486
13487
13488
13489
13490
13491
13492
13493
13494
13495
13496
13497
13498
13499
13500
13501
13502
13503
13504
13505
13506
13507
13508
13509
13510
13511
13512
13513
13514
13515
13516
13517
13518
13519
13520
13521
13522
13523
13524
13525
13526
13527
13528
13529
13530
13531
13532
13533
13534
13535
13536
13537
13538
13539
13540
13541
13542
13543
13544
13545
13546
13547
13548
13549
13550
13551
13552
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 13474

class Instance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # KeyRevocationActionType of the instance. Supported options are "STOP" and "NONE". The default value is "NONE" if it is not specified.
  module KeyRevocationActionType
    # A value indicating that the enum field is not set.
    UNDEFINED_KEY_REVOCATION_ACTION_TYPE = 0

    # Default value. This value is unused.
    KEY_REVOCATION_ACTION_TYPE_UNSPECIFIED = 467_110_106

    # Indicates user chose no operation.
    NONE = 2_402_104

    # Indicates user chose to opt for VM shutdown on key revocation.
    STOP = 2_555_906
  end

  # The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default.
  module PrivateIpv6GoogleAccess
    # A value indicating that the enum field is not set.
    UNDEFINED_PRIVATE_IPV6_GOOGLE_ACCESS = 0

    # Bidirectional private IPv6 access to/from Google services. If specified, the subnetwork who is attached to the instance's default network interface will be assigned an internal IPv6 prefix if it doesn't have before.
    ENABLE_BIDIRECTIONAL_ACCESS_TO_GOOGLE = 427_975_994

    # Outbound private IPv6 access from VMs in this subnet to Google services. If specified, the subnetwork who is attached to the instance's default network interface will be assigned an internal IPv6 prefix if it doesn't have before.
    ENABLE_OUTBOUND_VM_ACCESS_TO_GOOGLE = 288_210_263

    # Each network interface inherits PrivateIpv6GoogleAccess from its subnetwork.
    INHERIT_FROM_SUBNETWORK = 530_256_959
  end

  # [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, REPAIRING, and TERMINATED. For more information about the status of the instance, see Instance life cycle.
  module Status
    # A value indicating that the enum field is not set.
    UNDEFINED_STATUS = 0

    # The instance is halted and we are performing tear down tasks like network deprogramming, releasing quota, IP, tearing down disks etc.
    DEPROVISIONING = 428_935_662

    # Resources are being allocated for the instance.
    PROVISIONING = 290_896_621

    # The instance is in repair.
    REPAIRING = 413_483_285

    # The instance is running.
    RUNNING = 121_282_975

    # All required resources have been allocated and the instance is being started.
    STAGING = 431_072_283

    # The instance has stopped successfully.
    STOPPED = 444_276_141

    # The instance is currently stopping (either being deleted or killed).
    STOPPING = 350_791_796

    # The instance has suspended.
    SUSPENDED = 51_223_995

    # The instance is suspending.
    SUSPENDING = 514_206_246

    # The instance has stopped (either by explicit action or underlying failure).
    TERMINATED = 250_018_339
  end
end

#last_stop_timestamp::String

Returns [Output Only] Last stop timestamp in RFC3339 text format.

Returns:

  • (::String)

    [Output Only] Last stop timestamp in RFC3339 text format.



13474
13475
13476
13477
13478
13479
13480
13481
13482
13483
13484
13485
13486
13487
13488
13489
13490
13491
13492
13493
13494
13495
13496
13497
13498
13499
13500
13501
13502
13503
13504
13505
13506
13507
13508
13509
13510
13511
13512
13513
13514
13515
13516
13517
13518
13519
13520
13521
13522
13523
13524
13525
13526
13527
13528
13529
13530
13531
13532
13533
13534
13535
13536
13537
13538
13539
13540
13541
13542
13543
13544
13545
13546
13547
13548
13549
13550
13551
13552
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 13474

class Instance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # KeyRevocationActionType of the instance. Supported options are "STOP" and "NONE". The default value is "NONE" if it is not specified.
  module KeyRevocationActionType
    # A value indicating that the enum field is not set.
    UNDEFINED_KEY_REVOCATION_ACTION_TYPE = 0

    # Default value. This value is unused.
    KEY_REVOCATION_ACTION_TYPE_UNSPECIFIED = 467_110_106

    # Indicates user chose no operation.
    NONE = 2_402_104

    # Indicates user chose to opt for VM shutdown on key revocation.
    STOP = 2_555_906
  end

  # The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default.
  module PrivateIpv6GoogleAccess
    # A value indicating that the enum field is not set.
    UNDEFINED_PRIVATE_IPV6_GOOGLE_ACCESS = 0

    # Bidirectional private IPv6 access to/from Google services. If specified, the subnetwork who is attached to the instance's default network interface will be assigned an internal IPv6 prefix if it doesn't have before.
    ENABLE_BIDIRECTIONAL_ACCESS_TO_GOOGLE = 427_975_994

    # Outbound private IPv6 access from VMs in this subnet to Google services. If specified, the subnetwork who is attached to the instance's default network interface will be assigned an internal IPv6 prefix if it doesn't have before.
    ENABLE_OUTBOUND_VM_ACCESS_TO_GOOGLE = 288_210_263

    # Each network interface inherits PrivateIpv6GoogleAccess from its subnetwork.
    INHERIT_FROM_SUBNETWORK = 530_256_959
  end

  # [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, REPAIRING, and TERMINATED. For more information about the status of the instance, see Instance life cycle.
  module Status
    # A value indicating that the enum field is not set.
    UNDEFINED_STATUS = 0

    # The instance is halted and we are performing tear down tasks like network deprogramming, releasing quota, IP, tearing down disks etc.
    DEPROVISIONING = 428_935_662

    # Resources are being allocated for the instance.
    PROVISIONING = 290_896_621

    # The instance is in repair.
    REPAIRING = 413_483_285

    # The instance is running.
    RUNNING = 121_282_975

    # All required resources have been allocated and the instance is being started.
    STAGING = 431_072_283

    # The instance has stopped successfully.
    STOPPED = 444_276_141

    # The instance is currently stopping (either being deleted or killed).
    STOPPING = 350_791_796

    # The instance has suspended.
    SUSPENDED = 51_223_995

    # The instance is suspending.
    SUSPENDING = 514_206_246

    # The instance has stopped (either by explicit action or underlying failure).
    TERMINATED = 250_018_339
  end
end

#last_suspended_timestamp::String

Returns [Output Only] Last suspended timestamp in RFC3339 text format.

Returns:

  • (::String)

    [Output Only] Last suspended timestamp in RFC3339 text format.



13474
13475
13476
13477
13478
13479
13480
13481
13482
13483
13484
13485
13486
13487
13488
13489
13490
13491
13492
13493
13494
13495
13496
13497
13498
13499
13500
13501
13502
13503
13504
13505
13506
13507
13508
13509
13510
13511
13512
13513
13514
13515
13516
13517
13518
13519
13520
13521
13522
13523
13524
13525
13526
13527
13528
13529
13530
13531
13532
13533
13534
13535
13536
13537
13538
13539
13540
13541
13542
13543
13544
13545
13546
13547
13548
13549
13550
13551
13552
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 13474

class Instance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # KeyRevocationActionType of the instance. Supported options are "STOP" and "NONE". The default value is "NONE" if it is not specified.
  module KeyRevocationActionType
    # A value indicating that the enum field is not set.
    UNDEFINED_KEY_REVOCATION_ACTION_TYPE = 0

    # Default value. This value is unused.
    KEY_REVOCATION_ACTION_TYPE_UNSPECIFIED = 467_110_106

    # Indicates user chose no operation.
    NONE = 2_402_104

    # Indicates user chose to opt for VM shutdown on key revocation.
    STOP = 2_555_906
  end

  # The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default.
  module PrivateIpv6GoogleAccess
    # A value indicating that the enum field is not set.
    UNDEFINED_PRIVATE_IPV6_GOOGLE_ACCESS = 0

    # Bidirectional private IPv6 access to/from Google services. If specified, the subnetwork who is attached to the instance's default network interface will be assigned an internal IPv6 prefix if it doesn't have before.
    ENABLE_BIDIRECTIONAL_ACCESS_TO_GOOGLE = 427_975_994

    # Outbound private IPv6 access from VMs in this subnet to Google services. If specified, the subnetwork who is attached to the instance's default network interface will be assigned an internal IPv6 prefix if it doesn't have before.
    ENABLE_OUTBOUND_VM_ACCESS_TO_GOOGLE = 288_210_263

    # Each network interface inherits PrivateIpv6GoogleAccess from its subnetwork.
    INHERIT_FROM_SUBNETWORK = 530_256_959
  end

  # [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, REPAIRING, and TERMINATED. For more information about the status of the instance, see Instance life cycle.
  module Status
    # A value indicating that the enum field is not set.
    UNDEFINED_STATUS = 0

    # The instance is halted and we are performing tear down tasks like network deprogramming, releasing quota, IP, tearing down disks etc.
    DEPROVISIONING = 428_935_662

    # Resources are being allocated for the instance.
    PROVISIONING = 290_896_621

    # The instance is in repair.
    REPAIRING = 413_483_285

    # The instance is running.
    RUNNING = 121_282_975

    # All required resources have been allocated and the instance is being started.
    STAGING = 431_072_283

    # The instance has stopped successfully.
    STOPPED = 444_276_141

    # The instance is currently stopping (either being deleted or killed).
    STOPPING = 350_791_796

    # The instance has suspended.
    SUSPENDED = 51_223_995

    # The instance is suspending.
    SUSPENDING = 514_206_246

    # The instance has stopped (either by explicit action or underlying failure).
    TERMINATED = 250_018_339
  end
end

#machine_type::String

Returns Full or partial URL of the machine type resource to use for this instance, in the format: zones/zone/machineTypes/machine-type. This is provided by the client when the instance is created. For example, the following is a valid partial url to a predefined machine type: zones/us-central1-f/machineTypes/n1-standard-1 To create a custom machine type, provide a URL to a machine type in the following format, where CPUS is 1 or an even number up to 32 (2, 4, 6, ... 24, etc), and MEMORY is the total memory for this instance. Memory must be a multiple of 256 MB and must be supplied in MB (e.g. 5 GB of memory is 5120 MB): zones/zone/machineTypes/custom-CPUS-MEMORY For example: zones/us-central1-f/machineTypes/custom-4-5120 For a full list of restrictions, read the Specifications for custom machine types.

Returns:

  • (::String)

    Full or partial URL of the machine type resource to use for this instance, in the format: zones/zone/machineTypes/machine-type. This is provided by the client when the instance is created. For example, the following is a valid partial url to a predefined machine type: zones/us-central1-f/machineTypes/n1-standard-1 To create a custom machine type, provide a URL to a machine type in the following format, where CPUS is 1 or an even number up to 32 (2, 4, 6, ... 24, etc), and MEMORY is the total memory for this instance. Memory must be a multiple of 256 MB and must be supplied in MB (e.g. 5 GB of memory is 5120 MB): zones/zone/machineTypes/custom-CPUS-MEMORY For example: zones/us-central1-f/machineTypes/custom-4-5120 For a full list of restrictions, read the Specifications for custom machine types.



13474
13475
13476
13477
13478
13479
13480
13481
13482
13483
13484
13485
13486
13487
13488
13489
13490
13491
13492
13493
13494
13495
13496
13497
13498
13499
13500
13501
13502
13503
13504
13505
13506
13507
13508
13509
13510
13511
13512
13513
13514
13515
13516
13517
13518
13519
13520
13521
13522
13523
13524
13525
13526
13527
13528
13529
13530
13531
13532
13533
13534
13535
13536
13537
13538
13539
13540
13541
13542
13543
13544
13545
13546
13547
13548
13549
13550
13551
13552
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 13474

class Instance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # KeyRevocationActionType of the instance. Supported options are "STOP" and "NONE". The default value is "NONE" if it is not specified.
  module KeyRevocationActionType
    # A value indicating that the enum field is not set.
    UNDEFINED_KEY_REVOCATION_ACTION_TYPE = 0

    # Default value. This value is unused.
    KEY_REVOCATION_ACTION_TYPE_UNSPECIFIED = 467_110_106

    # Indicates user chose no operation.
    NONE = 2_402_104

    # Indicates user chose to opt for VM shutdown on key revocation.
    STOP = 2_555_906
  end

  # The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default.
  module PrivateIpv6GoogleAccess
    # A value indicating that the enum field is not set.
    UNDEFINED_PRIVATE_IPV6_GOOGLE_ACCESS = 0

    # Bidirectional private IPv6 access to/from Google services. If specified, the subnetwork who is attached to the instance's default network interface will be assigned an internal IPv6 prefix if it doesn't have before.
    ENABLE_BIDIRECTIONAL_ACCESS_TO_GOOGLE = 427_975_994

    # Outbound private IPv6 access from VMs in this subnet to Google services. If specified, the subnetwork who is attached to the instance's default network interface will be assigned an internal IPv6 prefix if it doesn't have before.
    ENABLE_OUTBOUND_VM_ACCESS_TO_GOOGLE = 288_210_263

    # Each network interface inherits PrivateIpv6GoogleAccess from its subnetwork.
    INHERIT_FROM_SUBNETWORK = 530_256_959
  end

  # [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, REPAIRING, and TERMINATED. For more information about the status of the instance, see Instance life cycle.
  module Status
    # A value indicating that the enum field is not set.
    UNDEFINED_STATUS = 0

    # The instance is halted and we are performing tear down tasks like network deprogramming, releasing quota, IP, tearing down disks etc.
    DEPROVISIONING = 428_935_662

    # Resources are being allocated for the instance.
    PROVISIONING = 290_896_621

    # The instance is in repair.
    REPAIRING = 413_483_285

    # The instance is running.
    RUNNING = 121_282_975

    # All required resources have been allocated and the instance is being started.
    STAGING = 431_072_283

    # The instance has stopped successfully.
    STOPPED = 444_276_141

    # The instance is currently stopping (either being deleted or killed).
    STOPPING = 350_791_796

    # The instance has suspended.
    SUSPENDED = 51_223_995

    # The instance is suspending.
    SUSPENDING = 514_206_246

    # The instance has stopped (either by explicit action or underlying failure).
    TERMINATED = 250_018_339
  end
end

#metadata::Google::Cloud::Compute::V1::Metadata

Returns The metadata key/value pairs assigned to this instance. This includes custom metadata and predefined keys.

Returns:



13474
13475
13476
13477
13478
13479
13480
13481
13482
13483
13484
13485
13486
13487
13488
13489
13490
13491
13492
13493
13494
13495
13496
13497
13498
13499
13500
13501
13502
13503
13504
13505
13506
13507
13508
13509
13510
13511
13512
13513
13514
13515
13516
13517
13518
13519
13520
13521
13522
13523
13524
13525
13526
13527
13528
13529
13530
13531
13532
13533
13534
13535
13536
13537
13538
13539
13540
13541
13542
13543
13544
13545
13546
13547
13548
13549
13550
13551
13552
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 13474

class Instance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # KeyRevocationActionType of the instance. Supported options are "STOP" and "NONE". The default value is "NONE" if it is not specified.
  module KeyRevocationActionType
    # A value indicating that the enum field is not set.
    UNDEFINED_KEY_REVOCATION_ACTION_TYPE = 0

    # Default value. This value is unused.
    KEY_REVOCATION_ACTION_TYPE_UNSPECIFIED = 467_110_106

    # Indicates user chose no operation.
    NONE = 2_402_104

    # Indicates user chose to opt for VM shutdown on key revocation.
    STOP = 2_555_906
  end

  # The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default.
  module PrivateIpv6GoogleAccess
    # A value indicating that the enum field is not set.
    UNDEFINED_PRIVATE_IPV6_GOOGLE_ACCESS = 0

    # Bidirectional private IPv6 access to/from Google services. If specified, the subnetwork who is attached to the instance's default network interface will be assigned an internal IPv6 prefix if it doesn't have before.
    ENABLE_BIDIRECTIONAL_ACCESS_TO_GOOGLE = 427_975_994

    # Outbound private IPv6 access from VMs in this subnet to Google services. If specified, the subnetwork who is attached to the instance's default network interface will be assigned an internal IPv6 prefix if it doesn't have before.
    ENABLE_OUTBOUND_VM_ACCESS_TO_GOOGLE = 288_210_263

    # Each network interface inherits PrivateIpv6GoogleAccess from its subnetwork.
    INHERIT_FROM_SUBNETWORK = 530_256_959
  end

  # [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, REPAIRING, and TERMINATED. For more information about the status of the instance, see Instance life cycle.
  module Status
    # A value indicating that the enum field is not set.
    UNDEFINED_STATUS = 0

    # The instance is halted and we are performing tear down tasks like network deprogramming, releasing quota, IP, tearing down disks etc.
    DEPROVISIONING = 428_935_662

    # Resources are being allocated for the instance.
    PROVISIONING = 290_896_621

    # The instance is in repair.
    REPAIRING = 413_483_285

    # The instance is running.
    RUNNING = 121_282_975

    # All required resources have been allocated and the instance is being started.
    STAGING = 431_072_283

    # The instance has stopped successfully.
    STOPPED = 444_276_141

    # The instance is currently stopping (either being deleted or killed).
    STOPPING = 350_791_796

    # The instance has suspended.
    SUSPENDED = 51_223_995

    # The instance is suspending.
    SUSPENDING = 514_206_246

    # The instance has stopped (either by explicit action or underlying failure).
    TERMINATED = 250_018_339
  end
end

#min_cpu_platform::String

Returns Specifies a minimum CPU platform for the VM instance. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: "Intel Haswell" or minCpuPlatform: "Intel Sandy Bridge".

Returns:

  • (::String)

    Specifies a minimum CPU platform for the VM instance. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: "Intel Haswell" or minCpuPlatform: "Intel Sandy Bridge".



13474
13475
13476
13477
13478
13479
13480
13481
13482
13483
13484
13485
13486
13487
13488
13489
13490
13491
13492
13493
13494
13495
13496
13497
13498
13499
13500
13501
13502
13503
13504
13505
13506
13507
13508
13509
13510
13511
13512
13513
13514
13515
13516
13517
13518
13519
13520
13521
13522
13523
13524
13525
13526
13527
13528
13529
13530
13531
13532
13533
13534
13535
13536
13537
13538
13539
13540
13541
13542
13543
13544
13545
13546
13547
13548
13549
13550
13551
13552
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 13474

class Instance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # KeyRevocationActionType of the instance. Supported options are "STOP" and "NONE". The default value is "NONE" if it is not specified.
  module KeyRevocationActionType
    # A value indicating that the enum field is not set.
    UNDEFINED_KEY_REVOCATION_ACTION_TYPE = 0

    # Default value. This value is unused.
    KEY_REVOCATION_ACTION_TYPE_UNSPECIFIED = 467_110_106

    # Indicates user chose no operation.
    NONE = 2_402_104

    # Indicates user chose to opt for VM shutdown on key revocation.
    STOP = 2_555_906
  end

  # The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default.
  module PrivateIpv6GoogleAccess
    # A value indicating that the enum field is not set.
    UNDEFINED_PRIVATE_IPV6_GOOGLE_ACCESS = 0

    # Bidirectional private IPv6 access to/from Google services. If specified, the subnetwork who is attached to the instance's default network interface will be assigned an internal IPv6 prefix if it doesn't have before.
    ENABLE_BIDIRECTIONAL_ACCESS_TO_GOOGLE = 427_975_994

    # Outbound private IPv6 access from VMs in this subnet to Google services. If specified, the subnetwork who is attached to the instance's default network interface will be assigned an internal IPv6 prefix if it doesn't have before.
    ENABLE_OUTBOUND_VM_ACCESS_TO_GOOGLE = 288_210_263

    # Each network interface inherits PrivateIpv6GoogleAccess from its subnetwork.
    INHERIT_FROM_SUBNETWORK = 530_256_959
  end

  # [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, REPAIRING, and TERMINATED. For more information about the status of the instance, see Instance life cycle.
  module Status
    # A value indicating that the enum field is not set.
    UNDEFINED_STATUS = 0

    # The instance is halted and we are performing tear down tasks like network deprogramming, releasing quota, IP, tearing down disks etc.
    DEPROVISIONING = 428_935_662

    # Resources are being allocated for the instance.
    PROVISIONING = 290_896_621

    # The instance is in repair.
    REPAIRING = 413_483_285

    # The instance is running.
    RUNNING = 121_282_975

    # All required resources have been allocated and the instance is being started.
    STAGING = 431_072_283

    # The instance has stopped successfully.
    STOPPED = 444_276_141

    # The instance is currently stopping (either being deleted or killed).
    STOPPING = 350_791_796

    # The instance has suspended.
    SUSPENDED = 51_223_995

    # The instance is suspending.
    SUSPENDING = 514_206_246

    # The instance has stopped (either by explicit action or underlying failure).
    TERMINATED = 250_018_339
  end
end

#name::String

Returns The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

Returns:

  • (::String)

    The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.



13474
13475
13476
13477
13478
13479
13480
13481
13482
13483
13484
13485
13486
13487
13488
13489
13490
13491
13492
13493
13494
13495
13496
13497
13498
13499
13500
13501
13502
13503
13504
13505
13506
13507
13508
13509
13510
13511
13512
13513
13514
13515
13516
13517
13518
13519
13520
13521
13522
13523
13524
13525
13526
13527
13528
13529
13530
13531
13532
13533
13534
13535
13536
13537
13538
13539
13540
13541
13542
13543
13544
13545
13546
13547
13548
13549
13550
13551
13552
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 13474

class Instance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # KeyRevocationActionType of the instance. Supported options are "STOP" and "NONE". The default value is "NONE" if it is not specified.
  module KeyRevocationActionType
    # A value indicating that the enum field is not set.
    UNDEFINED_KEY_REVOCATION_ACTION_TYPE = 0

    # Default value. This value is unused.
    KEY_REVOCATION_ACTION_TYPE_UNSPECIFIED = 467_110_106

    # Indicates user chose no operation.
    NONE = 2_402_104

    # Indicates user chose to opt for VM shutdown on key revocation.
    STOP = 2_555_906
  end

  # The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default.
  module PrivateIpv6GoogleAccess
    # A value indicating that the enum field is not set.
    UNDEFINED_PRIVATE_IPV6_GOOGLE_ACCESS = 0

    # Bidirectional private IPv6 access to/from Google services. If specified, the subnetwork who is attached to the instance's default network interface will be assigned an internal IPv6 prefix if it doesn't have before.
    ENABLE_BIDIRECTIONAL_ACCESS_TO_GOOGLE = 427_975_994

    # Outbound private IPv6 access from VMs in this subnet to Google services. If specified, the subnetwork who is attached to the instance's default network interface will be assigned an internal IPv6 prefix if it doesn't have before.
    ENABLE_OUTBOUND_VM_ACCESS_TO_GOOGLE = 288_210_263

    # Each network interface inherits PrivateIpv6GoogleAccess from its subnetwork.
    INHERIT_FROM_SUBNETWORK = 530_256_959
  end

  # [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, REPAIRING, and TERMINATED. For more information about the status of the instance, see Instance life cycle.
  module Status
    # A value indicating that the enum field is not set.
    UNDEFINED_STATUS = 0

    # The instance is halted and we are performing tear down tasks like network deprogramming, releasing quota, IP, tearing down disks etc.
    DEPROVISIONING = 428_935_662

    # Resources are being allocated for the instance.
    PROVISIONING = 290_896_621

    # The instance is in repair.
    REPAIRING = 413_483_285

    # The instance is running.
    RUNNING = 121_282_975

    # All required resources have been allocated and the instance is being started.
    STAGING = 431_072_283

    # The instance has stopped successfully.
    STOPPED = 444_276_141

    # The instance is currently stopping (either being deleted or killed).
    STOPPING = 350_791_796

    # The instance has suspended.
    SUSPENDED = 51_223_995

    # The instance is suspending.
    SUSPENDING = 514_206_246

    # The instance has stopped (either by explicit action or underlying failure).
    TERMINATED = 250_018_339
  end
end

#network_interfaces::Array<::Google::Cloud::Compute::V1::NetworkInterface>

Returns An array of network configurations for this instance. These specify how interfaces are configured to interact with other network services, such as connecting to the internet. Multiple interfaces are supported per instance.

Returns:

  • (::Array<::Google::Cloud::Compute::V1::NetworkInterface>)

    An array of network configurations for this instance. These specify how interfaces are configured to interact with other network services, such as connecting to the internet. Multiple interfaces are supported per instance.



13474
13475
13476
13477
13478
13479
13480
13481
13482
13483
13484
13485
13486
13487
13488
13489
13490
13491
13492
13493
13494
13495
13496
13497
13498
13499
13500
13501
13502
13503
13504
13505
13506
13507
13508
13509
13510
13511
13512
13513
13514
13515
13516
13517
13518
13519
13520
13521
13522
13523
13524
13525
13526
13527
13528
13529
13530
13531
13532
13533
13534
13535
13536
13537
13538
13539
13540
13541
13542
13543
13544
13545
13546
13547
13548
13549
13550
13551
13552
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 13474

class Instance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # KeyRevocationActionType of the instance. Supported options are "STOP" and "NONE". The default value is "NONE" if it is not specified.
  module KeyRevocationActionType
    # A value indicating that the enum field is not set.
    UNDEFINED_KEY_REVOCATION_ACTION_TYPE = 0

    # Default value. This value is unused.
    KEY_REVOCATION_ACTION_TYPE_UNSPECIFIED = 467_110_106

    # Indicates user chose no operation.
    NONE = 2_402_104

    # Indicates user chose to opt for VM shutdown on key revocation.
    STOP = 2_555_906
  end

  # The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default.
  module PrivateIpv6GoogleAccess
    # A value indicating that the enum field is not set.
    UNDEFINED_PRIVATE_IPV6_GOOGLE_ACCESS = 0

    # Bidirectional private IPv6 access to/from Google services. If specified, the subnetwork who is attached to the instance's default network interface will be assigned an internal IPv6 prefix if it doesn't have before.
    ENABLE_BIDIRECTIONAL_ACCESS_TO_GOOGLE = 427_975_994

    # Outbound private IPv6 access from VMs in this subnet to Google services. If specified, the subnetwork who is attached to the instance's default network interface will be assigned an internal IPv6 prefix if it doesn't have before.
    ENABLE_OUTBOUND_VM_ACCESS_TO_GOOGLE = 288_210_263

    # Each network interface inherits PrivateIpv6GoogleAccess from its subnetwork.
    INHERIT_FROM_SUBNETWORK = 530_256_959
  end

  # [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, REPAIRING, and TERMINATED. For more information about the status of the instance, see Instance life cycle.
  module Status
    # A value indicating that the enum field is not set.
    UNDEFINED_STATUS = 0

    # The instance is halted and we are performing tear down tasks like network deprogramming, releasing quota, IP, tearing down disks etc.
    DEPROVISIONING = 428_935_662

    # Resources are being allocated for the instance.
    PROVISIONING = 290_896_621

    # The instance is in repair.
    REPAIRING = 413_483_285

    # The instance is running.
    RUNNING = 121_282_975

    # All required resources have been allocated and the instance is being started.
    STAGING = 431_072_283

    # The instance has stopped successfully.
    STOPPED = 444_276_141

    # The instance is currently stopping (either being deleted or killed).
    STOPPING = 350_791_796

    # The instance has suspended.
    SUSPENDED = 51_223_995

    # The instance is suspending.
    SUSPENDING = 514_206_246

    # The instance has stopped (either by explicit action or underlying failure).
    TERMINATED = 250_018_339
  end
end

#network_performance_config::Google::Cloud::Compute::V1::NetworkPerformanceConfig



13474
13475
13476
13477
13478
13479
13480
13481
13482
13483
13484
13485
13486
13487
13488
13489
13490
13491
13492
13493
13494
13495
13496
13497
13498
13499
13500
13501
13502
13503
13504
13505
13506
13507
13508
13509
13510
13511
13512
13513
13514
13515
13516
13517
13518
13519
13520
13521
13522
13523
13524
13525
13526
13527
13528
13529
13530
13531
13532
13533
13534
13535
13536
13537
13538
13539
13540
13541
13542
13543
13544
13545
13546
13547
13548
13549
13550
13551
13552
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 13474

class Instance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # KeyRevocationActionType of the instance. Supported options are "STOP" and "NONE". The default value is "NONE" if it is not specified.
  module KeyRevocationActionType
    # A value indicating that the enum field is not set.
    UNDEFINED_KEY_REVOCATION_ACTION_TYPE = 0

    # Default value. This value is unused.
    KEY_REVOCATION_ACTION_TYPE_UNSPECIFIED = 467_110_106

    # Indicates user chose no operation.
    NONE = 2_402_104

    # Indicates user chose to opt for VM shutdown on key revocation.
    STOP = 2_555_906
  end

  # The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default.
  module PrivateIpv6GoogleAccess
    # A value indicating that the enum field is not set.
    UNDEFINED_PRIVATE_IPV6_GOOGLE_ACCESS = 0

    # Bidirectional private IPv6 access to/from Google services. If specified, the subnetwork who is attached to the instance's default network interface will be assigned an internal IPv6 prefix if it doesn't have before.
    ENABLE_BIDIRECTIONAL_ACCESS_TO_GOOGLE = 427_975_994

    # Outbound private IPv6 access from VMs in this subnet to Google services. If specified, the subnetwork who is attached to the instance's default network interface will be assigned an internal IPv6 prefix if it doesn't have before.
    ENABLE_OUTBOUND_VM_ACCESS_TO_GOOGLE = 288_210_263

    # Each network interface inherits PrivateIpv6GoogleAccess from its subnetwork.
    INHERIT_FROM_SUBNETWORK = 530_256_959
  end

  # [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, REPAIRING, and TERMINATED. For more information about the status of the instance, see Instance life cycle.
  module Status
    # A value indicating that the enum field is not set.
    UNDEFINED_STATUS = 0

    # The instance is halted and we are performing tear down tasks like network deprogramming, releasing quota, IP, tearing down disks etc.
    DEPROVISIONING = 428_935_662

    # Resources are being allocated for the instance.
    PROVISIONING = 290_896_621

    # The instance is in repair.
    REPAIRING = 413_483_285

    # The instance is running.
    RUNNING = 121_282_975

    # All required resources have been allocated and the instance is being started.
    STAGING = 431_072_283

    # The instance has stopped successfully.
    STOPPED = 444_276_141

    # The instance is currently stopping (either being deleted or killed).
    STOPPING = 350_791_796

    # The instance has suspended.
    SUSPENDED = 51_223_995

    # The instance is suspending.
    SUSPENDING = 514_206_246

    # The instance has stopped (either by explicit action or underlying failure).
    TERMINATED = 250_018_339
  end
end

#params::Google::Cloud::Compute::V1::InstanceParams

Returns Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload.

Returns:



13474
13475
13476
13477
13478
13479
13480
13481
13482
13483
13484
13485
13486
13487
13488
13489
13490
13491
13492
13493
13494
13495
13496
13497
13498
13499
13500
13501
13502
13503
13504
13505
13506
13507
13508
13509
13510
13511
13512
13513
13514
13515
13516
13517
13518
13519
13520
13521
13522
13523
13524
13525
13526
13527
13528
13529
13530
13531
13532
13533
13534
13535
13536
13537
13538
13539
13540
13541
13542
13543
13544
13545
13546
13547
13548
13549
13550
13551
13552
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 13474

class Instance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # KeyRevocationActionType of the instance. Supported options are "STOP" and "NONE". The default value is "NONE" if it is not specified.
  module KeyRevocationActionType
    # A value indicating that the enum field is not set.
    UNDEFINED_KEY_REVOCATION_ACTION_TYPE = 0

    # Default value. This value is unused.
    KEY_REVOCATION_ACTION_TYPE_UNSPECIFIED = 467_110_106

    # Indicates user chose no operation.
    NONE = 2_402_104

    # Indicates user chose to opt for VM shutdown on key revocation.
    STOP = 2_555_906
  end

  # The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default.
  module PrivateIpv6GoogleAccess
    # A value indicating that the enum field is not set.
    UNDEFINED_PRIVATE_IPV6_GOOGLE_ACCESS = 0

    # Bidirectional private IPv6 access to/from Google services. If specified, the subnetwork who is attached to the instance's default network interface will be assigned an internal IPv6 prefix if it doesn't have before.
    ENABLE_BIDIRECTIONAL_ACCESS_TO_GOOGLE = 427_975_994

    # Outbound private IPv6 access from VMs in this subnet to Google services. If specified, the subnetwork who is attached to the instance's default network interface will be assigned an internal IPv6 prefix if it doesn't have before.
    ENABLE_OUTBOUND_VM_ACCESS_TO_GOOGLE = 288_210_263

    # Each network interface inherits PrivateIpv6GoogleAccess from its subnetwork.
    INHERIT_FROM_SUBNETWORK = 530_256_959
  end

  # [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, REPAIRING, and TERMINATED. For more information about the status of the instance, see Instance life cycle.
  module Status
    # A value indicating that the enum field is not set.
    UNDEFINED_STATUS = 0

    # The instance is halted and we are performing tear down tasks like network deprogramming, releasing quota, IP, tearing down disks etc.
    DEPROVISIONING = 428_935_662

    # Resources are being allocated for the instance.
    PROVISIONING = 290_896_621

    # The instance is in repair.
    REPAIRING = 413_483_285

    # The instance is running.
    RUNNING = 121_282_975

    # All required resources have been allocated and the instance is being started.
    STAGING = 431_072_283

    # The instance has stopped successfully.
    STOPPED = 444_276_141

    # The instance is currently stopping (either being deleted or killed).
    STOPPING = 350_791_796

    # The instance has suspended.
    SUSPENDED = 51_223_995

    # The instance is suspending.
    SUSPENDING = 514_206_246

    # The instance has stopped (either by explicit action or underlying failure).
    TERMINATED = 250_018_339
  end
end

#private_ipv6_google_access::String

Returns The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default. Check the PrivateIpv6GoogleAccess enum for the list of possible values.

Returns:

  • (::String)

    The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default. Check the PrivateIpv6GoogleAccess enum for the list of possible values.



13474
13475
13476
13477
13478
13479
13480
13481
13482
13483
13484
13485
13486
13487
13488
13489
13490
13491
13492
13493
13494
13495
13496
13497
13498
13499
13500
13501
13502
13503
13504
13505
13506
13507
13508
13509
13510
13511
13512
13513
13514
13515
13516
13517
13518
13519
13520
13521
13522
13523
13524
13525
13526
13527
13528
13529
13530
13531
13532
13533
13534
13535
13536
13537
13538
13539
13540
13541
13542
13543
13544
13545
13546
13547
13548
13549
13550
13551
13552
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 13474

class Instance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # KeyRevocationActionType of the instance. Supported options are "STOP" and "NONE". The default value is "NONE" if it is not specified.
  module KeyRevocationActionType
    # A value indicating that the enum field is not set.
    UNDEFINED_KEY_REVOCATION_ACTION_TYPE = 0

    # Default value. This value is unused.
    KEY_REVOCATION_ACTION_TYPE_UNSPECIFIED = 467_110_106

    # Indicates user chose no operation.
    NONE = 2_402_104

    # Indicates user chose to opt for VM shutdown on key revocation.
    STOP = 2_555_906
  end

  # The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default.
  module PrivateIpv6GoogleAccess
    # A value indicating that the enum field is not set.
    UNDEFINED_PRIVATE_IPV6_GOOGLE_ACCESS = 0

    # Bidirectional private IPv6 access to/from Google services. If specified, the subnetwork who is attached to the instance's default network interface will be assigned an internal IPv6 prefix if it doesn't have before.
    ENABLE_BIDIRECTIONAL_ACCESS_TO_GOOGLE = 427_975_994

    # Outbound private IPv6 access from VMs in this subnet to Google services. If specified, the subnetwork who is attached to the instance's default network interface will be assigned an internal IPv6 prefix if it doesn't have before.
    ENABLE_OUTBOUND_VM_ACCESS_TO_GOOGLE = 288_210_263

    # Each network interface inherits PrivateIpv6GoogleAccess from its subnetwork.
    INHERIT_FROM_SUBNETWORK = 530_256_959
  end

  # [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, REPAIRING, and TERMINATED. For more information about the status of the instance, see Instance life cycle.
  module Status
    # A value indicating that the enum field is not set.
    UNDEFINED_STATUS = 0

    # The instance is halted and we are performing tear down tasks like network deprogramming, releasing quota, IP, tearing down disks etc.
    DEPROVISIONING = 428_935_662

    # Resources are being allocated for the instance.
    PROVISIONING = 290_896_621

    # The instance is in repair.
    REPAIRING = 413_483_285

    # The instance is running.
    RUNNING = 121_282_975

    # All required resources have been allocated and the instance is being started.
    STAGING = 431_072_283

    # The instance has stopped successfully.
    STOPPED = 444_276_141

    # The instance is currently stopping (either being deleted or killed).
    STOPPING = 350_791_796

    # The instance has suspended.
    SUSPENDED = 51_223_995

    # The instance is suspending.
    SUSPENDING = 514_206_246

    # The instance has stopped (either by explicit action or underlying failure).
    TERMINATED = 250_018_339
  end
end

#reservation_affinity::Google::Cloud::Compute::V1::ReservationAffinity

Returns Specifies the reservations that this instance can consume from.

Returns:



13474
13475
13476
13477
13478
13479
13480
13481
13482
13483
13484
13485
13486
13487
13488
13489
13490
13491
13492
13493
13494
13495
13496
13497
13498
13499
13500
13501
13502
13503
13504
13505
13506
13507
13508
13509
13510
13511
13512
13513
13514
13515
13516
13517
13518
13519
13520
13521
13522
13523
13524
13525
13526
13527
13528
13529
13530
13531
13532
13533
13534
13535
13536
13537
13538
13539
13540
13541
13542
13543
13544
13545
13546
13547
13548
13549
13550
13551
13552
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 13474

class Instance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # KeyRevocationActionType of the instance. Supported options are "STOP" and "NONE". The default value is "NONE" if it is not specified.
  module KeyRevocationActionType
    # A value indicating that the enum field is not set.
    UNDEFINED_KEY_REVOCATION_ACTION_TYPE = 0

    # Default value. This value is unused.
    KEY_REVOCATION_ACTION_TYPE_UNSPECIFIED = 467_110_106

    # Indicates user chose no operation.
    NONE = 2_402_104

    # Indicates user chose to opt for VM shutdown on key revocation.
    STOP = 2_555_906
  end

  # The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default.
  module PrivateIpv6GoogleAccess
    # A value indicating that the enum field is not set.
    UNDEFINED_PRIVATE_IPV6_GOOGLE_ACCESS = 0

    # Bidirectional private IPv6 access to/from Google services. If specified, the subnetwork who is attached to the instance's default network interface will be assigned an internal IPv6 prefix if it doesn't have before.
    ENABLE_BIDIRECTIONAL_ACCESS_TO_GOOGLE = 427_975_994

    # Outbound private IPv6 access from VMs in this subnet to Google services. If specified, the subnetwork who is attached to the instance's default network interface will be assigned an internal IPv6 prefix if it doesn't have before.
    ENABLE_OUTBOUND_VM_ACCESS_TO_GOOGLE = 288_210_263

    # Each network interface inherits PrivateIpv6GoogleAccess from its subnetwork.
    INHERIT_FROM_SUBNETWORK = 530_256_959
  end

  # [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, REPAIRING, and TERMINATED. For more information about the status of the instance, see Instance life cycle.
  module Status
    # A value indicating that the enum field is not set.
    UNDEFINED_STATUS = 0

    # The instance is halted and we are performing tear down tasks like network deprogramming, releasing quota, IP, tearing down disks etc.
    DEPROVISIONING = 428_935_662

    # Resources are being allocated for the instance.
    PROVISIONING = 290_896_621

    # The instance is in repair.
    REPAIRING = 413_483_285

    # The instance is running.
    RUNNING = 121_282_975

    # All required resources have been allocated and the instance is being started.
    STAGING = 431_072_283

    # The instance has stopped successfully.
    STOPPED = 444_276_141

    # The instance is currently stopping (either being deleted or killed).
    STOPPING = 350_791_796

    # The instance has suspended.
    SUSPENDED = 51_223_995

    # The instance is suspending.
    SUSPENDING = 514_206_246

    # The instance has stopped (either by explicit action or underlying failure).
    TERMINATED = 250_018_339
  end
end

#resource_policies::Array<::String>

Returns Resource policies applied to this instance.

Returns:

  • (::Array<::String>)

    Resource policies applied to this instance.



13474
13475
13476
13477
13478
13479
13480
13481
13482
13483
13484
13485
13486
13487
13488
13489
13490
13491
13492
13493
13494
13495
13496
13497
13498
13499
13500
13501
13502
13503
13504
13505
13506
13507
13508
13509
13510
13511
13512
13513
13514
13515
13516
13517
13518
13519
13520
13521
13522
13523
13524
13525
13526
13527
13528
13529
13530
13531
13532
13533
13534
13535
13536
13537
13538
13539
13540
13541
13542
13543
13544
13545
13546
13547
13548
13549
13550
13551
13552
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 13474

class Instance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # KeyRevocationActionType of the instance. Supported options are "STOP" and "NONE". The default value is "NONE" if it is not specified.
  module KeyRevocationActionType
    # A value indicating that the enum field is not set.
    UNDEFINED_KEY_REVOCATION_ACTION_TYPE = 0

    # Default value. This value is unused.
    KEY_REVOCATION_ACTION_TYPE_UNSPECIFIED = 467_110_106

    # Indicates user chose no operation.
    NONE = 2_402_104

    # Indicates user chose to opt for VM shutdown on key revocation.
    STOP = 2_555_906
  end

  # The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default.
  module PrivateIpv6GoogleAccess
    # A value indicating that the enum field is not set.
    UNDEFINED_PRIVATE_IPV6_GOOGLE_ACCESS = 0

    # Bidirectional private IPv6 access to/from Google services. If specified, the subnetwork who is attached to the instance's default network interface will be assigned an internal IPv6 prefix if it doesn't have before.
    ENABLE_BIDIRECTIONAL_ACCESS_TO_GOOGLE = 427_975_994

    # Outbound private IPv6 access from VMs in this subnet to Google services. If specified, the subnetwork who is attached to the instance's default network interface will be assigned an internal IPv6 prefix if it doesn't have before.
    ENABLE_OUTBOUND_VM_ACCESS_TO_GOOGLE = 288_210_263

    # Each network interface inherits PrivateIpv6GoogleAccess from its subnetwork.
    INHERIT_FROM_SUBNETWORK = 530_256_959
  end

  # [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, REPAIRING, and TERMINATED. For more information about the status of the instance, see Instance life cycle.
  module Status
    # A value indicating that the enum field is not set.
    UNDEFINED_STATUS = 0

    # The instance is halted and we are performing tear down tasks like network deprogramming, releasing quota, IP, tearing down disks etc.
    DEPROVISIONING = 428_935_662

    # Resources are being allocated for the instance.
    PROVISIONING = 290_896_621

    # The instance is in repair.
    REPAIRING = 413_483_285

    # The instance is running.
    RUNNING = 121_282_975

    # All required resources have been allocated and the instance is being started.
    STAGING = 431_072_283

    # The instance has stopped successfully.
    STOPPED = 444_276_141

    # The instance is currently stopping (either being deleted or killed).
    STOPPING = 350_791_796

    # The instance has suspended.
    SUSPENDED = 51_223_995

    # The instance is suspending.
    SUSPENDING = 514_206_246

    # The instance has stopped (either by explicit action or underlying failure).
    TERMINATED = 250_018_339
  end
end

#resource_status::Google::Cloud::Compute::V1::ResourceStatus

Returns [Output Only] Specifies values set for instance attributes as compared to the values requested by user in the corresponding input only field.

Returns:



13474
13475
13476
13477
13478
13479
13480
13481
13482
13483
13484
13485
13486
13487
13488
13489
13490
13491
13492
13493
13494
13495
13496
13497
13498
13499
13500
13501
13502
13503
13504
13505
13506
13507
13508
13509
13510
13511
13512
13513
13514
13515
13516
13517
13518
13519
13520
13521
13522
13523
13524
13525
13526
13527
13528
13529
13530
13531
13532
13533
13534
13535
13536
13537
13538
13539
13540
13541
13542
13543
13544
13545
13546
13547
13548
13549
13550
13551
13552
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 13474

class Instance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # KeyRevocationActionType of the instance. Supported options are "STOP" and "NONE". The default value is "NONE" if it is not specified.
  module KeyRevocationActionType
    # A value indicating that the enum field is not set.
    UNDEFINED_KEY_REVOCATION_ACTION_TYPE = 0

    # Default value. This value is unused.
    KEY_REVOCATION_ACTION_TYPE_UNSPECIFIED = 467_110_106

    # Indicates user chose no operation.
    NONE = 2_402_104

    # Indicates user chose to opt for VM shutdown on key revocation.
    STOP = 2_555_906
  end

  # The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default.
  module PrivateIpv6GoogleAccess
    # A value indicating that the enum field is not set.
    UNDEFINED_PRIVATE_IPV6_GOOGLE_ACCESS = 0

    # Bidirectional private IPv6 access to/from Google services. If specified, the subnetwork who is attached to the instance's default network interface will be assigned an internal IPv6 prefix if it doesn't have before.
    ENABLE_BIDIRECTIONAL_ACCESS_TO_GOOGLE = 427_975_994

    # Outbound private IPv6 access from VMs in this subnet to Google services. If specified, the subnetwork who is attached to the instance's default network interface will be assigned an internal IPv6 prefix if it doesn't have before.
    ENABLE_OUTBOUND_VM_ACCESS_TO_GOOGLE = 288_210_263

    # Each network interface inherits PrivateIpv6GoogleAccess from its subnetwork.
    INHERIT_FROM_SUBNETWORK = 530_256_959
  end

  # [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, REPAIRING, and TERMINATED. For more information about the status of the instance, see Instance life cycle.
  module Status
    # A value indicating that the enum field is not set.
    UNDEFINED_STATUS = 0

    # The instance is halted and we are performing tear down tasks like network deprogramming, releasing quota, IP, tearing down disks etc.
    DEPROVISIONING = 428_935_662

    # Resources are being allocated for the instance.
    PROVISIONING = 290_896_621

    # The instance is in repair.
    REPAIRING = 413_483_285

    # The instance is running.
    RUNNING = 121_282_975

    # All required resources have been allocated and the instance is being started.
    STAGING = 431_072_283

    # The instance has stopped successfully.
    STOPPED = 444_276_141

    # The instance is currently stopping (either being deleted or killed).
    STOPPING = 350_791_796

    # The instance has suspended.
    SUSPENDED = 51_223_995

    # The instance is suspending.
    SUSPENDING = 514_206_246

    # The instance has stopped (either by explicit action or underlying failure).
    TERMINATED = 250_018_339
  end
end

#satisfies_pzi::Boolean

Returns [Output Only] Reserved for future use.

Returns:

  • (::Boolean)

    [Output Only] Reserved for future use.



13474
13475
13476
13477
13478
13479
13480
13481
13482
13483
13484
13485
13486
13487
13488
13489
13490
13491
13492
13493
13494
13495
13496
13497
13498
13499
13500
13501
13502
13503
13504
13505
13506
13507
13508
13509
13510
13511
13512
13513
13514
13515
13516
13517
13518
13519
13520
13521
13522
13523
13524
13525
13526
13527
13528
13529
13530
13531
13532
13533
13534
13535
13536
13537
13538
13539
13540
13541
13542
13543
13544
13545
13546
13547
13548
13549
13550
13551
13552
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 13474

class Instance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # KeyRevocationActionType of the instance. Supported options are "STOP" and "NONE". The default value is "NONE" if it is not specified.
  module KeyRevocationActionType
    # A value indicating that the enum field is not set.
    UNDEFINED_KEY_REVOCATION_ACTION_TYPE = 0

    # Default value. This value is unused.
    KEY_REVOCATION_ACTION_TYPE_UNSPECIFIED = 467_110_106

    # Indicates user chose no operation.
    NONE = 2_402_104

    # Indicates user chose to opt for VM shutdown on key revocation.
    STOP = 2_555_906
  end

  # The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default.
  module PrivateIpv6GoogleAccess
    # A value indicating that the enum field is not set.
    UNDEFINED_PRIVATE_IPV6_GOOGLE_ACCESS = 0

    # Bidirectional private IPv6 access to/from Google services. If specified, the subnetwork who is attached to the instance's default network interface will be assigned an internal IPv6 prefix if it doesn't have before.
    ENABLE_BIDIRECTIONAL_ACCESS_TO_GOOGLE = 427_975_994

    # Outbound private IPv6 access from VMs in this subnet to Google services. If specified, the subnetwork who is attached to the instance's default network interface will be assigned an internal IPv6 prefix if it doesn't have before.
    ENABLE_OUTBOUND_VM_ACCESS_TO_GOOGLE = 288_210_263

    # Each network interface inherits PrivateIpv6GoogleAccess from its subnetwork.
    INHERIT_FROM_SUBNETWORK = 530_256_959
  end

  # [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, REPAIRING, and TERMINATED. For more information about the status of the instance, see Instance life cycle.
  module Status
    # A value indicating that the enum field is not set.
    UNDEFINED_STATUS = 0

    # The instance is halted and we are performing tear down tasks like network deprogramming, releasing quota, IP, tearing down disks etc.
    DEPROVISIONING = 428_935_662

    # Resources are being allocated for the instance.
    PROVISIONING = 290_896_621

    # The instance is in repair.
    REPAIRING = 413_483_285

    # The instance is running.
    RUNNING = 121_282_975

    # All required resources have been allocated and the instance is being started.
    STAGING = 431_072_283

    # The instance has stopped successfully.
    STOPPED = 444_276_141

    # The instance is currently stopping (either being deleted or killed).
    STOPPING = 350_791_796

    # The instance has suspended.
    SUSPENDED = 51_223_995

    # The instance is suspending.
    SUSPENDING = 514_206_246

    # The instance has stopped (either by explicit action or underlying failure).
    TERMINATED = 250_018_339
  end
end

#satisfies_pzs::Boolean

Returns [Output Only] Reserved for future use.

Returns:

  • (::Boolean)

    [Output Only] Reserved for future use.



13474
13475
13476
13477
13478
13479
13480
13481
13482
13483
13484
13485
13486
13487
13488
13489
13490
13491
13492
13493
13494
13495
13496
13497
13498
13499
13500
13501
13502
13503
13504
13505
13506
13507
13508
13509
13510
13511
13512
13513
13514
13515
13516
13517
13518
13519
13520
13521
13522
13523
13524
13525
13526
13527
13528
13529
13530
13531
13532
13533
13534
13535
13536
13537
13538
13539
13540
13541
13542
13543
13544
13545
13546
13547
13548
13549
13550
13551
13552
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 13474

class Instance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # KeyRevocationActionType of the instance. Supported options are "STOP" and "NONE". The default value is "NONE" if it is not specified.
  module KeyRevocationActionType
    # A value indicating that the enum field is not set.
    UNDEFINED_KEY_REVOCATION_ACTION_TYPE = 0

    # Default value. This value is unused.
    KEY_REVOCATION_ACTION_TYPE_UNSPECIFIED = 467_110_106

    # Indicates user chose no operation.
    NONE = 2_402_104

    # Indicates user chose to opt for VM shutdown on key revocation.
    STOP = 2_555_906
  end

  # The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default.
  module PrivateIpv6GoogleAccess
    # A value indicating that the enum field is not set.
    UNDEFINED_PRIVATE_IPV6_GOOGLE_ACCESS = 0

    # Bidirectional private IPv6 access to/from Google services. If specified, the subnetwork who is attached to the instance's default network interface will be assigned an internal IPv6 prefix if it doesn't have before.
    ENABLE_BIDIRECTIONAL_ACCESS_TO_GOOGLE = 427_975_994

    # Outbound private IPv6 access from VMs in this subnet to Google services. If specified, the subnetwork who is attached to the instance's default network interface will be assigned an internal IPv6 prefix if it doesn't have before.
    ENABLE_OUTBOUND_VM_ACCESS_TO_GOOGLE = 288_210_263

    # Each network interface inherits PrivateIpv6GoogleAccess from its subnetwork.
    INHERIT_FROM_SUBNETWORK = 530_256_959
  end

  # [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, REPAIRING, and TERMINATED. For more information about the status of the instance, see Instance life cycle.
  module Status
    # A value indicating that the enum field is not set.
    UNDEFINED_STATUS = 0

    # The instance is halted and we are performing tear down tasks like network deprogramming, releasing quota, IP, tearing down disks etc.
    DEPROVISIONING = 428_935_662

    # Resources are being allocated for the instance.
    PROVISIONING = 290_896_621

    # The instance is in repair.
    REPAIRING = 413_483_285

    # The instance is running.
    RUNNING = 121_282_975

    # All required resources have been allocated and the instance is being started.
    STAGING = 431_072_283

    # The instance has stopped successfully.
    STOPPED = 444_276_141

    # The instance is currently stopping (either being deleted or killed).
    STOPPING = 350_791_796

    # The instance has suspended.
    SUSPENDED = 51_223_995

    # The instance is suspending.
    SUSPENDING = 514_206_246

    # The instance has stopped (either by explicit action or underlying failure).
    TERMINATED = 250_018_339
  end
end

#scheduling::Google::Cloud::Compute::V1::Scheduling

Returns Sets the scheduling options for this instance.

Returns:



13474
13475
13476
13477
13478
13479
13480
13481
13482
13483
13484
13485
13486
13487
13488
13489
13490
13491
13492
13493
13494
13495
13496
13497
13498
13499
13500
13501
13502
13503
13504
13505
13506
13507
13508
13509
13510
13511
13512
13513
13514
13515
13516
13517
13518
13519
13520
13521
13522
13523
13524
13525
13526
13527
13528
13529
13530
13531
13532
13533
13534
13535
13536
13537
13538
13539
13540
13541
13542
13543
13544
13545
13546
13547
13548
13549
13550
13551
13552
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 13474

class Instance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # KeyRevocationActionType of the instance. Supported options are "STOP" and "NONE". The default value is "NONE" if it is not specified.
  module KeyRevocationActionType
    # A value indicating that the enum field is not set.
    UNDEFINED_KEY_REVOCATION_ACTION_TYPE = 0

    # Default value. This value is unused.
    KEY_REVOCATION_ACTION_TYPE_UNSPECIFIED = 467_110_106

    # Indicates user chose no operation.
    NONE = 2_402_104

    # Indicates user chose to opt for VM shutdown on key revocation.
    STOP = 2_555_906
  end

  # The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default.
  module PrivateIpv6GoogleAccess
    # A value indicating that the enum field is not set.
    UNDEFINED_PRIVATE_IPV6_GOOGLE_ACCESS = 0

    # Bidirectional private IPv6 access to/from Google services. If specified, the subnetwork who is attached to the instance's default network interface will be assigned an internal IPv6 prefix if it doesn't have before.
    ENABLE_BIDIRECTIONAL_ACCESS_TO_GOOGLE = 427_975_994

    # Outbound private IPv6 access from VMs in this subnet to Google services. If specified, the subnetwork who is attached to the instance's default network interface will be assigned an internal IPv6 prefix if it doesn't have before.
    ENABLE_OUTBOUND_VM_ACCESS_TO_GOOGLE = 288_210_263

    # Each network interface inherits PrivateIpv6GoogleAccess from its subnetwork.
    INHERIT_FROM_SUBNETWORK = 530_256_959
  end

  # [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, REPAIRING, and TERMINATED. For more information about the status of the instance, see Instance life cycle.
  module Status
    # A value indicating that the enum field is not set.
    UNDEFINED_STATUS = 0

    # The instance is halted and we are performing tear down tasks like network deprogramming, releasing quota, IP, tearing down disks etc.
    DEPROVISIONING = 428_935_662

    # Resources are being allocated for the instance.
    PROVISIONING = 290_896_621

    # The instance is in repair.
    REPAIRING = 413_483_285

    # The instance is running.
    RUNNING = 121_282_975

    # All required resources have been allocated and the instance is being started.
    STAGING = 431_072_283

    # The instance has stopped successfully.
    STOPPED = 444_276_141

    # The instance is currently stopping (either being deleted or killed).
    STOPPING = 350_791_796

    # The instance has suspended.
    SUSPENDED = 51_223_995

    # The instance is suspending.
    SUSPENDING = 514_206_246

    # The instance has stopped (either by explicit action or underlying failure).
    TERMINATED = 250_018_339
  end
end

Returns [Output Only] Server-defined URL for this resource.

Returns:

  • (::String)

    [Output Only] Server-defined URL for this resource.



13474
13475
13476
13477
13478
13479
13480
13481
13482
13483
13484
13485
13486
13487
13488
13489
13490
13491
13492
13493
13494
13495
13496
13497
13498
13499
13500
13501
13502
13503
13504
13505
13506
13507
13508
13509
13510
13511
13512
13513
13514
13515
13516
13517
13518
13519
13520
13521
13522
13523
13524
13525
13526
13527
13528
13529
13530
13531
13532
13533
13534
13535
13536
13537
13538
13539
13540
13541
13542
13543
13544
13545
13546
13547
13548
13549
13550
13551
13552
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 13474

class Instance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # KeyRevocationActionType of the instance. Supported options are "STOP" and "NONE". The default value is "NONE" if it is not specified.
  module KeyRevocationActionType
    # A value indicating that the enum field is not set.
    UNDEFINED_KEY_REVOCATION_ACTION_TYPE = 0

    # Default value. This value is unused.
    KEY_REVOCATION_ACTION_TYPE_UNSPECIFIED = 467_110_106

    # Indicates user chose no operation.
    NONE = 2_402_104

    # Indicates user chose to opt for VM shutdown on key revocation.
    STOP = 2_555_906
  end

  # The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default.
  module PrivateIpv6GoogleAccess
    # A value indicating that the enum field is not set.
    UNDEFINED_PRIVATE_IPV6_GOOGLE_ACCESS = 0

    # Bidirectional private IPv6 access to/from Google services. If specified, the subnetwork who is attached to the instance's default network interface will be assigned an internal IPv6 prefix if it doesn't have before.
    ENABLE_BIDIRECTIONAL_ACCESS_TO_GOOGLE = 427_975_994

    # Outbound private IPv6 access from VMs in this subnet to Google services. If specified, the subnetwork who is attached to the instance's default network interface will be assigned an internal IPv6 prefix if it doesn't have before.
    ENABLE_OUTBOUND_VM_ACCESS_TO_GOOGLE = 288_210_263

    # Each network interface inherits PrivateIpv6GoogleAccess from its subnetwork.
    INHERIT_FROM_SUBNETWORK = 530_256_959
  end

  # [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, REPAIRING, and TERMINATED. For more information about the status of the instance, see Instance life cycle.
  module Status
    # A value indicating that the enum field is not set.
    UNDEFINED_STATUS = 0

    # The instance is halted and we are performing tear down tasks like network deprogramming, releasing quota, IP, tearing down disks etc.
    DEPROVISIONING = 428_935_662

    # Resources are being allocated for the instance.
    PROVISIONING = 290_896_621

    # The instance is in repair.
    REPAIRING = 413_483_285

    # The instance is running.
    RUNNING = 121_282_975

    # All required resources have been allocated and the instance is being started.
    STAGING = 431_072_283

    # The instance has stopped successfully.
    STOPPED = 444_276_141

    # The instance is currently stopping (either being deleted or killed).
    STOPPING = 350_791_796

    # The instance has suspended.
    SUSPENDED = 51_223_995

    # The instance is suspending.
    SUSPENDING = 514_206_246

    # The instance has stopped (either by explicit action or underlying failure).
    TERMINATED = 250_018_339
  end
end

#service_accounts::Array<::Google::Cloud::Compute::V1::ServiceAccount>

Returns A list of service accounts, with their specified scopes, authorized for this instance. Only one service account per VM instance is supported. Service accounts generate access tokens that can be accessed through the metadata server and used to authenticate applications on the instance. See Service Accounts for more information.

Returns:

  • (::Array<::Google::Cloud::Compute::V1::ServiceAccount>)

    A list of service accounts, with their specified scopes, authorized for this instance. Only one service account per VM instance is supported. Service accounts generate access tokens that can be accessed through the metadata server and used to authenticate applications on the instance. See Service Accounts for more information.



13474
13475
13476
13477
13478
13479
13480
13481
13482
13483
13484
13485
13486
13487
13488
13489
13490
13491
13492
13493
13494
13495
13496
13497
13498
13499
13500
13501
13502
13503
13504
13505
13506
13507
13508
13509
13510
13511
13512
13513
13514
13515
13516
13517
13518
13519
13520
13521
13522
13523
13524
13525
13526
13527
13528
13529
13530
13531
13532
13533
13534
13535
13536
13537
13538
13539
13540
13541
13542
13543
13544
13545
13546
13547
13548
13549
13550
13551
13552
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 13474

class Instance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # KeyRevocationActionType of the instance. Supported options are "STOP" and "NONE". The default value is "NONE" if it is not specified.
  module KeyRevocationActionType
    # A value indicating that the enum field is not set.
    UNDEFINED_KEY_REVOCATION_ACTION_TYPE = 0

    # Default value. This value is unused.
    KEY_REVOCATION_ACTION_TYPE_UNSPECIFIED = 467_110_106

    # Indicates user chose no operation.
    NONE = 2_402_104

    # Indicates user chose to opt for VM shutdown on key revocation.
    STOP = 2_555_906
  end

  # The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default.
  module PrivateIpv6GoogleAccess
    # A value indicating that the enum field is not set.
    UNDEFINED_PRIVATE_IPV6_GOOGLE_ACCESS = 0

    # Bidirectional private IPv6 access to/from Google services. If specified, the subnetwork who is attached to the instance's default network interface will be assigned an internal IPv6 prefix if it doesn't have before.
    ENABLE_BIDIRECTIONAL_ACCESS_TO_GOOGLE = 427_975_994

    # Outbound private IPv6 access from VMs in this subnet to Google services. If specified, the subnetwork who is attached to the instance's default network interface will be assigned an internal IPv6 prefix if it doesn't have before.
    ENABLE_OUTBOUND_VM_ACCESS_TO_GOOGLE = 288_210_263

    # Each network interface inherits PrivateIpv6GoogleAccess from its subnetwork.
    INHERIT_FROM_SUBNETWORK = 530_256_959
  end

  # [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, REPAIRING, and TERMINATED. For more information about the status of the instance, see Instance life cycle.
  module Status
    # A value indicating that the enum field is not set.
    UNDEFINED_STATUS = 0

    # The instance is halted and we are performing tear down tasks like network deprogramming, releasing quota, IP, tearing down disks etc.
    DEPROVISIONING = 428_935_662

    # Resources are being allocated for the instance.
    PROVISIONING = 290_896_621

    # The instance is in repair.
    REPAIRING = 413_483_285

    # The instance is running.
    RUNNING = 121_282_975

    # All required resources have been allocated and the instance is being started.
    STAGING = 431_072_283

    # The instance has stopped successfully.
    STOPPED = 444_276_141

    # The instance is currently stopping (either being deleted or killed).
    STOPPING = 350_791_796

    # The instance has suspended.
    SUSPENDED = 51_223_995

    # The instance is suspending.
    SUSPENDING = 514_206_246

    # The instance has stopped (either by explicit action or underlying failure).
    TERMINATED = 250_018_339
  end
end

#shielded_instance_config::Google::Cloud::Compute::V1::ShieldedInstanceConfig



13474
13475
13476
13477
13478
13479
13480
13481
13482
13483
13484
13485
13486
13487
13488
13489
13490
13491
13492
13493
13494
13495
13496
13497
13498
13499
13500
13501
13502
13503
13504
13505
13506
13507
13508
13509
13510
13511
13512
13513
13514
13515
13516
13517
13518
13519
13520
13521
13522
13523
13524
13525
13526
13527
13528
13529
13530
13531
13532
13533
13534
13535
13536
13537
13538
13539
13540
13541
13542
13543
13544
13545
13546
13547
13548
13549
13550
13551
13552
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 13474

class Instance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # KeyRevocationActionType of the instance. Supported options are "STOP" and "NONE". The default value is "NONE" if it is not specified.
  module KeyRevocationActionType
    # A value indicating that the enum field is not set.
    UNDEFINED_KEY_REVOCATION_ACTION_TYPE = 0

    # Default value. This value is unused.
    KEY_REVOCATION_ACTION_TYPE_UNSPECIFIED = 467_110_106

    # Indicates user chose no operation.
    NONE = 2_402_104

    # Indicates user chose to opt for VM shutdown on key revocation.
    STOP = 2_555_906
  end

  # The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default.
  module PrivateIpv6GoogleAccess
    # A value indicating that the enum field is not set.
    UNDEFINED_PRIVATE_IPV6_GOOGLE_ACCESS = 0

    # Bidirectional private IPv6 access to/from Google services. If specified, the subnetwork who is attached to the instance's default network interface will be assigned an internal IPv6 prefix if it doesn't have before.
    ENABLE_BIDIRECTIONAL_ACCESS_TO_GOOGLE = 427_975_994

    # Outbound private IPv6 access from VMs in this subnet to Google services. If specified, the subnetwork who is attached to the instance's default network interface will be assigned an internal IPv6 prefix if it doesn't have before.
    ENABLE_OUTBOUND_VM_ACCESS_TO_GOOGLE = 288_210_263

    # Each network interface inherits PrivateIpv6GoogleAccess from its subnetwork.
    INHERIT_FROM_SUBNETWORK = 530_256_959
  end

  # [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, REPAIRING, and TERMINATED. For more information about the status of the instance, see Instance life cycle.
  module Status
    # A value indicating that the enum field is not set.
    UNDEFINED_STATUS = 0

    # The instance is halted and we are performing tear down tasks like network deprogramming, releasing quota, IP, tearing down disks etc.
    DEPROVISIONING = 428_935_662

    # Resources are being allocated for the instance.
    PROVISIONING = 290_896_621

    # The instance is in repair.
    REPAIRING = 413_483_285

    # The instance is running.
    RUNNING = 121_282_975

    # All required resources have been allocated and the instance is being started.
    STAGING = 431_072_283

    # The instance has stopped successfully.
    STOPPED = 444_276_141

    # The instance is currently stopping (either being deleted or killed).
    STOPPING = 350_791_796

    # The instance has suspended.
    SUSPENDED = 51_223_995

    # The instance is suspending.
    SUSPENDING = 514_206_246

    # The instance has stopped (either by explicit action or underlying failure).
    TERMINATED = 250_018_339
  end
end

#shielded_instance_integrity_policy::Google::Cloud::Compute::V1::ShieldedInstanceIntegrityPolicy



13474
13475
13476
13477
13478
13479
13480
13481
13482
13483
13484
13485
13486
13487
13488
13489
13490
13491
13492
13493
13494
13495
13496
13497
13498
13499
13500
13501
13502
13503
13504
13505
13506
13507
13508
13509
13510
13511
13512
13513
13514
13515
13516
13517
13518
13519
13520
13521
13522
13523
13524
13525
13526
13527
13528
13529
13530
13531
13532
13533
13534
13535
13536
13537
13538
13539
13540
13541
13542
13543
13544
13545
13546
13547
13548
13549
13550
13551
13552
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 13474

class Instance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # KeyRevocationActionType of the instance. Supported options are "STOP" and "NONE". The default value is "NONE" if it is not specified.
  module KeyRevocationActionType
    # A value indicating that the enum field is not set.
    UNDEFINED_KEY_REVOCATION_ACTION_TYPE = 0

    # Default value. This value is unused.
    KEY_REVOCATION_ACTION_TYPE_UNSPECIFIED = 467_110_106

    # Indicates user chose no operation.
    NONE = 2_402_104

    # Indicates user chose to opt for VM shutdown on key revocation.
    STOP = 2_555_906
  end

  # The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default.
  module PrivateIpv6GoogleAccess
    # A value indicating that the enum field is not set.
    UNDEFINED_PRIVATE_IPV6_GOOGLE_ACCESS = 0

    # Bidirectional private IPv6 access to/from Google services. If specified, the subnetwork who is attached to the instance's default network interface will be assigned an internal IPv6 prefix if it doesn't have before.
    ENABLE_BIDIRECTIONAL_ACCESS_TO_GOOGLE = 427_975_994

    # Outbound private IPv6 access from VMs in this subnet to Google services. If specified, the subnetwork who is attached to the instance's default network interface will be assigned an internal IPv6 prefix if it doesn't have before.
    ENABLE_OUTBOUND_VM_ACCESS_TO_GOOGLE = 288_210_263

    # Each network interface inherits PrivateIpv6GoogleAccess from its subnetwork.
    INHERIT_FROM_SUBNETWORK = 530_256_959
  end

  # [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, REPAIRING, and TERMINATED. For more information about the status of the instance, see Instance life cycle.
  module Status
    # A value indicating that the enum field is not set.
    UNDEFINED_STATUS = 0

    # The instance is halted and we are performing tear down tasks like network deprogramming, releasing quota, IP, tearing down disks etc.
    DEPROVISIONING = 428_935_662

    # Resources are being allocated for the instance.
    PROVISIONING = 290_896_621

    # The instance is in repair.
    REPAIRING = 413_483_285

    # The instance is running.
    RUNNING = 121_282_975

    # All required resources have been allocated and the instance is being started.
    STAGING = 431_072_283

    # The instance has stopped successfully.
    STOPPED = 444_276_141

    # The instance is currently stopping (either being deleted or killed).
    STOPPING = 350_791_796

    # The instance has suspended.
    SUSPENDED = 51_223_995

    # The instance is suspending.
    SUSPENDING = 514_206_246

    # The instance has stopped (either by explicit action or underlying failure).
    TERMINATED = 250_018_339
  end
end

#source_machine_image::String

Returns Source machine image.

Returns:

  • (::String)

    Source machine image



13474
13475
13476
13477
13478
13479
13480
13481
13482
13483
13484
13485
13486
13487
13488
13489
13490
13491
13492
13493
13494
13495
13496
13497
13498
13499
13500
13501
13502
13503
13504
13505
13506
13507
13508
13509
13510
13511
13512
13513
13514
13515
13516
13517
13518
13519
13520
13521
13522
13523
13524
13525
13526
13527
13528
13529
13530
13531
13532
13533
13534
13535
13536
13537
13538
13539
13540
13541
13542
13543
13544
13545
13546
13547
13548
13549
13550
13551
13552
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 13474

class Instance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # KeyRevocationActionType of the instance. Supported options are "STOP" and "NONE". The default value is "NONE" if it is not specified.
  module KeyRevocationActionType
    # A value indicating that the enum field is not set.
    UNDEFINED_KEY_REVOCATION_ACTION_TYPE = 0

    # Default value. This value is unused.
    KEY_REVOCATION_ACTION_TYPE_UNSPECIFIED = 467_110_106

    # Indicates user chose no operation.
    NONE = 2_402_104

    # Indicates user chose to opt for VM shutdown on key revocation.
    STOP = 2_555_906
  end

  # The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default.
  module PrivateIpv6GoogleAccess
    # A value indicating that the enum field is not set.
    UNDEFINED_PRIVATE_IPV6_GOOGLE_ACCESS = 0

    # Bidirectional private IPv6 access to/from Google services. If specified, the subnetwork who is attached to the instance's default network interface will be assigned an internal IPv6 prefix if it doesn't have before.
    ENABLE_BIDIRECTIONAL_ACCESS_TO_GOOGLE = 427_975_994

    # Outbound private IPv6 access from VMs in this subnet to Google services. If specified, the subnetwork who is attached to the instance's default network interface will be assigned an internal IPv6 prefix if it doesn't have before.
    ENABLE_OUTBOUND_VM_ACCESS_TO_GOOGLE = 288_210_263

    # Each network interface inherits PrivateIpv6GoogleAccess from its subnetwork.
    INHERIT_FROM_SUBNETWORK = 530_256_959
  end

  # [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, REPAIRING, and TERMINATED. For more information about the status of the instance, see Instance life cycle.
  module Status
    # A value indicating that the enum field is not set.
    UNDEFINED_STATUS = 0

    # The instance is halted and we are performing tear down tasks like network deprogramming, releasing quota, IP, tearing down disks etc.
    DEPROVISIONING = 428_935_662

    # Resources are being allocated for the instance.
    PROVISIONING = 290_896_621

    # The instance is in repair.
    REPAIRING = 413_483_285

    # The instance is running.
    RUNNING = 121_282_975

    # All required resources have been allocated and the instance is being started.
    STAGING = 431_072_283

    # The instance has stopped successfully.
    STOPPED = 444_276_141

    # The instance is currently stopping (either being deleted or killed).
    STOPPING = 350_791_796

    # The instance has suspended.
    SUSPENDED = 51_223_995

    # The instance is suspending.
    SUSPENDING = 514_206_246

    # The instance has stopped (either by explicit action or underlying failure).
    TERMINATED = 250_018_339
  end
end

#source_machine_image_encryption_key::Google::Cloud::Compute::V1::CustomerEncryptionKey

Returns Source machine image encryption key when creating an instance from a machine image.

Returns:



13474
13475
13476
13477
13478
13479
13480
13481
13482
13483
13484
13485
13486
13487
13488
13489
13490
13491
13492
13493
13494
13495
13496
13497
13498
13499
13500
13501
13502
13503
13504
13505
13506
13507
13508
13509
13510
13511
13512
13513
13514
13515
13516
13517
13518
13519
13520
13521
13522
13523
13524
13525
13526
13527
13528
13529
13530
13531
13532
13533
13534
13535
13536
13537
13538
13539
13540
13541
13542
13543
13544
13545
13546
13547
13548
13549
13550
13551
13552
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 13474

class Instance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # KeyRevocationActionType of the instance. Supported options are "STOP" and "NONE". The default value is "NONE" if it is not specified.
  module KeyRevocationActionType
    # A value indicating that the enum field is not set.
    UNDEFINED_KEY_REVOCATION_ACTION_TYPE = 0

    # Default value. This value is unused.
    KEY_REVOCATION_ACTION_TYPE_UNSPECIFIED = 467_110_106

    # Indicates user chose no operation.
    NONE = 2_402_104

    # Indicates user chose to opt for VM shutdown on key revocation.
    STOP = 2_555_906
  end

  # The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default.
  module PrivateIpv6GoogleAccess
    # A value indicating that the enum field is not set.
    UNDEFINED_PRIVATE_IPV6_GOOGLE_ACCESS = 0

    # Bidirectional private IPv6 access to/from Google services. If specified, the subnetwork who is attached to the instance's default network interface will be assigned an internal IPv6 prefix if it doesn't have before.
    ENABLE_BIDIRECTIONAL_ACCESS_TO_GOOGLE = 427_975_994

    # Outbound private IPv6 access from VMs in this subnet to Google services. If specified, the subnetwork who is attached to the instance's default network interface will be assigned an internal IPv6 prefix if it doesn't have before.
    ENABLE_OUTBOUND_VM_ACCESS_TO_GOOGLE = 288_210_263

    # Each network interface inherits PrivateIpv6GoogleAccess from its subnetwork.
    INHERIT_FROM_SUBNETWORK = 530_256_959
  end

  # [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, REPAIRING, and TERMINATED. For more information about the status of the instance, see Instance life cycle.
  module Status
    # A value indicating that the enum field is not set.
    UNDEFINED_STATUS = 0

    # The instance is halted and we are performing tear down tasks like network deprogramming, releasing quota, IP, tearing down disks etc.
    DEPROVISIONING = 428_935_662

    # Resources are being allocated for the instance.
    PROVISIONING = 290_896_621

    # The instance is in repair.
    REPAIRING = 413_483_285

    # The instance is running.
    RUNNING = 121_282_975

    # All required resources have been allocated and the instance is being started.
    STAGING = 431_072_283

    # The instance has stopped successfully.
    STOPPED = 444_276_141

    # The instance is currently stopping (either being deleted or killed).
    STOPPING = 350_791_796

    # The instance has suspended.
    SUSPENDED = 51_223_995

    # The instance is suspending.
    SUSPENDING = 514_206_246

    # The instance has stopped (either by explicit action or underlying failure).
    TERMINATED = 250_018_339
  end
end

#start_restricted::Boolean

Returns [Output Only] Whether a VM has been restricted for start because Compute Engine has detected suspicious activity.

Returns:

  • (::Boolean)

    [Output Only] Whether a VM has been restricted for start because Compute Engine has detected suspicious activity.



13474
13475
13476
13477
13478
13479
13480
13481
13482
13483
13484
13485
13486
13487
13488
13489
13490
13491
13492
13493
13494
13495
13496
13497
13498
13499
13500
13501
13502
13503
13504
13505
13506
13507
13508
13509
13510
13511
13512
13513
13514
13515
13516
13517
13518
13519
13520
13521
13522
13523
13524
13525
13526
13527
13528
13529
13530
13531
13532
13533
13534
13535
13536
13537
13538
13539
13540
13541
13542
13543
13544
13545
13546
13547
13548
13549
13550
13551
13552
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 13474

class Instance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # KeyRevocationActionType of the instance. Supported options are "STOP" and "NONE". The default value is "NONE" if it is not specified.
  module KeyRevocationActionType
    # A value indicating that the enum field is not set.
    UNDEFINED_KEY_REVOCATION_ACTION_TYPE = 0

    # Default value. This value is unused.
    KEY_REVOCATION_ACTION_TYPE_UNSPECIFIED = 467_110_106

    # Indicates user chose no operation.
    NONE = 2_402_104

    # Indicates user chose to opt for VM shutdown on key revocation.
    STOP = 2_555_906
  end

  # The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default.
  module PrivateIpv6GoogleAccess
    # A value indicating that the enum field is not set.
    UNDEFINED_PRIVATE_IPV6_GOOGLE_ACCESS = 0

    # Bidirectional private IPv6 access to/from Google services. If specified, the subnetwork who is attached to the instance's default network interface will be assigned an internal IPv6 prefix if it doesn't have before.
    ENABLE_BIDIRECTIONAL_ACCESS_TO_GOOGLE = 427_975_994

    # Outbound private IPv6 access from VMs in this subnet to Google services. If specified, the subnetwork who is attached to the instance's default network interface will be assigned an internal IPv6 prefix if it doesn't have before.
    ENABLE_OUTBOUND_VM_ACCESS_TO_GOOGLE = 288_210_263

    # Each network interface inherits PrivateIpv6GoogleAccess from its subnetwork.
    INHERIT_FROM_SUBNETWORK = 530_256_959
  end

  # [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, REPAIRING, and TERMINATED. For more information about the status of the instance, see Instance life cycle.
  module Status
    # A value indicating that the enum field is not set.
    UNDEFINED_STATUS = 0

    # The instance is halted and we are performing tear down tasks like network deprogramming, releasing quota, IP, tearing down disks etc.
    DEPROVISIONING = 428_935_662

    # Resources are being allocated for the instance.
    PROVISIONING = 290_896_621

    # The instance is in repair.
    REPAIRING = 413_483_285

    # The instance is running.
    RUNNING = 121_282_975

    # All required resources have been allocated and the instance is being started.
    STAGING = 431_072_283

    # The instance has stopped successfully.
    STOPPED = 444_276_141

    # The instance is currently stopping (either being deleted or killed).
    STOPPING = 350_791_796

    # The instance has suspended.
    SUSPENDED = 51_223_995

    # The instance is suspending.
    SUSPENDING = 514_206_246

    # The instance has stopped (either by explicit action or underlying failure).
    TERMINATED = 250_018_339
  end
end

#status::String

Returns [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, REPAIRING, and TERMINATED. For more information about the status of the instance, see Instance life cycle. Check the Status enum for the list of possible values.

Returns:

  • (::String)

    [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, REPAIRING, and TERMINATED. For more information about the status of the instance, see Instance life cycle. Check the Status enum for the list of possible values.



13474
13475
13476
13477
13478
13479
13480
13481
13482
13483
13484
13485
13486
13487
13488
13489
13490
13491
13492
13493
13494
13495
13496
13497
13498
13499
13500
13501
13502
13503
13504
13505
13506
13507
13508
13509
13510
13511
13512
13513
13514
13515
13516
13517
13518
13519
13520
13521
13522
13523
13524
13525
13526
13527
13528
13529
13530
13531
13532
13533
13534
13535
13536
13537
13538
13539
13540
13541
13542
13543
13544
13545
13546
13547
13548
13549
13550
13551
13552
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 13474

class Instance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # KeyRevocationActionType of the instance. Supported options are "STOP" and "NONE". The default value is "NONE" if it is not specified.
  module KeyRevocationActionType
    # A value indicating that the enum field is not set.
    UNDEFINED_KEY_REVOCATION_ACTION_TYPE = 0

    # Default value. This value is unused.
    KEY_REVOCATION_ACTION_TYPE_UNSPECIFIED = 467_110_106

    # Indicates user chose no operation.
    NONE = 2_402_104

    # Indicates user chose to opt for VM shutdown on key revocation.
    STOP = 2_555_906
  end

  # The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default.
  module PrivateIpv6GoogleAccess
    # A value indicating that the enum field is not set.
    UNDEFINED_PRIVATE_IPV6_GOOGLE_ACCESS = 0

    # Bidirectional private IPv6 access to/from Google services. If specified, the subnetwork who is attached to the instance's default network interface will be assigned an internal IPv6 prefix if it doesn't have before.
    ENABLE_BIDIRECTIONAL_ACCESS_TO_GOOGLE = 427_975_994

    # Outbound private IPv6 access from VMs in this subnet to Google services. If specified, the subnetwork who is attached to the instance's default network interface will be assigned an internal IPv6 prefix if it doesn't have before.
    ENABLE_OUTBOUND_VM_ACCESS_TO_GOOGLE = 288_210_263

    # Each network interface inherits PrivateIpv6GoogleAccess from its subnetwork.
    INHERIT_FROM_SUBNETWORK = 530_256_959
  end

  # [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, REPAIRING, and TERMINATED. For more information about the status of the instance, see Instance life cycle.
  module Status
    # A value indicating that the enum field is not set.
    UNDEFINED_STATUS = 0

    # The instance is halted and we are performing tear down tasks like network deprogramming, releasing quota, IP, tearing down disks etc.
    DEPROVISIONING = 428_935_662

    # Resources are being allocated for the instance.
    PROVISIONING = 290_896_621

    # The instance is in repair.
    REPAIRING = 413_483_285

    # The instance is running.
    RUNNING = 121_282_975

    # All required resources have been allocated and the instance is being started.
    STAGING = 431_072_283

    # The instance has stopped successfully.
    STOPPED = 444_276_141

    # The instance is currently stopping (either being deleted or killed).
    STOPPING = 350_791_796

    # The instance has suspended.
    SUSPENDED = 51_223_995

    # The instance is suspending.
    SUSPENDING = 514_206_246

    # The instance has stopped (either by explicit action or underlying failure).
    TERMINATED = 250_018_339
  end
end

#status_message::String

Returns [Output Only] An optional, human-readable explanation of the status.

Returns:

  • (::String)

    [Output Only] An optional, human-readable explanation of the status.



13474
13475
13476
13477
13478
13479
13480
13481
13482
13483
13484
13485
13486
13487
13488
13489
13490
13491
13492
13493
13494
13495
13496
13497
13498
13499
13500
13501
13502
13503
13504
13505
13506
13507
13508
13509
13510
13511
13512
13513
13514
13515
13516
13517
13518
13519
13520
13521
13522
13523
13524
13525
13526
13527
13528
13529
13530
13531
13532
13533
13534
13535
13536
13537
13538
13539
13540
13541
13542
13543
13544
13545
13546
13547
13548
13549
13550
13551
13552
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 13474

class Instance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # KeyRevocationActionType of the instance. Supported options are "STOP" and "NONE". The default value is "NONE" if it is not specified.
  module KeyRevocationActionType
    # A value indicating that the enum field is not set.
    UNDEFINED_KEY_REVOCATION_ACTION_TYPE = 0

    # Default value. This value is unused.
    KEY_REVOCATION_ACTION_TYPE_UNSPECIFIED = 467_110_106

    # Indicates user chose no operation.
    NONE = 2_402_104

    # Indicates user chose to opt for VM shutdown on key revocation.
    STOP = 2_555_906
  end

  # The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default.
  module PrivateIpv6GoogleAccess
    # A value indicating that the enum field is not set.
    UNDEFINED_PRIVATE_IPV6_GOOGLE_ACCESS = 0

    # Bidirectional private IPv6 access to/from Google services. If specified, the subnetwork who is attached to the instance's default network interface will be assigned an internal IPv6 prefix if it doesn't have before.
    ENABLE_BIDIRECTIONAL_ACCESS_TO_GOOGLE = 427_975_994

    # Outbound private IPv6 access from VMs in this subnet to Google services. If specified, the subnetwork who is attached to the instance's default network interface will be assigned an internal IPv6 prefix if it doesn't have before.
    ENABLE_OUTBOUND_VM_ACCESS_TO_GOOGLE = 288_210_263

    # Each network interface inherits PrivateIpv6GoogleAccess from its subnetwork.
    INHERIT_FROM_SUBNETWORK = 530_256_959
  end

  # [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, REPAIRING, and TERMINATED. For more information about the status of the instance, see Instance life cycle.
  module Status
    # A value indicating that the enum field is not set.
    UNDEFINED_STATUS = 0

    # The instance is halted and we are performing tear down tasks like network deprogramming, releasing quota, IP, tearing down disks etc.
    DEPROVISIONING = 428_935_662

    # Resources are being allocated for the instance.
    PROVISIONING = 290_896_621

    # The instance is in repair.
    REPAIRING = 413_483_285

    # The instance is running.
    RUNNING = 121_282_975

    # All required resources have been allocated and the instance is being started.
    STAGING = 431_072_283

    # The instance has stopped successfully.
    STOPPED = 444_276_141

    # The instance is currently stopping (either being deleted or killed).
    STOPPING = 350_791_796

    # The instance has suspended.
    SUSPENDED = 51_223_995

    # The instance is suspending.
    SUSPENDING = 514_206_246

    # The instance has stopped (either by explicit action or underlying failure).
    TERMINATED = 250_018_339
  end
end

#tags::Google::Cloud::Compute::V1::Tags

Returns Tags to apply to this instance. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during instance creation. The tags can be later modified by the setTags method. Each tag within the list must comply with RFC1035. Multiple tags can be specified via the 'tags.items' field.

Returns:

  • (::Google::Cloud::Compute::V1::Tags)

    Tags to apply to this instance. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during instance creation. The tags can be later modified by the setTags method. Each tag within the list must comply with RFC1035. Multiple tags can be specified via the 'tags.items' field.



13474
13475
13476
13477
13478
13479
13480
13481
13482
13483
13484
13485
13486
13487
13488
13489
13490
13491
13492
13493
13494
13495
13496
13497
13498
13499
13500
13501
13502
13503
13504
13505
13506
13507
13508
13509
13510
13511
13512
13513
13514
13515
13516
13517
13518
13519
13520
13521
13522
13523
13524
13525
13526
13527
13528
13529
13530
13531
13532
13533
13534
13535
13536
13537
13538
13539
13540
13541
13542
13543
13544
13545
13546
13547
13548
13549
13550
13551
13552
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 13474

class Instance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # KeyRevocationActionType of the instance. Supported options are "STOP" and "NONE". The default value is "NONE" if it is not specified.
  module KeyRevocationActionType
    # A value indicating that the enum field is not set.
    UNDEFINED_KEY_REVOCATION_ACTION_TYPE = 0

    # Default value. This value is unused.
    KEY_REVOCATION_ACTION_TYPE_UNSPECIFIED = 467_110_106

    # Indicates user chose no operation.
    NONE = 2_402_104

    # Indicates user chose to opt for VM shutdown on key revocation.
    STOP = 2_555_906
  end

  # The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default.
  module PrivateIpv6GoogleAccess
    # A value indicating that the enum field is not set.
    UNDEFINED_PRIVATE_IPV6_GOOGLE_ACCESS = 0

    # Bidirectional private IPv6 access to/from Google services. If specified, the subnetwork who is attached to the instance's default network interface will be assigned an internal IPv6 prefix if it doesn't have before.
    ENABLE_BIDIRECTIONAL_ACCESS_TO_GOOGLE = 427_975_994

    # Outbound private IPv6 access from VMs in this subnet to Google services. If specified, the subnetwork who is attached to the instance's default network interface will be assigned an internal IPv6 prefix if it doesn't have before.
    ENABLE_OUTBOUND_VM_ACCESS_TO_GOOGLE = 288_210_263

    # Each network interface inherits PrivateIpv6GoogleAccess from its subnetwork.
    INHERIT_FROM_SUBNETWORK = 530_256_959
  end

  # [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, REPAIRING, and TERMINATED. For more information about the status of the instance, see Instance life cycle.
  module Status
    # A value indicating that the enum field is not set.
    UNDEFINED_STATUS = 0

    # The instance is halted and we are performing tear down tasks like network deprogramming, releasing quota, IP, tearing down disks etc.
    DEPROVISIONING = 428_935_662

    # Resources are being allocated for the instance.
    PROVISIONING = 290_896_621

    # The instance is in repair.
    REPAIRING = 413_483_285

    # The instance is running.
    RUNNING = 121_282_975

    # All required resources have been allocated and the instance is being started.
    STAGING = 431_072_283

    # The instance has stopped successfully.
    STOPPED = 444_276_141

    # The instance is currently stopping (either being deleted or killed).
    STOPPING = 350_791_796

    # The instance has suspended.
    SUSPENDED = 51_223_995

    # The instance is suspending.
    SUSPENDING = 514_206_246

    # The instance has stopped (either by explicit action or underlying failure).
    TERMINATED = 250_018_339
  end
end

#zone::String

Returns [Output Only] URL of the zone where the instance resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

Returns:

  • (::String)

    [Output Only] URL of the zone where the instance resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.



13474
13475
13476
13477
13478
13479
13480
13481
13482
13483
13484
13485
13486
13487
13488
13489
13490
13491
13492
13493
13494
13495
13496
13497
13498
13499
13500
13501
13502
13503
13504
13505
13506
13507
13508
13509
13510
13511
13512
13513
13514
13515
13516
13517
13518
13519
13520
13521
13522
13523
13524
13525
13526
13527
13528
13529
13530
13531
13532
13533
13534
13535
13536
13537
13538
13539
13540
13541
13542
13543
13544
13545
13546
13547
13548
13549
13550
13551
13552
# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 13474

class Instance
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # KeyRevocationActionType of the instance. Supported options are "STOP" and "NONE". The default value is "NONE" if it is not specified.
  module KeyRevocationActionType
    # A value indicating that the enum field is not set.
    UNDEFINED_KEY_REVOCATION_ACTION_TYPE = 0

    # Default value. This value is unused.
    KEY_REVOCATION_ACTION_TYPE_UNSPECIFIED = 467_110_106

    # Indicates user chose no operation.
    NONE = 2_402_104

    # Indicates user chose to opt for VM shutdown on key revocation.
    STOP = 2_555_906
  end

  # The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default.
  module PrivateIpv6GoogleAccess
    # A value indicating that the enum field is not set.
    UNDEFINED_PRIVATE_IPV6_GOOGLE_ACCESS = 0

    # Bidirectional private IPv6 access to/from Google services. If specified, the subnetwork who is attached to the instance's default network interface will be assigned an internal IPv6 prefix if it doesn't have before.
    ENABLE_BIDIRECTIONAL_ACCESS_TO_GOOGLE = 427_975_994

    # Outbound private IPv6 access from VMs in this subnet to Google services. If specified, the subnetwork who is attached to the instance's default network interface will be assigned an internal IPv6 prefix if it doesn't have before.
    ENABLE_OUTBOUND_VM_ACCESS_TO_GOOGLE = 288_210_263

    # Each network interface inherits PrivateIpv6GoogleAccess from its subnetwork.
    INHERIT_FROM_SUBNETWORK = 530_256_959
  end

  # [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, REPAIRING, and TERMINATED. For more information about the status of the instance, see Instance life cycle.
  module Status
    # A value indicating that the enum field is not set.
    UNDEFINED_STATUS = 0

    # The instance is halted and we are performing tear down tasks like network deprogramming, releasing quota, IP, tearing down disks etc.
    DEPROVISIONING = 428_935_662

    # Resources are being allocated for the instance.
    PROVISIONING = 290_896_621

    # The instance is in repair.
    REPAIRING = 413_483_285

    # The instance is running.
    RUNNING = 121_282_975

    # All required resources have been allocated and the instance is being started.
    STAGING = 431_072_283

    # The instance has stopped successfully.
    STOPPED = 444_276_141

    # The instance is currently stopping (either being deleted or killed).
    STOPPING = 350_791_796

    # The instance has suspended.
    SUSPENDED = 51_223_995

    # The instance is suspending.
    SUSPENDING = 514_206_246

    # The instance has stopped (either by explicit action or underlying failure).
    TERMINATED = 250_018_339
  end
end