com.google.api.services.compute

Class Compute.InstanceGroups

java.lang.Object

com.google.api.services.compute.Compute.InstanceGroups

Enclosing class:

Compute

public class Compute.InstanceGroups
extends Object

The "instanceGroups" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Compute.InstanceGroups.AddInstances
class	Compute.InstanceGroups.AggregatedList
class	Compute.InstanceGroups.Delete
class	Compute.InstanceGroups.Get
class	Compute.InstanceGroups.Insert
class	Compute.InstanceGroups.List
class	Compute.InstanceGroups.ListInstances
class	Compute.InstanceGroups.RemoveInstances
class	Compute.InstanceGroups.SetNamedPorts
class	Compute.InstanceGroups.TestIamPermissions

Constructor Summary

Constructors

Constructor and Description
InstanceGroups()

Method Summary

Modifier and Type	Method and Description
Compute.InstanceGroups.AddInstances	addInstances(String project, String zone, String instanceGroup, InstanceGroupsAddInstancesRequest content) Adds a list of instances to the specified instance group.
Compute.InstanceGroups.AggregatedList	aggregatedList(String project) Retrieves the list of instance groups and sorts them by zone.
Compute.InstanceGroups.Delete	delete(String project, String zone, String instanceGroup) Deletes the specified instance group.
Compute.InstanceGroups.Get	get(String project, String zone, String instanceGroup) Returns the specified zonal instance group.
Compute.InstanceGroups.Insert	insert(String project, String zone, InstanceGroup content) Creates an instance group in the specified project using the parameters that are included in the request.
Compute.InstanceGroups.List	list(String project, String zone) Retrieves the list of zonal instance group resources contained within the specified zone.
Compute.InstanceGroups.ListInstances	listInstances(String project, String zone, String instanceGroup, InstanceGroupsListInstancesRequest content) Lists the instances in the specified instance group.
Compute.InstanceGroups.RemoveInstances	removeInstances(String project, String zone, String instanceGroup, InstanceGroupsRemoveInstancesRequest content) Removes one or more instances from the specified instance group, but does not delete those instances.
Compute.InstanceGroups.SetNamedPorts	setNamedPorts(String project, String zone, String instanceGroup, InstanceGroupsSetNamedPortsRequest content) Sets the named ports for the specified instance group.
Compute.InstanceGroups.TestIamPermissions	testIamPermissions(String project, String zone, String resource, TestPermissionsRequest content) Returns permissions that a caller has on the specified resource.

Methods inherited from class java.lang.Object

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

Constructor Detail

InstanceGroups

public InstanceGroups()

Method Detail

addInstances

public Compute.InstanceGroups.AddInstances addInstances(String project,
                                                        String zone,
                                                        String instanceGroup,
                                                        InstanceGroupsAddInstancesRequest content)
                                                 throws IOException

Adds a list of instances to the specified instance group. All of the instances in the instance group must be in the same network/subnetwork. Read Adding instances for more information. Create a request for the method "instanceGroups.addInstances". 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 where the instance group is located.

instanceGroup - The name of the instance group where you are adding instances.

content - the InstanceGroupsAddInstancesRequest

Returns:

the request

Throws:

IOException

aggregatedList

public Compute.InstanceGroups.AggregatedList aggregatedList(String project)
                                                     throws IOException

Retrieves the list of instance groups and sorts them by zone. Create a request for the method "instanceGroups.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:

IOException

delete

public Compute.InstanceGroups.Delete delete(String project,
                                            String zone,
                                            String instanceGroup)
                                     throws IOException

Deletes the specified instance group. The instances in the group are not deleted. Note that instance group must not belong to a backend service. Read Deleting an instance group for more information. Create a request for the method "instanceGroups.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 where the instance group is located.

instanceGroup - The name of the instance group to delete.

Returns:

the request

Throws:

IOException

get

public Compute.InstanceGroups.Get get(String project,
                                      String zone,
                                      String instanceGroup)
                               throws IOException

Returns the specified zonal instance group. Get a list of available zonal instance groups by making a list() request. For managed instance groups, use the instanceGroupManagers or regionInstanceGroupManagers methods instead. Create a request for the method "instanceGroups.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 where the instance group is located.

instanceGroup - The name of the instance group.

Returns:

the request

Throws:

IOException

insert

public Compute.InstanceGroups.Insert insert(String project,
                                            String zone,
                                            InstanceGroup content)
                                     throws IOException

Creates an instance group in the specified project using the parameters that are included in the request. Create a request for the method "instanceGroups.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 where you want to create the instance group.

content - the InstanceGroup

Returns:

the request

Throws:

IOException

list

public Compute.InstanceGroups.List list(String project,
                                        String zone)
                                 throws IOException

Retrieves the list of zonal instance group resources contained within the specified zone. For managed instance groups, use the instanceGroupManagers or regionInstanceGroupManagers methods instead. Create a request for the method "instanceGroups.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 where the instance group is located.

Returns:

the request

Throws:

IOException

listInstances

public Compute.InstanceGroups.ListInstances listInstances(String project,
                                                          String zone,
                                                          String instanceGroup,
                                                          InstanceGroupsListInstancesRequest content)
                                                   throws IOException

Lists the instances in the specified instance group. The orderBy query parameter is not supported. The filter query parameter is supported, but only for expressions that use `eq` (equal) or `ne` (not equal) operators. Create a request for the method "instanceGroups.listInstances". 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 where the instance group is located.

instanceGroup - The name of the instance group from which you want to generate a list of included instances.

content - the InstanceGroupsListInstancesRequest

Returns:

the request

Throws:

IOException

removeInstances

public Compute.InstanceGroups.RemoveInstances removeInstances(String project,
                                                              String zone,
                                                              String instanceGroup,
                                                              InstanceGroupsRemoveInstancesRequest content)
                                                       throws IOException

Removes one or more instances from the specified instance group, but does not delete those instances. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration before the VM instance is removed or deleted. Create a request for the method "instanceGroups.removeInstances". 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 where the instance group is located.

instanceGroup - The name of the instance group where the specified instances will be removed.

content - the InstanceGroupsRemoveInstancesRequest

Returns:

the request

Throws:

IOException

setNamedPorts

public Compute.InstanceGroups.SetNamedPorts setNamedPorts(String project,
                                                          String zone,
                                                          String instanceGroup,
                                                          InstanceGroupsSetNamedPortsRequest content)
                                                   throws IOException

Sets the named ports for the specified instance group. Create a request for the method "instanceGroups.setNamedPorts". 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 where the instance group is located.

instanceGroup - The name of the instance group where the named ports are updated.

content - the InstanceGroupsSetNamedPortsRequest

Returns:

the request

Throws:

IOException

testIamPermissions

public Compute.InstanceGroups.TestIamPermissions testIamPermissions(String project,
                                                                    String zone,
                                                                    String resource,
                                                                    TestPermissionsRequest content)
                                                             throws IOException

Returns permissions that a caller has on the specified resource. Create a request for the method "instanceGroups.testIamPermissions". 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.

resource - Name or id of the resource for this request.

content - the TestPermissionsRequest

Returns:

the request

Throws:

IOException