Class UpdateObjectRequest.Builder (2.11.3) 

public static final class UpdateObjectRequest.Builder extends GeneratedMessageV3.Builder<UpdateObjectRequest.Builder> implements UpdateObjectRequestOrBuilder

Request message for UpdateObject.

Protobuf type google.storage.v2.UpdateObjectRequest

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > UpdateObjectRequest.Builder

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public UpdateObjectRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
UpdateObjectRequest.Builder
Overrides

build()

public UpdateObjectRequest build()
Returns
Type Description
UpdateObjectRequest

buildPartial()

public UpdateObjectRequest buildPartial()
Returns
Type Description
UpdateObjectRequest

clear()

public UpdateObjectRequest.Builder clear()
Returns
Type Description
UpdateObjectRequest.Builder
Overrides

clearCommonObjectRequestParams()

public UpdateObjectRequest.Builder clearCommonObjectRequestParams()

A set of parameters common to Storage API requests concerning an object.

.google.storage.v2.CommonObjectRequestParams common_object_request_params = 8;

Returns
Type Description
UpdateObjectRequest.Builder

clearField(Descriptors.FieldDescriptor field)

public UpdateObjectRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
UpdateObjectRequest.Builder
Overrides

clearIfGenerationMatch()

public UpdateObjectRequest.Builder clearIfGenerationMatch()

Makes the operation conditional on whether the object's current generation matches the given value. Setting to 0 makes the operation succeed only if there are no live versions of the object.

optional int64 if_generation_match = 2;

Returns
Type Description
UpdateObjectRequest.Builder

This builder for chaining.

clearIfGenerationNotMatch()

public UpdateObjectRequest.Builder clearIfGenerationNotMatch()

Makes the operation conditional on whether the object's live generation does not match the given value. If no live object exists, the precondition fails. Setting to 0 makes the operation succeed only if there is a live version of the object.

optional int64 if_generation_not_match = 3;

Returns
Type Description
UpdateObjectRequest.Builder

This builder for chaining.

clearIfMetagenerationMatch()

public UpdateObjectRequest.Builder clearIfMetagenerationMatch()

Makes the operation conditional on whether the object's current metageneration matches the given value.

optional int64 if_metageneration_match = 4;

Returns
Type Description
UpdateObjectRequest.Builder

This builder for chaining.

clearIfMetagenerationNotMatch()

public UpdateObjectRequest.Builder clearIfMetagenerationNotMatch()

Makes the operation conditional on whether the object's current metageneration does not match the given value.

optional int64 if_metageneration_not_match = 5;

Returns
Type Description
UpdateObjectRequest.Builder

This builder for chaining.

clearObject()

public UpdateObjectRequest.Builder clearObject()

The object to update. The object's bucket and name fields are used to identify the object to update. If present, the object's generation field selects a specific revision of this object whose metadata should be updated. Otherwise, assumes the live version of the object.

.google.storage.v2.Object object = 1;

Returns
Type Description
UpdateObjectRequest.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public UpdateObjectRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
UpdateObjectRequest.Builder
Overrides

clearPredefinedAcl()

public UpdateObjectRequest.Builder clearPredefinedAcl()

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

string predefined_acl = 10;

Returns
Type Description
UpdateObjectRequest.Builder

This builder for chaining.

clearUpdateMask()

public UpdateObjectRequest.Builder clearUpdateMask()

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. Not specifying a field while setting that field to a non-default value is an error.

.google.protobuf.FieldMask update_mask = 7;

Returns
Type Description
UpdateObjectRequest.Builder

clone()

public UpdateObjectRequest.Builder clone()
Returns
Type Description
UpdateObjectRequest.Builder
Overrides

getCommonObjectRequestParams()

public CommonObjectRequestParams getCommonObjectRequestParams()

A set of parameters common to Storage API requests concerning an object.

.google.storage.v2.CommonObjectRequestParams common_object_request_params = 8;

Returns
Type Description
CommonObjectRequestParams

The commonObjectRequestParams.

getCommonObjectRequestParamsBuilder()

public CommonObjectRequestParams.Builder getCommonObjectRequestParamsBuilder()

A set of parameters common to Storage API requests concerning an object.

.google.storage.v2.CommonObjectRequestParams common_object_request_params = 8;

