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

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > RenameFolderRequest.Builder

Implements

RenameFolderRequestOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

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

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

GeneratedMessageV3.Builder<BuilderType>.clear()

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

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

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

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

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

GeneratedMessageV3.Builder<BuilderType>.clone()

getDefaultInstanceForType()

public RenameFolderRequest getDefaultInstanceForType()

Returns
Type	Description
`RenameFolderRequest`

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
`Descriptor`

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

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

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

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

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
`IOException`

mergeFrom(Message other)

public RenameFolderRequest.Builder mergeFrom(Message other)

Parameter
Name	Description
`other`	`Message`

Returns
Type	Description
`RenameFolderRequest.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

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

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

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

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

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

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

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

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)