Instance (Compute Engine API v1 (Rev. 103) 1.21.0)

java.lang.Object
- java.util.AbstractMap<java.lang.String,java.lang.Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.compute.model.Instance

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>
```
public final class Instance
extends com.google.api.client.json.GenericJson
```
An Instance resource.
This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Compute Engine API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  com.google.api.client.util.GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  java.util.Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

Instance()

Constructors
Constructor and Description
`Instance()`

Method Summary

Methods
Modifier and Type	Method and Description
`Instance`	`clone()`
`java.lang.Boolean`	`getCanIpForward()` Allows this instance to send and receive packets with non-matching destination or source IPs.
`java.lang.String`	`getCpuPlatform()` [Output Only] The CPU platform used by this instance.
`java.lang.String`	`getCreationTimestamp()` [Output Only] Creation timestamp in RFC3339 text format.
`java.lang.String`	`getDescription()` An optional description of this resource.
`java.util.List<AttachedDisk>`	`getDisks()` Array of disks associated with this instance.
`java.math.BigInteger`	`getId()` [Output Only] The unique identifier for the resource.
`java.lang.String`	`getKind()` [Output Only] Type of the resource.
`java.lang.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.
`java.lang.String`	`getName()` The name of the resource, provided by the client when initially creating the resource.
`java.util.List<NetworkInterface>`	`getNetworkInterfaces()` An array of configurations for this interface.
`Scheduling`	`getScheduling()` Scheduling options for this instance.
`java.lang.String`	`getSelfLink()` [Output Only] Server-defined URL for this resource.
`java.util.List<ServiceAccount>`	`getServiceAccounts()` A list of service accounts, with their specified scopes, authorized for this instance.
`java.lang.String`	`getStatus()` [Output Only] The status of the instance.
`java.lang.String`	`getStatusMessage()` [Output Only] An optional, human-readable explanation of the status.
`Tags`	`getTags()` A list of tags to apply to this instance.
`java.lang.String`	`getZone()` [Output Only] URL of the zone where the instance resides.
`Instance`	`set(java.lang.String fieldName, java.lang.Object value)`
`Instance`	`setCanIpForward(java.lang.Boolean canIpForward)` Allows this instance to send and receive packets with non-matching destination or source IPs.
`Instance`	`setCpuPlatform(java.lang.String cpuPlatform)` [Output Only] The CPU platform used by this instance.
`Instance`	`setCreationTimestamp(java.lang.String creationTimestamp)` [Output Only] Creation timestamp in RFC3339 text format.
`Instance`	`setDescription(java.lang.String description)` An optional description of this resource.
`Instance`	`setDisks(java.util.List<AttachedDisk> disks)` Array of disks associated with this instance.
`Instance`	`setId(java.math.BigInteger id)` [Output Only] The unique identifier for the resource.
`Instance`	`setKind(java.lang.String kind)` [Output Only] Type of the resource.
`Instance`	`setMachineType(java.lang.String machineType)` Full or partial URL of the machine type resource to use for this instance, in the format: zones/zone/machineTypes/machine-type.
`Instance`	`setMetadata(Metadata metadata)` The metadata key/value pairs assigned to this instance.
`Instance`	`setName(java.lang.String name)` The name of the resource, provided by the client when initially creating the resource.
`Instance`	`setNetworkInterfaces(java.util.List<NetworkInterface> networkInterfaces)` An array of configurations for this interface.
`Instance`	`setScheduling(Scheduling scheduling)` Scheduling options for this instance.
`Instance`	`setSelfLink(java.lang.String selfLink)` [Output Only] Server-defined URL for this resource.
`Instance`	`setServiceAccounts(java.util.List<ServiceAccount> serviceAccounts)` A list of service accounts, with their specified scopes, authorized for this instance.
`Instance`	`setStatus(java.lang.String status)` [Output Only] The status of the instance.
`Instance`	`setStatusMessage(java.lang.String statusMessage)` [Output Only] An optional, human-readable explanation of the status.
`Instance`	`setTags(Tags tags)` A list of tags to apply to this instance.
`Instance`	`setZone(java.lang.String zone)` [Output Only] URL of the zone where the instance resides.

Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData
entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, values

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

- Constructor Detail
  - Instance
```
public Instance()
```
- Method Detail
  - getCanIpForward
```
public java.lang.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.
    
    Returns:
    value or null for none
  - setCanIpForward
```
public Instance setCanIpForward(java.lang.Boolean canIpForward)
```
    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.
    
    Parameters:
    canIpForward - canIpForward or null for none
  - getCpuPlatform
```
public java.lang.String getCpuPlatform()
```
    [Output Only] The CPU platform used by this instance.
    
    Returns:
    value or null for none
  - setCpuPlatform
```
public Instance setCpuPlatform(java.lang.String cpuPlatform)
```
    [Output Only] The CPU platform used by this instance.
    
    Parameters:
    cpuPlatform - cpuPlatform or null for none
  - getCreationTimestamp
```
public java.lang.String getCreationTimestamp()
```
    [Output Only] Creation timestamp in RFC3339 text format.
    
    Returns:
    value or null for none
  - setCreationTimestamp
```
public Instance setCreationTimestamp(java.lang.String creationTimestamp)
```
    [Output Only] Creation timestamp in RFC3339 text format.
    
    Parameters:
    creationTimestamp - creationTimestamp or null for none
  - getDescription
```
public java.lang.String getDescription()
```
    An optional description of this resource. Provide this property when you create the resource.
    
    Returns:
    value or null for none
  - setDescription
```
public Instance setDescription(java.lang.String description)
```
    An optional description of this resource. Provide this property when you create the resource.
    
    Parameters:
    description - description or null for none
  - getDisks
