Class UpdateBucketRequest (2.33.0)

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
Type Description
int

IF_METAGENERATION_MATCH_FIELD_NUMBER

public static final int IF_METAGENERATION_MATCH_FIELD_NUMBER
Field Value
Type Description
int

IF_METAGENERATION_NOT_MATCH_FIELD_NUMBER

public static final int IF_METAGENERATION_NOT_MATCH_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

UPDATE_MASK_FIELD_NUMBER

public static final int UPDATE_MASK_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static UpdateBucketRequest getDefaultInstance()
Returns
Type Description
UpdateBucketRequest

getDescriptor()

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

newBuilder()

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

newBuilder(UpdateBucketRequest prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
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
Type Description
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
Type Description
BucketOrBuilder

getDefaultInstanceForType()

public UpdateBucketRequest getDefaultInstanceForType()
Returns
Type Description
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
Type Description
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
Type Description
long

The ifMetagenerationNotMatch.

getParserForType()

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

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

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

Returns
Type Description
ByteString

The bytes for predefinedDefaultObjectAcl.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
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
Type Description
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
Type Description
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
Type Description
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
Type Description
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
Type Description
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
Type Description
boolean

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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