Instance.Builder (Google Cloud 0.119.0-alpha API)

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

Enclosing class:: Instance

public static class Instance.Builder
extends Object

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Instance.Builder`	`addAllDisks(List<AttachedDisk> disks)` Array of disks associated with this instance.
`Instance.Builder`	`addAllGuestAccelerators(List<AcceleratorConfig> guestAccelerators)` A list of the type and count of accelerator cards attached to the instance.
`Instance.Builder`	`addAllNetworkInterfaces(List<NetworkInterface> networkInterfaces)` An array of network configurations for this instance.
`Instance.Builder`	`addAllServiceAccounts(List<ServiceAccount> serviceAccounts)` A list of service accounts, with their specified scopes, authorized for this instance.
`Instance.Builder`	`addDisks(AttachedDisk disks)` Array of disks associated with this instance.
`Instance.Builder`	`addGuestAccelerators(AcceleratorConfig guestAccelerators)` A list of the type and count of accelerator cards attached to the instance.
`Instance.Builder`	`addNetworkInterfaces(NetworkInterface networkInterfaces)` An array of network configurations for this instance.
`Instance.Builder`	`addServiceAccounts(ServiceAccount serviceAccounts)` A list of service accounts, with their specified scopes, authorized for this instance.
`Instance`	`build()`
`Instance.Builder`	`clone()`
`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.
`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<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.
`Instance.Builder`	`mergeFrom(Instance other)`
`Instance.Builder`	`putAllLabels(Map<String,String> labels)` Labels to apply to this instance.
`Instance.Builder`	`setCanIpForward(Boolean canIpForward)` Allows this instance to send and receive packets with non-matching destination or source IPs.
`Instance.Builder`	`setCpuPlatform(String cpuPlatform)` [Output Only] The CPU platform used by this instance.
`Instance.Builder`	`setCreationTimestamp(String creationTimestamp)` [Output Only] Creation timestamp in RFC3339 text format.
`Instance.Builder`	`setDeletionProtection(Boolean deletionProtection)` Whether the resource should be protected against deletion.
`Instance.Builder`	`setDescription(String description)` An optional description of this resource.
`Instance.Builder`	`setDisplayDevice(DisplayDevice displayDevice)` Enables display device for the instance.
`Instance.Builder`	`setHostname(String hostname)` Specifies the hostname of the instance.
`Instance.Builder`	`setId(String id)` [Output Only] The unique identifier for the resource.
`Instance.Builder`	`setKind(String kind)` [Output Only] Type of the resource.
`Instance.Builder`	`setLabelFingerprint(String labelFingerprint)` A fingerprint for this request, which is essentially a hash of the label's contents and used for optimistic locking.
`Instance.Builder`	`setMachineType(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.Builder`	`setMetadata(Metadata metadata)` The metadata key/value pairs assigned to this instance.
`Instance.Builder`	`setMinCpuPlatform(String minCpuPlatform)` Specifies a minimum CPU platform for the VM instance.
`Instance.Builder`	`setName(String name)` The name of the resource, provided by the client when initially creating the resource.
`Instance.Builder`	`setReservationAffinity(ReservationAffinity reservationAffinity)` Specifies the reservations that this instance can consume from.
`Instance.Builder`	`setScheduling(Scheduling scheduling)` Sets the scheduling options for this instance.
`Instance.Builder`	`setSelfLink(String selfLink)` [Output Only] Server-defined URL for this resource.
`Instance.Builder`	`setShieldedInstanceConfig(ShieldedInstanceConfig shieldedInstanceConfig)`
`Instance.Builder`	`setShieldedInstanceIntegrityPolicy(ShieldedInstanceIntegrityPolicy shieldedInstanceIntegrityPolicy)`
`Instance.Builder`	`setStartRestricted(Boolean startRestricted)` [Output Only] Whether a VM has been restricted for start because Compute Engine has detected suspicious activity.
`Instance.Builder`	`setStatus(String status)` [Output Only] The status of the instance.
`Instance.Builder`	`setStatusMessage(String statusMessage)` [Output Only] An optional, human-readable explanation of the status.
`Instance.Builder`	`setTags(Tags tags)` Tags to apply to this instance.
`Instance.Builder`	`setZone(String zone)` [Output Only] URL of the zone where the instance resides.

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

- Method Detail
  - mergeFrom
```
public Instance.Builder mergeFrom(Instance other)
```
  - 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.
  - setCanIpForward
```
public Instance.Builder setCanIpForward(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.
  - getCpuPlatform
```
public String getCpuPlatform()
```
    [Output Only] The CPU platform used by this instance.
  - setCpuPlatform
```
public Instance.Builder setCpuPlatform(String cpuPlatform)
```
    [Output Only] The CPU platform used by this instance.
  - getCreationTimestamp
```
public String getCreationTimestamp()
```
    [Output Only] Creation timestamp in RFC3339 text format.
  - setCreationTimestamp
```
public Instance.Builder setCreationTimestamp(String creationTimestamp)
```
    [Output Only] Creation timestamp in RFC3339 text format.
  - getDeletionProtection
```
public Boolean getDeletionProtection()
```
    Whether the resource should be protected against deletion.
  - setDeletionProtection
```
public Instance.Builder setDeletionProtection(Boolean deletionProtection)
```
    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.
  - setDescription
```
public Instance.Builder setDescription(String description)
```
    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.
  - addAllDisks
```
public Instance.Builder addAllDisks(List<AttachedDisk> disks)
```
    Array of disks associated with this instance. Persistent disks must be created before you can assign them.
  - addDisks
```
public Instance.Builder addDisks(AttachedDisk disks)
```
    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.
  - setDisplayDevice
```
public Instance.Builder setDisplayDevice(DisplayDevice displayDevice)
```
    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.
  - addAllGuestAccelerators
```
public Instance.Builder addAllGuestAccelerators(List<AcceleratorConfig> guestAccelerators)
```
    A list of the type and count of accelerator cards attached to the instance.
  - addGuestAccelerators
```
public Instance.Builder addGuestAccelerators(AcceleratorConfig guestAccelerators)
```
    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.
  - setHostname
```
public Instance.Builder setHostname(String hostname)
```
    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.
  - setId
```
public Instance.Builder setId(String id)
```
    [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.
  - setKind
```
public Instance.Builder setKind(String kind)
```
    [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.
  - setLabelFingerprint
```
public Instance.Builder setLabelFingerprint(String labelFingerprint)
```
    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.
  - putAllLabels
```
public Instance.Builder putAllLabels(Map<String,String> labels)
```
    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.
  - setMachineType
```
public Instance.Builder setMachineType(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.
  - getMetadata
```
public Metadata getMetadata()
```
    The metadata key/value pairs assigned to this instance. This includes custom metadata and predefined keys.
  - setMetadata
```
public Instance.Builder setMetadata(Metadata metadata)
```
    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".
  - setMinCpuPlatform
```
public Instance.Builder setMinCpuPlatform(String minCpuPlatform)
```
    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.
  - setName
```
public Instance.Builder setName(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.
  - 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.
  - addAllNetworkInterfaces
```
public Instance.Builder addAllNetworkInterfaces(List<NetworkInterface> networkInterfaces)
```
    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.
  - addNetworkInterfaces
```
public Instance.Builder addNetworkInterfaces(NetworkInterface networkInterfaces)
```
    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.
  - setReservationAffinity
```
public Instance.Builder setReservationAffinity(ReservationAffinity reservationAffinity)
```
    Specifies the reservations that this instance can consume from.
  - getScheduling
```
public Scheduling getScheduling()
```
    Sets the scheduling options for this instance.
  - setScheduling
```
public Instance.Builder setScheduling(Scheduling scheduling)
```
    Sets the scheduling options for this instance.
  - getSelfLink
```
public String getSelfLink()
```
    [Output Only] Server-defined URL for this resource.
  - setSelfLink
```
public Instance.Builder setSelfLink(String selfLink)
```
    [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.
  - addAllServiceAccounts
```
public Instance.Builder addAllServiceAccounts(List<ServiceAccount> serviceAccounts)
```
    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.
  - addServiceAccounts
```
public Instance.Builder addServiceAccounts(ServiceAccount serviceAccounts)
```
    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()
```
  - setShieldedInstanceConfig
```
public Instance.Builder setShieldedInstanceConfig(ShieldedInstanceConfig shieldedInstanceConfig)
```
  - getShieldedInstanceIntegrityPolicy
```
public ShieldedInstanceIntegrityPolicy getShieldedInstanceIntegrityPolicy()
```
  - setShieldedInstanceIntegrityPolicy
```
public Instance.Builder setShieldedInstanceIntegrityPolicy(ShieldedInstanceIntegrityPolicy shieldedInstanceIntegrityPolicy)
```
  - getStartRestricted
```
public Boolean getStartRestricted()
```
    [Output Only] Whether a VM has been restricted for start because Compute Engine has detected suspicious activity.
  - setStartRestricted
```
public Instance.Builder setStartRestricted(Boolean startRestricted)
```
    [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.
  - setStatus
```
public Instance.Builder setStatus(String status)
```
    [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.
  - setStatusMessage
```
public Instance.Builder setStatusMessage(String statusMessage)
```
    [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.
  - setTags
```
public Instance.Builder setTags(Tags 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.
  - 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.
  - setZone
```
public Instance.Builder setZone(String zone)
```
    [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.
  - build
```
public Instance build()
```
  - clone
```
public Instance.Builder clone()
```
    Overrides:
    
    clone in class Object

Class Instance.Builder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

mergeFrom

getCanIpForward

setCanIpForward

getCpuPlatform

setCpuPlatform

getCreationTimestamp

setCreationTimestamp

getDeletionProtection

setDeletionProtection

getDescription

setDescription

getDisksList

addAllDisks

addDisks

getDisplayDevice

setDisplayDevice

getGuestAcceleratorsList

addAllGuestAccelerators

addGuestAccelerators

getHostname

setHostname

getId

setId

getKind

setKind

getLabelFingerprint

setLabelFingerprint

getLabelsMap

putAllLabels

getMachineType

setMachineType

getMetadata

setMetadata

getMinCpuPlatform

setMinCpuPlatform

getName

setName

getNetworkInterfacesList

addAllNetworkInterfaces

addNetworkInterfaces

getReservationAffinity

setReservationAffinity

getScheduling

setScheduling

getSelfLink

setSelfLink

getServiceAccountsList

addAllServiceAccounts

addServiceAccounts

getShieldedInstanceConfig

setShieldedInstanceConfig

getShieldedInstanceIntegrityPolicy

setShieldedInstanceIntegrityPolicy

getStartRestricted

setStartRestricted

getStatus

setStatus

getStatusMessage

setStatusMessage

getTags

setTags

getZone

setZone

build

clone