Class UpdateBucketRequest (2.36.1)

public final class UpdateBucketRequest extends GeneratedMessageV3 implements UpdateBucketRequestOrBuilder

Request for UpdateBucket method.

Protobuf type google.storage.v2.UpdateBucketRequest

Static Fields

BUCKET_FIELD_NUMBER

public static final int BUCKET_FIELD_NUMBER
Field Value
TypeDescription
int

IF_METAGENERATION_MATCH_FIELD_NUMBER

public static final int IF_METAGENERATION_MATCH_FIELD_NUMBER
Field Value
TypeDescription
int

IF_METAGENERATION_NOT_MATCH_FIELD_NUMBER

public static final int IF_METAGENERATION_NOT_MATCH_FIELD_NUMBER
Field Value
TypeDescription
int

PREDEFINED_ACL_FIELD_NUMBER

public static final int PREDEFINED_ACL_FIELD_NUMBER
Field Value
TypeDescription
int

PREDEFINED_DEFAULT_OBJECT_ACL_FIELD_NUMBER

public static final int PREDEFINED_DEFAULT_OBJECT_ACL_FIELD_NUMBER
Field Value
TypeDescription
int

UPDATE_MASK_FIELD_NUMBER

public static final int UPDATE_MASK_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static UpdateBucketRequest getDefaultInstance()
Returns
TypeDescription
UpdateBucketRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static UpdateBucketRequest.Builder newBuilder()
Returns
TypeDescription
UpdateBucketRequest.Builder

newBuilder(UpdateBucketRequest prototype)

public static UpdateBucketRequest.Builder newBuilder(UpdateBucketRequest prototype)
Parameter
NameDescription
prototypeUpdateBucketRequest
Returns
TypeDescription
UpdateBucketRequest.Builder

parseDelimitedFrom(InputStream input)

public static UpdateBucketRequest parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
UpdateBucketRequest
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static UpdateBucketRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
UpdateBucketRequest
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static UpdateBucketRequest parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
UpdateBucketRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static UpdateBucketRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
UpdateBucketRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static UpdateBucketRequest parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
UpdateBucketRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static UpdateBucketRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
UpdateBucketRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static UpdateBucketRequest parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
UpdateBucketRequest
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static UpdateBucketRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
UpdateBucketRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static UpdateBucketRequest parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
UpdateBucketRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static UpdateBucketRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
UpdateBucketRequest
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static UpdateBucketRequest parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
UpdateBucketRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static UpdateBucketRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
UpdateBucketRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<UpdateBucketRequest> parser()
Returns
TypeDescription
Parser<UpdateBucketRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getBucket()

public Bucket getBucket()

Required. The bucket to update. The bucket's name field will be used to identify the bucket.

.google.storage.v2.Bucket bucket = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
Bucket

The bucket.

getBucketOrBuilder()

public BucketOrBuilder getBucketOrBuilder()

Required. The bucket to update. The bucket's name field will be used to identify the bucket.

.google.storage.v2.Bucket bucket = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
BucketOrBuilder

getDefaultInstanceForType()

public UpdateBucketRequest getDefaultInstanceForType()
Returns
TypeDescription
UpdateBucketRequest

getIfMetagenerationMatch()

public long getIfMetagenerationMatch()

If set, will only modify the bucket if its metageneration matches this value.

optional int64 if_metageneration_match = 2;

Returns
TypeDescription
long

The ifMetagenerationMatch.

getIfMetagenerationNotMatch()

public long getIfMetagenerationNotMatch()

If set, will only modify the bucket if its metageneration does not match this value.

optional int64 if_metageneration_not_match = 3;

Returns
TypeDescription
long

The ifMetagenerationNotMatch.

getParserForType()

public Parser<UpdateBucketRequest> getParserForType()
Returns
TypeDescription
Parser<UpdateBucketRequest>
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 = 8;

Returns
TypeDescription
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 = 8;

Returns
TypeDescription
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 = 9;

Returns
TypeDescription
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 = 9;

Returns
TypeDescription
ByteString

The bytes for predefinedDefaultObjectAcl.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getUpdateMask()

public FieldMask getUpdateMask()

Required. List of fields to be updated.

To specify ALL fields, equivalent to the JSON API's "update" function, specify a single field with the value . Note: not recommended. If a new field is introduced at a later time, an older client updating with the may accidentally reset the new field's value.

Not specifying any fields is an error.

.google.protobuf.FieldMask update_mask = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
FieldMask

The updateMask.

getUpdateMaskOrBuilder()

public FieldMaskOrBuilder getUpdateMaskOrBuilder()

Required. List of fields to be updated.

To specify ALL fields, equivalent to the JSON API's "update" function, specify a single field with the value . Note: not recommended. If a new field is introduced at a later time, an older client updating with the may accidentally reset the new field's value.

Not specifying any fields is an error.

.google.protobuf.FieldMask update_mask = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
FieldMaskOrBuilder

hasBucket()

public boolean hasBucket()

Required. The bucket to update. The bucket's name field will be used to identify the bucket.

.google.storage.v2.Bucket bucket = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
boolean

Whether the bucket field is set.

hasIfMetagenerationMatch()

public boolean hasIfMetagenerationMatch()

If set, will only modify the bucket if its metageneration matches this value.

optional int64 if_metageneration_match = 2;

Returns
TypeDescription
boolean

Whether the ifMetagenerationMatch field is set.

hasIfMetagenerationNotMatch()

public boolean hasIfMetagenerationNotMatch()

If set, will only modify the bucket if its metageneration does not match this value.

optional int64 if_metageneration_not_match = 3;

Returns
TypeDescription
boolean

Whether the ifMetagenerationNotMatch field is set.

hasUpdateMask()

public boolean hasUpdateMask()

Required. List of fields to be updated.

To specify ALL fields, equivalent to the JSON API's "update" function, specify a single field with the value . Note: not recommended. If a new field is introduced at a later time, an older client updating with the may accidentally reset the new field's value.

Not specifying any fields is an error.

.google.protobuf.FieldMask update_mask = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
boolean

Whether the updateMask field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public UpdateBucketRequest.Builder newBuilderForType()
Returns
TypeDescription
UpdateBucketRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected UpdateBucketRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
UpdateBucketRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public UpdateBucketRequest.Builder toBuilder()
Returns
TypeDescription
UpdateBucketRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException