com.google.api.services.storage

Class Storage.Folders.DeleteRecursive

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

com.google.api.services.storage.Storage.Folders.DeleteRecursive

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Storage.Folders

public class Storage.Folders.DeleteRecursive
extends StorageRequest<GoogleLongrunningOperation>

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	DeleteRecursive(String bucket, String folder) Deletes a folder recursively.

Method Summary

Modifier and Type	Method and Description
String	getBucket() Name of the bucket in which the folder resides.
String	getFolder() Name of a folder.
Long	getIfMetagenerationMatch() If set, only deletes the folder if its metageneration matches this value.
Long	getIfMetagenerationNotMatch() If set, only deletes the folder if its metageneration does not match this value.
Storage.Folders.DeleteRecursive	set(String parameterName, Object value)
Storage.Folders.DeleteRecursive	setAlt(String alt) Data format for the response.
Storage.Folders.DeleteRecursive	setBucket(String bucket) Name of the bucket in which the folder resides.
Storage.Folders.DeleteRecursive	setFields(String fields) Selector specifying which fields to include in a partial response.
Storage.Folders.DeleteRecursive	setFolder(String folder) Name of a folder.
Storage.Folders.DeleteRecursive	setIfMetagenerationMatch(Long ifMetagenerationMatch) If set, only deletes the folder if its metageneration matches this value.
Storage.Folders.DeleteRecursive	setIfMetagenerationNotMatch(Long ifMetagenerationNotMatch) If set, only deletes the folder if its metageneration does not match this value.
Storage.Folders.DeleteRecursive	setKey(String key) API key.
Storage.Folders.DeleteRecursive	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
Storage.Folders.DeleteRecursive	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
Storage.Folders.DeleteRecursive	setQuotaUser(String quotaUser) An opaque string that represents a user for quota purposes.
Storage.Folders.DeleteRecursive	setUploadType(String uploadType) Upload protocol for media (e.g.
Storage.Folders.DeleteRecursive	setUserIp(String userIp) Deprecated.

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

DeleteRecursive

protected DeleteRecursive(String bucket,
                          String folder)

Deletes a folder recursively. Only applicable to buckets with hierarchical namespace enabled. Create a request for the method "folders.deleteRecursive". 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.

DeleteRecursive#initialize(com.google.api.client.googleapis.services.AbstractGoogleC lientRequest) must be called to initialize this instance immediately after invoking the constructor.

Parameters:

bucket - Name of the bucket in which the folder resides.

folder - Name of a folder.

Since:

1.13

Method Detail

setAlt

public Storage.Folders.DeleteRecursive setAlt(String alt)

Description copied from class: StorageRequest

Data format for the response.

Overrides:

setAlt in class StorageRequest<GoogleLongrunningOperation>

setFields

public Storage.Folders.DeleteRecursive setFields(String fields)

Description copied from class: StorageRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class StorageRequest<GoogleLongrunningOperation>

setKey

public Storage.Folders.DeleteRecursive 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<GoogleLongrunningOperation>

setOauthToken

public Storage.Folders.DeleteRecursive setOauthToken(String oauthToken)

Description copied from class: StorageRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class StorageRequest<GoogleLongrunningOperation>

setPrettyPrint

public Storage.Folders.DeleteRecursive setPrettyPrint(Boolean prettyPrint)

Description copied from class: StorageRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class StorageRequest<GoogleLongrunningOperation>

setQuotaUser

public Storage.Folders.DeleteRecursive 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<GoogleLongrunningOperation>

setUploadType

public Storage.Folders.DeleteRecursive setUploadType(String uploadType)

Description copied from class: StorageRequest

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

Overrides:

setUploadType in class StorageRequest<GoogleLongrunningOperation>

setUserIp

public Storage.Folders.DeleteRecursive setUserIp(String userIp)

Description copied from class: StorageRequest

Deprecated. Please use quotaUser instead.

Overrides:

setUserIp in class StorageRequest<GoogleLongrunningOperation>

getBucket

public String getBucket()

Name of the bucket in which the folder resides.

setBucket

public Storage.Folders.DeleteRecursive setBucket(String bucket)

Name of the bucket in which the folder resides.

getFolder

public String getFolder()

Name of a folder.

setFolder

public Storage.Folders.DeleteRecursive setFolder(String folder)

Name of a folder.

getIfMetagenerationMatch

public Long getIfMetagenerationMatch()

If set, only deletes the folder if its metageneration matches this value.

setIfMetagenerationMatch

public Storage.Folders.DeleteRecursive setIfMetagenerationMatch(Long ifMetagenerationMatch)

If set, only deletes the folder if its metageneration matches this value.

getIfMetagenerationNotMatch

public Long getIfMetagenerationNotMatch()

If set, only deletes the folder if its metageneration does not match this value.

setIfMetagenerationNotMatch

public Storage.Folders.DeleteRecursive setIfMetagenerationNotMatch(Long ifMetagenerationNotMatch)

If set, only deletes the folder if its metageneration does not match this value.

set

public Storage.Folders.DeleteRecursive set(String parameterName,
                                           Object value)

Overrides:

set in class StorageRequest<GoogleLongrunningOperation>