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 |
| Type |
Description |
int |
|
IF_GENERATION_MATCH_FIELD_NUMBER
public static final int IF_GENERATION_MATCH_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
IF_GENERATION_NOT_MATCH_FIELD_NUMBER
public static final int IF_GENERATION_NOT_MATCH_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int IF_METAGENERATION_MATCH_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int IF_METAGENERATION_NOT_MATCH_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
OBJECT_FIELD_NUMBER
public static final int OBJECT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
PREDEFINED_ACL_FIELD_NUMBER
public static final int PREDEFINED_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 UpdateObjectRequest getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static UpdateObjectRequest.Builder newBuilder()
newBuilder(UpdateObjectRequest prototype)
public static UpdateObjectRequest.Builder newBuilder(UpdateObjectRequest prototype)
public static UpdateObjectRequest parseDelimitedFrom(InputStream input)
public static UpdateObjectRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static UpdateObjectRequest parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static UpdateObjectRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static UpdateObjectRequest parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static UpdateObjectRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static UpdateObjectRequest parseFrom(CodedInputStream input)
public static UpdateObjectRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static UpdateObjectRequest parseFrom(InputStream input)
public static UpdateObjectRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static UpdateObjectRequest parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static UpdateObjectRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<UpdateObjectRequest> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
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;
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;
getDefaultInstanceForType()
public UpdateObjectRequest getDefaultInstanceForType()
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];
getParserForType()
public Parser<UpdateObjectRequest> getParserForType()
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 |
| Type |
Description |
int |
|
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
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
.google.protobuf.FieldMask update_mask = 7 [(.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
.google.protobuf.FieldMask update_mask = 7 [(.google.api.field_behavior) = REQUIRED];
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
.google.protobuf.FieldMask update_mask = 7 [(.google.api.field_behavior) = REQUIRED];
| Returns |
| Type |
Description |
boolean |
Whether the updateMask field is set.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public UpdateObjectRequest.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected UpdateObjectRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public UpdateObjectRequest.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
