com.google.api.services.compute

Class Compute.Instances

java.lang.Object

com.google.api.services.compute.Compute.Instances

Enclosing class:

Compute

public class Compute.Instances
extends java.lang.Object

The "instances" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Compute.Instances.AddAccessConfig
class	Compute.Instances.AggregatedList
class	Compute.Instances.AttachDisk
class	Compute.Instances.Delete
class	Compute.Instances.DeleteAccessConfig
class	Compute.Instances.DetachDisk
class	Compute.Instances.Get
class	Compute.Instances.GetSerialPortOutput
class	Compute.Instances.Insert
class	Compute.Instances.List
class	Compute.Instances.Reset
class	Compute.Instances.SetDiskAutoDelete
class	Compute.Instances.SetMachineType
class	Compute.Instances.SetMetadata
class	Compute.Instances.SetScheduling
class	Compute.Instances.SetTags
class	Compute.Instances.Start
class	Compute.Instances.Stop

Constructor Summary

Constructors

Constructor and Description
Compute.Instances()

Method Summary

Methods

Modifier and Type	Method and Description
Compute.Instances.AddAccessConfig	addAccessConfig(java.lang.String project, java.lang.String zone, java.lang.String instance, java.lang.String networkInterface, AccessConfig content) Adds an access config to an instance's network interface.
Compute.Instances.AggregatedList	aggregatedList(java.lang.String project) Retrieves aggregated list of instances.
Compute.Instances.AttachDisk	attachDisk(java.lang.String project, java.lang.String zone, java.lang.String instance, AttachedDisk content) Attaches a Disk resource to an instance.
Compute.Instances.Delete	delete(java.lang.String project, java.lang.String zone, java.lang.String instance) Deletes the specified Instance resource.
Compute.Instances.DeleteAccessConfig	deleteAccessConfig(java.lang.String project, java.lang.String zone, java.lang.String instance, java.lang.String accessConfig, java.lang.String networkInterface) Deletes an access config from an instance's network interface.
Compute.Instances.DetachDisk	detachDisk(java.lang.String project, java.lang.String zone, java.lang.String instance, java.lang.String deviceName) Detaches a disk from an instance.
Compute.Instances.Get	get(java.lang.String project, java.lang.String zone, java.lang.String instance) Returns the specified Instance resource.
Compute.Instances.GetSerialPortOutput	getSerialPortOutput(java.lang.String project, java.lang.String zone, java.lang.String instance) Returns the specified instance's serial port output.
Compute.Instances.Insert	insert(java.lang.String project, java.lang.String zone, Instance content) Creates an instance resource in the specified project using the data included in the request.
Compute.Instances.List	list(java.lang.String project, java.lang.String zone) Retrieves the list of instances contained within the specified zone.
Compute.Instances.Reset	reset(java.lang.String project, java.lang.String zone, java.lang.String instance) Performs a hard reset on the instance.
Compute.Instances.SetDiskAutoDelete	setDiskAutoDelete(java.lang.String project, java.lang.String zone, java.lang.String instance, java.lang.Boolean autoDelete, java.lang.String deviceName) Sets the auto-delete flag for a disk attached to an instance.
Compute.Instances.SetMachineType	setMachineType(java.lang.String project, java.lang.String zone, java.lang.String instance, InstancesSetMachineTypeRequest content) Changes the machine type for a stopped instance to the machine type specified in the request.
Compute.Instances.SetMetadata	setMetadata(java.lang.String project, java.lang.String zone, java.lang.String instance, Metadata content) Sets metadata for the specified instance to the data included in the request.
Compute.Instances.SetScheduling	setScheduling(java.lang.String project, java.lang.String zone, java.lang.String instance, Scheduling content) Sets an instance's scheduling options.
Compute.Instances.SetTags	setTags(java.lang.String project, java.lang.String zone, java.lang.String instance, Tags content) Sets tags for the specified instance to the data included in the request.
Compute.Instances.Start	start(java.lang.String project, java.lang.String zone, java.lang.String instance) Starts an instance that was stopped using the using the instances().stop method.
Compute.Instances.Stop	stop(java.lang.String project, java.lang.String zone, java.lang.String instance) Stops a running instance, shutting it down cleanly, and allows you to restart the instance at a later time.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Compute.Instances

public Compute.Instances()

Method Detail

addAccessConfig

public Compute.Instances.AddAccessConfig addAccessConfig(java.lang.String project,
                                                java.lang.String zone,
                                                java.lang.String instance,
                                                java.lang.String networkInterface,
                                                AccessConfig content)
                                                  throws java.io.IOException

