com.google.api.services.compute

Class Compute.Instances.AggregatedList

java.lang.Object

java.util.AbstractMap<java.lang.String,java.lang.Object>

com.google.api.client.util.GenericData

com.google.api.client.googleapis.services.AbstractGoogleClientRequest<T>

com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest<T>

com.google.api.services.compute.ComputeRequest<InstanceAggregatedList>

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

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>

Enclosing class:

Compute.Instances

public class Compute.Instances.AggregatedList
extends ComputeRequest<InstanceAggregatedList>

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>

Field Summary

Fields inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

USER_AGENT_SUFFIX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Compute.Instances.AggregatedList(java.lang.String project) Retrieves aggregated list of instances.

Method Summary

Methods

Modifier and Type	Method and Description
com.google.api.client.http.HttpRequest	buildHttpRequestUsingHead()
com.google.api.client.http.HttpResponse	executeUsingHead()
java.lang.String	getFilter() Sets a filter expression for filtering listed resources, in the form filter={expression}.
java.lang.Long	getMaxResults() The maximum number of results per page that should be returned.
java.lang.String	getPageToken() Specifies a page token to use.
java.lang.String	getProject() Project ID for this request.
Compute.Instances.AggregatedList	set(java.lang.String parameterName, java.lang.Object value)
Compute.Instances.AggregatedList	setAlt(java.lang.String alt) Data format for the response.
Compute.Instances.AggregatedList	setFields(java.lang.String fields) Selector specifying which fields to include in a partial response.
Compute.Instances.AggregatedList	setFilter(java.lang.String filter) Sets a filter expression for filtering listed resources, in the form filter={expression}.
Compute.Instances.AggregatedList	setKey(java.lang.String key) API key.
Compute.Instances.AggregatedList	setMaxResults(java.lang.Long maxResults) The maximum number of results per page that should be returned.
Compute.Instances.AggregatedList	setOauthToken(java.lang.String oauthToken) OAuth 2.0 token for the current user.
Compute.Instances.AggregatedList	setPageToken(java.lang.String pageToken) Specifies a page token to use.
Compute.Instances.AggregatedList	setPrettyPrint(java.lang.Boolean prettyPrint) Returns response with indentations and line breaks.
Compute.Instances.AggregatedList	setProject(java.lang.String project) Project ID for this request.
Compute.Instances.AggregatedList	setQuotaUser(java.lang.String quotaUser) Available to use for quota purposes for server-side applications.
Compute.Instances.AggregatedList	setUserIp(java.lang.String userIp) IP address of the site where the request originates.

Methods inherited from class com.google.api.services.compute.ComputeRequest

getAbstractGoogleClient, getAlt, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUserIp, setDisableGZipContent, setRequestHeaders

Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest

getJsonContent, newExceptionOnError, queue

Methods inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

buildHttpRequest, buildHttpRequestUrl, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, getDisableGZipContent, getHttpContent, getLastResponseHeaders, getLastStatusCode, getLastStatusMessage, getMediaHttpDownloader, getMediaHttpUploader, getRequestHeaders, getRequestMethod, getResponseClass, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue

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

clone, entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, toString, values

Methods inherited from class java.lang.Object

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

Constructor Detail

Compute.Instances.AggregatedList

protected Compute.Instances.AggregatedList(java.lang.String project)

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

AggregatedList#initialize(com.google.api.client.googleapis.services.AbstractGoogleCl ientRequest) must be called to initialize this instance immediately after invoking the constructor.

Parameters:

project - Project ID for this request.

Since:

1.13

Method Detail

executeUsingHead

public com.google.api.client.http.HttpResponse executeUsingHead()
                                                         throws java.io.IOException

Overrides:

executeUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<InstanceAggregatedList>

Throws:

java.io.IOException

buildHttpRequestUsingHead

public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead()
                                                                 throws java.io.IOException

Overrides:

buildHttpRequestUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<InstanceAggregatedList>

Throws:

java.io.IOException

setAlt

public Compute.Instances.AggregatedList setAlt(java.lang.String alt)

Description copied from class: ComputeRequest

Data format for the response.

Overrides:

setAlt in class ComputeRequest<InstanceAggregatedList>

setFields

public Compute.Instances.AggregatedList setFields(java.lang.String fields)

Description copied from class: ComputeRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class ComputeRequest<InstanceAggregatedList>

setKey

public Compute.Instances.AggregatedList setKey(java.lang.String key)

Description copied from class: ComputeRequest

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Overrides:

setKey in class ComputeRequest<InstanceAggregatedList>

setOauthToken

public Compute.Instances.AggregatedList setOauthToken(java.lang.String oauthToken)

Description copied from class: ComputeRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class ComputeRequest<InstanceAggregatedList>

setPrettyPrint

public Compute.Instances.AggregatedList setPrettyPrint(java.lang.Boolean prettyPrint)

Description copied from class: ComputeRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class ComputeRequest<InstanceAggregatedList>

setQuotaUser

public Compute.Instances.AggregatedList setQuotaUser(java.lang.String quotaUser)

Description copied from class: ComputeRequest

Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

Overrides:

setQuotaUser in class ComputeRequest<InstanceAggregatedList>

setUserIp

public Compute.Instances.AggregatedList setUserIp(java.lang.String userIp)

Description copied from class: ComputeRequest

IP address of the site where the request originates. Use this if you want to enforce per-user limits.

Overrides:

setUserIp in class ComputeRequest<InstanceAggregatedList>

getProject

public java.lang.String getProject()

Project ID for this request.

setProject

public Compute.Instances.AggregatedList setProject(java.lang.String project)

Project ID for this request.

getFilter

public java.lang.String getFilter()

Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. Compute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values. The Beta API also supports filtering on multiple expressions by providing each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

setFilter

public Compute.Instances.AggregatedList setFilter(java.lang.String filter)

Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. Compute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values. The Beta API also supports filtering on multiple expressions by providing each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

getMaxResults

public java.lang.Long getMaxResults()

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. [default: 500] [minimum: 0] [maximum: 500]

setMaxResults

public Compute.Instances.AggregatedList setMaxResults(java.lang.Long maxResults)

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.

getPageToken

public java.lang.String getPageToken()

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

setPageToken

public Compute.Instances.AggregatedList setPageToken(java.lang.String pageToken)

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

set

public Compute.Instances.AggregatedList set(java.lang.String parameterName,
                                   java.lang.Object value)

Overrides:

set in class ComputeRequest<InstanceAggregatedList>