Class CreateFolderRequest.Builder (2.40.0)

public static final class CreateFolderRequest.Builder extends GeneratedMessageV3.Builder<CreateFolderRequest.Builder> implements CreateFolderRequestOrBuilder

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

Protobuf type google.storage.control.v2.CreateFolderRequest

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public CreateFolderRequest build()
Returns
Type Description
CreateFolderRequest

buildPartial()

public CreateFolderRequest buildPartial()
Returns
Type Description
CreateFolderRequest

clear()

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

clearField(Descriptors.FieldDescriptor field)

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

clearFolder()

public CreateFolderRequest.Builder clearFolder()

Required. Properties of the new folder being created. The bucket and name of the folder are specified in the parent and folder_id fields, respectively. Populating those fields in folder will result in an error.

.google.storage.control.v2.Folder folder = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
CreateFolderRequest.Builder

clearFolderId()

public CreateFolderRequest.Builder clearFolderId()

Required. The full name of a folder, including all its parent folders. Folders use single '/' characters as a delimiter. The folder_id must end with a slash. For example, the folder_id of "books/biographies/" would create a new "biographies/" folder under the "books/" folder.

string folder_id = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
CreateFolderRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearParent()

public CreateFolderRequest.Builder clearParent()

Required. Name of the bucket in which the folder will reside. The bucket must be a hierarchical namespace enabled bucket.

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
CreateFolderRequest.Builder

This builder for chaining.

clearRecursive()

public CreateFolderRequest.Builder clearRecursive()

Optional. If true, parent folder doesn't have to be present and all missing ancestor folders will be created atomically.

bool recursive = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
CreateFolderRequest.Builder

This builder for chaining.

clearRequestId()

public CreateFolderRequest.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
CreateFolderRequest.Builder

This builder for chaining.

clone()

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

getDefaultInstanceForType()

public CreateFolderRequest getDefaultInstanceForType()
Returns
Type Description
CreateFolderRequest

getDescriptorForType()

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

getFolder()

public Folder getFolder()

Required. Properties of the new folder being created. The bucket and name of the folder are specified in the parent and folder_id fields, respectively. Populating those fields in folder will result in an error.

.google.storage.control.v2.Folder folder = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Folder

The folder.

getFolderBuilder()

public Folder.Builder getFolderBuilder()

Required. Properties of the new folder being created. The bucket and name of the folder are specified in the parent and folder_id fields, respectively. Populating those fields in folder will result in an error.

.google.storage.control.v2.Folder folder = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Folder.Builder

getFolderId()

public String getFolderId()

Required. The full name of a folder, including all its parent folders. Folders use single '/' characters as a delimiter. The folder_id must end with a slash. For example, the folder_id of "books/biographies/" would create a new "biographies/" folder under the "books/" folder.

string folder_id = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The folderId.

getFolderIdBytes()

public ByteString getFolderIdBytes()

Required. The full name of a folder, including all its parent folders. Folders use single '/' characters as a delimiter. The folder_id must end with a slash. For example, the folder_id of "books/biographies/" would create a new "biographies/" folder under the "books/" folder.

string folder_id = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for folderId.

getFolderOrBuilder()

public FolderOrBuilder getFolderOrBuilder()

Required. Properties of the new folder being created. The bucket and name of the folder are specified in the parent and folder_id fields, respectively. Populating those fields in folder will result in an error.

.google.storage.control.v2.Folder folder = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
FolderOrBuilder

getParent()

public String getParent()

Required. Name of the bucket in which the folder will reside. The bucket must be a hierarchical namespace enabled bucket.

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The parent.

getParentBytes()

public ByteString getParentBytes()

Required. Name of the bucket in which the folder will reside. The bucket must be a hierarchical namespace enabled bucket.

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for parent.

getRecursive()

public boolean getRecursive()

Optional. If true, parent folder doesn't have to be present and all missing ancestor folders will be created atomically.

bool recursive = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The recursive.

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.

hasFolder()

public boolean hasFolder()

Required. Properties of the new folder being created. The bucket and name of the folder are specified in the parent and folder_id fields, respectively. Populating those fields in folder will result in an error.

.google.storage.control.v2.Folder folder = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the folder field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFolder(Folder value)

public CreateFolderRequest.Builder mergeFolder(Folder value)

Required. Properties of the new folder being created. The bucket and name of the folder are specified in the parent and folder_id fields, respectively. Populating those fields in folder will result in an error.

.google.storage.control.v2.Folder folder = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value Folder
Returns
Type Description
CreateFolderRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeFrom(CreateFolderRequest other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setField(Descriptors.FieldDescriptor field, Object value)

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

setFolder(Folder value)

public CreateFolderRequest.Builder setFolder(Folder value)

Required. Properties of the new folder being created. The bucket and name of the folder are specified in the parent and folder_id fields, respectively. Populating those fields in folder will result in an error.

.google.storage.control.v2.Folder folder = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value Folder
Returns
Type Description
CreateFolderRequest.Builder

setFolder(Folder.Builder builderForValue)

public CreateFolderRequest.Builder setFolder(Folder.Builder builderForValue)

Required. Properties of the new folder being created. The bucket and name of the folder are specified in the parent and folder_id fields, respectively. Populating those fields in folder will result in an error.

.google.storage.control.v2.Folder folder = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
builderForValue Folder.Builder
Returns
Type Description
CreateFolderRequest.Builder

setFolderId(String value)

public CreateFolderRequest.Builder setFolderId(String value)

Required. The full name of a folder, including all its parent folders. Folders use single '/' characters as a delimiter. The folder_id must end with a slash. For example, the folder_id of "books/biographies/" would create a new "biographies/" folder under the "books/" folder.

string folder_id = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value String

The folderId to set.

Returns
Type Description
CreateFolderRequest.Builder

This builder for chaining.

setFolderIdBytes(ByteString value)

public CreateFolderRequest.Builder setFolderIdBytes(ByteString value)

Required. The full name of a folder, including all its parent folders. Folders use single '/' characters as a delimiter. The folder_id must end with a slash. For example, the folder_id of "books/biographies/" would create a new "biographies/" folder under the "books/" folder.

string folder_id = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value ByteString

The bytes for folderId to set.

Returns
Type Description
CreateFolderRequest.Builder

This builder for chaining.

setParent(String value)

public CreateFolderRequest.Builder setParent(String value)

Required. Name of the bucket in which the folder will reside. The bucket must be a hierarchical namespace enabled bucket.

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The parent to set.

Returns
Type Description
CreateFolderRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public CreateFolderRequest.Builder setParentBytes(ByteString value)

Required. Name of the bucket in which the folder will reside. The bucket must be a hierarchical namespace enabled bucket.

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

The bytes for parent to set.

Returns
Type Description
CreateFolderRequest.Builder

This builder for chaining.

setRecursive(boolean value)

public CreateFolderRequest.Builder setRecursive(boolean value)

Optional. If true, parent folder doesn't have to be present and all missing ancestor folders will be created atomically.

bool recursive = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value boolean

The recursive to set.

Returns
Type Description
CreateFolderRequest.Builder

This builder for chaining.

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

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

setRequestId(String value)

public CreateFolderRequest.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
CreateFolderRequest.Builder

This builder for chaining.

setRequestIdBytes(ByteString value)

public CreateFolderRequest.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
CreateFolderRequest.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

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