```
public java.util.List<AttachedDisk> getDisks()
```
    Array of disks associated with this instance. Persistent disks must be created before you can assign them.
    
    Returns:
    value or null for none
  - setDisks
```
public Instance setDisks(java.util.List<AttachedDisk> disks)
```
    Array of disks associated with this instance. Persistent disks must be created before you can assign them.
    
    Parameters:
    disks - disks or null for none
  - getId
```
public java.math.BigInteger getId()
```
    [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    
    Returns:
    value or null for none
  - setId
```
public Instance setId(java.math.BigInteger id)
```
    [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    
    Parameters:
    id - id or null for none
  - getKind
```
public java.lang.String getKind()
```
    [Output Only] Type of the resource. Always compute#instance for instances.
    
    Returns:
    value or null for none
  - setKind
```
public Instance setKind(java.lang.String kind)
```
    [Output Only] Type of the resource. Always compute#instance for instances.
    
    Parameters:
    kind - kind or null for none
  - getMachineType
```
public java.lang.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.
    
    Returns:
    value or null for none
  - setMachineType
```
public Instance setMachineType(java.lang.String machineType)
```
    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.
    
    Parameters:
    machineType - machineType or null for none
  - getMetadata
```
public Metadata getMetadata()
```
    The metadata key/value pairs assigned to this instance. This includes custom metadata and predefined keys.
    
    Returns:
    value or null for none
  - setMetadata
```
public Instance setMetadata(Metadata metadata)
```
    The metadata key/value pairs assigned to this instance. This includes custom metadata and predefined keys.
    
    Parameters:
    metadata - metadata or null for none
  - getName
```
public java.lang.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.
    
    Returns:
    value or null for none
  - setName
```
public Instance setName(java.lang.String name)
```
    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.
    
    Parameters:
    name - name or null for none
  - getNetworkInterfaces
```
public java.util.List<NetworkInterface> getNetworkInterfaces()
```
    An array of configurations for this interface. This specifies how this interface is configured to interact with other network services, such as connecting to the internet.
    
    Returns:
    value or null for none
  - setNetworkInterfaces
```
public Instance setNetworkInterfaces(java.util.List<NetworkInterface> networkInterfaces)
```
    An array of configurations for this interface. This specifies how this interface is configured to interact with other network services, such as connecting to the internet.
    
    Parameters:
    networkInterfaces - networkInterfaces or null for none
  - getScheduling
```
public Scheduling getScheduling()
```
    Scheduling options for this instance.
    
    Returns:
    value or null for none
  - setScheduling
```
public Instance setScheduling(Scheduling scheduling)
```
    Scheduling options for this instance.
    
    Parameters:
    scheduling - scheduling or null for none
  - getSelfLink
```
public java.lang.String getSelfLink()
```
    [Output Only] Server-defined URL for this resource.
    
    Returns:
    value or null for none
  - setSelfLink
```
public Instance setSelfLink(java.lang.String selfLink)
```
    [Output Only] Server-defined URL for this resource.
    
    Parameters:
    selfLink - selfLink or null for none
  - getServiceAccounts
```
public java.util.List<ServiceAccount> getServiceAccounts()
```
    A list of service accounts, with their specified scopes, authorized for this instance. Service accounts generate access tokens that can be accessed through the metadata server and used to authenticate applications on the instance. See Authenticating from Google Compute Engine for more information.
    
    Returns:
    value or null for none
  - setServiceAccounts
```
public Instance setServiceAccounts(java.util.List<ServiceAccount> serviceAccounts)
```
    A list of service accounts, with their specified scopes, authorized for this instance. Service accounts generate access tokens that can be accessed through the metadata server and used to authenticate applications on the instance. See Authenticating from Google Compute Engine for more information.
    
    Parameters:
    serviceAccounts - serviceAccounts or null for none
  - getStatus
```
public java.lang.String getStatus()
```
    [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, and TERMINATED.
    
    Returns:
    value or null for none
  - setStatus
```
public Instance setStatus(java.lang.String status)
```
    [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, and TERMINATED.
    
    Parameters:
    status - status or null for none
  - getStatusMessage
```
public java.lang.String getStatusMessage()
```
    [Output Only] An optional, human-readable explanation of the status.
    
    Returns:
    value or null for none
  - setStatusMessage
```
public Instance setStatusMessage(java.lang.String statusMessage)
```
    [Output Only] An optional, human-readable explanation of the status.
    
    Parameters:
    statusMessage - statusMessage or null for none
  - getTags
```
public Tags getTags()
```
    A list of 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.
    
    Returns:
    value or null for none
  - setTags
```
public Instance setTags(Tags tags)
```
    A list of 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.
    
    Parameters:
    tags - tags or null for none
  - getZone
```
public java.lang.String getZone()
```
    [Output Only] URL of the zone where the instance resides.
    
    Returns:
    value or null for none
  - setZone
```
public Instance setZone(java.lang.String zone)
```
    [Output Only] URL of the zone where the instance resides.
    
    Parameters:
    zone - zone or null for none
  - set
```
public Instance set(java.lang.String fieldName,
           java.lang.Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public Instance clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Compute Engine API v1 (revision 103)

Class Instance

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class com.google.api.client.json.GenericJson

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Constructor Detail

Instance

Method Detail

getCanIpForward

setCanIpForward

getCpuPlatform

setCpuPlatform

getCreationTimestamp

setCreationTimestamp

getDescription

setDescription

getDisks

setDisks

getId

setId

getKind

setKind

getMachineType

setMachineType

getMetadata

setMetadata

getName

setName

getNetworkInterfaces

setNetworkInterfaces

getScheduling

setScheduling

getSelfLink

setSelfLink

getServiceAccounts

setServiceAccounts

getStatus

setStatus

getStatusMessage

setStatusMessage

getTags

setTags

getZone

setZone

set

clone