com.google.cloud.compute

Class Instance

java.lang.Object

com.google.cloud.compute.InstanceInfo

com.google.cloud.compute.Instance

All Implemented Interfaces:

Serializable

public class Instance
extends InstanceInfo

A Google Compute Engine VM Instance. An instance is a virtual machine (VM) hosted on Google's infrastructure. Instances can run Linux and Windows Server images provided by Google, or any customized versions of these images. You can also build and run images of other operating systems. Objects of this class are immutable. To get an Instance object with the most recent information use reload(com.google.cloud.compute.Compute.InstanceOption...). Instance adds a layer of service-related functionality over InstanceInfo.

See Also:

Virtual Machine Instances, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Instance.Builder A builder for Instance objects.

Nested classes/interfaces inherited from class com.google.cloud.compute.InstanceInfo

InstanceInfo.BuilderImpl, InstanceInfo.Status

Method Summary

Methods

Modifier and Type	Method and Description
Operation	addAccessConfig(String networkInterface, NetworkInterface.AccessConfig accessConfig, Compute.OperationOption... options) Adds an access configuration to the provided network interface for this instance.
Operation	attachDisk(AttachedDisk.PersistentDiskConfiguration configuration, Compute.OperationOption... options) Attaches a persistent disk to this instance given its configuration.
Operation	attachDisk(String deviceName, AttachedDisk.PersistentDiskConfiguration configuration, Compute.OperationOption... options) Attaches a persistent disk to this instance given the device name and its configuration.
Operation	attachDisk(String deviceName, AttachedDisk.PersistentDiskConfiguration configuration, int index, Compute.OperationOption... options) Attaches a persistent disk to this instance given the device name, its configuration and the device index.
Compute	compute() Returns the snapshot's Compute object used to issue requests.
Operation	delete(Compute.OperationOption... options) Deletes this instance.
Operation	deleteAccessConfig(String networkInterface, String accessConfig, Compute.OperationOption... options) Deletes an access configuration from the provided network interface for this instance.
Operation	detachDisk(String deviceName, Compute.OperationOption... options) Detaches a disk from this instance.
boolean	equals(Object obj)
boolean	exists() Checks if this instance exists.
String	getSerialPortOutput() Returns the default serial port output for this instance.
String	getSerialPortOutput(int port) Returns the serial port output for this instance and port number.
int	hashCode()
Instance	reload(Compute.InstanceOption... options) Fetches current instance's latest information.
Operation	reset(Compute.OperationOption... options) Resets this instance.
Operation	setDiskAutoDelete(String deviceName, boolean autoDelete, Compute.OperationOption... options) Sets the auto-delete flag for a disk attached to this instance.
Operation	setMachineType(MachineTypeId machineType, Compute.OperationOption... options) Sets the machine type for this instance.
Operation	setMetadata(Map<String,String> metadata, Compute.OperationOption... options) Sets the metadata for this instance, fingerprint value is taken from this instance's tags().fingerprint().
Operation	setMetadata(Metadata metadata, Compute.OperationOption... options) Sets the metadata for this instance.
Operation	setSchedulingOptions(SchedulingOptions scheduling, Compute.OperationOption... options) Sets the scheduling options for this instance.
Operation	setTags(Iterable<String> tags, Compute.OperationOption... options) Sets the tags for this instance, fingerprint value is taken from this instance's tags().fingerprint().
Operation	setTags(Tags tags, Compute.OperationOption... options) Sets the tags for this instance.
Operation	start(Compute.OperationOption... options) Starts this instance.
Operation	stop(Compute.OperationOption... options) Stops this instance.
Instance.Builder	toBuilder() Returns a builder for the current instance.

Methods inherited from class com.google.cloud.compute.InstanceInfo

attachedDisks, builder, canIpForward, cpuPlatform, creationTimestamp, description, generatedId, instanceId, machineType, metadata, networkInterfaces, of, schedulingOptions, serviceAccounts, status, statusMessage, tags, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

exists

public boolean exists()

Checks if this instance exists.

Returns:

true if this instance exists, false otherwise

Throws:

ComputeException - upon failure

reload

public Instance reload(Compute.InstanceOption... options)

Fetches current instance's latest information. Returns null if the instance does not exist.

Parameters:

options - instance options

Returns:

a Instance object with latest information or null if not found

Throws:

ComputeException - upon failure

delete

public Operation delete(Compute.OperationOption... options)

Deletes this instance.

Returns:

a zone operation if delete request was successfully sent, null if the instance was not found

Throws:

ComputeException - upon failure

addAccessConfig

public Operation addAccessConfig(String networkInterface,
                        NetworkInterface.AccessConfig accessConfig,
                        Compute.OperationOption... options)

Adds an access configuration to the provided network interface for this instance.

Returns:

a zone operation if the add request was issued correctly, null if the instance was not found

Throws:

ComputeException - upon failure

attachDisk

public Operation attachDisk(AttachedDisk.PersistentDiskConfiguration configuration,
                   Compute.OperationOption... options)

