com.google.api.services.container

Class Container.Projects.Zones.Clusters.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.container.ContainerRequest<ListClustersResponse>

com.google.api.services.container.Container.Projects.Zones.Clusters.List

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Container.Projects.Zones.Clusters

public class Container.Projects.Zones.Clusters.List
extends ContainerRequest<ListClustersResponse>

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	List(String projectId, String zone) Lists all clusters owned by a project in either the specified zone or all zones.

Method Summary

Modifier and Type	Method and Description
HttpRequest	buildHttpRequestUsingHead()
HttpResponse	executeUsingHead()
String	getParent() The parent (project and location) where the clusters will be listed.
String	getProjectId() Deprecated.
String	getZone() Deprecated.
Container.Projects.Zones.Clusters.List	set(String parameterName, Object value)
Container.Projects.Zones.Clusters.List	set$Xgafv(String $Xgafv) V1 error format.
Container.Projects.Zones.Clusters.List	setAccessToken(String accessToken) OAuth access token.
Container.Projects.Zones.Clusters.List	setAlt(String alt) Data format for response.
Container.Projects.Zones.Clusters.List	setCallback(String callback) JSONP
Container.Projects.Zones.Clusters.List	setFields(String fields) Selector specifying which fields to include in a partial response.
Container.Projects.Zones.Clusters.List	setKey(String key) API key.
Container.Projects.Zones.Clusters.List	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
Container.Projects.Zones.Clusters.List	setParent(String parent) The parent (project and location) where the clusters will be listed.
Container.Projects.Zones.Clusters.List	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
Container.Projects.Zones.Clusters.List	setProjectId(String projectId) Deprecated.
Container.Projects.Zones.Clusters.List	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
Container.Projects.Zones.Clusters.List	setUploadProtocol(String uploadProtocol) Upload protocol for media (e.g.
Container.Projects.Zones.Clusters.List	setUploadType(String uploadType) Legacy upload protocol for media (e.g.
Container.Projects.Zones.Clusters.List	setZone(String zone) Deprecated.

Methods inherited from class com.google.api.services.container.ContainerRequest

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 projectId,
               String zone)

Lists all clusters owned by a project in either the specified zone or all zones. Create a request for the method "clusters.list". This request holds the parameters needed by the the container server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

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

Parameters:

projectId - Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the parent field.

zone - Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides, or "-" for all zones. This field has been deprecated and replaced by the parent field.

Since:

1.13

Method Detail

executeUsingHead

public HttpResponse executeUsingHead()
                              throws IOException

Overrides:

executeUsingHead in class AbstractGoogleClientRequest<ListClustersResponse>

Throws:

IOException

buildHttpRequestUsingHead

public HttpRequest buildHttpRequestUsingHead()
                                      throws IOException

Overrides:

buildHttpRequestUsingHead in class AbstractGoogleClientRequest<ListClustersResponse>

Throws:

IOException

set$Xgafv

public Container.Projects.Zones.Clusters.List set$Xgafv(String $Xgafv)

Description copied from class: ContainerRequest

V1 error format.

Overrides:

set$Xgafv in class ContainerRequest<ListClustersResponse>

setAccessToken

public Container.Projects.Zones.Clusters.List setAccessToken(String accessToken)

Description copied from class: ContainerRequest

OAuth access token.

Overrides:

setAccessToken in class ContainerRequest<ListClustersResponse>

setAlt

public Container.Projects.Zones.Clusters.List setAlt(String alt)

Description copied from class: ContainerRequest

Data format for response.

Overrides:

setAlt in class ContainerRequest<ListClustersResponse>

setCallback

public Container.Projects.Zones.Clusters.List setCallback(String callback)

Description copied from class: ContainerRequest

JSONP

Overrides:

setCallback in class ContainerRequest<ListClustersResponse>

setFields

public Container.Projects.Zones.Clusters.List setFields(String fields)

Description copied from class: ContainerRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class ContainerRequest<ListClustersResponse>

setKey

public Container.Projects.Zones.Clusters.List setKey(String key)

Description copied from class: ContainerRequest

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 ContainerRequest<ListClustersResponse>

setOauthToken

public Container.Projects.Zones.Clusters.List setOauthToken(String oauthToken)

Description copied from class: ContainerRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class ContainerRequest<ListClustersResponse>

setPrettyPrint

public Container.Projects.Zones.Clusters.List setPrettyPrint(Boolean prettyPrint)

Description copied from class: ContainerRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class ContainerRequest<ListClustersResponse>

setQuotaUser

public Container.Projects.Zones.Clusters.List setQuotaUser(String quotaUser)

Description copied from class: ContainerRequest

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 ContainerRequest<ListClustersResponse>

setUploadType

public Container.Projects.Zones.Clusters.List setUploadType(String uploadType)

Description copied from class: ContainerRequest

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

Overrides:

setUploadType in class ContainerRequest<ListClustersResponse>

setUploadProtocol

public Container.Projects.Zones.Clusters.List setUploadProtocol(String uploadProtocol)

Description copied from class: ContainerRequest

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

Overrides:

setUploadProtocol in class ContainerRequest<ListClustersResponse>

getProjectId

public String getProjectId()

Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the parent field.

setProjectId

public Container.Projects.Zones.Clusters.List setProjectId(String projectId)

Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the parent field.

getZone

public String getZone()

Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides, or "-" for all zones. This field has been deprecated and replaced by the parent field.

setZone

public Container.Projects.Zones.Clusters.List setZone(String zone)

Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides, or "-" for all zones. This field has been deprecated and replaced by the parent field.

getParent

public String getParent()

The parent (project and location) where the clusters will be listed. Specified in the format 'projects/locations'. Location "-" matches all zones and all regions.

setParent

public Container.Projects.Zones.Clusters.List setParent(String parent)

The parent (project and location) where the clusters will be listed. Specified in the format 'projects/locations'. Location "-" matches all zones and all regions.

set

public Container.Projects.Zones.Clusters.List set(String parameterName,
                                                  Object value)

Overrides:

set in class ContainerRequest<ListClustersResponse>