Compute.InstanceGroups.ListInstances (Compute Engine API v1-rev20240218-2.0.0)

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<InstanceGroupsListInstances>
        
        com.google.api.services.compute.Compute.InstanceGroups.ListInstances

All Implemented Interfaces:: Cloneable, Map<String,Object>

Enclosing class:: Compute.InstanceGroups

public class Compute.InstanceGroups.ListInstances
extends ComputeRequest<InstanceGroupsListInstances>

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
  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 zone, String instanceGroup, InstanceGroupsListInstancesRequest content)` Lists the instances in the specified instance group.

Method Summary

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

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 zone,
                        String instanceGroup,
                        InstanceGroupsListInstancesRequest content)
```
    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 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.
    
    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
    
    Since:
    
    1.13
- Method Detail
  - set$Xgafv
```
public Compute.InstanceGroups.ListInstances set$Xgafv(String $Xgafv)
```
    Description copied from class: ComputeRequest
    
    V1 error format.
    
    Overrides:
    
    set$Xgafv in class ComputeRequest<InstanceGroupsListInstances>
  - setAccessToken
```
public Compute.InstanceGroups.ListInstances setAccessToken(String accessToken)
```
    Description copied from class: ComputeRequest
    
    OAuth access token.
    
    Overrides:
    
    setAccessToken in class ComputeRequest<InstanceGroupsListInstances>
  - setAlt
```
public Compute.InstanceGroups.ListInstances setAlt(String alt)
```
    Description copied from class: ComputeRequest
    
    Data format for response.
    
    Overrides:
    
    setAlt in class ComputeRequest<InstanceGroupsListInstances>
  - setCallback
```
public Compute.InstanceGroups.ListInstances setCallback(String callback)
```
    Description copied from class: ComputeRequest
    
    JSONP
    
    Overrides:
    
    setCallback in class ComputeRequest<InstanceGroupsListInstances>
  - setFields
```
public Compute.InstanceGroups.ListInstances setFields(String fields)
```
    Description copied from class: ComputeRequest
    
    Selector specifying which fields to include in a partial response.
    
    Overrides:
    
    setFields in class ComputeRequest<InstanceGroupsListInstances>
  - setKey
```
public Compute.InstanceGroups.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<InstanceGroupsListInstances>
  - setOauthToken
```
public Compute.InstanceGroups.ListInstances setOauthToken(String oauthToken)
```
    Description copied from class: ComputeRequest
    
    OAuth 2.0 token for the current user.
    
    Overrides:
    
    setOauthToken in class ComputeRequest<InstanceGroupsListInstances>
  - setPrettyPrint
```
public Compute.InstanceGroups.ListInstances setPrettyPrint(Boolean prettyPrint)
```
    Description copied from class: ComputeRequest
    
    Returns response with indentations and line breaks.
    
    Overrides:
    
    setPrettyPrint in class ComputeRequest<InstanceGroupsListInstances>
  - setQuotaUser
```
public Compute.InstanceGroups.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<InstanceGroupsListInstances>
  - setUploadType
```
public Compute.InstanceGroups.ListInstances setUploadType(String uploadType)
```
    Description copied from class: ComputeRequest
    
    Legacy upload protocol for media (e.g. "media", "multipart").
    
    Overrides:
    
    setUploadType in class ComputeRequest<InstanceGroupsListInstances>
  - setUploadProtocol
```
public Compute.InstanceGroups.ListInstances setUploadProtocol(String uploadProtocol)
```
    Description copied from class: ComputeRequest
    
    Upload protocol for media (e.g. "raw", "multipart").
    
    Overrides:
    
    setUploadProtocol in class ComputeRequest<InstanceGroupsListInstances>
  - setUserIp
```
public Compute.InstanceGroups.ListInstances setUserIp(String userIp)
```
    Description copied from class: ComputeRequest
    
    Legacy name for parameter that has been superseded by `quotaUser`.
    
    Overrides:
    
    setUserIp in class ComputeRequest<InstanceGroupsListInstances>
  - getProject
```
public String getProject()
```
    Project ID for this request.
  - setProject
```
public Compute.InstanceGroups.ListInstances setProject(String project)
```
    Project ID for this request.
  - getZone
```
public String getZone()
```
    The name of the zone where the instance group is located.
  - setZone
```
public Compute.InstanceGroups.ListInstances setZone(String zone)
```
    The name of the zone where the instance group is located.
  - getInstanceGroup
```
public String getInstanceGroup()
```
    The name of the instance group from which you want to generate a list of included instances.
  - setInstanceGroup
```
public Compute.InstanceGroups.ListInstances setInstanceGroup(String instanceGroup)
```
    The name of the instance group from which you want to generate a list of included instances.
  - getFilter
```
public String getFilter()
```
    A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` 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) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.
  - setFilter
```
public Compute.InstanceGroups.ListInstances setFilter(String filter)
```
    A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` 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) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un- parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.
  - 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.InstanceGroups.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.InstanceGroups.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.InstanceGroups.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. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.
  - setReturnPartialSuccess
```
public Compute.InstanceGroups.ListInstances setReturnPartialSuccess(Boolean returnPartialSuccess)
```
    Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.
  - set
```
public Compute.InstanceGroups.ListInstances set(String parameterName,
                                                Object value)
```
    Overrides:
    
    set in class ComputeRequest<InstanceGroupsListInstances>

Class Compute.InstanceGroups.ListInstances

Nested Class Summary

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

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

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

Field Summary

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

Constructor Summary

Method Summary

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

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

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

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

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

ListInstances

Method Detail

set$Xgafv

setAccessToken

setAlt

setCallback

setFields

setKey

setOauthToken

setPrettyPrint

setQuotaUser

setUploadType

setUploadProtocol

setUserIp

getProject

setProject

getZone

setZone

getInstanceGroup

setInstanceGroup

getFilter

setFilter

getMaxResults

setMaxResults

getOrderBy

setOrderBy

getPageToken

setPageToken

getReturnPartialSuccess

setReturnPartialSuccess

set