Attaches a persistent disk to this instance given its configuration.

Returns:

a zone operation if the attach request was issued correctly, null if the instance was not found

Throws:

ComputeException - upon failure

attachDisk

public Operation attachDisk(String deviceName,
                   AttachedDisk.PersistentDiskConfiguration configuration,
                   Compute.OperationOption... options)

Attaches a persistent disk to this instance given the device name and its configuration.

Returns:

a zone operation if the attach request was issued correctly, null if the instance was not found

Throws:

ComputeException - upon failure

attachDisk

public Operation attachDisk(String deviceName,
                   AttachedDisk.PersistentDiskConfiguration configuration,
                   int index,
                   Compute.OperationOption... options)

Attaches a persistent disk to this instance given the device name, its configuration and the device index.

Returns:

a zone operation if the attach request was issued correctly, null if the instance was not found

Throws:

ComputeException - upon failure

deleteAccessConfig

public Operation deleteAccessConfig(String networkInterface,
                           String accessConfig,
                           Compute.OperationOption... options)

Deletes an access configuration from the provided network interface for this instance.

Returns:

a zone operation if the delete request was issued correctly, null if the instance was not found

Throws:

ComputeException - upon failure

detachDisk

public Operation detachDisk(String deviceName,
                   Compute.OperationOption... options)

Detaches a disk from this instance.

Returns:

a zone operation if the detach request was issued correctly, null if the instance was not found

Throws:

ComputeException - upon failure

getSerialPortOutput

public String getSerialPortOutput(int port)

Returns the serial port output for this instance and port number. port must be between 1 and 4 (inclusive).

Returns:

the serial port output or null if the instance was not found

Throws:

ComputeException - upon failure

getSerialPortOutput

public String getSerialPortOutput()

Returns the default serial port output for this instance. Default serial port corresponds to port number 1.

Returns:

the serial port output or null if the instance was not found

Throws:

ComputeException - upon failure

reset

public Operation reset(Compute.OperationOption... options)

Resets this instance.

Returns:

a zone operation if the reset request was issued correctly, null if the instance was not found

Throws:

ComputeException - upon failure

setDiskAutoDelete

public Operation setDiskAutoDelete(String deviceName,
                          boolean autoDelete,
                          Compute.OperationOption... options)

Sets the auto-delete flag for a disk attached to this instance.

Returns:

a zone operation if the flag setting request was issued correctly, null if the instance was not found

Throws:

ComputeException - upon failure

setMachineType

public Operation setMachineType(MachineTypeId machineType,
                       Compute.OperationOption... options)

Sets the machine type for this instance. The instance must be in InstanceInfo.Status.TERMINATED state to be able to set its machine type.

Returns:

a zone operation if the set request was issued correctly, null if the instance was not found

Throws:

ComputeException - upon failure

setMetadata

public Operation setMetadata(Metadata metadata,
                    Compute.OperationOption... options)

Sets the metadata for this instance.

Returns:

a zone operation if the set request was issued correctly, null if the instance was not found

Throws:

ComputeException - upon failure

setMetadata

public Operation setMetadata(Map<String,String> metadata,
                    Compute.OperationOption... options)

Sets the metadata for this instance, fingerprint value is taken from this instance's tags().fingerprint().

Returns:

a zone operation if the set request was issued correctly, null if the instance was not found

Throws:

ComputeException - upon failure

setSchedulingOptions

public Operation setSchedulingOptions(SchedulingOptions scheduling,
                             Compute.OperationOption... options)

Sets the scheduling options for this instance.

Returns:

a zone operation if the set request was issued correctly, null if the instance was not found

Throws:

ComputeException - upon failure

setTags

public Operation setTags(Tags tags,
                Compute.OperationOption... options)

Sets the tags for this instance.

Returns:

a zone operation if the set request was issued correctly, null if the instance was not found

Throws:

ComputeException - upon failure

setTags

public Operation setTags(Iterable<String> tags,
                Compute.OperationOption... options)

Sets the tags for this instance, fingerprint value is taken from this instance's tags().fingerprint().

Returns:

a zone operation if the set request was issued correctly, null if the instance was not found

Throws:

ComputeException - upon failure

start

public Operation start(Compute.OperationOption... options)

Starts this instance.

Returns:

a zone operation if the start request was issued correctly, null if the instance was not found

Throws:

ComputeException - upon failure

stop

public Operation stop(Compute.OperationOption... options)

Stops this instance.

Returns:

a zone operation if the stop request was issued correctly, null if the instance was not found

Throws:

ComputeException - upon failure

compute

public Compute compute()

Returns the snapshot's Compute object used to issue requests.

toBuilder

public Instance.Builder toBuilder()

Description copied from class: InstanceInfo

Returns a builder for the current instance.

Overrides:

toBuilder in class InstanceInfo

equals

public final boolean equals(Object obj)

Overrides:

equals in class InstanceInfo

hashCode

public final int hashCode()

Overrides:

hashCode in class InstanceInfo