target.apidocs.com.google.api.services.spanner.v1.Spanner.Projects.Instances.Databases.GetDdl.html Maven / Gradle / Ivy
Spanner.Projects.Instances.Databases.GetDdl (Cloud Spanner API v1-rev20240711-2.0.0)
com.google.api.services.spanner.v1
Class Spanner.Projects.Instances.Databases.GetDdl
- 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<GetDatabaseDdlResponse>
-
- com.google.api.services.spanner.v1.Spanner.Projects.Instances.Databases.GetDdl
-
- Enclosing class:
- Spanner.Projects.Instances.Databases
public class Spanner.Projects.Instances.Databases.GetDdl
extends SpannerRequest<GetDatabaseDdlResponse>
-
-
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>
-
Constructor Summary
Constructors
Modifier
Constructor and Description
protected GetDdl(String database)
Returns the schema of a Cloud Spanner database as a list of formatted DDL statements.
-
Method Summary
-
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
-
GetDdl
protected GetDdl(String database)
Returns the schema of a Cloud Spanner database as a list of formatted DDL statements. This
method does not show pending schema updates, those may be queried using the Operations API.
Create a request for the method "databases.getDdl".
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:
database - Required. The database whose schema we wish to get. Values are of the form
`projects//instances//databases/`- 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<GetDatabaseDdlResponse>- Throws:
IOException
-
buildHttpRequestUsingHead
public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead()
throws IOException
- Overrides:
buildHttpRequestUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<GetDatabaseDdlResponse>- Throws:
IOException
-
set$Xgafv
public Spanner.Projects.Instances.Databases.GetDdl set$Xgafv(String $Xgafv)
Description copied from class: SpannerRequest
V1 error format.
- Overrides:
set$Xgafv in class SpannerRequest<GetDatabaseDdlResponse>
-
setAccessToken
public Spanner.Projects.Instances.Databases.GetDdl setAccessToken(String accessToken)
Description copied from class: SpannerRequest
OAuth access token.
- Overrides:
setAccessToken in class SpannerRequest<GetDatabaseDdlResponse>
-
setAlt
public Spanner.Projects.Instances.Databases.GetDdl setAlt(String alt)
Description copied from class: SpannerRequest
Data format for response.
- Overrides:
setAlt in class SpannerRequest<GetDatabaseDdlResponse>
-
setCallback
public Spanner.Projects.Instances.Databases.GetDdl setCallback(String callback)
Description copied from class: SpannerRequest
JSONP
- Overrides:
setCallback in class SpannerRequest<GetDatabaseDdlResponse>
-
setFields
public Spanner.Projects.Instances.Databases.GetDdl setFields(String fields)
Description copied from class: SpannerRequest
Selector specifying which fields to include in a partial response.
- Overrides:
setFields in class SpannerRequest<GetDatabaseDdlResponse>
-
setKey
public Spanner.Projects.Instances.Databases.GetDdl 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<GetDatabaseDdlResponse>
-
setOauthToken
public Spanner.Projects.Instances.Databases.GetDdl setOauthToken(String oauthToken)
Description copied from class: SpannerRequest
OAuth 2.0 token for the current user.
- Overrides:
setOauthToken in class SpannerRequest<GetDatabaseDdlResponse>
-
setPrettyPrint
public Spanner.Projects.Instances.Databases.GetDdl setPrettyPrint(Boolean prettyPrint)
Description copied from class: SpannerRequest
Returns response with indentations and line breaks.
- Overrides:
setPrettyPrint in class SpannerRequest<GetDatabaseDdlResponse>
-
setQuotaUser
public Spanner.Projects.Instances.Databases.GetDdl 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<GetDatabaseDdlResponse>
-
setUploadType
public Spanner.Projects.Instances.Databases.GetDdl setUploadType(String uploadType)
Description copied from class: SpannerRequest
Legacy upload protocol for media (e.g. "media", "multipart").
- Overrides:
setUploadType in class SpannerRequest<GetDatabaseDdlResponse>
-
setUploadProtocol
public Spanner.Projects.Instances.Databases.GetDdl setUploadProtocol(String uploadProtocol)
Description copied from class: SpannerRequest
Upload protocol for media (e.g. "raw", "multipart").
- Overrides:
setUploadProtocol in class SpannerRequest<GetDatabaseDdlResponse>
-
getDatabase
public String getDatabase()
Required. The database whose schema we wish to get. Values are of the form
`projects//instances//databases/`
-
setDatabase
public Spanner.Projects.Instances.Databases.GetDdl setDatabase(String database)
Required. The database whose schema we wish to get. Values are of the form
`projects//instances//databases/`
-
set
public Spanner.Projects.Instances.Databases.GetDdl set(String parameterName,
Object value)
- Overrides:
set in class SpannerRequest<GetDatabaseDdlResponse>
Copyright © 2011–2024 Google. All rights reserved.
© 2015 - 2024 Weber Informatics LLC | Privacy Policy