com.google.api.services.cloudkms.v1

Class CloudKMS.Projects.Locations.KeyRings.CryptoKeys.Encrypt

java.lang.Object

java.util.AbstractMap<java.lang.String,java.lang.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<EncryptResponse>

com.google.api.services.cloudkms.v1.CloudKMS.Projects.Locations.KeyRings.CryptoKeys.Encrypt

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>

Enclosing class:

CloudKMS.Projects.Locations.KeyRings.CryptoKeys

public class CloudKMS.Projects.Locations.KeyRings.CryptoKeys.Encrypt
extends CloudKMSRequest<EncryptResponse>

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

java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

java.util.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	CloudKMS.Projects.Locations.KeyRings.CryptoKeys.Encrypt(java.lang.String name, EncryptRequest content) Encrypt data, so that it can only be recovered by a call to Decrypt.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getName() Required.
CloudKMS.Projects.Locations.KeyRings.CryptoKeys.Encrypt	set(java.lang.String parameterName, java.lang.Object value)
CloudKMS.Projects.Locations.KeyRings.CryptoKeys.Encrypt	set$Xgafv(java.lang.String $Xgafv) V1 error format.
CloudKMS.Projects.Locations.KeyRings.CryptoKeys.Encrypt	setAccessToken(java.lang.String accessToken) OAuth access token.
CloudKMS.Projects.Locations.KeyRings.CryptoKeys.Encrypt	setAlt(java.lang.String alt) Data format for response.
CloudKMS.Projects.Locations.KeyRings.CryptoKeys.Encrypt	setBearerToken(java.lang.String bearerToken) OAuth bearer token.
CloudKMS.Projects.Locations.KeyRings.CryptoKeys.Encrypt	setCallback(java.lang.String callback) JSONP
CloudKMS.Projects.Locations.KeyRings.CryptoKeys.Encrypt	setFields(java.lang.String fields) Selector specifying which fields to include in a partial response.
CloudKMS.Projects.Locations.KeyRings.CryptoKeys.Encrypt	setKey(java.lang.String key) API key.
CloudKMS.Projects.Locations.KeyRings.CryptoKeys.Encrypt	setName(java.lang.String name) Required.
CloudKMS.Projects.Locations.KeyRings.CryptoKeys.Encrypt	setOauthToken(java.lang.String oauthToken) OAuth 2.0 token for the current user.
CloudKMS.Projects.Locations.KeyRings.CryptoKeys.Encrypt	setPp(java.lang.Boolean pp) Pretty-print response.
CloudKMS.Projects.Locations.KeyRings.CryptoKeys.Encrypt	setPrettyPrint(java.lang.Boolean prettyPrint) Returns response with indentations and line breaks.
CloudKMS.Projects.Locations.KeyRings.CryptoKeys.Encrypt	setQuotaUser(java.lang.String quotaUser) Available to use for quota purposes for server-side applications.
CloudKMS.Projects.Locations.KeyRings.CryptoKeys.Encrypt	setUploadProtocol(java.lang.String uploadProtocol) Upload protocol for media (e.g.
CloudKMS.Projects.Locations.KeyRings.CryptoKeys.Encrypt	setUploadType(java.lang.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, getBearerToken, getCallback, getFields, getKey, getOauthToken, getPp, 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, buildHttpRequestUsingHead, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, executeUsingHead, 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

Constructor Detail

CloudKMS.Projects.Locations.KeyRings.CryptoKeys.Encrypt

protected CloudKMS.Projects.Locations.KeyRings.CryptoKeys.Encrypt(java.lang.String name,
                                                       EncryptRequest content)

Encrypt data, so that it can only be recovered by a call to Decrypt. Create a request for the method "cryptoKeys.encrypt". 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 resource name of the CryptoKey or CryptoKeyVersion to use for encryption. If a CryptoKey is specified, the server will use its primary version.

content - the EncryptRequest

Since:

1.13

Method Detail

set$Xgafv

public CloudKMS.Projects.Locations.KeyRings.CryptoKeys.Encrypt set$Xgafv(java.lang.String $Xgafv)

Description copied from class: CloudKMSRequest

V1 error format.

Overrides:

set$Xgafv in class CloudKMSRequest<EncryptResponse>

setAccessToken

public CloudKMS.Projects.Locations.KeyRings.CryptoKeys.Encrypt setAccessToken(java.lang.String accessToken)

Description copied from class: CloudKMSRequest

OAuth access token.

Overrides:

setAccessToken in class CloudKMSRequest<EncryptResponse>

setAlt

public CloudKMS.Projects.Locations.KeyRings.CryptoKeys.Encrypt setAlt(java.lang.String alt)

Description copied from class: CloudKMSRequest

Data format for response.

Overrides:

setAlt in class CloudKMSRequest<EncryptResponse>

setBearerToken

public CloudKMS.Projects.Locations.KeyRings.CryptoKeys.Encrypt setBearerToken(java.lang.String bearerToken)

Description copied from class: CloudKMSRequest

OAuth bearer token.

Overrides:

setBearerToken in class CloudKMSRequest<EncryptResponse>

setCallback

public CloudKMS.Projects.Locations.KeyRings.CryptoKeys.Encrypt setCallback(java.lang.String callback)

Description copied from class: CloudKMSRequest

JSONP

Overrides:

setCallback in class CloudKMSRequest<EncryptResponse>

setFields

public CloudKMS.Projects.Locations.KeyRings.CryptoKeys.Encrypt setFields(java.lang.String fields)

Description copied from class: CloudKMSRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class CloudKMSRequest<EncryptResponse>

setKey

public CloudKMS.Projects.Locations.KeyRings.CryptoKeys.Encrypt setKey(java.lang.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<EncryptResponse>

setOauthToken

public CloudKMS.Projects.Locations.KeyRings.CryptoKeys.Encrypt setOauthToken(java.lang.String oauthToken)

Description copied from class: CloudKMSRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class CloudKMSRequest<EncryptResponse>

setPp

public CloudKMS.Projects.Locations.KeyRings.CryptoKeys.Encrypt setPp(java.lang.Boolean pp)

Description copied from class: CloudKMSRequest

Pretty-print response.

Overrides:

setPp in class CloudKMSRequest<EncryptResponse>

setPrettyPrint

public CloudKMS.Projects.Locations.KeyRings.CryptoKeys.Encrypt setPrettyPrint(java.lang.Boolean prettyPrint)

Description copied from class: CloudKMSRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class CloudKMSRequest<EncryptResponse>

setQuotaUser

public CloudKMS.Projects.Locations.KeyRings.CryptoKeys.Encrypt setQuotaUser(java.lang.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<EncryptResponse>

setUploadType

public CloudKMS.Projects.Locations.KeyRings.CryptoKeys.Encrypt setUploadType(java.lang.String uploadType)

Description copied from class: CloudKMSRequest

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

Overrides:

setUploadType in class CloudKMSRequest<EncryptResponse>

setUploadProtocol

public CloudKMS.Projects.Locations.KeyRings.CryptoKeys.Encrypt setUploadProtocol(java.lang.String uploadProtocol)

Description copied from class: CloudKMSRequest

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

Overrides:

setUploadProtocol in class CloudKMSRequest<EncryptResponse>

getName

public java.lang.String getName()

Required. The resource name of the CryptoKey or CryptoKeyVersion to use for encryption. If a CryptoKey is specified, the server will use its primary version.

setName

public CloudKMS.Projects.Locations.KeyRings.CryptoKeys.Encrypt setName(java.lang.String name)

Required. The resource name of the CryptoKey or CryptoKeyVersion to use for encryption. If a CryptoKey is specified, the server will use its primary version.

set

public CloudKMS.Projects.Locations.KeyRings.CryptoKeys.Encrypt set(java.lang.String parameterName,
                                                          java.lang.Object value)

Overrides:

set in class CloudKMSRequest<EncryptResponse>