Instance (Google Cloud 0.119.0-alpha API)

java.lang.Object
- com.google.cloud.compute.v1.Instance

All Implemented Interfaces:: com.google.api.gax.httpjson.ApiMessage

@Generated(value="by GAPIC")
 @BetaApi
public final class Instance
extends Object
implements com.google.api.gax.httpjson.ApiMessage

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Instance.Builder

Nested Classes
Modifier and Type	Class and Description
`static class`	`Instance.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object o)`
`com.google.api.gax.httpjson.ApiMessage`	`getApiMessageRequestBody()`
`Boolean`	`getCanIpForward()` Allows this instance to send and receive packets with non-matching destination or source IPs.
`String`	`getCpuPlatform()` [Output Only] The CPU platform used by this instance.
`String`	`getCreationTimestamp()` [Output Only] Creation timestamp in RFC3339 text format.
`static Instance`	`getDefaultInstance()`
`Boolean`	`getDeletionProtection()` Whether the resource should be protected against deletion.
`String`	`getDescription()` An optional description of this resource.
`List<AttachedDisk>`	`getDisksList()` Array of disks associated with this instance.
`DisplayDevice`	`getDisplayDevice()` Enables display device for the instance.
`List<String>`	`getFieldMask()`
`Object`	`getFieldValue(String fieldName)`
`List<AcceleratorConfig>`	`getGuestAcceleratorsList()` A list of the type and count of accelerator cards attached to the instance.
`String`	`getHostname()` Specifies the hostname of the instance.
`String`	`getId()` [Output Only] The unique identifier for the resource.
`String`	`getKind()` [Output Only] Type of the resource.
`String`	`getLabelFingerprint()` A fingerprint for this request, which is essentially a hash of the label's contents and used for optimistic locking.
`Map<String,String>`	`getLabelsMap()` Labels to apply to this instance.
`String`	`getMachineType()` Full or partial URL of the machine type resource to use for this instance, in the format: zones/zone/machineTypes/machine-type.
`Metadata`	`getMetadata()` The metadata key/value pairs assigned to this instance.
`String`	`getMinCpuPlatform()` Specifies a minimum CPU platform for the VM instance.
`String`	`getName()` The name of the resource, provided by the client when initially creating the resource.
`List<NetworkInterface>`	`getNetworkInterfacesList()` An array of network configurations for this instance.
`ReservationAffinity`	`getReservationAffinity()` Specifies the reservations that this instance can consume from.
`Scheduling`	`getScheduling()` Sets the scheduling options for this instance.
`String`	`getSelfLink()` [Output Only] Server-defined URL for this resource.
`List<ServiceAccount>`	`getServiceAccountsList()` A list of service accounts, with their specified scopes, authorized for this instance.
`ShieldedInstanceConfig`	`getShieldedInstanceConfig()`
`ShieldedInstanceIntegrityPolicy`	`getShieldedInstanceIntegrityPolicy()`
`Boolean`	`getStartRestricted()` [Output Only] Whether a VM has been restricted for start because Compute Engine has detected suspicious activity.
`String`	`getStatus()` [Output Only] The status of the instance.
`String`	`getStatusMessage()` [Output Only] An optional, human-readable explanation of the status.
`Tags`	`getTags()` Tags to apply to this instance.
`String`	`getZone()` [Output Only] URL of the zone where the instance resides.
`int`	`hashCode()`
`static Instance.Builder`	`newBuilder()`
`static Instance.Builder`	`newBuilder(Instance prototype)`
`Instance.Builder`	`toBuilder()`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Method Detail
  - getFieldValue
```
public Object getFieldValue(String fieldName)
```
    Specified by:
    
    getFieldValue in interface com.google.api.gax.httpjson.ApiMessage
  - getApiMessageRequestBody
```
@Nullable
public com.google.api.gax.httpjson.ApiMessage getApiMessageRequestBody()
```
    Specified by:
    
    getApiMessageRequestBody in interface com.google.api.gax.httpjson.ApiMessage
  - getFieldMask
```
@Nullable
public List<String> getFieldMask()
```
    Specified by:
    
    getFieldMask in interface com.google.api.gax.httpjson.ApiMessage
  - getCanIpForward
