com.google.api.services.compute

Class Compute.Projects.GetXpnResources

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<ProjectsGetXpnResources>

com.google.api.services.compute.Compute.Projects.GetXpnResources

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Compute.Projects

public class Compute.Projects.GetXpnResources
extends ComputeRequest<ProjectsGetXpnResources>

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	GetXpnResources(String project) Gets service resources (a.k.a service project) associated with this host project.

Method Summary

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

GetXpnResources

protected GetXpnResources(String project)

Gets service resources (a.k.a service project) associated with this host project. Create a request for the method "projects.getXpnResources". 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.

GetXpnResources#initialize(com.google.api.client.googleapis.services.AbstractGoogleC lientRequest) must be called to initialize this instance immediately after invoking the constructor.

Parameters:

project - Project ID 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<ProjectsGetXpnResources>

Throws:

IOException

buildHttpRequestUsingHead

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

Overrides:

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

Throws:

IOException

set$Xgafv

public Compute.Projects.GetXpnResources set$Xgafv(String $Xgafv)

Description copied from class: ComputeRequest

V1 error format.

Overrides:

set$Xgafv in class ComputeRequest<ProjectsGetXpnResources>

setAccessToken

public Compute.Projects.GetXpnResources setAccessToken(String accessToken)

Description copied from class: ComputeRequest

OAuth access token.

Overrides:

setAccessToken in class ComputeRequest<ProjectsGetXpnResources>

setAlt

public Compute.Projects.GetXpnResources setAlt(String alt)

Description copied from class: ComputeRequest

Data format for response.

Overrides:

setAlt in class ComputeRequest<ProjectsGetXpnResources>

setCallback

public Compute.Projects.GetXpnResources setCallback(String callback)

Description copied from class: ComputeRequest

JSONP

Overrides:

setCallback in class ComputeRequest<ProjectsGetXpnResources>

setFields

public Compute.Projects.GetXpnResources setFields(String fields)

Description copied from class: ComputeRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class ComputeRequest<ProjectsGetXpnResources>

setKey

public Compute.Projects.GetXpnResources 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<ProjectsGetXpnResources>

setOauthToken

public Compute.Projects.GetXpnResources setOauthToken(String oauthToken)

Description copied from class: ComputeRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class ComputeRequest<ProjectsGetXpnResources>

setPrettyPrint

public Compute.Projects.GetXpnResources setPrettyPrint(Boolean prettyPrint)

Description copied from class: ComputeRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class ComputeRequest<ProjectsGetXpnResources>

setQuotaUser

public Compute.Projects.GetXpnResources 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<ProjectsGetXpnResources>

setUploadType

public Compute.Projects.GetXpnResources setUploadType(String uploadType)

Description copied from class: ComputeRequest

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

Overrides:

setUploadType in class ComputeRequest<ProjectsGetXpnResources>

setUploadProtocol

public Compute.Projects.GetXpnResources setUploadProtocol(String uploadProtocol)

Description copied from class: ComputeRequest

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

Overrides:

setUploadProtocol in class ComputeRequest<ProjectsGetXpnResources>

setUserIp

public Compute.Projects.GetXpnResources setUserIp(String userIp)

Description copied from class: ComputeRequest

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

Overrides:

setUserIp in class ComputeRequest<ProjectsGetXpnResources>

getProject

public String getProject()

Project ID for this request.

setProject

public Compute.Projects.GetXpnResources setProject(String project)

Project ID 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 Compute.Projects.GetXpnResources 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.Projects.GetXpnResources 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.Projects.GetXpnResources 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.Projects.GetXpnResources 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.Projects.GetXpnResources 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.Projects.GetXpnResources set(String parameterName,
                                            Object value)

Overrides:

set in class ComputeRequest<ProjectsGetXpnResources>