Adds an access config to an instance's network interface. Create a request for the method "instances.addAccessConfig". This request holds the parameters needed by the compute server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

project - Project ID for this request.

zone - The name of the zone for this request.

instance - The instance name for this request.

networkInterface - The name of the network interface to add to this instance.

content - the AccessConfig

Returns:

the request

Throws:

java.io.IOException

aggregatedList

public Compute.Instances.AggregatedList aggregatedList(java.lang.String project)
                                                throws java.io.IOException

Retrieves aggregated list of instances. Create a request for the method "instances.aggregatedList". This request holds the parameters needed by the compute server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

project - Project ID for this request.

Returns:

the request

Throws:

java.io.IOException

attachDisk

public Compute.Instances.AttachDisk attachDisk(java.lang.String project,
                                      java.lang.String zone,
                                      java.lang.String instance,
                                      AttachedDisk content)
                                        throws java.io.IOException

Attaches a Disk resource to an instance. Create a request for the method "instances.attachDisk". This request holds the parameters needed by the compute server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

project - Project ID for this request.

zone - The name of the zone for this request.

instance - The instance name for this request.

content - the AttachedDisk

Returns:

the request

Throws:

java.io.IOException

delete

public Compute.Instances.Delete delete(java.lang.String project,
                              java.lang.String zone,
                              java.lang.String instance)
                                throws java.io.IOException

Deletes the specified Instance resource. For more information, see Stopping or Deleting an Instance. Create a request for the method "instances.delete". This request holds the parameters needed by the compute server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

project - Project ID for this request.

zone - The name of the zone for this request.

instance - Name of the instance resource to delete.

Returns:

the request

Throws:

java.io.IOException

deleteAccessConfig

public Compute.Instances.DeleteAccessConfig deleteAccessConfig(java.lang.String project,
                                                      java.lang.String zone,
                                                      java.lang.String instance,
                                                      java.lang.String accessConfig,
                                                      java.lang.String networkInterface)
                                                        throws java.io.IOException

Deletes an access config from an instance's network interface. Create a request for the method "instances.deleteAccessConfig". This request holds the parameters needed by the compute server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

project - Project ID for this request.

zone - The name of the zone for this request.

instance - The instance name for this request.

accessConfig - The name of the access config to delete.

networkInterface - The name of the network interface.

Returns:

the request

Throws:

java.io.IOException

detachDisk

public Compute.Instances.DetachDisk detachDisk(java.lang.String project,
                                      java.lang.String zone,
                                      java.lang.String instance,
                                      java.lang.String deviceName)
                                        throws java.io.IOException

Detaches a disk from an instance. Create a request for the method "instances.detachDisk". This request holds the parameters needed by the compute server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

project - Project ID for this request.

zone - The name of the zone for this request.

instance - Instance name.

deviceName - Disk device name to detach.

Returns:

the request

Throws:

java.io.IOException

get

public Compute.Instances.Get get(java.lang.String project,
                        java.lang.String zone,
                        java.lang.String instance)
                          throws java.io.IOException

Returns the specified Instance resource. Get a list of available instances by making a list() request. Create a request for the method "instances.get". This request holds the parameters needed by the compute server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

project - Project ID for this request.

zone - The name of the zone for this request.

instance - Name of the instance resource to return.

Returns:

the request

Throws:

java.io.IOException

getSerialPortOutput

public Compute.Instances.GetSerialPortOutput getSerialPortOutput(java.lang.String project,
                                                        java.lang.String zone,
                                                        java.lang.String instance)
                                                          throws java.io.IOException

Returns the specified instance's serial port output. Create a request for the method "instances.getSerialPortOutput". This request holds the parameters needed by the compute server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

project - Project ID for this request.

zone - The name of the zone for this request.

instance - Name of the instance scoping this request.

Returns:

the request

Throws:

java.io.IOException

insert

public Compute.Instances.Insert insert(java.lang.String project,
                              java.lang.String zone,
                              Instance content)
                                throws java.io.IOException

Creates an instance resource in the specified project using the data included in the request. Create a request for the method "instances.insert". This request holds the parameters needed by the compute server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

project - Project ID for this request.

zone - The name of the zone for this request.

content - the Instance

Returns:

the request

Throws:

java.io.IOException

list

public Compute.Instances.List list(java.lang.String project,
                          java.lang.String zone)
                            throws java.io.IOException

Retrieves the list of instances contained within the specified zone. Create a request for the method "instances.list". This request holds the parameters needed by the compute server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

