com.google.api.services.compute

Class Compute.Networks.ListIpAddresses

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

com.google.api.services.compute.Compute.Networks.ListIpAddresses

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Compute.Networks

public class Compute.Networks.ListIpAddresses
extends ComputeRequest<IpAddressesList>

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	ListIpAddresses(String project, String network) Lists the internal IP addresses in the specified network.

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	getNetwork() Name of the network for this request.
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.
String	getTypes() ( Optional) types filter separate by comma, valid values are: SUBNETWORK, RESERVED, PEER_USED, ( PEER_RESERVED, REMOTE_USED, REMOTE_RESERVED.
Compute.Networks.ListIpAddresses	set(String parameterName, Object value)
Compute.Networks.ListIpAddresses	setAlt(String alt) Data format for the response.
Compute.Networks.ListIpAddresses	setFields(String fields) Selector specifying which fields to include in a partial response.
Compute.Networks.ListIpAddresses	setFilter(String filter) A filter expression that filters resources listed in the response.
Compute.Networks.ListIpAddresses	setKey(String key) API key.
Compute.Networks.ListIpAddresses	setMaxResults(Long maxResults) The maximum number of results per page that should be returned.
Compute.Networks.ListIpAddresses	setNetwork(String network) Name of the network for this request.
Compute.Networks.ListIpAddresses	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
Compute.Networks.ListIpAddresses	setOrderBy(String orderBy) Sorts list results by a certain order.
Compute.Networks.ListIpAddresses	setPageToken(String pageToken) Specifies a page token to use.
Compute.Networks.ListIpAddresses	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
Compute.Networks.ListIpAddresses	setProject(String project) Project ID for this request.
Compute.Networks.ListIpAddresses	setQuotaUser(String quotaUser) An opaque string that represents a user for quota purposes.
Compute.Networks.ListIpAddresses	setReturnPartialSuccess(Boolean returnPartialSuccess) Opt-in for partial success behavior which provides partial results in case of failure.
Compute.Networks.ListIpAddresses	setTypes(String types) (Optional) types filter separate by comma, valid values are: SUBNETWORK, RESERVED, PEER_USED, PEER_RESERVED, REMOTE_USED, REMOTE_RESERVED.
Compute.Networks.ListIpAddresses	setUserIp(String userIp) Deprecated.

Methods inherited from class com.google.api.services.compute.ComputeRequest

getAbstractGoogleClient, getAlt, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, 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

ListIpAddresses

protected ListIpAddresses(String project,
                          String network)

Lists the internal IP addresses in the specified network. Create a request for the method "networks.listIpAddresses". 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.

ListIpAddresses#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.

network - Name of the network for this request.

Since:

1.13

Method Detail

executeUsingHead

public HttpResponse executeUsingHead()
                              throws IOException

Overrides:

executeUsingHead in class AbstractGoogleClientRequest<IpAddressesList>

Throws:

IOException

buildHttpRequestUsingHead

public HttpRequest buildHttpRequestUsingHead()
                                      throws IOException

Overrides:

buildHttpRequestUsingHead in class AbstractGoogleClientRequest<IpAddressesList>

Throws:

IOException

setAlt

public Compute.Networks.ListIpAddresses setAlt(String alt)

Description copied from class: ComputeRequest

Data format for the response.

Overrides:

setAlt in class ComputeRequest<IpAddressesList>

setFields

public Compute.Networks.ListIpAddresses setFields(String fields)

Description copied from class: ComputeRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class ComputeRequest<IpAddressesList>

setKey

public Compute.Networks.ListIpAddresses 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<IpAddressesList>

setOauthToken

public Compute.Networks.ListIpAddresses setOauthToken(String oauthToken)

Description copied from class: ComputeRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class ComputeRequest<IpAddressesList>

setPrettyPrint

public Compute.Networks.ListIpAddresses setPrettyPrint(Boolean prettyPrint)

Description copied from class: ComputeRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class ComputeRequest<IpAddressesList>

setQuotaUser

public Compute.Networks.ListIpAddresses setQuotaUser(String quotaUser)

Description copied from class: ComputeRequest

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Overrides:

setQuotaUser in class ComputeRequest<IpAddressesList>

setUserIp

public Compute.Networks.ListIpAddresses setUserIp(String userIp)

Description copied from class: ComputeRequest

Deprecated. Please use quotaUser instead.

Overrides:

setUserIp in class ComputeRequest<IpAddressesList>

getProject

public String getProject()

Project ID for this request.

setProject

public Compute.Networks.ListIpAddresses setProject(String project)

Project ID for this request.

getNetwork

public String getNetwork()

Name of the network for this request.

setNetwork

public Compute.Networks.ListIpAddresses setNetwork(String network)

Name of the network for this request.

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 Compute.Networks.ListIpAddresses 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) ```

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.Networks.ListIpAddresses 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.Networks.ListIpAddresses 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.Networks.ListIpAddresses 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 and the logic is the same as today.

setReturnPartialSuccess

public Compute.Networks.ListIpAddresses setReturnPartialSuccess(Boolean returnPartialSuccess)

Opt-in for partial success behavior which provides partial results in case of failure. The default value is false and the logic is the same as today.

getTypes

public String getTypes()

( Optional) types filter separate by comma, valid values are: SUBNETWORK, RESERVED, PEER_USED, ( PEER_RESERVED, REMOTE_USED, REMOTE_RESERVED. (

setTypes

public Compute.Networks.ListIpAddresses setTypes(String types)

(Optional) types filter separate by comma, valid values are: SUBNETWORK, RESERVED, PEER_USED, PEER_RESERVED, REMOTE_USED, REMOTE_RESERVED.

set

public Compute.Networks.ListIpAddresses set(String parameterName,
                                            Object value)

Overrides:

set in class ComputeRequest<IpAddressesList>