ListInstancesHttpRequest.Builder (Google Cloud 0.90.0-alpha API)

java.lang.Object
- com.google.cloud.compute.v1.ListInstancesHttpRequest.Builder

Enclosing class:: ListInstancesHttpRequest

public static class ListInstancesHttpRequest.Builder
extends Object

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ListInstancesHttpRequest`	`build()`
`ListInstancesHttpRequest.Builder`	`clone()`
`String`	`getAccessToken()` OAuth 2.0 token for the current user.
`String`	`getCallback()` Name of the JavaScript callback function that handles the response.
`String`	`getFields()` Selector specifying a subset of fields to include in the response.
`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 for this request.
`ListInstancesHttpRequest.Builder`	`mergeFrom(ListInstancesHttpRequest other)`
`ListInstancesHttpRequest.Builder`	`setAccessToken(String access_token)` OAuth 2.0 token for the current user.
`ListInstancesHttpRequest.Builder`	`setCallback(String callback)` Name of the JavaScript callback function that handles the response.
`ListInstancesHttpRequest.Builder`	`setFields(String fields)` Selector specifying a subset of fields to include in the response.
`ListInstancesHttpRequest.Builder`	`setFilter(String filter)` A filter expression that filters resources listed in the response.
`ListInstancesHttpRequest.Builder`	`setKey(String key)` API key.
`ListInstancesHttpRequest.Builder`	`setMaxResults(Integer maxResults)` The maximum number of results per page that should be returned.
`ListInstancesHttpRequest.Builder`	`setOrderBy(String orderBy)` Sorts list results by a certain order.
`ListInstancesHttpRequest.Builder`	`setPageToken(String pageToken)` Specifies a page token to use.
`ListInstancesHttpRequest.Builder`	`setPrettyPrint(String prettyPrint)` Returns response with indentations and line breaks.
`ListInstancesHttpRequest.Builder`	`setQuotaUser(String quotaUser)` Alternative to userIp.
`ListInstancesHttpRequest.Builder`	`setUserIp(String userIp)` IP address of the end user for whom the API call is being made.
`ListInstancesHttpRequest.Builder`	`setZone(String zone)` The name of the zone for this request.

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - mergeFrom
```
public ListInstancesHttpRequest.Builder mergeFrom(ListInstancesHttpRequest other)
```
  - getAccessToken
```
public String getAccessToken()
```
    OAuth 2.0 token for the current user.
  - setAccessToken
```
public ListInstancesHttpRequest.Builder setAccessToken(String access_token)
```
    OAuth 2.0 token for the current user.
  - getCallback
```
public String getCallback()
```
    Name of the JavaScript callback function that handles the response.
  - setCallback
```
public ListInstancesHttpRequest.Builder setCallback(String callback)
```
    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.
  - setFields
```
public ListInstancesHttpRequest.Builder setFields(String fields)
```
    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).
  - setFilter
```
public ListInstancesHttpRequest.Builder 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).
  - getKey
```
public String getKey()
```
    API key. Required unless you provide an OAuth 2.0 token.
  - setKey
```
public ListInstancesHttpRequest.Builder setKey(String key)
```
    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)
  - setMaxResults
```
public ListInstancesHttpRequest.Builder setMaxResults(Integer 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 ListInstancesHttpRequest.Builder 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 ListInstancesHttpRequest.Builder 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.
  - getPrettyPrint
```
public String getPrettyPrint()
```
    Returns response with indentations and line breaks.
  - setPrettyPrint
```
public ListInstancesHttpRequest.Builder setPrettyPrint(String prettyPrint)
```
    Returns response with indentations and line breaks.
  - getQuotaUser
```
public String getQuotaUser()
```
    Alternative to userIp.
  - setQuotaUser
```
public ListInstancesHttpRequest.Builder setQuotaUser(String quotaUser)
```
    Alternative to userIp.
  - getUserIp
```
public String getUserIp()
```
    IP address of the end user for whom the API call is being made.
  - setUserIp
```
public ListInstancesHttpRequest.Builder setUserIp(String userIp)
```
    IP address of the end user for whom the API call is being made.
  - getZone
```
public String getZone()
```
    The name of the zone for this request. It must have the format `{project}/zones/{zone}/instances`. \`{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"\`.
  - setZone
```
public ListInstancesHttpRequest.Builder setZone(String zone)
```
    The name of the zone for this request. It must have the format `{project}/zones/{zone}/instances`. \`{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"\`.
  - build
```
public ListInstancesHttpRequest build()
```
  - clone
```
public ListInstancesHttpRequest.Builder clone()
```
    Overrides:
    
    clone in class Object

Class ListInstancesHttpRequest.Builder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

mergeFrom

getAccessToken

setAccessToken

getCallback

setCallback

getFields

setFields

getFilter

setFilter

getKey

setKey

getMaxResults

setMaxResults

getOrderBy

setOrderBy

getPageToken

setPageToken

getPrettyPrint

setPrettyPrint

getQuotaUser

setQuotaUser

getUserIp

setUserIp

getZone

setZone

build

clone