com.google.api.services.storage

Class Storage.Objects.Restore

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Storage.Objects

public class Storage.Objects.Restore
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	Restore(String bucket, String object__, Long generation) Restores a soft-deleted object.

Method Summary

Modifier and Type	Method and Description
String	getBucket() Name of the bucket in which the object resides.
Boolean	getCopySourceAcl() If true, copies the source object's ACL; otherwise, uses the bucket's default object ACL.
Long	getGeneration() Selects a specific revision of this object.
Long	getIfGenerationMatch() Makes the operation conditional on whether the object's one live generation matches the given value.
Long	getIfGenerationNotMatch() Makes the operation conditional on whether none of the object's live generations match the given value.
Long	getIfMetagenerationMatch() Makes the operation conditional on whether the object's one live metageneration matches the given value.
Long	getIfMetagenerationNotMatch() Makes the operation conditional on whether none of the object's live metagenerations match the given value.
String	getObject() Name of the object.
String	getProjection() Set of properties to return.
String	getRestoreToken() Restore token used to differentiate sof-deleted objects with the same name and generation.
String	getUserProject() The project to be billed for this request.
Storage.Objects.Restore	set(String parameterName, Object value)
Storage.Objects.Restore	setAlt(String alt) Data format for the response.
Storage.Objects.Restore	setBucket(String bucket) Name of the bucket in which the object resides.
Storage.Objects.Restore	setCopySourceAcl(Boolean copySourceAcl) If true, copies the source object's ACL; otherwise, uses the bucket's default object ACL.
Storage.Objects.Restore	setFields(String fields) Selector specifying which fields to include in a partial response.
Storage.Objects.Restore	setGeneration(Long generation) Selects a specific revision of this object.
Storage.Objects.Restore	setIfGenerationMatch(Long ifGenerationMatch) Makes the operation conditional on whether the object's one live generation matches the given value.
Storage.Objects.Restore	setIfGenerationNotMatch(Long ifGenerationNotMatch) Makes the operation conditional on whether none of the object's live generations match the given value.
Storage.Objects.Restore	setIfMetagenerationMatch(Long ifMetagenerationMatch) Makes the operation conditional on whether the object's one live metageneration matches the given value.
Storage.Objects.Restore	setIfMetagenerationNotMatch(Long ifMetagenerationNotMatch) Makes the operation conditional on whether none of the object's live metagenerations match the given value.
Storage.Objects.Restore	setKey(String key) API key.
Storage.Objects.Restore	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
Storage.Objects.Restore	setObject(String object__) Name of the object.
Storage.Objects.Restore	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
Storage.Objects.Restore	setProjection(String projection) Set of properties to return.
Storage.Objects.Restore	setQuotaUser(String quotaUser) An opaque string that represents a user for quota purposes.
Storage.Objects.Restore	setRestoreToken(String restoreToken) Restore token used to differentiate sof-deleted objects with the same name and generation.
Storage.Objects.Restore	setUploadType(String uploadType) Upload protocol for media (e.g.
Storage.Objects.Restore	setUserIp(String userIp) Deprecated.
Storage.Objects.Restore	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

Restore

protected Restore(String bucket,
                  String object__,
                  Long generation)

Restores a soft-deleted object. Create a request for the method "objects.restore". 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).

generation - Selects a specific revision of this object.

Since:

1.13

Method Detail

setAlt

public Storage.Objects.Restore setAlt(String alt)

Description copied from class: StorageRequest

Data format for the response.

Overrides:

setAlt in class StorageRequest<StorageObject>

setFields

public Storage.Objects.Restore 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.Restore 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.Restore 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.Restore 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.Restore 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.Restore 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.Restore 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.Restore 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.Restore 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()

Selects a specific revision of this object.

setGeneration

public Storage.Objects.Restore setGeneration(Long generation)

Selects a specific revision of this object.

getCopySourceAcl

public Boolean getCopySourceAcl()

If true, copies the source object's ACL; otherwise, uses the bucket's default object ACL. The default is false.

setCopySourceAcl

public Storage.Objects.Restore setCopySourceAcl(Boolean copySourceAcl)

If true, copies the source object's ACL; otherwise, uses the bucket's default object ACL. The default is false.

getIfGenerationMatch

public Long getIfGenerationMatch()

Makes the operation conditional on whether the object's one live 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.Restore setIfGenerationMatch(Long ifGenerationMatch)

Makes the operation conditional on whether the object's one live 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 none of the object's live generations 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.Restore setIfGenerationNotMatch(Long ifGenerationNotMatch)

Makes the operation conditional on whether none of the object's live generations 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 one live metageneration matches the given value.

setIfMetagenerationMatch

public Storage.Objects.Restore setIfMetagenerationMatch(Long ifMetagenerationMatch)

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

getIfMetagenerationNotMatch

public Long getIfMetagenerationNotMatch()

Makes the operation conditional on whether none of the object's live metagenerations match the given value.

setIfMetagenerationNotMatch

public Storage.Objects.Restore setIfMetagenerationNotMatch(Long ifMetagenerationNotMatch)

Makes the operation conditional on whether none of the object's live metagenerations match the given value.

getProjection

public String getProjection()

Set of properties to return. Defaults to full.

setProjection

public Storage.Objects.Restore setProjection(String projection)

Set of properties to return. Defaults to full.

getRestoreToken

public String getRestoreToken()

Restore token used to differentiate sof-deleted objects with the same name and generation. Only applicable for hierarchical namespace buckets. This parameter is optional, and is only required in the rare case when there are multiple soft-deleted objects with the same name and generation.

setRestoreToken

public Storage.Objects.Restore setRestoreToken(String restoreToken)

Restore token used to differentiate sof-deleted objects with the same name and generation. Only applicable for hierarchical namespace buckets. This parameter is optional, and is only required in the rare case when there are multiple soft-deleted objects with the same name and generation.

getUserProject

public String getUserProject()

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

setUserProject

public Storage.Objects.Restore setUserProject(String userProject)

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

set

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

Overrides:

set in class StorageRequest<StorageObject>