Class GetFolderRequest (2.39.0) 

public final class GetFolderRequest extends GeneratedMessageV3 implements GetFolderRequestOrBuilder

Request message for GetFolder. This operation is only applicable to a hierarchical namespace enabled bucket. Hierarchical namespace buckets are in allowlist preview.

Protobuf type google.storage.control.v2.GetFolderRequest

Inheritance

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

Static Fields

IF_METAGENERATION_MATCH_FIELD_NUMBER

public static final int IF_METAGENERATION_MATCH_FIELD_NUMBER
Field Value
Type Description
int

IF_METAGENERATION_NOT_MATCH_FIELD_NUMBER

public static final int IF_METAGENERATION_NOT_MATCH_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

REQUEST_ID_FIELD_NUMBER

public static final int REQUEST_ID_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static GetFolderRequest getDefaultInstance()
Returns
Type Description
GetFolderRequest

getDescriptor()

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

newBuilder()

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

newBuilder(GetFolderRequest prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public GetFolderRequest getDefaultInstanceForType()
Returns
Type Description
GetFolderRequest

getIfMetagenerationMatch()

public long getIfMetagenerationMatch()

Makes the operation only succeed conditional on whether the folder's current metageneration matches the given value.

optional int64 if_metageneration_match = 3;

Returns
Type Description
long

The ifMetagenerationMatch.

getIfMetagenerationNotMatch()

public long getIfMetagenerationNotMatch()

Makes the operation only succeed conditional on whether the folder's current metageneration does not match the given value.

optional int64 if_metageneration_not_match = 4;

Returns
Type Description
long

The ifMetagenerationNotMatch.

getName()

public String getName()

Required. Name of the folder. Format: projects/{project}/buckets/{bucket}/folders/{folder}

string name = 6 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Required. Name of the folder. Format: projects/{project}/buckets/{bucket}/folders/{folder}

string name = 6 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

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

getRequestId()

public String getRequestId()

Optional. A unique identifier for this request. UUID is the recommended format, but other formats are still accepted.

string request_id = 5 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_info) = { ... }

Returns
Type Description
String

The requestId.

getRequestIdBytes()

public ByteString getRequestIdBytes()

Optional. A unique identifier for this request. UUID is the recommended format, but other formats are still accepted.

string request_id = 5 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_info) = { ... }

Returns
Type Description
ByteString

The bytes for requestId.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasIfMetagenerationMatch()

public boolean hasIfMetagenerationMatch()

Makes the operation only succeed conditional on whether the folder's current metageneration matches the given value.

optional int64 if_metageneration_match = 3;

Returns
Type Description
boolean

Whether the ifMetagenerationMatch field is set.

hasIfMetagenerationNotMatch()

public boolean hasIfMetagenerationNotMatch()

Makes the operation only succeed conditional on whether the folder's current metageneration does not match the given value.

optional int64 if_metageneration_not_match = 4;

Returns
Type Description
boolean

Whether the ifMetagenerationNotMatch 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 GetFolderRequest.Builder newBuilderForType()
Returns
Type Description
GetFolderRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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