com.google.api.services.storage

Class Storage.Objects.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.storage.StorageRequest<StorageObject>

com.google.api.services.storage.Storage.Objects.Patch

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Storage.Objects

public class Storage.Objects.Patch
extends StorageRequest<StorageObject>

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	Patch(String bucket, String object__, StorageObject content) Patches an object's metadata.

Method Summary

Modifier and Type	Method and Description
String	getBucket() Name of the bucket in which the object resides.
Long	getGeneration() If present, selects a specific revision of this object (as opposed to the latest version, the default).
Long	getIfGenerationMatch() Makes the operation conditional on whether the object's current generation matches the given value.
Long	getIfGenerationNotMatch() Makes the operation conditional on whether the object's current generation does not match the given value.
Long	getIfMetagenerationMatch() Makes the operation conditional on whether the object's current metageneration matches the given value.
Long	getIfMetagenerationNotMatch() Makes the operation conditional on whether the object's current metageneration does not match the given value.
String	getObject() Name of the object.
Boolean	getOverrideUnlockedRetention() Must be true to remove the retention configuration, reduce its unlocked retention period, or change its mode from unlocked to locked.
String	getPredefinedAcl() Apply a predefined set of access controls to this object.
String	getProjection() Set of properties to return.
String	getUserProject() The project to be billed for this request, for Requester Pays buckets.
Storage.Objects.Patch	set(String parameterName, Object value)
Storage.Objects.Patch	setAlt(String alt) Data format for the response.
Storage.Objects.Patch	setBucket(String bucket) Name of the bucket in which the object resides.
Storage.Objects.Patch	setFields(String fields) Selector specifying which fields to include in a partial response.
Storage.Objects.Patch	setGeneration(Long generation) If present, selects a specific revision of this object (as opposed to the latest version, the default).
Storage.Objects.Patch	setIfGenerationMatch(Long ifGenerationMatch) Makes the operation conditional on whether the object's current generation matches the given value.
Storage.Objects.Patch	setIfGenerationNotMatch(Long ifGenerationNotMatch) Makes the operation conditional on whether the object's current generation does not match the given value.
Storage.Objects.Patch	setIfMetagenerationMatch(Long ifMetagenerationMatch) Makes the operation conditional on whether the object's current metageneration matches the given value.
Storage.Objects.Patch	setIfMetagenerationNotMatch(Long ifMetagenerationNotMatch) Makes the operation conditional on whether the object's current metageneration does not match the given value.
Storage.Objects.Patch	setKey(String key) API key.
Storage.Objects.Patch	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
Storage.Objects.Patch	setObject(String object__) Name of the object.
Storage.Objects.Patch	setOverrideUnlockedRetention(Boolean overrideUnlockedRetention) Must be true to remove the retention configuration, reduce its unlocked retention period, or change its mode from unlocked to locked.
Storage.Objects.Patch	setPredefinedAcl(String predefinedAcl) Apply a predefined set of access controls to this object.
Storage.Objects.Patch	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
Storage.Objects.Patch	setProjection(String projection) Set of properties to return.
Storage.Objects.Patch	setQuotaUser(String quotaUser) An opaque string that represents a user for quota purposes.
Storage.Objects.Patch	setUploadType(String uploadType) Upload protocol for media (e.g.
Storage.Objects.Patch	setUserIp(String userIp) Deprecated.
Storage.Objects.Patch	setUserProject(String userProject) The project to be billed for this request, for Requester Pays buckets.

Methods inherited from class com.google.api.services.storage.StorageRequest

getAbstractGoogleClient, getAlt, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUploadType, getUserIp, 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 bucket,
                String object__,
                StorageObject content)

Patches an object's metadata. Create a request for the method "objects.patch". This request holds the parameters needed by the the storage server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

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

Parameters:

bucket - Name of the bucket in which the object resides.

