com.google.api.services.storage.model

Class Folder

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.storage.model.Folder

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class Folder
extends com.google.api.client.json.GenericJson

A folder. Only available in buckets with hierarchical namespace enabled.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Cloud Storage JSON API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Folder.PendingRenameInfo Only present if the folder is part of an ongoing rename folder operation.

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>

Constructor Summary

Constructors

Constructor and Description
Folder()

Method Summary

Modifier and Type	Method and Description
Folder	clone()
String	getBucket() The name of the bucket containing this folder.
com.google.api.client.util.DateTime	getCreateTime() The creation time of the folder in RFC 3339 format.
String	getId() The ID of the folder, including the bucket name, folder name.
String	getKind() The kind of item this is.
Long	getMetageneration() The version of the metadata for this folder.
String	getName() The name of the folder.
Folder.PendingRenameInfo	getPendingRenameInfo() Only present if the folder is part of an ongoing rename folder operation.
String	getSelfLink() The link to this folder.
com.google.api.client.util.DateTime	getUpdateTime() The modification time of the folder metadata in RFC 3339 format.
Folder	set(String fieldName, Object value)
Folder	setBucket(String bucket) The name of the bucket containing this folder.
Folder	setCreateTime(com.google.api.client.util.DateTime createTime) The creation time of the folder in RFC 3339 format.
Folder	setId(String id) The ID of the folder, including the bucket name, folder name.
Folder	setKind(String kind) The kind of item this is.
Folder	setMetageneration(Long metageneration) The version of the metadata for this folder.
Folder	setName(String name) The name of the folder.
Folder	setPendingRenameInfo(Folder.PendingRenameInfo pendingRenameInfo) Only present if the folder is part of an ongoing rename folder operation.
Folder	setSelfLink(String selfLink) The link to this folder.
Folder	setUpdateTime(com.google.api.client.util.DateTime updateTime) The modification time of the folder metadata in RFC 3339 format.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

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

Folder

public Folder()

Method Detail

getBucket

public String getBucket()

The name of the bucket containing this folder.

Returns:

value or null for none

setBucket

public Folder setBucket(String bucket)

The name of the bucket containing this folder.

Parameters:

bucket - bucket or null for none

getCreateTime

public com.google.api.client.util.DateTime getCreateTime()

The creation time of the folder in RFC 3339 format.

Returns:

value or null for none

setCreateTime

public Folder setCreateTime(com.google.api.client.util.DateTime createTime)

The creation time of the folder in RFC 3339 format.

Parameters:

createTime - createTime or null for none

getId

public String getId()

The ID of the folder, including the bucket name, folder name.

Returns:

value or null for none

setId

public Folder setId(String id)

The ID of the folder, including the bucket name, folder name.

Parameters:

id - id or null for none

getKind

public String getKind()

The kind of item this is. For folders, this is always storage#folder.

Returns:

value or null for none

setKind

public Folder setKind(String kind)

The kind of item this is. For folders, this is always storage#folder.

Parameters:

kind - kind or null for none

getMetageneration

public Long getMetageneration()

The version of the metadata for this folder. Used for preconditions and for detecting changes in metadata.

Returns:

value or null for none

setMetageneration

public Folder setMetageneration(Long metageneration)

The version of the metadata for this folder. Used for preconditions and for detecting changes in metadata.

Parameters:

metageneration - metageneration or null for none

getName

public String getName()

The name of the folder. Required if not specified by URL parameter.

Returns:

value or null for none

setName

public Folder setName(String name)

The name of the folder. Required if not specified by URL parameter.

Parameters:

name - name or null for none

getPendingRenameInfo

public Folder.PendingRenameInfo getPendingRenameInfo()

Only present if the folder is part of an ongoing rename folder operation. Contains information which can be used to query the operation status.

Returns:

value or null for none

setPendingRenameInfo

public Folder setPendingRenameInfo(Folder.PendingRenameInfo pendingRenameInfo)

Only present if the folder is part of an ongoing rename folder operation. Contains information which can be used to query the operation status.

Parameters:

pendingRenameInfo - pendingRenameInfo or null for none

getSelfLink

public String getSelfLink()

The link to this folder.

Returns:

value or null for none

setSelfLink

public Folder setSelfLink(String selfLink)

The link to this folder.

Parameters:

selfLink - selfLink or null for none

getUpdateTime

public com.google.api.client.util.DateTime getUpdateTime()

The modification time of the folder metadata in RFC 3339 format.

Returns:

value or null for none

setUpdateTime

public Folder setUpdateTime(com.google.api.client.util.DateTime updateTime)

The modification time of the folder metadata in RFC 3339 format.

Parameters:

updateTime - updateTime or null for none

set

public Folder set(String fieldName,
                  Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public Folder clone()

Overrides:

clone in class com.google.api.client.json.GenericJson