com.google.api.services.cloudkms.v1

Class CloudKMS.Projects.Locations.KeyRings.Get

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.cloudkms.v1.CloudKMSRequest<KeyRing>

com.google.api.services.cloudkms.v1.CloudKMS.Projects.Locations.KeyRings.Get

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

CloudKMS.Projects.Locations.KeyRings

public class CloudKMS.Projects.Locations.KeyRings.Get
extends CloudKMSRequest<KeyRing>

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	Get(String name) Returns metadata for a given KeyRing.

Method Summary

Modifier and Type	Method and Description
HttpRequest	buildHttpRequestUsingHead()
HttpResponse	executeUsingHead()
String	getName() Required.
CloudKMS.Projects.Locations.KeyRings.Get	set(String parameterName, Object value)
CloudKMS.Projects.Locations.KeyRings.Get	set$Xgafv(String $Xgafv) V1 error format.
CloudKMS.Projects.Locations.KeyRings.Get	setAccessToken(String accessToken) OAuth access token.
CloudKMS.Projects.Locations.KeyRings.Get	setAlt(String alt) Data format for response.
CloudKMS.Projects.Locations.KeyRings.Get	setCallback(String callback) JSONP
CloudKMS.Projects.Locations.KeyRings.Get	setFields(String fields) Selector specifying which fields to include in a partial response.
CloudKMS.Projects.Locations.KeyRings.Get	setKey(String key) API key.
CloudKMS.Projects.Locations.KeyRings.Get	setName(String name) Required.
CloudKMS.Projects.Locations.KeyRings.Get	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
CloudKMS.Projects.Locations.KeyRings.Get	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
CloudKMS.Projects.Locations.KeyRings.Get	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
CloudKMS.Projects.Locations.KeyRings.Get	setUploadProtocol(String uploadProtocol) Upload protocol for media (e.g.
CloudKMS.Projects.Locations.KeyRings.Get	setUploadType(String uploadType) Legacy upload protocol for media (e.g.

Methods inherited from class com.google.api.services.cloudkms.v1.CloudKMSRequest

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

Get

protected Get(String name)

Returns metadata for a given KeyRing. Create a request for the method "keyRings.get". This request holds the parameters needed by the the cloudkms server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

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

Parameters:

name - Required. The name of the KeyRing to get.

Since:

1.13

Method Detail

executeUsingHead

public HttpResponse executeUsingHead()
                              throws IOException

Overrides:

executeUsingHead in class AbstractGoogleClientRequest<KeyRing>

Throws:

IOException

buildHttpRequestUsingHead

public HttpRequest buildHttpRequestUsingHead()
                                      throws IOException

Overrides:

buildHttpRequestUsingHead in class AbstractGoogleClientRequest<KeyRing>

Throws:

IOException

set$Xgafv

public CloudKMS.Projects.Locations.KeyRings.Get set$Xgafv(String $Xgafv)

Description copied from class: CloudKMSRequest

V1 error format.

Overrides:

set$Xgafv in class CloudKMSRequest<KeyRing>

setAccessToken

public CloudKMS.Projects.Locations.KeyRings.Get setAccessToken(String accessToken)

Description copied from class: CloudKMSRequest

OAuth access token.

Overrides:

setAccessToken in class CloudKMSRequest<KeyRing>

setAlt

public CloudKMS.Projects.Locations.KeyRings.Get setAlt(String alt)

Description copied from class: CloudKMSRequest

Data format for response.

Overrides:

setAlt in class CloudKMSRequest<KeyRing>

setCallback

public CloudKMS.Projects.Locations.KeyRings.Get setCallback(String callback)

Description copied from class: CloudKMSRequest

JSONP

Overrides:

setCallback in class CloudKMSRequest<KeyRing>

setFields

public CloudKMS.Projects.Locations.KeyRings.Get setFields(String fields)

Description copied from class: CloudKMSRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class CloudKMSRequest<KeyRing>

setKey

public CloudKMS.Projects.Locations.KeyRings.Get setKey(String key)

Description copied from class: CloudKMSRequest

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 CloudKMSRequest<KeyRing>

setOauthToken

public CloudKMS.Projects.Locations.KeyRings.Get setOauthToken(String oauthToken)

Description copied from class: CloudKMSRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class CloudKMSRequest<KeyRing>

setPrettyPrint

public CloudKMS.Projects.Locations.KeyRings.Get setPrettyPrint(Boolean prettyPrint)

Description copied from class: CloudKMSRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class CloudKMSRequest<KeyRing>

setQuotaUser

public CloudKMS.Projects.Locations.KeyRings.Get setQuotaUser(String quotaUser)

Description copied from class: CloudKMSRequest

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 CloudKMSRequest<KeyRing>

setUploadType

public CloudKMS.Projects.Locations.KeyRings.Get setUploadType(String uploadType)

Description copied from class: CloudKMSRequest

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

Overrides:

setUploadType in class CloudKMSRequest<KeyRing>

setUploadProtocol

public CloudKMS.Projects.Locations.KeyRings.Get setUploadProtocol(String uploadProtocol)

Description copied from class: CloudKMSRequest

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

Overrides:

setUploadProtocol in class CloudKMSRequest<KeyRing>

getName

public String getName()

Required. The name of the KeyRing to get.

setName

public CloudKMS.Projects.Locations.KeyRings.Get setName(String name)

Required. The name of the KeyRing to get.

set

public CloudKMS.Projects.Locations.KeyRings.Get set(String parameterName,
                                                    Object value)

Overrides:

set in class CloudKMSRequest<KeyRing>