ListInstanceGroupsHttpRequest (Google Cloud 0.89.0-alpha API)

java.lang.Object
- com.google.cloud.compute.v1.ListInstanceGroupsHttpRequest

All Implemented Interfaces:: ApiMessage

@Generated(value="by GAPIC")
 @BetaApi
public final class ListInstanceGroupsHttpRequest
extends Object
implements ApiMessage

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ListInstanceGroupsHttpRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static class`	`ListInstanceGroupsHttpRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object o)`
`String`	`getAccessToken()` OAuth 2.0 token for the current user.
`ApiMessage`	`getApiMessageRequestBody()`
`String`	`getCallback()` Name of the JavaScript callback function that handles the response.
`static ListInstanceGroupsHttpRequest`	`getDefaultInstance()`
`List<String>`	`getFieldMask()`
`String`	`getFields()` Selector specifying a subset of fields to include in the response.
`Object`	`getFieldValue(String fieldName)`
`String`	`getFilter()` A filter expression that filters resources listed in the response.
`String`	`getKey()` API key.
`Integer`	`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`	`getPrettyPrint()` Returns response with indentations and line breaks.
`String`	`getQuotaUser()` Alternative to userIp.
`String`	`getUserIp()` IP address of the end user for whom the API call is being made.
`String`	`getZone()` The name of the zone where the instance group is located.
`int`	`hashCode()`
`static ListInstanceGroupsHttpRequest.Builder`	`newBuilder()`
`static ListInstanceGroupsHttpRequest.Builder`	`newBuilder(ListInstanceGroupsHttpRequest prototype)`
`ListInstanceGroupsHttpRequest.Builder`	`toBuilder()`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Method Detail
  - getFieldValue
```
public Object getFieldValue(String fieldName)
```
    Specified by:
    
    getFieldValue in interface ApiMessage
  - getApiMessageRequestBody
```
@Nullable
public ApiMessage getApiMessageRequestBody()
```
    Specified by:
    
    getApiMessageRequestBody in interface ApiMessage
  - getFieldMask
```
@Nullable
public List<String> getFieldMask()
```
    Specified by:
    
    getFieldMask in interface ApiMessage
  - getAccessToken
```
public String getAccessToken()
```
    OAuth 2.0 token for the current user.
  - getCallback
```
public String getCallback()
```
    Name of the JavaScript callback function that handles the response.
  - getFields
```
public String getFields()
```
    Selector specifying a subset of fields to include in the response.
  - 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).
  - getKey
```
public String getKey()
```
    API key. Required unless you provide an OAuth 2.0 token.
  - getMaxResults
```
public Integer 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)
  - 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.
  - 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.
  - getPrettyPrint
```
public String getPrettyPrint()
```
    Returns response with indentations and line breaks.
  - getQuotaUser
```
public String getQuotaUser()
```
    Alternative to userIp.
  - getUserIp
```
public String getUserIp()
```
    IP address of the end user for whom the API call is being made.
  - getZone
```
public String getZone()
```
    The name of the zone where the instance group is located. It must have the format `{project}/zones/{zone}/instanceGroups`. \`{zone}\` must start with a letter, and contain only letters (\`[A-Za-z]\`), numbers (\`[0-9]\`), dashes (\`-\`), * underscores (\`_\`), periods (\`.\`), tildes (\`~\`), plus (\`+\`) or percent * signs (\`%\`). It must be between 3 and 255 characters in length, and it * must not start with \`"goog"\`.
  - newBuilder
```
public static ListInstanceGroupsHttpRequest.Builder newBuilder()
```
  - newBuilder
```
public static ListInstanceGroupsHttpRequest.Builder newBuilder(ListInstanceGroupsHttpRequest prototype)
```
  - toBuilder
```
public ListInstanceGroupsHttpRequest.Builder toBuilder()
```
  - getDefaultInstance
```
public static ListInstanceGroupsHttpRequest getDefaultInstance()
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object

Class ListInstanceGroupsHttpRequest

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getFieldValue

getApiMessageRequestBody

getFieldMask

getAccessToken

getCallback

getFields

getFilter

getKey

getMaxResults

getOrderBy

getPageToken

getPrettyPrint

getQuotaUser

getUserIp

getZone

newBuilder

newBuilder

toBuilder

getDefaultInstance

toString

equals

hashCode