Send feedback
Class WriteObjectRequest (2.20.2)
Stay organized with collections
Save and categorize content based on your preferences.
Version 2.20.2 keyboard_arrow_down
public final class WriteObjectRequest extends GeneratedMessageV3 implements WriteObjectRequestOrBuilder
Request message for WriteObject.
Protobuf type google.storage.v2.WriteObjectRequest
Static Fields
CHECKSUMMED_DATA_FIELD_NUMBER
public static final int CHECKSUMMED_DATA_FIELD_NUMBER
Field Value
Type Description
int
COMMON_OBJECT_REQUEST_PARAMS_FIELD_NUMBER
public static final int COMMON_OBJECT_REQUEST_PARAMS_FIELD_NUMBER
Field Value
Type Description
int
FINISH_WRITE_FIELD_NUMBER
public static final int FINISH_WRITE_FIELD_NUMBER
Field Value
Type Description
int
OBJECT_CHECKSUMS_FIELD_NUMBER
public static final int OBJECT_CHECKSUMS_FIELD_NUMBER
Field Value
Type Description
int
UPLOAD_ID_FIELD_NUMBER
public static final int UPLOAD_ID_FIELD_NUMBER
Field Value
Type Description
int
WRITE_OBJECT_SPEC_FIELD_NUMBER
public static final int WRITE_OBJECT_SPEC_FIELD_NUMBER
Field Value
Type Description
int
WRITE_OFFSET_FIELD_NUMBER
public static final int WRITE_OFFSET_FIELD_NUMBER
Field Value
Type Description
int
Static Methods
getDefaultInstance()
public static WriteObjectRequest getDefaultInstance ()
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
newBuilder()
public static WriteObjectRequest . Builder newBuilder ()
newBuilder(WriteObjectRequest prototype)
public static WriteObjectRequest . Builder newBuilder ( WriteObjectRequest prototype )
public static WriteObjectRequest parseDelimitedFrom ( InputStream input )
public static WriteObjectRequest parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(byte[] data)
public static WriteObjectRequest parseFrom ( byte [] data )
Parameter
Name Description
databyte []
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static WriteObjectRequest parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteString data)
public static WriteObjectRequest parseFrom ( ByteString data )
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static WriteObjectRequest parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
public static WriteObjectRequest parseFrom ( CodedInputStream input )
public static WriteObjectRequest parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
public static WriteObjectRequest parseFrom ( InputStream input )
public static WriteObjectRequest parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteBuffer data)
public static WriteObjectRequest parseFrom ( ByteBuffer data )
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static WriteObjectRequest parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
parser()
public static Parser<WriteObjectRequest> parser ()
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Name Description
objObject
Overrides
getChecksummedData()
public ChecksummedData getChecksummedData ()
The data to insert. If a crc32c checksum is provided that doesn't match
the checksum computed by the service, the request will fail.
.google.storage.v2.ChecksummedData checksummed_data = 4;
getChecksummedDataOrBuilder()
public ChecksummedDataOrBuilder getChecksummedDataOrBuilder ()
The data to insert. If a crc32c checksum is provided that doesn't match
the checksum computed by the service, the request will fail.
.google.storage.v2.ChecksummedData checksummed_data = 4;
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;
getDataCase()
public WriteObjectRequest . DataCase getDataCase ()
getDefaultInstanceForType()
public WriteObjectRequest getDefaultInstanceForType ()
getFinishWrite()
public boolean getFinishWrite ()
If true, this indicates that the write is complete. Sending any
WriteObjectRequests subsequent to one in which finish_write is true
will cause an error.
For a non-resumable write (where the upload_id was not set in the first
message), it is an error not to set this field in the final message of the
stream.
bool finish_write = 7;
Returns
Type Description
boolean The finishWrite.
getFirstMessageCase()
public WriteObjectRequest . FirstMessageCase getFirstMessageCase ()
getObjectChecksums()
public ObjectChecksums getObjectChecksums ()
Checksums for the complete object. If the checksums computed by the service
don't match the specifified checksums the call will fail. May only be
provided in the first or last request (either with first_message, or
finish_write set).
.google.storage.v2.ObjectChecksums object_checksums = 6;
getObjectChecksumsOrBuilder()
public ObjectChecksumsOrBuilder getObjectChecksumsOrBuilder ()
Checksums for the complete object. If the checksums computed by the service
don't match the specifified checksums the call will fail. May only be
provided in the first or last request (either with first_message, or
finish_write set).
.google.storage.v2.ObjectChecksums object_checksums = 6;
getParserForType()
public Parser<WriteObjectRequest> getParserForType ()
Overrides
getSerializedSize()
public int getSerializedSize ()
Returns
Type Description
int
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields ()
Overrides
getUploadId()
public String getUploadId ()
For resumable uploads. This should be the upload_id returned from a
call to StartResumableWriteResponse.
string upload_id = 1;
Returns
Type Description
String The uploadId.
getUploadIdBytes()
public ByteString getUploadIdBytes ()
For resumable uploads. This should be the upload_id returned from a
call to StartResumableWriteResponse.
string upload_id = 1;
Returns
Type Description
ByteString The bytes for uploadId.
getWriteObjectSpec()
public WriteObjectSpec getWriteObjectSpec ()
For non-resumable uploads. Describes the overall upload, including the
destination bucket and object name, preconditions, etc.
.google.storage.v2.WriteObjectSpec write_object_spec = 2;
getWriteObjectSpecOrBuilder()
public WriteObjectSpecOrBuilder getWriteObjectSpecOrBuilder ()
For non-resumable uploads. Describes the overall upload, including the
destination bucket and object name, preconditions, etc.
.google.storage.v2.WriteObjectSpec write_object_spec = 2;
getWriteOffset()
public long getWriteOffset ()
Required. The offset from the beginning of the object at which the data
should be written.
In the first WriteObjectRequest of a WriteObject() action, it
indicates the initial offset for the Write() call. The value must be
equal to the persisted_size that a call to QueryWriteStatus() would
return (0 if this is the first write to the object).
On subsequent calls, this value must be no larger than the sum of the
first write_offset and the sizes of all data chunks sent previously on
this stream.
An incorrect value will cause an error.
int64 write_offset = 3 [(.google.api.field_behavior) = REQUIRED];
Returns
Type Description
long The writeOffset.
hasChecksummedData()
public boolean hasChecksummedData ()
The data to insert. If a crc32c checksum is provided that doesn't match
the checksum computed by the service, the request will fail.
.google.storage.v2.ChecksummedData checksummed_data = 4;
Returns
Type Description
boolean Whether the checksummedData field is set.
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.
hasObjectChecksums()
public boolean hasObjectChecksums ()
Checksums for the complete object. If the checksums computed by the service
don't match the specifified checksums the call will fail. May only be
provided in the first or last request (either with first_message, or
finish_write set).
.google.storage.v2.ObjectChecksums object_checksums = 6;
Returns
Type Description
boolean Whether the objectChecksums field is set.
hasUploadId()
public boolean hasUploadId ()
For resumable uploads. This should be the upload_id returned from a
call to StartResumableWriteResponse.
string upload_id = 1;
Returns
Type Description
boolean Whether the uploadId field is set.
hasWriteObjectSpec()
public boolean hasWriteObjectSpec ()
For non-resumable uploads. Describes the overall upload, including the
destination bucket and object name, preconditions, etc.
.google.storage.v2.WriteObjectSpec write_object_spec = 2;
Returns
Type Description
boolean Whether the writeObjectSpec field is set.
hashCode()
Returns
Type Description
int
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
isInitialized()
public final boolean isInitialized ()
Overrides
newBuilderForType()
public WriteObjectRequest . Builder newBuilderForType ()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected WriteObjectRequest . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Returns
Type Description
Object
Overrides
toBuilder()
public WriteObjectRequest . Builder toBuilder ()
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Overrides
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-01-28 UTC.
Need to tell us more?
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-01-28 UTC."],[],[]]
