com.google.api.services.compute

Class Compute.Subnetworks.ListUsable

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

com.google.api.services.compute.Compute.Subnetworks.ListUsable

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Compute.Subnetworks

public class Compute.Subnetworks.ListUsable
extends ComputeRequest<UsableSubnetworksAggregatedList>

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	ListUsable(String project) Retrieves an aggregated list of all usable subnetworks in the project.

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	getOrderBy() Sorts list results by a certain order.
String	getPageToken() Specifies a page token to use.
String	getProject() Project ID for this request.
Compute.Subnetworks.ListUsable	set(String parameterName, Object value)
Compute.Subnetworks.ListUsable	setAlt(String alt) Data format for the response.
Compute.Subnetworks.ListUsable	setFields(String fields) Selector specifying which fields to include in a partial response.
Compute.Subnetworks.ListUsable	setFilter(String filter) A filter expression that filters resources listed in the response.
Compute.Subnetworks.ListUsable	setKey(String key) API key.
Compute.Subnetworks.ListUsable	setMaxResults(Long maxResults) The maximum number of results per page that should be returned.
Compute.Subnetworks.ListUsable	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
Compute.Subnetworks.ListUsable	setOrderBy(String orderBy) Sorts list results by a certain order.
Compute.Subnetworks.ListUsable	setPageToken(String pageToken) Specifies a page token to use.
Compute.Subnetworks.ListUsable	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
Compute.Subnetworks.ListUsable	setProject(String project) Project ID for this request.
Compute.Subnetworks.ListUsable	setQuotaUser(String quotaUser) An opaque string that represents a user for quota purposes.
Compute.Subnetworks.ListUsable	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, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue

Methods inherited from class com.google.api.client.util.GenericData

clone, entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, toString, 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

ListUsable

protected ListUsable(String project)

Retrieves an aggregated list of all usable subnetworks in the project. The list contains all of the subnetworks in the project and the subnetworks that were shared by a Shared VPC host project. Create a request for the method "subnetworks.listUsable". 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.

Compute.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest) 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 HttpResponse executeUsingHead()
                              throws IOException

Overrides:

executeUsingHead in class AbstractGoogleClientRequest<UsableSubnetworksAggregatedList>

Throws:

IOException

buildHttpRequestUsingHead

public HttpRequest buildHttpRequestUsingHead()
                                      throws IOException

Overrides:

buildHttpRequestUsingHead in class AbstractGoogleClientRequest<UsableSubnetworksAggregatedList>

Throws:

IOException

setAlt

public Compute.Subnetworks.ListUsable setAlt(String alt)

Description copied from class: ComputeRequest

Data format for the response.

Overrides:

setAlt in class ComputeRequest<UsableSubnetworksAggregatedList>

setFields

public Compute.Subnetworks.ListUsable setFields(String fields)

Description copied from class: ComputeRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class ComputeRequest<UsableSubnetworksAggregatedList>

setKey

public Compute.Subnetworks.ListUsable 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<UsableSubnetworksAggregatedList>

setOauthToken

public Compute.Subnetworks.ListUsable setOauthToken(String oauthToken)

Description copied from class: ComputeRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class ComputeRequest<UsableSubnetworksAggregatedList>

setPrettyPrint

public Compute.Subnetworks.ListUsable setPrettyPrint(Boolean prettyPrint)

Description copied from class: ComputeRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class ComputeRequest<UsableSubnetworksAggregatedList>

setQuotaUser

public Compute.Subnetworks.ListUsable 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<UsableSubnetworksAggregatedList>

setUserIp

public Compute.Subnetworks.ListUsable setUserIp(String userIp)

Description copied from class: ComputeRequest

Deprecated. Please use quotaUser instead.

Overrides:

setUserIp in class ComputeRequest<UsableSubnetworksAggregatedList>

getProject

public String getProject()

Project ID for this request.

setProject

public Compute.Subnetworks.ListUsable setProject(String project)

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

Overrides:

set in class ComputeRequest<UsableSubnetworksAggregatedList>