Class GetFolderRequest.Builder (2.39.0)

public static final class GetFolderRequest.Builder extends GeneratedMessageV3.Builder<GetFolderRequest.Builder> 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

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public GetFolderRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
GetFolderRequest.Builder
Overrides

build()

public GetFolderRequest build()
Returns
Type Description
GetFolderRequest

buildPartial()

public GetFolderRequest buildPartial()
Returns
Type Description
GetFolderRequest

clear()

public GetFolderRequest.Builder clear()
Returns
Type Description
GetFolderRequest.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public GetFolderRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
GetFolderRequest.Builder
Overrides

clearIfMetagenerationMatch()

public GetFolderRequest.Builder clearIfMetagenerationMatch()

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
GetFolderRequest.Builder

This builder for chaining.

clearIfMetagenerationNotMatch()

public GetFolderRequest.Builder clearIfMetagenerationNotMatch()

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
GetFolderRequest.Builder

This builder for chaining.

clearName()

public GetFolderRequest.Builder clearName()

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
GetFolderRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public GetFolderRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
GetFolderRequest.Builder
Overrides

clearRequestId()

public GetFolderRequest.Builder clearRequestId()

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
GetFolderRequest.Builder

This builder for chaining.

clone()

public GetFolderRequest.Builder clone()
Returns
Type Description
GetFolderRequest.Builder
Overrides

getDefaultInstanceForType()

public GetFolderRequest getDefaultInstanceForType()
Returns
Type Description
GetFolderRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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.

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.

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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public GetFolderRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GetFolderRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public GetFolderRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
GetFolderRequest.Builder
Overrides

mergeFrom(GetFolderRequest other)

public GetFolderRequest.Builder mergeFrom(GetFolderRequest other)
Parameter
Name Description
other GetFolderRequest
Returns
Type Description
GetFolderRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final GetFolderRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
GetFolderRequest.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public GetFolderRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
GetFolderRequest.Builder
Overrides

setIfMetagenerationMatch(long value)

public GetFolderRequest.Builder setIfMetagenerationMatch(long value)

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

optional int64 if_metageneration_match = 3;

Parameter
Name Description
value long

The ifMetagenerationMatch to set.

Returns
Type Description
GetFolderRequest.Builder

This builder for chaining.

setIfMetagenerationNotMatch(long value)

public GetFolderRequest.Builder setIfMetagenerationNotMatch(long value)

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;

Parameter
Name Description
value long

The ifMetagenerationNotMatch to set.

Returns
Type Description
GetFolderRequest.Builder

This builder for chaining.

setName(String value)

public GetFolderRequest.Builder setName(String value)

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

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

Parameter
Name Description
value String

The name to set.

Returns
Type Description
GetFolderRequest.Builder

This builder for chaining.

setNameBytes(ByteString value)

public GetFolderRequest.Builder setNameBytes(ByteString value)

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

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

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
GetFolderRequest.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public GetFolderRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
GetFolderRequest.Builder
Overrides

setRequestId(String value)

public GetFolderRequest.Builder setRequestId(String value)

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) = { ... }

Parameter
Name Description
value String

The requestId to set.

Returns
Type Description
GetFolderRequest.Builder

This builder for chaining.

setRequestIdBytes(ByteString value)

public GetFolderRequest.Builder setRequestIdBytes(ByteString value)

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) = { ... }

Parameter
Name Description
value ByteString

The bytes for requestId to set.

Returns
Type Description
GetFolderRequest.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final GetFolderRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
GetFolderRequest.Builder
Overrides