Cloud Storage API v1beta2 (revision 2)

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

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>

Constructor Summary

protected

Storage.ObjectAccessControls.Patch(String bucket, String storageObject, String entity, ObjectAccessControl content) Updates an ACL entry on the specified object.

Method Summary

String	getBucket() Name of a bucket.
String	getEntity() The entity holding the permission.
BigInteger	getGeneration() If present, selects a specific revision of this object (as opposed to the latest version, the default).
String	getObject() Name of the object.
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(BigInteger 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 storageObject) Name of the object.
Storage.ObjectAccessControls.Patch	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
Storage.ObjectAccessControls.Patch	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
Storage.ObjectAccessControls.Patch	setUserIp(String userIp) IP address of the site where the request originates.

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

getAbstractGoogleClient, getAlt, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, 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, 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

Storage.ObjectAccessControls.Patch

protected Storage.ObjectAccessControls.Patch(String bucket,
                                             String storageObject,
                                             String entity,
                                             ObjectAccessControl content)

Updates an ACL entry on the specified object. This method supports patch semantics. 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.

storageObject - Name of the object.

entity - The entity holding the permission. Can be user-userId, group-groupId, 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

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 userIp if both are provided.

Overrides:

setQuotaUser in class StorageRequest<ObjectAccessControl>

setUserIp

public Storage.ObjectAccessControls.Patch setUserIp(String userIp)

Description copied from class: StorageRequest

IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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.

setObject

public Storage.ObjectAccessControls.Patch setObject(String storageObject)

Name of the object.

getEntity

public String getEntity()

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

setEntity

public Storage.ObjectAccessControls.Patch setEntity(String entity)

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

getGeneration

public BigInteger getGeneration()

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

setGeneration

public Storage.ObjectAccessControls.Patch setGeneration(BigInteger generation)

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

set

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

Overrides:

set in class StorageRequest<ObjectAccessControl>