com.google.api.services.storage

Class Storage.Buckets.LockRetentionPolicy

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

com.google.api.services.storage.Storage.Buckets.LockRetentionPolicy

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Storage.Buckets

public class Storage.Buckets.LockRetentionPolicy
extends StorageRequest<Bucket>

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	LockRetentionPolicy(String bucket, Long ifMetagenerationMatch) Locks retention policy on a bucket.

Method Summary

Modifier and Type	Method and Description
String	getBucket() Name of a bucket.
Long	getIfMetagenerationMatch() Makes the operation conditional on whether bucket's current metageneration matches the given value.
String	getProvisionalUserProject() The project to be billed for this request if the target bucket is requester-pays bucket.
String	getUserProject() The project to be billed for this request.
Storage.Buckets.LockRetentionPolicy	set(String parameterName, Object value)
Storage.Buckets.LockRetentionPolicy	setAlt(String alt) Data format for the response.
Storage.Buckets.LockRetentionPolicy	setBucket(String bucket) Name of a bucket.
Storage.Buckets.LockRetentionPolicy	setFields(String fields) Selector specifying which fields to include in a partial response.
Storage.Buckets.LockRetentionPolicy	setIfMetagenerationMatch(Long ifMetagenerationMatch) Makes the operation conditional on whether bucket's current metageneration matches the given value.
Storage.Buckets.LockRetentionPolicy	setKey(String key) API key.
Storage.Buckets.LockRetentionPolicy	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
Storage.Buckets.LockRetentionPolicy	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
Storage.Buckets.LockRetentionPolicy	setProvisionalUserProject(String provisionalUserProject) The project to be billed for this request if the target bucket is requester-pays bucket.
Storage.Buckets.LockRetentionPolicy	setQuotaUser(String quotaUser) An opaque string that represents a user for quota purposes.
Storage.Buckets.LockRetentionPolicy	setUserIp(String userIp) Deprecated.
Storage.Buckets.LockRetentionPolicy	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, 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

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

LockRetentionPolicy

protected LockRetentionPolicy(String bucket,
                              Long ifMetagenerationMatch)

Locks retention policy on a bucket. Create a request for the method "buckets.lockRetentionPolicy". 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.

LockRetentionPolicy#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.

ifMetagenerationMatch - Makes the operation conditional on whether bucket's current metageneration matches the given value.

Since:

1.13

Method Detail

setAlt

public Storage.Buckets.LockRetentionPolicy setAlt(String alt)

Description copied from class: StorageRequest

Data format for the response.

Overrides:

setAlt in class StorageRequest<Bucket>

setFields

public Storage.Buckets.LockRetentionPolicy setFields(String fields)

Description copied from class: StorageRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class StorageRequest<Bucket>

setKey

public Storage.Buckets.LockRetentionPolicy 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<Bucket>

setOauthToken

public Storage.Buckets.LockRetentionPolicy setOauthToken(String oauthToken)

Description copied from class: StorageRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class StorageRequest<Bucket>

setPrettyPrint

public Storage.Buckets.LockRetentionPolicy setPrettyPrint(Boolean prettyPrint)

Description copied from class: StorageRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class StorageRequest<Bucket>

setQuotaUser

public Storage.Buckets.LockRetentionPolicy 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<Bucket>

setUserIp

public Storage.Buckets.LockRetentionPolicy setUserIp(String userIp)

Description copied from class: StorageRequest

Deprecated. Please use quotaUser instead.

Overrides:

setUserIp in class StorageRequest<Bucket>

getBucket

public String getBucket()

Name of a bucket.

setBucket

public Storage.Buckets.LockRetentionPolicy setBucket(String bucket)

Name of a bucket.

getIfMetagenerationMatch

public Long getIfMetagenerationMatch()

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

setIfMetagenerationMatch

public Storage.Buckets.LockRetentionPolicy setIfMetagenerationMatch(Long ifMetagenerationMatch)

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

getProvisionalUserProject

public String getProvisionalUserProject()

The project to be billed for this request if the target bucket is requester-pays bucket.

setProvisionalUserProject

public Storage.Buckets.LockRetentionPolicy setProvisionalUserProject(String provisionalUserProject)

The project to be billed for this request if the target bucket is requester-pays bucket.

getUserProject

public String getUserProject()

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

setUserProject

public Storage.Buckets.LockRetentionPolicy setUserProject(String userProject)

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

set

public Storage.Buckets.LockRetentionPolicy set(String parameterName,
                                               Object value)

Overrides:

set in class StorageRequest<Bucket>