Class CreateBucketRequest (2.38.0)

public final class CreateBucketRequest extends GeneratedMessageV3 implements CreateBucketRequestOrBuilder

Request message for CreateBucket.

Protobuf type google.storage.v2.CreateBucketRequest

Static Fields

BUCKET_FIELD_NUMBER

public static final int BUCKET_FIELD_NUMBER
Field Value
Type Description
int

BUCKET_ID_FIELD_NUMBER

public static final int BUCKET_ID_FIELD_NUMBER
Field Value
Type Description
int

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER
Field Value
Type Description
int

PREDEFINED_ACL_FIELD_NUMBER

public static final int PREDEFINED_ACL_FIELD_NUMBER
Field Value
Type Description
int

PREDEFINED_DEFAULT_OBJECT_ACL_FIELD_NUMBER

public static final int PREDEFINED_DEFAULT_OBJECT_ACL_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static CreateBucketRequest getDefaultInstance()
Returns
Type Description
CreateBucketRequest

getDescriptor()

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

newBuilder()

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

newBuilder(CreateBucketRequest prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getBucket()

public Bucket getBucket()

Properties of the new bucket being inserted. The name of the bucket is specified in the bucket_id field. Populating bucket.name field will result in an error. The project of the bucket must be specified in the bucket.project field. This field must be in projects/{projectIdentifier} format, {projectIdentifier} can be the project ID or project number. The parent field must be either empty or projects/_.

.google.storage.v2.Bucket bucket = 2;

Returns
Type Description
Bucket

The bucket.

getBucketId()

public String getBucketId()

Required. The ID to use for this bucket, which will become the final component of the bucket's resource name. For example, the value foo might result in a bucket with the name projects/123456/buckets/foo.

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

Returns
Type Description
String

The bucketId.

getBucketIdBytes()

public ByteString getBucketIdBytes()

Required. The ID to use for this bucket, which will become the final component of the bucket's resource name. For example, the value foo might result in a bucket with the name projects/123456/buckets/foo.

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

Returns
Type Description
ByteString

The bytes for bucketId.

getBucketOrBuilder()

public BucketOrBuilder getBucketOrBuilder()

Properties of the new bucket being inserted. The name of the bucket is specified in the bucket_id field. Populating bucket.name field will result in an error. The project of the bucket must be specified in the bucket.project field. This field must be in projects/{projectIdentifier} format, {projectIdentifier} can be the project ID or project number. The parent field must be either empty or projects/_.

.google.storage.v2.Bucket bucket = 2;

Returns
Type Description
BucketOrBuilder

getDefaultInstanceForType()

public CreateBucketRequest getDefaultInstanceForType()
Returns
Type Description
CreateBucketRequest

getParent()

public String getParent()

Required. The project to which this bucket will belong.

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

Returns
Type Description
String

The parent.

getParentBytes()

public ByteString getParentBytes()

Required. The project to which this bucket will belong.

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

Returns
Type Description
ByteString

The bytes for parent.

getParserForType()

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

getPredefinedAcl()

public String getPredefinedAcl()

Apply a predefined set of access controls to this bucket. Valid values are "authenticatedRead", "private", "projectPrivate", "publicRead", or "publicReadWrite".

string predefined_acl = 6;

Returns
Type Description
String

The predefinedAcl.

getPredefinedAclBytes()

public ByteString getPredefinedAclBytes()

Apply a predefined set of access controls to this bucket. Valid values are "authenticatedRead", "private", "projectPrivate", "publicRead", or "publicReadWrite".

string predefined_acl = 6;

Returns
Type Description
ByteString

The bytes for predefinedAcl.

getPredefinedDefaultObjectAcl()

public String getPredefinedDefaultObjectAcl()

Apply a predefined set of default object access controls to this bucket. Valid values are "authenticatedRead", "bucketOwnerFullControl", "bucketOwnerRead", "private", "projectPrivate", or "publicRead".

string predefined_default_object_acl = 7;

Returns
Type Description
String

The predefinedDefaultObjectAcl.

getPredefinedDefaultObjectAclBytes()

public ByteString getPredefinedDefaultObjectAclBytes()

Apply a predefined set of default object access controls to this bucket. Valid values are "authenticatedRead", "bucketOwnerFullControl", "bucketOwnerRead", "private", "projectPrivate", or "publicRead".

string predefined_default_object_acl = 7;

Returns
Type Description
ByteString

The bytes for predefinedDefaultObjectAcl.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasBucket()

public boolean hasBucket()

Properties of the new bucket being inserted. The name of the bucket is specified in the bucket_id field. Populating bucket.name field will result in an error. The project of the bucket must be specified in the bucket.project field. This field must be in projects/{projectIdentifier} format, {projectIdentifier} can be the project ID or project number. The parent field must be either empty or projects/_.

.google.storage.v2.Bucket bucket = 2;

Returns
Type Description
boolean

Whether the bucket 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 CreateBucketRequest.Builder newBuilderForType()
Returns
Type Description
CreateBucketRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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