Class CreateFolderRequest (2.40.0)

public final class CreateFolderRequest extends GeneratedMessageV3 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 Fields

FOLDER_FIELD_NUMBER

public static final int FOLDER_FIELD_NUMBER
Field Value
Type Description
int

FOLDER_ID_FIELD_NUMBER

public static final int FOLDER_ID_FIELD_NUMBER
Field Value
Type Description
int

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER
Field Value
Type Description
int

RECURSIVE_FIELD_NUMBER

public static final int RECURSIVE_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 CreateFolderRequest getDefaultInstance()
Returns
Type Description
CreateFolderRequest

getDescriptor()

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

newBuilder()

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

newBuilder(CreateFolderRequest prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public CreateFolderRequest getDefaultInstanceForType()
Returns
Type Description
CreateFolderRequest

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.

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.

getParserForType()

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

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.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

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 CreateFolderRequest.Builder newBuilderForType()
Returns
Type Description
CreateFolderRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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