```
public Boolean getCanIpForward()
```
    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.
  - getCpuPlatform
```
public String getCpuPlatform()
```
    [Output Only] The CPU platform used by this instance.
  - getCreationTimestamp
```
public String getCreationTimestamp()
```
    [Output Only] Creation timestamp in RFC3339 text format.
  - getDeletionProtection
```
public Boolean getDeletionProtection()
```
    Whether the resource should be protected against deletion.
  - getDescription
```
public String getDescription()
```
    An optional description of this resource. Provide this property when you create the resource.
  - getDisksList
```
public List<AttachedDisk> getDisksList()
```
    Array of disks associated with this instance. Persistent disks must be created before you can assign them.
  - getDisplayDevice
```
public DisplayDevice getDisplayDevice()
```
    Enables display device for the instance.
  - getGuestAcceleratorsList
```
public List<AcceleratorConfig> getGuestAcceleratorsList()
```
    A list of the type and count of accelerator cards attached to the instance.
  - getHostname
```
public String getHostname()
```
    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.
  - getId
```
public String getId()
```
    [Output Only] The unique identifier for the resource. This identifier is defined by the server.
  - getKind
```
public String getKind()
```
    [Output Only] Type of the resource. Always compute#instance for instances.
  - getLabelFingerprint
```
public String getLabelFingerprint()
```
    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.
  - getLabelsMap
```
public Map<String,String> getLabelsMap()
```
    Labels to apply to this instance. These can be later modified by the setLabels method.
  - getMachineType
```
public String getMachineType()
```
    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.
  - getMetadata
```
public Metadata getMetadata()
```
    The metadata key/value pairs assigned to this instance. This includes custom metadata and predefined keys.
  - getMinCpuPlatform
```
public String getMinCpuPlatform()
```
    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".
  - getName
```
public String getName()
```
    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.
  - getNetworkInterfacesList
```
public List<NetworkInterface> getNetworkInterfacesList()
```
    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.
  - getReservationAffinity
```
public ReservationAffinity getReservationAffinity()
```
    Specifies the reservations that this instance can consume from.
  - getScheduling
```
public Scheduling getScheduling()
```
    Sets the scheduling options for this instance.
  - getSelfLink
```
public String getSelfLink()
```
    [Output Only] Server-defined URL for this resource.
  - getServiceAccountsList
```
public List<ServiceAccount> getServiceAccountsList()
```
    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.
  - getShieldedInstanceConfig
```
public ShieldedInstanceConfig getShieldedInstanceConfig()
```
  - getShieldedInstanceIntegrityPolicy
```
public ShieldedInstanceIntegrityPolicy getShieldedInstanceIntegrityPolicy()
```
  - getStartRestricted
```
public Boolean getStartRestricted()
```
    [Output Only] Whether a VM has been restricted for start because Compute Engine has detected suspicious activity.
  - getStatus
```
public String getStatus()
```
    [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, STOPPED, SUSPENDING, SUSPENDED, and TERMINATED.
  - getStatusMessage
```
public String getStatusMessage()
```
    [Output Only] An optional, human-readable explanation of the status.
  - getTags
```
public Tags getTags()
```
    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.
  - getZone
```
public String getZone()
```
    [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.
  - newBuilder
```
public static Instance.Builder newBuilder()
```
  - newBuilder
```
public static Instance.Builder newBuilder(Instance prototype)
```
  - toBuilder
```
public Instance.Builder toBuilder()
```
  - getDefaultInstance
```
public static Instance getDefaultInstance()
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object

Class Instance

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getFieldValue

getApiMessageRequestBody

getFieldMask

getCanIpForward

getCpuPlatform

getCreationTimestamp

getDeletionProtection

getDescription

getDisksList

getDisplayDevice

getGuestAcceleratorsList

getHostname

getId

getKind

getLabelFingerprint

getLabelsMap

getMachineType

getMetadata

getMinCpuPlatform

getName

getNetworkInterfacesList

getReservationAffinity

getScheduling

getSelfLink

getServiceAccountsList

getShieldedInstanceConfig

getShieldedInstanceIntegrityPolicy

getStartRestricted

getStatus

getStatusMessage

getTags

getZone

newBuilder

newBuilder

toBuilder

getDefaultInstance

toString

equals

hashCode