com.google.api.services.storage

Class Storage.ObjectAccessControls.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<ObjectAccessControl>

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Storage.ObjectAccessControls

public class Storage.ObjectAccessControls.Patch
extends StorageRequest<ObjectAccessControl>

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__, String entity, ObjectAccessControl content) Patches an ACL entry on the specified object.

Method Summary

Modifier and Type	Method and Description
String	getBucket() Name of a bucket.
String	getEntity() The entity holding the permission.
Long	getGeneration() If present, selects a specific revision of this object (as opposed to the latest version, the default).
String	getObject() Name of the object.
String	getUserProject() The project to be billed for this request.
Storage.ObjectAccessControls.Patch	set(String parameterName, Object value)
Storage.ObjectAccessControls.Patch	setAlt(String alt) Data format for the response.
Storage.ObjectAccessControls.Patch	setBucket(String bucket) Name of a bucket.
Storage.ObjectAccessControls.Patch	setEntity(String entity) The entity holding the permission.
Storage.ObjectAccessControls.Patch	setFields(String fields) Selector specifying which fields to include in a partial response.
Storage.ObjectAccessControls.Patch	setGeneration(Long generation) If present, selects a specific revision of this object (as opposed to the latest version, the default).
Storage.ObjectAccessControls.Patch	setKey(String key) API key.
Storage.ObjectAccessControls.Patch	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
Storage.ObjectAccessControls.Patch	setObject(String object__) Name of the object.
Storage.ObjectAccessControls.Patch	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
Storage.ObjectAccessControls.Patch	setQuotaUser(String quotaUser) An opaque string that represents a user for quota purposes.
Storage.ObjectAccessControls.Patch	setUploadType(String uploadType) Upload protocol for media (e.g.
Storage.ObjectAccessControls.Patch	setUserIp(String userIp) Deprecated.
Storage.ObjectAccessControls.Patch	setUserProject(String userProject) The project to be billed for this request.

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__,
                String entity,
                ObjectAccessControl content)

Patches an ACL entry on the specified object. Create a request for the method "objectAccessControls.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 a bucket.

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).

entity - The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group- emailAddress, allUsers, or allAuthenticatedUsers.

content - the ObjectAccessControl

Since:

1.13

Method Detail

setAlt

public Storage.ObjectAccessControls.Patch setAlt(String alt)

Description copied from class: StorageRequest

Data format for the response.

Overrides:

setAlt in class StorageRequest<ObjectAccessControl>

setFields

public Storage.ObjectAccessControls.Patch setFields(String fields)

Description copied from class: StorageRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class StorageRequest<ObjectAccessControl>

setKey

public Storage.ObjectAccessControls.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<ObjectAccessControl>

setOauthToken

public Storage.ObjectAccessControls.Patch setOauthToken(String oauthToken)

Description copied from class: StorageRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class StorageRequest<ObjectAccessControl>

setPrettyPrint

public Storage.ObjectAccessControls.Patch setPrettyPrint(Boolean prettyPrint)

Description copied from class: StorageRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class StorageRequest<ObjectAccessControl>

setQuotaUser

public Storage.ObjectAccessControls.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<ObjectAccessControl>

setUploadType

public Storage.ObjectAccessControls.Patch setUploadType(String uploadType)

Description copied from class: StorageRequest

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

Overrides:

setUploadType in class StorageRequest<ObjectAccessControl>

setUserIp

public Storage.ObjectAccessControls.Patch setUserIp(String userIp)

Description copied from class: StorageRequest

Deprecated. Please use quotaUser instead.

Overrides:

setUserIp in class StorageRequest<ObjectAccessControl>

getBucket

public String getBucket()

Name of a bucket.

setBucket

public Storage.ObjectAccessControls.Patch setBucket(String bucket)

Name of a bucket.

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.ObjectAccessControls.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).

getEntity

public String getEntity()

The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group- emailAddress, allUsers, or allAuthenticatedUsers.

setEntity

public Storage.ObjectAccessControls.Patch setEntity(String entity)

The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.

getGeneration

public Long getGeneration()

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

setGeneration

public Storage.ObjectAccessControls.Patch setGeneration(Long generation)

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

getUserProject

public String getUserProject()

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

setUserProject

public Storage.ObjectAccessControls.Patch setUserProject(String userProject)

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

set

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

Overrides:

set in class StorageRequest<ObjectAccessControl>