com.google.api.services.compute

Class Compute.RegionInstanceGroups.ListInstances

java.lang.Object

java.util.AbstractMap<String,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<RegionInstanceGroupsListInstances>

com.google.api.services.compute.Compute.RegionInstanceGroups.ListInstances

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Compute.RegionInstanceGroups

public class Compute.RegionInstanceGroups.ListInstances
extends ComputeRequest<RegionInstanceGroupsListInstances>

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

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	ListInstances(String project, String region, String instanceGroup, RegionInstanceGroupsListInstancesRequest content) Lists the instances in the specified instance group and displays information about the named ports.

Method Summary

Modifier and Type	Method and Description
String	getFilter() A filter expression that filters resources listed in the response.
String	getInstanceGroup() Name of the regional instance group for which we want to list the instances.
Long	getMaxResults() The maximum number of results per page that should be returned.
String	getOrderBy() Sorts list results by a certain order.
String	getPageToken() Specifies a page token to use.
String	getProject() Project ID for this request.
String	getRegion() Name of the region scoping this request.
Boolean	getReturnPartialSuccess() Opt-in for partial success behavior which provides partial results in case of failure.
Compute.RegionInstanceGroups.ListInstances	set(String parameterName, Object value)
Compute.RegionInstanceGroups.ListInstances	set$Xgafv(String $Xgafv) V1 error format.
Compute.RegionInstanceGroups.ListInstances	setAccessToken(String accessToken) OAuth access token.
Compute.RegionInstanceGroups.ListInstances	setAlt(String alt) Data format for response.
Compute.RegionInstanceGroups.ListInstances	setCallback(String callback) JSONP
Compute.RegionInstanceGroups.ListInstances	setFields(String fields) Selector specifying which fields to include in a partial response.
Compute.RegionInstanceGroups.ListInstances	setFilter(String filter) A filter expression that filters resources listed in the response.
Compute.RegionInstanceGroups.ListInstances	setInstanceGroup(String instanceGroup) Name of the regional instance group for which we want to list the instances.
Compute.RegionInstanceGroups.ListInstances	setKey(String key) API key.
Compute.RegionInstanceGroups.ListInstances	setMaxResults(Long maxResults) The maximum number of results per page that should be returned.
Compute.RegionInstanceGroups.ListInstances	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
Compute.RegionInstanceGroups.ListInstances	setOrderBy(String orderBy) Sorts list results by a certain order.
Compute.RegionInstanceGroups.ListInstances	setPageToken(String pageToken) Specifies a page token to use.
Compute.RegionInstanceGroups.ListInstances	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
Compute.RegionInstanceGroups.ListInstances	setProject(String project) Project ID for this request.
Compute.RegionInstanceGroups.ListInstances	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
Compute.RegionInstanceGroups.ListInstances	setRegion(String region) Name of the region scoping this request.
Compute.RegionInstanceGroups.ListInstances	setReturnPartialSuccess(Boolean returnPartialSuccess) Opt-in for partial success behavior which provides partial results in case of failure.
Compute.RegionInstanceGroups.ListInstances	setUploadProtocol(String uploadProtocol) Upload protocol for media (e.g.
Compute.RegionInstanceGroups.ListInstances	setUploadType(String uploadType) Legacy upload protocol for media (e.g.
Compute.RegionInstanceGroups.ListInstances	setUserIp(String userIp) Legacy name for parameter that has been superseded by `quotaUser`.

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

get$Xgafv, getAbstractGoogleClient, getAccessToken, getAlt, getCallback, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUploadProtocol, getUploadType, 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, buildHttpRequestUsingHead, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, executeUsingHead, getDisableGZipContent, getHttpContent, getLastResponseHeaders, getLastStatusCode, getLastStatusMessage, getMediaHttpDownloader, getMediaHttpUploader, getRequestHeaders, getRequestMethod, getResponseClass, getReturnRawInputSteam, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue, setReturnRawInputStream

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

clone, entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys, toString

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

ListInstances

protected ListInstances(String project,
                        String region,
                        String instanceGroup,
                        RegionInstanceGroupsListInstancesRequest content)

Lists the instances in the specified instance group and displays information about the named ports. Depending on the specified options, this method can list all instances or only the instances that are running. The orderBy query parameter is not supported. Create a request for the method "regionInstanceGroups.listInstances". 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.

ListInstances#initialize(com.google.api.client.googleapis.services.AbstractGoogleClientR equest) must be called to initialize this instance immediately after invoking the constructor.

Parameters:

project - Project ID for this request.

region - Name of the region scoping this request.

instanceGroup - Name of the regional instance group for which we want to list the instances.

content - the RegionInstanceGroupsListInstancesRequest

Since:

1.13

Method Detail

set$Xgafv

public Compute.RegionInstanceGroups.ListInstances set$Xgafv(String $Xgafv)

Description copied from class: ComputeRequest

V1 error format.

Overrides:

set$Xgafv in class ComputeRequest<RegionInstanceGroupsListInstances>

setAccessToken

public Compute.RegionInstanceGroups.ListInstances setAccessToken(String accessToken)

Description copied from class: ComputeRequest

OAuth access token.

Overrides:

setAccessToken in class ComputeRequest<RegionInstanceGroupsListInstances>

setAlt

public Compute.RegionInstanceGroups.ListInstances setAlt(String alt)

Description copied from class: ComputeRequest

Data format for response.

Overrides:

setAlt in class ComputeRequest<RegionInstanceGroupsListInstances>

setCallback

public Compute.RegionInstanceGroups.ListInstances setCallback(String callback)

Description copied from class: ComputeRequest

JSONP

Overrides:

setCallback in class ComputeRequest<RegionInstanceGroupsListInstances>

setFields

public Compute.RegionInstanceGroups.ListInstances setFields(String fields)

Description copied from class: ComputeRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class ComputeRequest<RegionInstanceGroupsListInstances>

setKey

public Compute.RegionInstanceGroups.ListInstances setKey(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<RegionInstanceGroupsListInstances>

setOauthToken

public Compute.RegionInstanceGroups.ListInstances setOauthToken(String oauthToken)

Description copied from class: ComputeRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class ComputeRequest<RegionInstanceGroupsListInstances>

setPrettyPrint

public Compute.RegionInstanceGroups.ListInstances setPrettyPrint(Boolean prettyPrint)

Description copied from class: ComputeRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class ComputeRequest<RegionInstanceGroupsListInstances>

setQuotaUser

public Compute.RegionInstanceGroups.ListInstances setQuotaUser(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:

setQuotaUser in class ComputeRequest<RegionInstanceGroupsListInstances>

setUploadType

public Compute.RegionInstanceGroups.ListInstances setUploadType(String uploadType)

Description copied from class: ComputeRequest

Legacy upload protocol for media (e.g. "media", "multipart").

Overrides:

setUploadType in class ComputeRequest<RegionInstanceGroupsListInstances>

setUploadProtocol

public Compute.RegionInstanceGroups.ListInstances setUploadProtocol(String uploadProtocol)

Description copied from class: ComputeRequest

Upload protocol for media (e.g. "raw", "multipart").

Overrides:

setUploadProtocol in class ComputeRequest<RegionInstanceGroupsListInstances>

setUserIp

public Compute.RegionInstanceGroups.ListInstances setUserIp(String userIp)

Description copied from class: ComputeRequest

Legacy name for parameter that has been superseded by `quotaUser`.

Overrides:

setUserIp in class ComputeRequest<RegionInstanceGroupsListInstances>

getProject

public String getProject()

Project ID for this request.

setProject

public Compute.RegionInstanceGroups.ListInstances setProject(String project)

Project ID for this request.

getRegion

public String getRegion()

Name of the region scoping this request.

setRegion

public Compute.RegionInstanceGroups.ListInstances setRegion(String region)

Name of the region scoping this request.

getInstanceGroup

public String getInstanceGroup()

Name of the regional instance group for which we want to list the instances.

setInstanceGroup

public Compute.RegionInstanceGroups.ListInstances setInstanceGroup(String instanceGroup)

Name of the regional instance group for which we want to list the instances.

getFilter

public String getFilter()

A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ```

setFilter

public Compute.RegionInstanceGroups.ListInstances setFilter(String filter)

A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ```

getMaxResults

public 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. Acceptable values are `0` to `500`, inclusive. (Default: `500`) [default: 500] [minimum: 0]

setMaxResults

public Compute.RegionInstanceGroups.ListInstances setMaxResults(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. Acceptable values are `0` to `500`, inclusive. (Default: `500`)

getOrderBy

public String getOrderBy()

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.

setOrderBy

public Compute.RegionInstanceGroups.ListInstances setOrderBy(String orderBy)

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.

getPageToken

public 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.RegionInstanceGroups.ListInstances setPageToken(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.

getReturnPartialSuccess

public Boolean getReturnPartialSuccess()

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.

setReturnPartialSuccess

public Compute.RegionInstanceGroups.ListInstances setReturnPartialSuccess(Boolean returnPartialSuccess)

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.

set

public Compute.RegionInstanceGroups.ListInstances set(String parameterName,
                                                      Object value)

Overrides:

set in class ComputeRequest<RegionInstanceGroupsListInstances>