Class Folder (2.47.0) 

public final class Folder extends GeneratedMessageV3 implements FolderOrBuilder

A folder resource. This resource can only exist in a hierarchical namespace enabled bucket.

Protobuf type google.storage.control.v2.Folder

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > Folder

Implements

FolderOrBuilder

Static Fields

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

METAGENERATION_FIELD_NUMBER

public static final int METAGENERATION_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

PENDING_RENAME_INFO_FIELD_NUMBER

public static final int PENDING_RENAME_INFO_FIELD_NUMBER
Field Value
Type Description
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Folder getDefaultInstance()
Returns
Type Description
Folder

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static Folder.Builder newBuilder()
Returns
Type Description
Folder.Builder

newBuilder(Folder prototype)

public static Folder.Builder newBuilder(Folder prototype)
Parameter
Name Description
prototype Folder
Returns
Type Description
Folder.Builder

parseDelimitedFrom(InputStream input)

public static Folder parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Folder
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Folder parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Folder
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Folder parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Folder
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Folder parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Folder
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Folder parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Folder
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Folder parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Folder
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Folder parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Folder
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Folder parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Folder
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Folder parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Folder
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Folder parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Folder
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Folder parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Folder
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Folder parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Folder
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Folder> parser()
Returns
Type Description
Parser<Folder>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getCreateTime()

public Timestamp getCreateTime()

Output only. The creation time of the folder.

.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. The creation time of the folder.

.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public Folder getDefaultInstanceForType()
Returns
Type Description
Folder

getMetageneration()

public long getMetageneration()

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

int64 metageneration = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
long

The metageneration.

getName()

public String getName()

Identifier. The name of this folder. Format: projects/{project}/buckets/{bucket}/folders/{folder}

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Identifier. The name of this folder. Format: projects/{project}/buckets/{bucket}/folders/{folder}

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

public Parser<Folder> getParserForType()
Returns
Type Description
Parser<Folder>
Overrides

getPendingRenameInfo()

public PendingRenameInfo getPendingRenameInfo()

Output only. Only present if the folder is part of an ongoing RenameFolder operation. Contains information which can be used to query the operation status. The presence of this field also indicates all write operations are blocked for this folder, including folder, managed folder, and object operations.

.google.storage.control.v2.PendingRenameInfo pending_rename_info = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
PendingRenameInfo

The pendingRenameInfo.

getPendingRenameInfoOrBuilder()

public PendingRenameInfoOrBuilder getPendingRenameInfoOrBuilder()

Output only. Only present if the folder is part of an ongoing RenameFolder operation. Contains information which can be used to query the operation status. The presence of this field also indicates all write operations are blocked for this folder, including folder, managed folder, and object operations.

.google.storage.control.v2.PendingRenameInfo pending_rename_info = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
PendingRenameInfoOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getUpdateTime()

public Timestamp getUpdateTime()

Output only. The modification time of the folder.

.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. The modification time of the folder.

.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

hasCreateTime()

public boolean hasCreateTime()

Output only. The creation time of the folder.

.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the createTime field is set.

hasPendingRenameInfo()

public boolean hasPendingRenameInfo()

Output only. Only present if the folder is part of an ongoing RenameFolder operation. Contains information which can be used to query the operation status. The presence of this field also indicates all write operations are blocked for this folder, including folder, managed folder, and object operations.

.google.storage.control.v2.PendingRenameInfo pending_rename_info = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the pendingRenameInfo field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. The modification time of the folder.

.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the updateTime field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Folder.Builder newBuilderForType()
Returns
Type Description
Folder.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Folder.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Folder.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public Folder.Builder toBuilder()
Returns
Type Description
Folder.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException