com.google.api.services.deploymentmanager

Class DeploymentManager.Resources.List

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.deploymentmanager.DeploymentManagerRequest<ResourcesListResponse>

com.google.api.services.deploymentmanager.DeploymentManager.Resources.List

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

DeploymentManager.Resources

public class DeploymentManager.Resources.List
extends DeploymentManagerRequest<ResourcesListResponse>

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

API_VERSION_HEADER, USER_AGENT_SUFFIX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	List(String project, String deployment) Lists all resources in a given deployment.

Method Summary

Modifier and Type	Method and Description
com.google.api.client.http.HttpRequest	buildHttpRequestUsingHead()
com.google.api.client.http.HttpResponse	executeUsingHead()
String	getDeployment() The name of the deployment for this request.
String	getFilter() A filter expression that filters resources listed in the response.
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() The project ID for this request.
DeploymentManager.Resources.List	set(String parameterName, Object value)
DeploymentManager.Resources.List	set$Xgafv(String $Xgafv) V1 error format.
DeploymentManager.Resources.List	setAccessToken(String accessToken) OAuth access token.
DeploymentManager.Resources.List	setAlt(String alt) Data format for response.
DeploymentManager.Resources.List	setCallback(String callback) JSONP
DeploymentManager.Resources.List	setDeployment(String deployment) The name of the deployment for this request.
DeploymentManager.Resources.List	setFields(String fields) Selector specifying which fields to include in a partial response.
DeploymentManager.Resources.List	setFilter(String filter) A filter expression that filters resources listed in the response.
DeploymentManager.Resources.List	setKey(String key) API key.
DeploymentManager.Resources.List	setMaxResults(Long maxResults) The maximum number of results per page that should be returned.
DeploymentManager.Resources.List	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
DeploymentManager.Resources.List	setOrderBy(String orderBy) Sorts list results by a certain order.
DeploymentManager.Resources.List	setPageToken(String pageToken) Specifies a page token to use.
DeploymentManager.Resources.List	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
DeploymentManager.Resources.List	setProject(String project) The project ID for this request.
DeploymentManager.Resources.List	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
DeploymentManager.Resources.List	setUploadProtocol(String uploadProtocol) Upload protocol for media (e.g.
DeploymentManager.Resources.List	setUploadType(String uploadType) Legacy upload protocol for media (e.g.

Methods inherited from class com.google.api.services.deploymentmanager.DeploymentManagerRequest

get$Xgafv, getAbstractGoogleClient, getAccessToken, getAlt, getCallback, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUploadProtocol, getUploadType, 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, 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

List

protected List(String project,
               String deployment)

Lists all resources in a given deployment. Create a request for the method "resources.list". This request holds the parameters needed by the the deploymentmanager server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

DeploymentManager.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.

Parameters:

project - The project ID for this request.

deployment - The name of the deployment for this request.

Since:

1.13

Method Detail

executeUsingHead

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

Overrides:

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

Throws:

IOException

buildHttpRequestUsingHead

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

Overrides:

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

Throws:

IOException

set$Xgafv

public DeploymentManager.Resources.List set$Xgafv(String $Xgafv)

Description copied from class: DeploymentManagerRequest

V1 error format.

Overrides:

set$Xgafv in class DeploymentManagerRequest<ResourcesListResponse>

setAccessToken

public DeploymentManager.Resources.List setAccessToken(String accessToken)

Description copied from class: DeploymentManagerRequest

OAuth access token.

Overrides:

setAccessToken in class DeploymentManagerRequest<ResourcesListResponse>

setAlt

public DeploymentManager.Resources.List setAlt(String alt)

Description copied from class: DeploymentManagerRequest

Data format for response.

Overrides:

setAlt in class DeploymentManagerRequest<ResourcesListResponse>

setCallback

public DeploymentManager.Resources.List setCallback(String callback)

Description copied from class: DeploymentManagerRequest

JSONP

Overrides:

setCallback in class DeploymentManagerRequest<ResourcesListResponse>

setFields

public DeploymentManager.Resources.List setFields(String fields)

Description copied from class: DeploymentManagerRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class DeploymentManagerRequest<ResourcesListResponse>

setKey

public DeploymentManager.Resources.List setKey(String key)

Description copied from class: DeploymentManagerRequest

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 DeploymentManagerRequest<ResourcesListResponse>

setOauthToken

public DeploymentManager.Resources.List setOauthToken(String oauthToken)

Description copied from class: DeploymentManagerRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class DeploymentManagerRequest<ResourcesListResponse>

setPrettyPrint

public DeploymentManager.Resources.List setPrettyPrint(Boolean prettyPrint)

Description copied from class: DeploymentManagerRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class DeploymentManagerRequest<ResourcesListResponse>

setQuotaUser

public DeploymentManager.Resources.List setQuotaUser(String quotaUser)

Description copied from class: DeploymentManagerRequest

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 DeploymentManagerRequest<ResourcesListResponse>

setUploadType

public DeploymentManager.Resources.List setUploadType(String uploadType)

Description copied from class: DeploymentManagerRequest

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

Overrides:

setUploadType in class DeploymentManagerRequest<ResourcesListResponse>

setUploadProtocol

public DeploymentManager.Resources.List setUploadProtocol(String uploadProtocol)

Description copied from class: DeploymentManagerRequest

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

Overrides:

setUploadProtocol in class DeploymentManagerRequest<ResourcesListResponse>

getProject

public String getProject()

The project ID for this request.

setProject

public DeploymentManager.Resources.List setProject(String project)

The project ID for this request.

getDeployment

public String getDeployment()

The name of the deployment for this request.

setDeployment

public DeploymentManager.Resources.List setDeployment(String deployment)

The name of the deployment for this request.

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 DeploymentManager.Resources.List 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 DeploymentManager.Resources.List 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 DeploymentManager.Resources.List 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 DeploymentManager.Resources.List 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.

set

public DeploymentManager.Resources.List set(String parameterName,
                                            Object value)

Overrides:

set in class DeploymentManagerRequest<ResourcesListResponse>