public static final class UpdateObjectRequest.Builder extends GeneratedMessageV3.Builder<UpdateObjectRequest.Builder> implements UpdateObjectRequestOrBuilderRequest message for UpdateObject.
Protobuf type google.storage.v2.UpdateObjectRequest
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > UpdateObjectRequest.BuilderImplements
UpdateObjectRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Type | Description |
| Descriptor |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public UpdateObjectRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Name | Description |
| field | FieldDescriptor |
| value | Object |
| Type | Description |
| UpdateObjectRequest.Builder |
build()
public UpdateObjectRequest build()| Type | Description |
| UpdateObjectRequest |
buildPartial()
public UpdateObjectRequest buildPartial()| Type | Description |
| UpdateObjectRequest |
clear()
public UpdateObjectRequest.Builder clear()| Type | Description |
| UpdateObjectRequest.Builder |
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;
| Type | Description |
| UpdateObjectRequest.Builder |
clearField(Descriptors.FieldDescriptor field)
public UpdateObjectRequest.Builder clearField(Descriptors.FieldDescriptor field)| Name | Description |
| field | FieldDescriptor |
| Type | Description |
| UpdateObjectRequest.Builder |
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;
| 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;
| 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;
| 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;
| Type | Description |
| UpdateObjectRequest.Builder | This builder for chaining. |
clearObject()
public UpdateObjectRequest.Builder clearObject()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];
| Type | Description |
| UpdateObjectRequest.Builder |
clearOneof(Descriptors.OneofDescriptor oneof)
public UpdateObjectRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Name | Description |
| oneof | OneofDescriptor |
| Type | Description |
| UpdateObjectRequest.Builder |
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;
| Type | Description |
| UpdateObjectRequest.Builder | This builder for chaining. |
clearUpdateMask()
public UpdateObjectRequest.Builder clearUpdateMask() 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];
| Type | Description |
| UpdateObjectRequest.Builder |
clone()
public UpdateObjectRequest.Builder clone()| Type | Description |
| UpdateObjectRequest.Builder |
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;
| 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;
| 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;
| Type | Description |
| CommonObjectRequestParamsOrBuilder |
getDefaultInstanceForType()
public UpdateObjectRequest getDefaultInstanceForType()| Type | Description |
| UpdateObjectRequest |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Type | Description |
| Descriptor |
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;
| 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;
| 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;
| 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;
| Type | Description |
| long | The ifMetagenerationNotMatch. |
getObject()
public 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];
| Type | Description |
| Object | The object. |
getObjectBuilder()
public Object.Builder getObjectBuilder()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];
| Type | Description |
| Object.Builder |
getObjectOrBuilder()
public 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];
| 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;
| 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;
| Type | Description |
| ByteString | The bytes for predefinedAcl. |
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.
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];
| Type | Description |
| FieldMask | The updateMask. |
getUpdateMaskBuilder()
public FieldMask.Builder getUpdateMaskBuilder() 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];
| Type | Description |
| Builder |
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.
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];
| 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;
| 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;
| 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;
| 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;
| 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;
| Type | Description |
| boolean | Whether the ifMetagenerationNotMatch field is set. |
hasObject()
public 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];
| Type | Description |
| boolean | Whether the object 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.
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];
| Type | Description |
| boolean | Whether the updateMask field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Type | Description |
| FieldAccessorTable |
isInitialized()
public final boolean isInitialized()| Type | Description |
| boolean |
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;
| Name | Description |
| value | CommonObjectRequestParams |
| Type | Description |
| UpdateObjectRequest.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public UpdateObjectRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Name | Description |
| input | CodedInputStream |
| extensionRegistry | ExtensionRegistryLite |
| Type | Description |
| UpdateObjectRequest.Builder |
| Type | Description |
| IOException |
mergeFrom(Message other)
public UpdateObjectRequest.Builder mergeFrom(Message other)| Name | Description |
| other | Message |
| Type | Description |
| UpdateObjectRequest.Builder |
mergeFrom(UpdateObjectRequest other)
public UpdateObjectRequest.Builder mergeFrom(UpdateObjectRequest other)| Name | Description |
| other | UpdateObjectRequest |
| Type | Description |
| UpdateObjectRequest.Builder |
mergeObject(Object value)
public UpdateObjectRequest.Builder mergeObject(Object value)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];
| Name | Description |
| value | Object |
| Type | Description |
| UpdateObjectRequest.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final UpdateObjectRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Name | Description |
| unknownFields | UnknownFieldSet |
| Type | Description |
| UpdateObjectRequest.Builder |
mergeUpdateMask(FieldMask value)
public UpdateObjectRequest.Builder mergeUpdateMask(FieldMask value) 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];
| Name | Description |
| value | FieldMask |
| 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;
| Name | Description |
| value | CommonObjectRequestParams |
| 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;
| Name | Description |
| builderForValue | CommonObjectRequestParams.Builder |
| Type | Description |
| UpdateObjectRequest.Builder |
setField(Descriptors.FieldDescriptor field, Object value)
public UpdateObjectRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)| Name | Description |
| field | FieldDescriptor |
| value | Object |
| Type | Description |
| UpdateObjectRequest.Builder |
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;
| Name | Description |
| value | longThe ifGenerationMatch to set. |
| 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;
| Name | Description |
| value | longThe ifGenerationNotMatch to set. |
| 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;
| Name | Description |
| value | longThe ifMetagenerationMatch to set. |
| 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;
| Name | Description |
| value | longThe ifMetagenerationNotMatch to set. |
| Type | Description |
| UpdateObjectRequest.Builder | This builder for chaining. |
setObject(Object value)
public UpdateObjectRequest.Builder setObject(Object value)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];
| Name | Description |
| value | Object |
| Type | Description |
| UpdateObjectRequest.Builder |
setObject(Object.Builder builderForValue)
public UpdateObjectRequest.Builder setObject(Object.Builder builderForValue)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];
| Name | Description |
| builderForValue | Object.Builder |
| 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;
| Name | Description |
| value | StringThe predefinedAcl to set. |
| 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;
| Name | Description |
| value | ByteStringThe bytes for predefinedAcl to set. |
| 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)| Name | Description |
| field | FieldDescriptor |
| index | int |
| value | Object |
| Type | Description |
| UpdateObjectRequest.Builder |
setUnknownFields(UnknownFieldSet unknownFields)
public final UpdateObjectRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)| Name | Description |
| unknownFields | UnknownFieldSet |
| Type | Description |
| UpdateObjectRequest.Builder |
setUpdateMask(FieldMask value)
public UpdateObjectRequest.Builder setUpdateMask(FieldMask value) 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];
| Name | Description |
| value | FieldMask |
| Type | Description |
| UpdateObjectRequest.Builder |
setUpdateMask(FieldMask.Builder builderForValue)
public UpdateObjectRequest.Builder setUpdateMask(FieldMask.Builder builderForValue) 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];
| Name | Description |
| builderForValue | Builder |
| Type | Description |
| UpdateObjectRequest.Builder |