Class RenameFolderRequest.Builder (2.38.0)

public static final class RenameFolderRequest.Builder extends GeneratedMessageV3.Builder<RenameFolderRequest.Builder> implements RenameFolderRequestOrBuilder

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

Protobuf type google.storage.control.v2.RenameFolderRequest

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public RenameFolderRequest build()
Returns
Type Description
RenameFolderRequest

buildPartial()

public RenameFolderRequest buildPartial()
Returns
Type Description
RenameFolderRequest

clear()

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

clearDestinationFolderId()

public RenameFolderRequest.Builder clearDestinationFolderId()

Required. The destination folder ID, e.g. foo/bar/.

string destination_folder_id = 8 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
RenameFolderRequest.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

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

clearIfMetagenerationMatch()

public RenameFolderRequest.Builder clearIfMetagenerationMatch()

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

optional int64 if_metageneration_match = 4;

Returns
Type Description
RenameFolderRequest.Builder

This builder for chaining.

clearIfMetagenerationNotMatch()

public RenameFolderRequest.Builder clearIfMetagenerationNotMatch()

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

optional int64 if_metageneration_not_match = 5;

Returns
Type Description
RenameFolderRequest.Builder

This builder for chaining.

clearName()

public RenameFolderRequest.Builder clearName()

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

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

Returns
Type Description
RenameFolderRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearRequestId()

public RenameFolderRequest.Builder clearRequestId()

Optional. A unique identifier for this request. UUID is the recommended format, but other formats are still accepted. This request is only idempotent if a request_id is provided.

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

Returns
Type Description
RenameFolderRequest.Builder

This builder for chaining.

clone()

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

getDefaultInstanceForType()

public RenameFolderRequest getDefaultInstanceForType()
Returns
Type Description
RenameFolderRequest

getDescriptorForType()

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

getDestinationFolderId()

public String getDestinationFolderId()

Required. The destination folder ID, e.g. foo/bar/.

string destination_folder_id = 8 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The destinationFolderId.

getDestinationFolderIdBytes()

public ByteString getDestinationFolderIdBytes()

Required. The destination folder ID, e.g. foo/bar/.

string destination_folder_id = 8 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for destinationFolderId.

getIfMetagenerationMatch()

public long getIfMetagenerationMatch()

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

optional int64 if_metageneration_match = 4;

Returns
Type Description
long

The ifMetagenerationMatch.

getIfMetagenerationNotMatch()

public long getIfMetagenerationNotMatch()

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

optional int64 if_metageneration_not_match = 5;

Returns
Type Description
long

The ifMetagenerationNotMatch.

getName()

public String getName()

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

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

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

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

string name = 7 [(.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. This request is only idempotent if a request_id is provided.

string request_id = 6 [(.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. This request is only idempotent if a request_id is provided.

string request_id = 6 [(.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 source folder's current metageneration matches the given value.

optional int64 if_metageneration_match = 4;

Returns
Type Description
boolean

Whether the ifMetagenerationMatch field is set.

hasIfMetagenerationNotMatch()

public boolean hasIfMetagenerationNotMatch()

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

optional int64 if_metageneration_not_match = 5;

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 RenameFolderRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RenameFolderRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

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

mergeFrom(RenameFolderRequest other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setDestinationFolderId(String value)

public RenameFolderRequest.Builder setDestinationFolderId(String value)

Required. The destination folder ID, e.g. foo/bar/.

string destination_folder_id = 8 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value String

The destinationFolderId to set.

Returns
Type Description
RenameFolderRequest.Builder

This builder for chaining.

setDestinationFolderIdBytes(ByteString value)

public RenameFolderRequest.Builder setDestinationFolderIdBytes(ByteString value)

Required. The destination folder ID, e.g. foo/bar/.

string destination_folder_id = 8 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value ByteString

The bytes for destinationFolderId to set.

Returns
Type Description
RenameFolderRequest.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

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

setIfMetagenerationMatch(long value)

public RenameFolderRequest.Builder setIfMetagenerationMatch(long value)

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

optional int64 if_metageneration_match = 4;

Parameter
Name Description
value long

The ifMetagenerationMatch to set.

Returns
Type Description
RenameFolderRequest.Builder

This builder for chaining.

setIfMetagenerationNotMatch(long value)

public RenameFolderRequest.Builder setIfMetagenerationNotMatch(long value)

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

optional int64 if_metageneration_not_match = 5;

Parameter
Name Description
value long

The ifMetagenerationNotMatch to set.

Returns
Type Description
RenameFolderRequest.Builder

This builder for chaining.

setName(String value)

public RenameFolderRequest.Builder setName(String value)

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

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

Parameter
Name Description
value String

The name to set.

Returns
Type Description
RenameFolderRequest.Builder

This builder for chaining.

setNameBytes(ByteString value)

public RenameFolderRequest.Builder setNameBytes(ByteString value)

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

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

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
RenameFolderRequest.Builder

This builder for chaining.

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

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

setRequestId(String value)

public RenameFolderRequest.Builder setRequestId(String value)

Optional. A unique identifier for this request. UUID is the recommended format, but other formats are still accepted. This request is only idempotent if a request_id is provided.

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

Parameter
Name Description
value String

The requestId to set.

Returns
Type Description
RenameFolderRequest.Builder

This builder for chaining.

setRequestIdBytes(ByteString value)

public RenameFolderRequest.Builder setRequestIdBytes(ByteString value)

Optional. A unique identifier for this request. UUID is the recommended format, but other formats are still accepted. This request is only idempotent if a request_id is provided.

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

Parameter
Name Description
value ByteString

The bytes for requestId to set.

Returns
Type Description
RenameFolderRequest.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

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