com.google.api.services.cloudkms.v1

Class CloudKMS.Projects.Locations.KeyRings.CryptoKeys.CryptoKeyVersions.Patch

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

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

CloudKMS.Projects.Locations.KeyRings.CryptoKeys.CryptoKeyVersions

public class CloudKMS.Projects.Locations.KeyRings.CryptoKeys.CryptoKeyVersions.Patch
extends CloudKMSRequest<CryptoKeyVersion>

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	Patch(String name, CryptoKeyVersion content) Update a CryptoKeyVersion's metadata.

Method Summary

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

Patch

protected Patch(String name,
                CryptoKeyVersion content)

Update a CryptoKeyVersion's metadata. state may be changed between ENABLED and DISABLED using this method. See DestroyCryptoKeyVersion and RestoreCryptoKeyVersion to move between other states. Create a request for the method "cryptoKeyVersions.patch". 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 - Output only. The resource name for this CryptoKeyVersion in the format `projects/locations/keyRings/cryptoKeys/cryptoKeyVersions`.

content - the CryptoKeyVersion

Since:

1.13

Method Detail

set$Xgafv

public CloudKMS.Projects.Locations.KeyRings.CryptoKeys.CryptoKeyVersions.Patch set$Xgafv(String $Xgafv)

Description copied from class: CloudKMSRequest

V1 error format.

Overrides:

set$Xgafv in class CloudKMSRequest<CryptoKeyVersion>

setAccessToken

public CloudKMS.Projects.Locations.KeyRings.CryptoKeys.CryptoKeyVersions.Patch setAccessToken(String accessToken)

Description copied from class: CloudKMSRequest

OAuth access token.

Overrides:

setAccessToken in class CloudKMSRequest<CryptoKeyVersion>

setAlt

public CloudKMS.Projects.Locations.KeyRings.CryptoKeys.CryptoKeyVersions.Patch setAlt(String alt)

Description copied from class: CloudKMSRequest

Data format for response.

Overrides:

setAlt in class CloudKMSRequest<CryptoKeyVersion>

setCallback

public CloudKMS.Projects.Locations.KeyRings.CryptoKeys.CryptoKeyVersions.Patch setCallback(String callback)

Description copied from class: CloudKMSRequest

JSONP

Overrides:

setCallback in class CloudKMSRequest<CryptoKeyVersion>

setFields

public CloudKMS.Projects.Locations.KeyRings.CryptoKeys.CryptoKeyVersions.Patch setFields(String fields)

Description copied from class: CloudKMSRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class CloudKMSRequest<CryptoKeyVersion>

setKey

public CloudKMS.Projects.Locations.KeyRings.CryptoKeys.CryptoKeyVersions.Patch 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<CryptoKeyVersion>

setOauthToken

public CloudKMS.Projects.Locations.KeyRings.CryptoKeys.CryptoKeyVersions.Patch setOauthToken(String oauthToken)

Description copied from class: CloudKMSRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class CloudKMSRequest<CryptoKeyVersion>

setPrettyPrint

public CloudKMS.Projects.Locations.KeyRings.CryptoKeys.CryptoKeyVersions.Patch setPrettyPrint(Boolean prettyPrint)

Description copied from class: CloudKMSRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class CloudKMSRequest<CryptoKeyVersion>

setQuotaUser

public CloudKMS.Projects.Locations.KeyRings.CryptoKeys.CryptoKeyVersions.Patch 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<CryptoKeyVersion>

setUploadType

public CloudKMS.Projects.Locations.KeyRings.CryptoKeys.CryptoKeyVersions.Patch setUploadType(String uploadType)

Description copied from class: CloudKMSRequest

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

Overrides:

setUploadType in class CloudKMSRequest<CryptoKeyVersion>

setUploadProtocol

public CloudKMS.Projects.Locations.KeyRings.CryptoKeys.CryptoKeyVersions.Patch setUploadProtocol(String uploadProtocol)

Description copied from class: CloudKMSRequest

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

Overrides:

setUploadProtocol in class CloudKMSRequest<CryptoKeyVersion>

getName

public String getName()

Output only. The resource name for this CryptoKeyVersion in the format `projects/locations/keyRings/cryptoKeys/cryptoKeyVersions`.

setName

public CloudKMS.Projects.Locations.KeyRings.CryptoKeys.CryptoKeyVersions.Patch setName(String name)

Output only. The resource name for this CryptoKeyVersion in the format `projects/locations/keyRings/cryptoKeys/cryptoKeyVersions`.

getUpdateMask

public String getUpdateMask()

Required. List of fields to be updated in this request.

setUpdateMask

public CloudKMS.Projects.Locations.KeyRings.CryptoKeys.CryptoKeyVersions.Patch setUpdateMask(String updateMask)

Required. List of fields to be updated in this request.

set

public CloudKMS.Projects.Locations.KeyRings.CryptoKeys.CryptoKeyVersions.Patch set(String parameterName,
                                                                                   Object value)

Overrides:

set in class CloudKMSRequest<CryptoKeyVersion>