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
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
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()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static CreateFolderRequest.Builder newBuilder()
newBuilder(CreateFolderRequest prototype)
public static CreateFolderRequest.Builder newBuilder(CreateFolderRequest prototype)
public static CreateFolderRequest parseDelimitedFrom(InputStream input)
public static CreateFolderRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static CreateFolderRequest parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static CreateFolderRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static CreateFolderRequest parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static CreateFolderRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static CreateFolderRequest parseFrom(CodedInputStream input)
public static CreateFolderRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static CreateFolderRequest parseFrom(InputStream input)
public static CreateFolderRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static CreateFolderRequest parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static CreateFolderRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<CreateFolderRequest> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getDefaultInstanceForType()
public CreateFolderRequest getDefaultInstanceForType()
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];
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()
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()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public CreateFolderRequest.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected CreateFolderRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public CreateFolderRequest.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