object__ - Name of the object. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](https://cloud.google.com/storage/docs/request- endpoints#encoding).

content - the StorageObject

Since:

1.13

Method Detail

setAlt

public Storage.Objects.Patch setAlt(String alt)

Description copied from class: StorageRequest

Data format for the response.

Overrides:

setAlt in class StorageRequest<StorageObject>

setFields

public Storage.Objects.Patch setFields(String fields)

Description copied from class: StorageRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class StorageRequest<StorageObject>

setKey

public Storage.Objects.Patch setKey(String key)

Description copied from class: StorageRequest

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 StorageRequest<StorageObject>

setOauthToken

public Storage.Objects.Patch setOauthToken(String oauthToken)

Description copied from class: StorageRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class StorageRequest<StorageObject>

setPrettyPrint

public Storage.Objects.Patch setPrettyPrint(Boolean prettyPrint)

Description copied from class: StorageRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class StorageRequest<StorageObject>

setQuotaUser

public Storage.Objects.Patch setQuotaUser(String quotaUser)

Description copied from class: StorageRequest

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Overrides:

setQuotaUser in class StorageRequest<StorageObject>

setUploadType

public Storage.Objects.Patch setUploadType(String uploadType)

Description copied from class: StorageRequest

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

Overrides:

setUploadType in class StorageRequest<StorageObject>

setUserIp

public Storage.Objects.Patch setUserIp(String userIp)

Description copied from class: StorageRequest

Deprecated. Please use quotaUser instead.

Overrides:

setUserIp in class StorageRequest<StorageObject>

getBucket

public String getBucket()

Name of the bucket in which the object resides.

setBucket

public Storage.Objects.Patch setBucket(String bucket)

Name of the bucket in which the object resides.

getObject

public String getObject()

Name of the object. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](https://cloud.google.com/storage/docs/request-endpoints#encoding).

setObject

public Storage.Objects.Patch setObject(String object__)

Name of the object. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](https://cloud.google.com/storage/docs/request- endpoints#encoding).

getGeneration

public Long getGeneration()

If present, selects a specific revision of this object (as opposed to the latest version, the default).

setGeneration

public Storage.Objects.Patch setGeneration(Long generation)

If present, selects a specific revision of this object (as opposed to the latest version, the default).

getIfGenerationMatch

public Long getIfGenerationMatch()

Makes the operation conditional on whether the object's current generation matches the given value. Setting to 0 makes the operation succeed only if there are no live versions of the object.

setIfGenerationMatch

public Storage.Objects.Patch setIfGenerationMatch(Long ifGenerationMatch)

Makes the operation conditional on whether the object's current generation matches the given value. Setting to 0 makes the operation succeed only if there are no live versions of the object.

getIfGenerationNotMatch

public Long getIfGenerationNotMatch()

Makes the operation conditional on whether the object's current generation does not match the given value. If no live object exists, the precondition fails. Setting to 0 makes the operation succeed only if there is a live version of the object.

setIfGenerationNotMatch

public Storage.Objects.Patch setIfGenerationNotMatch(Long ifGenerationNotMatch)

Makes the operation conditional on whether the object's current generation does not match the given value. If no live object exists, the precondition fails. Setting to 0 makes the operation succeed only if there is a live version of the object.

getIfMetagenerationMatch

public Long getIfMetagenerationMatch()

Makes the operation conditional on whether the object's current metageneration matches the given value.

setIfMetagenerationMatch

public Storage.Objects.Patch setIfMetagenerationMatch(Long ifMetagenerationMatch)

Makes the operation conditional on whether the object's current metageneration matches the given value.

getIfMetagenerationNotMatch

public Long getIfMetagenerationNotMatch()

Makes the operation conditional on whether the object's current metageneration does not match the given value.

setIfMetagenerationNotMatch

public Storage.Objects.Patch setIfMetagenerationNotMatch(Long ifMetagenerationNotMatch)

Makes the operation conditional on whether the object's current metageneration does not match the given value.

getOverrideUnlockedRetention

public Boolean getOverrideUnlockedRetention()

Must be true to remove the retention configuration, reduce its unlocked retention period, or change its mode from unlocked to locked.

setOverrideUnlockedRetention

public Storage.Objects.Patch setOverrideUnlockedRetention(Boolean overrideUnlockedRetention)

Must be true to remove the retention configuration, reduce its unlocked retention period, or change its mode from unlocked to locked.

getPredefinedAcl

public String getPredefinedAcl()

Apply a predefined set of access controls to this object.

setPredefinedAcl

public Storage.Objects.Patch setPredefinedAcl(String predefinedAcl)

Apply a predefined set of access controls to this object.

getProjection

public String getProjection()

Set of properties to return. Defaults to full.

setProjection

public Storage.Objects.Patch setProjection(String projection)

Set of properties to return. Defaults to full.

getUserProject

public String getUserProject()

The project to be billed for this request, for Requester Pays buckets.

setUserProject

public Storage.Objects.Patch setUserProject(String userProject)

The project to be billed for this request, for Requester Pays buckets.

set

public Storage.Objects.Patch set(String parameterName,
                                 Object value)

Overrides:

set in class StorageRequest<StorageObject>