com.google.api.services.storage

Class Storage.Objects.Delete

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

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Storage.Objects

public class Storage.Objects.Delete
extends StorageRequest<Void>

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	Delete(String bucket, String object__) Deletes an object and its metadata.

Method Summary

Modifier and Type	Method and Description
String	getBucket() Name of the bucket in which the object resides.
Long	getGeneration() If present, permanently deletes 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.
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.Objects.Delete	set(String parameterName, Object value)
Storage.Objects.Delete	setAlt(String alt) Data format for the response.
Storage.Objects.Delete	setBucket(String bucket) Name of the bucket in which the object resides.
Storage.Objects.Delete	setFields(String fields) Selector specifying which fields to include in a partial response.
Storage.Objects.Delete	setGeneration(Long generation) If present, permanently deletes a specific revision of this object (as opposed to the latest version, the default).
Storage.Objects.Delete	setIfGenerationMatch(Long ifGenerationMatch) Makes the operation conditional on whether the object's current generation matches the given value.
Storage.Objects.Delete	setIfGenerationNotMatch(Long ifGenerationNotMatch) Makes the operation conditional on whether the object's current generation does not match the given value.
Storage.Objects.Delete	setIfMetagenerationMatch(Long ifMetagenerationMatch) Makes the operation conditional on whether the object's current metageneration matches the given value.
Storage.Objects.Delete	setIfMetagenerationNotMatch(Long ifMetagenerationNotMatch) Makes the operation conditional on whether the object's current metageneration does not match the given value.
Storage.Objects.Delete	setKey(String key) API key.
Storage.Objects.Delete	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
Storage.Objects.Delete	setObject(String object__) Name of the object.
Storage.Objects.Delete	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
Storage.Objects.Delete	setProvisionalUserProject(String provisionalUserProject) The project to be billed for this request if the target bucket is requester-pays bucket.
Storage.Objects.Delete	setQuotaUser(String quotaUser) An opaque string that represents a user for quota purposes.
Storage.Objects.Delete	setUserIp(String userIp) Deprecated.
Storage.Objects.Delete	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, 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

Delete

protected Delete(String bucket,
                 String object__)

Deletes an object and its metadata. Deletions are permanent if versioning is not enabled for the bucket, or if the generation parameter is used. Create a request for the method "objects.delete". 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.

Since:

1.13

Method Detail

setAlt

public Storage.Objects.Delete setAlt(String alt)

Description copied from class: StorageRequest

Data format for the response.

Overrides:

setAlt in class StorageRequest<Void>

setFields

public Storage.Objects.Delete setFields(String fields)

Description copied from class: StorageRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class StorageRequest<Void>

setKey

public Storage.Objects.Delete 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<Void>

setOauthToken

public Storage.Objects.Delete setOauthToken(String oauthToken)

Description copied from class: StorageRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class StorageRequest<Void>

setPrettyPrint

public Storage.Objects.Delete setPrettyPrint(Boolean prettyPrint)

Description copied from class: StorageRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class StorageRequest<Void>

setQuotaUser

public Storage.Objects.Delete 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<Void>

setUserIp

public Storage.Objects.Delete setUserIp(String userIp)

Description copied from class: StorageRequest

Deprecated. Please use quotaUser instead.

Overrides:

setUserIp in class StorageRequest<Void>

getBucket

public String getBucket()

Name of the bucket in which the object resides.

setBucket

public Storage.Objects.Delete 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.

setObject

public Storage.Objects.Delete 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.

getGeneration

public Long getGeneration()

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

setGeneration

public Storage.Objects.Delete setGeneration(Long generation)

If present, permanently deletes 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.Delete 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.Delete 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.Delete 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.Delete setIfMetagenerationNotMatch(Long ifMetagenerationNotMatch)

Makes the operation conditional on whether the object's current metageneration does not match 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.Objects.Delete 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.Objects.Delete setUserProject(String userProject)

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

set

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

Overrides:

set in class StorageRequest<Void>