Interface UpdateObjectRequestOrBuilder (2.20.2)

Version 2.20.2

• 2.44.1 (latest)
• 2.43.2
• 2.42.0
• 2.41.0
• 2.40.1
• 2.39.0
• 2.38.0
• 2.37.0
• 2.36.1
• 2.34.0
• 2.33.0
• 2.32.1
• 2.30.1
• 2.29.1
• 2.28.0
• 2.27.1
• 2.24.0
• 2.23.0
• 2.22.6
• 2.21.0
• 2.20.2
• 2.19.0
• 2.18.0
• 2.17.2
• 2.16.0
• 2.15.1
• 2.14.0
• 2.13.1
• 2.12.0
• 2.11.3
• 2.10.0
• 2.9.3
• 2.8.1
• 2.7.1
• 2.6.1
• 2.5.1
• 2.4.5
• 2.3.0
• 2.2.3
• 2.1.10

public interface UpdateObjectRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getCommonObjectRequestParams()

public abstract 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.

getCommonObjectRequestParamsOrBuilder()

public abstract 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

getIfGenerationMatch()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract Object getObject()

Required. 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 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
Object	The object.

getObjectOrBuilder()

public abstract ObjectOrBuilder getObjectOrBuilder()

Required. 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 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
ObjectOrBuilder

getPredefinedAcl()

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

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

Returns
Type	Description
FieldMask	The updateMask.

getUpdateMaskOrBuilder()

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

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

Returns
Type	Description
FieldMaskOrBuilder

hasCommonObjectRequestParams()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract boolean hasObject()

Required. 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 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
boolean	Whether the object field is set.

hasUpdateMask()

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

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

Returns
Type	Description
boolean	Whether the updateMask field is set.