Returns
Type Description
CommonObjectRequestParams.Builder

getCommonObjectRequestParamsOrBuilder()

public CommonObjectRequestParamsOrBuilder getCommonObjectRequestParamsOrBuilder()

A set of parameters common to Storage API requests concerning an object.

.google.storage.v2.CommonObjectRequestParams common_object_request_params = 8;

Returns
Type Description
CommonObjectRequestParamsOrBuilder

getDefaultInstanceForType()

public UpdateObjectRequest getDefaultInstanceForType()
Returns
Type Description
UpdateObjectRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getIfGenerationMatch()

public long getIfGenerationMatch()

Makes the operation conditional on whether the object's current generation matches the given value. Setting to 0 makes the operation succeed only if there are no live versions of the object.

optional int64 if_generation_match = 2;

Returns
Type Description
long

The ifGenerationMatch.

getIfGenerationNotMatch()

public long getIfGenerationNotMatch()

Makes the operation conditional on whether the object's live generation does not match the given value. If no live object exists, the precondition fails. Setting to 0 makes the operation succeed only if there is a live version of the object.

optional int64 if_generation_not_match = 3;

Returns
Type Description
long

The ifGenerationNotMatch.

getIfMetagenerationMatch()

public long getIfMetagenerationMatch()

Makes the operation conditional on whether the object's current metageneration matches the given value.

optional int64 if_metageneration_match = 4;

Returns
Type Description
long

The ifMetagenerationMatch.

getIfMetagenerationNotMatch()

public long getIfMetagenerationNotMatch()

Makes the operation conditional on whether the object's current metageneration does not match the given value.

optional int64 if_metageneration_not_match = 5;

Returns
Type Description
long

The ifMetagenerationNotMatch.

getObject()

public Object getObject()

The object to update. The object's bucket and name fields are used to identify the object to update. If present, the object's generation field selects a specific revision of this object whose metadata should be updated. Otherwise, assumes the live version of the object.

.google.storage.v2.Object object = 1;

Returns
Type Description
Object

The object.

getObjectBuilder()

public Object.Builder getObjectBuilder()

The object to update. The object's bucket and name fields are used to identify the object to update. If present, the object's generation field selects a specific revision of this object whose metadata should be updated. Otherwise, assumes the live version of the object.

.google.storage.v2.Object object = 1;

Returns
Type Description
Object.Builder

getObjectOrBuilder()

public ObjectOrBuilder getObjectOrBuilder()

The object to update. The object's bucket and name fields are used to identify the object to update. If present, the object's generation field selects a specific revision of this object whose metadata should be updated. Otherwise, assumes the live version of the object.

.google.storage.v2.Object object = 1;

Returns
Type Description
ObjectOrBuilder

getPredefinedAcl()

public String getPredefinedAcl()

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

string predefined_acl = 10;

Returns
Type Description
String

The predefinedAcl.

getPredefinedAclBytes()

public ByteString getPredefinedAclBytes()

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

string predefined_acl = 10;

Returns
Type Description
ByteString

The bytes for predefinedAcl.

getUpdateMask()

public FieldMask getUpdateMask()

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. Not specifying a field while setting that field to a non-default value is an error.

.google.protobuf.FieldMask update_mask = 7;

Returns
Type Description
FieldMask

The updateMask.

getUpdateMaskBuilder()

public FieldMask.Builder getUpdateMaskBuilder()

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. Not specifying a field while setting that field to a non-default value is an error.

.google.protobuf.FieldMask update_mask = 7;

Returns
Type Description
Builder

getUpdateMaskOrBuilder()

public FieldMaskOrBuilder getUpdateMaskOrBuilder()

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. Not specifying a field while setting that field to a non-default value is an error.

.google.protobuf.FieldMask update_mask = 7;

Returns
Type Description
FieldMaskOrBuilder

hasCommonObjectRequestParams()

public boolean hasCommonObjectRequestParams()

A set of parameters common to Storage API requests concerning an object.

.google.storage.v2.CommonObjectRequestParams common_object_request_params = 8;

Returns
Type Description
boolean

Whether the commonObjectRequestParams field is set.

hasIfGenerationMatch()

public boolean hasIfGenerationMatch()