project - Project ID for this request.

zone - The name of the zone for this request.

Returns:

the request

Throws:

java.io.IOException

reset

public Compute.Instances.Reset reset(java.lang.String project,
                            java.lang.String zone,
                            java.lang.String instance)
                              throws java.io.IOException

Performs a hard reset on the instance. Create a request for the method "instances.reset". This request holds the parameters needed by the compute server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

project - Project ID for this request.

zone - The name of the zone for this request.

instance - Name of the instance scoping this request.

Returns:

the request

Throws:

java.io.IOException

setDiskAutoDelete

public Compute.Instances.SetDiskAutoDelete setDiskAutoDelete(java.lang.String project,
                                                    java.lang.String zone,
                                                    java.lang.String instance,
                                                    java.lang.Boolean autoDelete,
                                                    java.lang.String deviceName)
                                                      throws java.io.IOException

Sets the auto-delete flag for a disk attached to an instance. Create a request for the method "instances.setDiskAutoDelete". This request holds the parameters needed by the compute server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

project - Project ID for this request.

zone - The name of the zone for this request.

instance - The instance name.

autoDelete - Whether to auto-delete the disk when the instance is deleted.

deviceName - The device name of the disk to modify.

Returns:

the request

Throws:

java.io.IOException

setMachineType

public Compute.Instances.SetMachineType setMachineType(java.lang.String project,
                                              java.lang.String zone,
                                              java.lang.String instance,
                                              InstancesSetMachineTypeRequest content)
                                                throws java.io.IOException

Changes the machine type for a stopped instance to the machine type specified in the request. Create a request for the method "instances.setMachineType". This request holds the parameters needed by the compute server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

project - Project ID for this request.

zone - The name of the zone for this request.

instance - Name of the instance scoping this request.

content - the InstancesSetMachineTypeRequest

Returns:

the request

Throws:

java.io.IOException

setMetadata

public Compute.Instances.SetMetadata setMetadata(java.lang.String project,
                                        java.lang.String zone,
                                        java.lang.String instance,
                                        Metadata content)
                                          throws java.io.IOException

Sets metadata for the specified instance to the data included in the request. Create a request for the method "instances.setMetadata". This request holds the parameters needed by the compute server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

project - Project ID for this request.

zone - The name of the zone for this request.

instance - Name of the instance scoping this request.

content - the Metadata

Returns:

the request

Throws:

java.io.IOException

setScheduling

public Compute.Instances.SetScheduling setScheduling(java.lang.String project,
                                            java.lang.String zone,
                                            java.lang.String instance,
                                            Scheduling content)
                                              throws java.io.IOException

Sets an instance's scheduling options. Create a request for the method "instances.setScheduling". This request holds the parameters needed by the compute server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

project - Project ID for this request.

zone - The name of the zone for this request.

instance - Instance name.

content - the Scheduling

Returns:

the request

Throws:

java.io.IOException

setTags

public Compute.Instances.SetTags setTags(java.lang.String project,
                                java.lang.String zone,
                                java.lang.String instance,
                                Tags content)
                                  throws java.io.IOException

Sets tags for the specified instance to the data included in the request. Create a request for the method "instances.setTags". This request holds the parameters needed by the compute server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

project - Project ID for this request.

zone - The name of the zone for this request.

instance - Name of the instance scoping this request.

content - the Tags

Returns:

the request

Throws:

java.io.IOException

start

public Compute.Instances.Start start(java.lang.String project,
                            java.lang.String zone,
                            java.lang.String instance)
                              throws java.io.IOException

Starts an instance that was stopped using the using the instances().stop method. For more information, see Restart an instance. Create a request for the method "instances.start". This request holds the parameters needed by the compute server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

project - Project ID for this request.

zone - The name of the zone for this request.

instance - Name of the instance resource to start.

Returns:

the request

Throws:

java.io.IOException

stop

public Compute.Instances.Stop stop(java.lang.String project,
                          java.lang.String zone,
                          java.lang.String instance)
                            throws java.io.IOException

Stops a running instance, shutting it down cleanly, and allows you to restart the instance at a later time. Stopped instances do not incur per-minute, virtual machine usage charges while they are stopped, but any resources that the virtual machine is using, such as persistent disks and static IP addresses, will continue to be charged until they are deleted. For more information, see Stopping an instance. Create a request for the method "instances.stop". This request holds the parameters needed by the compute server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

project - Project ID for this request.

zone - The name of the zone for this request.

instance - Name of the instance resource to stop.

Returns:

the request

Throws:

java.io.IOException