com.google.api.services.spanner.v1

Class Spanner.Projects.Instances.InstancePartitions.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.spanner.v1.SpannerRequest<ListInstancePartitionsResponse>

com.google.api.services.spanner.v1.Spanner.Projects.Instances.InstancePartitions.List

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Spanner.Projects.Instances.InstancePartitions

public class Spanner.Projects.Instances.InstancePartitions.List
extends SpannerRequest<ListInstancePartitionsResponse>

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

API_VERSION_HEADER, USER_AGENT_SUFFIX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	List(String parent) Lists all instance partitions for the given instance.

Method Summary

Modifier and Type	Method and Description
com.google.api.client.http.HttpRequest	buildHttpRequestUsingHead()
com.google.api.client.http.HttpResponse	executeUsingHead()
String	getInstancePartitionDeadline() Optional.
Integer	getPageSize() Number of instance partitions to be returned in the response.
String	getPageToken() If non-empty, `page_token` should contain a next_page_token from a previous ListInstancePartitionsResponse.
String	getParent() Required.
Spanner.Projects.Instances.InstancePartitions.List	set(String parameterName, Object value)
Spanner.Projects.Instances.InstancePartitions.List	set$Xgafv(String $Xgafv) V1 error format.
Spanner.Projects.Instances.InstancePartitions.List	setAccessToken(String accessToken) OAuth access token.
Spanner.Projects.Instances.InstancePartitions.List	setAlt(String alt) Data format for response.
Spanner.Projects.Instances.InstancePartitions.List	setCallback(String callback) JSONP
Spanner.Projects.Instances.InstancePartitions.List	setFields(String fields) Selector specifying which fields to include in a partial response.
Spanner.Projects.Instances.InstancePartitions.List	setInstancePartitionDeadline(String instancePartitionDeadline) Optional.
Spanner.Projects.Instances.InstancePartitions.List	setKey(String key) API key.
Spanner.Projects.Instances.InstancePartitions.List	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
Spanner.Projects.Instances.InstancePartitions.List	setPageSize(Integer pageSize) Number of instance partitions to be returned in the response.
Spanner.Projects.Instances.InstancePartitions.List	setPageToken(String pageToken) If non-empty, `page_token` should contain a next_page_token from a previous ListInstancePartitionsResponse.
Spanner.Projects.Instances.InstancePartitions.List	setParent(String parent) Required.
Spanner.Projects.Instances.InstancePartitions.List	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
Spanner.Projects.Instances.InstancePartitions.List	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
Spanner.Projects.Instances.InstancePartitions.List	setUploadProtocol(String uploadProtocol) Upload protocol for media (e.g.
Spanner.Projects.Instances.InstancePartitions.List	setUploadType(String uploadType) Legacy upload protocol for media (e.g.

Methods inherited from class com.google.api.services.spanner.v1.SpannerRequest

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 parent)

Lists all instance partitions for the given instance. Create a request for the method "instancePartitions.list". This request holds the parameters needed by the the spanner server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

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

Parameters:

parent - Required. The instance whose instance partitions should be listed. Values are of the form `projects//instances/`. Use `{instance} = '-'` to list instance partitions for all Instances in a project, e.g., `projects/myproject/instances/-`.

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

Throws:

IOException

buildHttpRequestUsingHead

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

Overrides:

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

Throws:

IOException

set$Xgafv

public Spanner.Projects.Instances.InstancePartitions.List set$Xgafv(String $Xgafv)

Description copied from class: SpannerRequest

V1 error format.

Overrides:

set$Xgafv in class SpannerRequest<ListInstancePartitionsResponse>

setAccessToken

public Spanner.Projects.Instances.InstancePartitions.List setAccessToken(String accessToken)

Description copied from class: SpannerRequest

OAuth access token.

Overrides:

setAccessToken in class SpannerRequest<ListInstancePartitionsResponse>

setAlt

public Spanner.Projects.Instances.InstancePartitions.List setAlt(String alt)

Description copied from class: SpannerRequest

Data format for response.

Overrides:

setAlt in class SpannerRequest<ListInstancePartitionsResponse>

setCallback

public Spanner.Projects.Instances.InstancePartitions.List setCallback(String callback)

Description copied from class: SpannerRequest

JSONP

Overrides:

setCallback in class SpannerRequest<ListInstancePartitionsResponse>

setFields

public Spanner.Projects.Instances.InstancePartitions.List setFields(String fields)

Description copied from class: SpannerRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class SpannerRequest<ListInstancePartitionsResponse>

setKey

public Spanner.Projects.Instances.InstancePartitions.List setKey(String key)

Description copied from class: SpannerRequest

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 SpannerRequest<ListInstancePartitionsResponse>

setOauthToken

public Spanner.Projects.Instances.InstancePartitions.List setOauthToken(String oauthToken)

Description copied from class: SpannerRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class SpannerRequest<ListInstancePartitionsResponse>

setPrettyPrint

public Spanner.Projects.Instances.InstancePartitions.List setPrettyPrint(Boolean prettyPrint)

Description copied from class: SpannerRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class SpannerRequest<ListInstancePartitionsResponse>

setQuotaUser

public Spanner.Projects.Instances.InstancePartitions.List setQuotaUser(String quotaUser)

Description copied from class: SpannerRequest

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 SpannerRequest<ListInstancePartitionsResponse>

setUploadType

public Spanner.Projects.Instances.InstancePartitions.List setUploadType(String uploadType)

Description copied from class: SpannerRequest

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

Overrides:

setUploadType in class SpannerRequest<ListInstancePartitionsResponse>

setUploadProtocol

public Spanner.Projects.Instances.InstancePartitions.List setUploadProtocol(String uploadProtocol)

Description copied from class: SpannerRequest

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

Overrides:

setUploadProtocol in class SpannerRequest<ListInstancePartitionsResponse>

getParent

public String getParent()

Required. The instance whose instance partitions should be listed. Values are of the form `projects//instances/`. Use `{instance} = '-'` to list instance partitions for all Instances in a project, e.g., `projects/myproject/instances/-`.

setParent

public Spanner.Projects.Instances.InstancePartitions.List setParent(String parent)

Required. The instance whose instance partitions should be listed. Values are of the form `projects//instances/`. Use `{instance} = '-'` to list instance partitions for all Instances in a project, e.g., `projects/myproject/instances/-`.

getInstancePartitionDeadline

public String getInstancePartitionDeadline()

Optional. Deadline used while retrieving metadata for instance partitions. Instance partitions whose metadata cannot be retrieved within this deadline will be added to unreachable in ListInstancePartitionsResponse.

setInstancePartitionDeadline

public Spanner.Projects.Instances.InstancePartitions.List setInstancePartitionDeadline(String instancePartitionDeadline)

Optional. Deadline used while retrieving metadata for instance partitions. Instance partitions whose metadata cannot be retrieved within this deadline will be added to unreachable in ListInstancePartitionsResponse.

getPageSize

public Integer getPageSize()

Number of instance partitions to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.

setPageSize

public Spanner.Projects.Instances.InstancePartitions.List setPageSize(Integer pageSize)

Number of instance partitions to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.

getPageToken

public String getPageToken()

If non-empty, `page_token` should contain a next_page_token from a previous ListInstancePartitionsResponse.

setPageToken

public Spanner.Projects.Instances.InstancePartitions.List setPageToken(String pageToken)

If non-empty, `page_token` should contain a next_page_token from a previous ListInstancePartitionsResponse.

set

public Spanner.Projects.Instances.InstancePartitions.List set(String parameterName,
                                                              Object value)

Overrides:

set in class SpannerRequest<ListInstancePartitionsResponse>