Makes the operation conditional on whether the object's current generation matches the given value. Setting to 0 makes the operation succeed only if there are no live versions of the object.

optional int64 if_generation_match = 2;

Returns
Type Description
boolean

Whether the ifGenerationMatch field is set.

hasIfGenerationNotMatch()

public boolean hasIfGenerationNotMatch()

Makes the operation conditional on whether the object's live generation does not match the given value. If no live object exists, the precondition fails. Setting to 0 makes the operation succeed only if there is a live version of the object.

optional int64 if_generation_not_match = 3;

Returns
Type Description
boolean

Whether the ifGenerationNotMatch field is set.

hasIfMetagenerationMatch()

public boolean hasIfMetagenerationMatch()

Makes the operation conditional on whether the object's current metageneration matches the given value.

optional int64 if_metageneration_match = 4;

Returns
Type Description
boolean

Whether the ifMetagenerationMatch field is set.

hasIfMetagenerationNotMatch()

public boolean hasIfMetagenerationNotMatch()

Makes the operation conditional on whether the object's current metageneration does not match the given value.

optional int64 if_metageneration_not_match = 5;

Returns
Type Description
boolean

Whether the ifMetagenerationNotMatch field is set.

hasObject()

public boolean hasObject()

The object to update. The object's bucket and name fields are used to identify the object to update. If present, the object's generation field selects a specific revision of this object whose metadata should be updated. Otherwise, assumes the live version of the object.

.google.storage.v2.Object object = 1;

Returns
Type Description
boolean

Whether the object field is set.

hasUpdateMask()

public boolean hasUpdateMask()

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. Not specifying a field while setting that field to a non-default value is an error.

.google.protobuf.FieldMask update_mask = 7;

Returns
Type Description
boolean

Whether the updateMask field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeCommonObjectRequestParams(CommonObjectRequestParams value)

public UpdateObjectRequest.Builder mergeCommonObjectRequestParams(CommonObjectRequestParams value)

A set of parameters common to Storage API requests concerning an object.

.google.storage.v2.CommonObjectRequestParams common_object_request_params = 8;

Parameter
Name Description
value CommonObjectRequestParams
Returns
Type Description
UpdateObjectRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public UpdateObjectRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
UpdateObjectRequest.Builder
Overrides Exceptions
Type Description
IOException

mergeFrom(Message other)

public UpdateObjectRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
UpdateObjectRequest.Builder
Overrides

mergeFrom(UpdateObjectRequest other)

public UpdateObjectRequest.Builder mergeFrom(UpdateObjectRequest other)
Parameter
Name Description
other UpdateObjectRequest
Returns
Type Description
UpdateObjectRequest.Builder

mergeObject(Object value)

public UpdateObjectRequest.Builder mergeObject(Object value)

The object to update. The object's bucket and name fields are used to identify the object to update. If present, the object's generation field selects a specific revision of this object whose metadata should be updated. Otherwise, assumes the live version of the object.

.google.storage.v2.Object object = 1;

Parameter
Name Description
value Object
Returns
Type Description
UpdateObjectRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final UpdateObjectRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
UpdateObjectRequest.Builder
Overrides

mergeUpdateMask(FieldMask value)

public UpdateObjectRequest.Builder mergeUpdateMask(FieldMask value)

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. Not specifying a field while setting that field to a non-default value is an error.

.google.protobuf.FieldMask update_mask = 7;

Parameter
Name Description
value FieldMask
Returns
Type Description
UpdateObjectRequest.Builder

setCommonObjectRequestParams(CommonObjectRequestParams value)

public UpdateObjectRequest.Builder setCommonObjectRequestParams(CommonObjectRequestParams value)

A set of parameters common to Storage API requests concerning an object.

.google.storage.v2.CommonObjectRequestParams common_object_request_params = 8;

Parameter
Name Description
value CommonObjectRequestParams
Returns
Type Description
UpdateObjectRequest.Builder

setCommonObjectRequestParams(CommonObjectRequestParams.Builder builderForValue)

public UpdateObjectRequest.Builder setCommonObjectRequestParams(CommonObjectRequestParams.Builder builderForValue)

A set of parameters common to Storage API requests concerning an object.

.google.storage.v2.CommonObjectRequestParams common_object_request_params = 8;

