public final class UpdateObjectRequest extends GeneratedMessageV3 implements UpdateObjectRequestOrBuilder
Request message for UpdateObject.
Protobuf type google.storage.v2.UpdateObjectRequest
Static Fields
COMMON_OBJECT_REQUEST_PARAMS_FIELD_NUMBER
public static final int COMMON_OBJECT_REQUEST_PARAMS_FIELD_NUMBER
Field Value
IF_GENERATION_MATCH_FIELD_NUMBER
public static final int IF_GENERATION_MATCH_FIELD_NUMBER
Field Value
IF_GENERATION_NOT_MATCH_FIELD_NUMBER
public static final int IF_GENERATION_NOT_MATCH_FIELD_NUMBER
Field Value
public static final int IF_METAGENERATION_MATCH_FIELD_NUMBER
Field Value
public static final int IF_METAGENERATION_NOT_MATCH_FIELD_NUMBER
Field Value
OBJECT_FIELD_NUMBER
public static final int OBJECT_FIELD_NUMBER
Field Value
PREDEFINED_ACL_FIELD_NUMBER
public static final int PREDEFINED_ACL_FIELD_NUMBER
Field Value
UPDATE_MASK_FIELD_NUMBER
public static final int UPDATE_MASK_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static UpdateObjectRequest getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static UpdateObjectRequest.Builder newBuilder()
Returns
newBuilder(UpdateObjectRequest prototype)
public static UpdateObjectRequest.Builder newBuilder(UpdateObjectRequest prototype)
Parameter
Returns
public static UpdateObjectRequest parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static UpdateObjectRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static UpdateObjectRequest parseFrom(byte[] data)
Parameter
Name | Description |
data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static UpdateObjectRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static UpdateObjectRequest parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static UpdateObjectRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static UpdateObjectRequest parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static UpdateObjectRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static UpdateObjectRequest parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static UpdateObjectRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static UpdateObjectRequest parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static UpdateObjectRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<UpdateObjectRequest> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
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
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
getDefaultInstanceForType()
public UpdateObjectRequest getDefaultInstanceForType()
Returns
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.
|
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.
|
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()
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 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
getParserForType()
public Parser<UpdateObjectRequest> getParserForType()
Returns
Overrides
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.
|
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
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.
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
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];
Returns
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.
|
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.
|
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()
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 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.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public UpdateObjectRequest.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected UpdateObjectRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public UpdateObjectRequest.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions