com.google.api.services.compute

Class Compute.Routers.GetNatMappingInfo

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

com.google.api.services.compute.Compute.Routers.GetNatMappingInfo

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Compute.Routers

public class Compute.Routers.GetNatMappingInfo
extends ComputeRequest<VmEndpointNatMappingsList>

Nested Class Summary

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

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	GetNatMappingInfo(String project, String region, String router) Retrieves runtime Nat mapping information of VM endpoints.

Method Summary

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

GetNatMappingInfo

protected GetNatMappingInfo(String project,
                            String region,
                            String router)

Retrieves runtime Nat mapping information of VM endpoints. Create a request for the method "routers.getNatMappingInfo". 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.

GetNatMappingInfo#initialize(com.google.api.client.googleapis.services.AbstractGoogl eClientRequest) must be called to initialize this instance immediately after invoking the constructor.

Parameters:

project - Project ID for this request.

region - Name of the region for this request.

router - Name of the Router resource to query for Nat Mapping information of VM endpoints.

Since:

1.13

Method Detail

executeUsingHead

public HttpResponse executeUsingHead()
                              throws IOException

Overrides:

executeUsingHead in class AbstractGoogleClientRequest<VmEndpointNatMappingsList>

Throws:

IOException

buildHttpRequestUsingHead

public HttpRequest buildHttpRequestUsingHead()
                                      throws IOException

Overrides:

buildHttpRequestUsingHead in class AbstractGoogleClientRequest<VmEndpointNatMappingsList>

Throws:

IOException

set$Xgafv

public Compute.Routers.GetNatMappingInfo set$Xgafv(String $Xgafv)

Description copied from class: ComputeRequest

V1 error format.

Overrides:

set$Xgafv in class ComputeRequest<VmEndpointNatMappingsList>

setAccessToken

public Compute.Routers.GetNatMappingInfo setAccessToken(String accessToken)

Description copied from class: ComputeRequest

OAuth access token.

Overrides:

setAccessToken in class ComputeRequest<VmEndpointNatMappingsList>

setAlt

public Compute.Routers.GetNatMappingInfo setAlt(String alt)

Description copied from class: ComputeRequest

Data format for response.

Overrides:

setAlt in class ComputeRequest<VmEndpointNatMappingsList>

setCallback

public Compute.Routers.GetNatMappingInfo setCallback(String callback)

Description copied from class: ComputeRequest

JSONP

Overrides:

setCallback in class ComputeRequest<VmEndpointNatMappingsList>

setFields

public Compute.Routers.GetNatMappingInfo setFields(String fields)

Description copied from class: ComputeRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class ComputeRequest<VmEndpointNatMappingsList>

setKey

public Compute.Routers.GetNatMappingInfo 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<VmEndpointNatMappingsList>

setOauthToken

public Compute.Routers.GetNatMappingInfo setOauthToken(String oauthToken)

Description copied from class: ComputeRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class ComputeRequest<VmEndpointNatMappingsList>

setPrettyPrint

public Compute.Routers.GetNatMappingInfo setPrettyPrint(Boolean prettyPrint)

Description copied from class: ComputeRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class ComputeRequest<VmEndpointNatMappingsList>

setQuotaUser

public Compute.Routers.GetNatMappingInfo 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<VmEndpointNatMappingsList>

setUploadType

public Compute.Routers.GetNatMappingInfo setUploadType(String uploadType)

Description copied from class: ComputeRequest

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

Overrides:

setUploadType in class ComputeRequest<VmEndpointNatMappingsList>

setUploadProtocol

public Compute.Routers.GetNatMappingInfo setUploadProtocol(String uploadProtocol)

Description copied from class: ComputeRequest

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

Overrides:

setUploadProtocol in class ComputeRequest<VmEndpointNatMappingsList>

setUserIp

public Compute.Routers.GetNatMappingInfo setUserIp(String userIp)

Description copied from class: ComputeRequest

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

Overrides:

setUserIp in class ComputeRequest<VmEndpointNatMappingsList>

getProject

public String getProject()

Project ID for this request.

setProject

public Compute.Routers.GetNatMappingInfo setProject(String project)

Project ID for this request.

getRegion

public String getRegion()

Name of the region for this request.

setRegion

public Compute.Routers.GetNatMappingInfo setRegion(String region)

Name of the region for this request.

getRouter

public String getRouter()

Name of the Router resource to query for Nat Mapping information of VM endpoints.

setRouter

public Compute.Routers.GetNatMappingInfo setRouter(String router)

Name of the Router resource to query for Nat Mapping information of VM endpoints.

getFilter

public String getFilter()

A filter expression that filters resources listed in the response. The 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 `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. 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) ```

setFilter

public Compute.Routers.GetNatMappingInfo setFilter(String filter)

A filter expression that filters resources listed in the response. The 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 `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. 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) ```

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.Routers.GetNatMappingInfo 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`)

getNatName

public String getNatName()

Name of the nat service to filter the Nat Mapping information. If it is omitted, all nats for this router will be returned. Name should conform to RFC1035.

setNatName

public Compute.Routers.GetNatMappingInfo setNatName(String natName)

Name of the nat service to filter the Nat Mapping information. If it is omitted, all nats for this router will be returned. Name should conform to RFC1035.

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.Routers.GetNatMappingInfo 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.Routers.GetNatMappingInfo 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.

setReturnPartialSuccess

public Compute.Routers.GetNatMappingInfo setReturnPartialSuccess(Boolean returnPartialSuccess)

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.

set

public Compute.Routers.GetNatMappingInfo set(String parameterName,
                                             Object value)

Overrides:

set in class ComputeRequest<VmEndpointNatMappingsList>