Parameter
Name Description
builderForValue CommonObjectRequestParams.Builder
Returns
Type Description
UpdateObjectRequest.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public UpdateObjectRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
UpdateObjectRequest.Builder
Overrides

setIfGenerationMatch(long value)

public UpdateObjectRequest.Builder setIfGenerationMatch(long value)

Makes the operation conditional on whether the object's current generation matches the given value. Setting to 0 makes the operation succeed only if there are no live versions of the object.

optional int64 if_generation_match = 2;

Parameter
Name Description
value long

The ifGenerationMatch to set.
Returns
Type Description
UpdateObjectRequest.Builder

This builder for chaining.

setIfGenerationNotMatch(long value)

public UpdateObjectRequest.Builder setIfGenerationNotMatch(long value)

Makes the operation conditional on whether the object's live generation does not match the given value. If no live object exists, the precondition fails. Setting to 0 makes the operation succeed only if there is a live version of the object.

optional int64 if_generation_not_match = 3;

Parameter
Name Description
value long

The ifGenerationNotMatch to set.
Returns
Type Description
UpdateObjectRequest.Builder

This builder for chaining.

setIfMetagenerationMatch(long value)

public UpdateObjectRequest.Builder setIfMetagenerationMatch(long value)

Makes the operation conditional on whether the object's current metageneration matches the given value.

optional int64 if_metageneration_match = 4;

Parameter
Name Description
value long

The ifMetagenerationMatch to set.
Returns
Type Description
UpdateObjectRequest.Builder

This builder for chaining.

setIfMetagenerationNotMatch(long value)

public UpdateObjectRequest.Builder setIfMetagenerationNotMatch(long value)

Makes the operation conditional on whether the object's current metageneration does not match the given value.

optional int64 if_metageneration_not_match = 5;

Parameter
Name Description
value long

The ifMetagenerationNotMatch to set.
Returns
Type Description
UpdateObjectRequest.Builder

This builder for chaining.

setObject(Object value)

public UpdateObjectRequest.Builder setObject(Object value)

The object to update. The object's bucket and name fields are used to identify the object to update. If present, the object's generation field selects a specific revision of this object whose metadata should be updated. Otherwise, assumes the live version of the object.

.google.storage.v2.Object object = 1;

Parameter
Name Description
value Object
Returns
Type Description
UpdateObjectRequest.Builder

setObject(Object.Builder builderForValue)

public UpdateObjectRequest.Builder setObject(Object.Builder builderForValue)

The object to update. The object's bucket and name fields are used to identify the object to update. If present, the object's generation field selects a specific revision of this object whose metadata should be updated. Otherwise, assumes the live version of the object.

.google.storage.v2.Object object = 1;

Parameter
Name Description
builderForValue Object.Builder
Returns
Type Description
UpdateObjectRequest.Builder

setPredefinedAcl(String value)

public UpdateObjectRequest.Builder setPredefinedAcl(String value)

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

string predefined_acl = 10;

Parameter
Name Description
value String

The predefinedAcl to set.
Returns
Type Description
UpdateObjectRequest.Builder

This builder for chaining.

setPredefinedAclBytes(ByteString value)

public UpdateObjectRequest.Builder setPredefinedAclBytes(ByteString value)

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

string predefined_acl = 10;

Parameter
Name Description
value ByteString

The bytes for predefinedAcl to set.
Returns
Type Description
UpdateObjectRequest.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public UpdateObjectRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
UpdateObjectRequest.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final UpdateObjectRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
UpdateObjectRequest.Builder
Overrides

setUpdateMask(FieldMask value)

public UpdateObjectRequest.Builder setUpdateMask(FieldMask value)

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. Not specifying a field while setting that field to a non-default value is an error.

.google.protobuf.FieldMask update_mask = 7;

Parameter
Name Description
value FieldMask
Returns
Type Description
UpdateObjectRequest.Builder

setUpdateMask(FieldMask.Builder builderForValue)

public UpdateObjectRequest.Builder setUpdateMask(FieldMask.Builder builderForValue)

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. Not specifying a field while setting that field to a non-default value is an error.

.google.protobuf.FieldMask update_mask = 7;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
UpdateObjectRequest.Builder