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
COMMON_OBJECT_REQUEST_PARAMS_FIELD_NUMBER
public static final int COMMON_OBJECT_REQUEST_PARAMS_FIELD_NUMBER
Field Value
FINISH_WRITE_FIELD_NUMBER
public static final int FINISH_WRITE_FIELD_NUMBER
Field Value
OBJECT_CHECKSUMS_FIELD_NUMBER
public static final int OBJECT_CHECKSUMS_FIELD_NUMBER
Field Value
UPLOAD_ID_FIELD_NUMBER
public static final int UPLOAD_ID_FIELD_NUMBER
Field Value
WRITE_OBJECT_SPEC_FIELD_NUMBER
public static final int WRITE_OBJECT_SPEC_FIELD_NUMBER
Field Value
WRITE_OFFSET_FIELD_NUMBER
public static final int WRITE_OFFSET_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static WriteObjectRequest getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static WriteObjectRequest.Builder newBuilder()
Returns
newBuilder(WriteObjectRequest prototype)
public static WriteObjectRequest.Builder newBuilder(WriteObjectRequest prototype)
Parameter
Returns
public static WriteObjectRequest parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static WriteObjectRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static WriteObjectRequest parseFrom(byte[] data)
Parameter
| Name |
Description |
| data |
byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static WriteObjectRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static WriteObjectRequest parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static WriteObjectRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static WriteObjectRequest parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static WriteObjectRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static WriteObjectRequest parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static WriteObjectRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static WriteObjectRequest parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static WriteObjectRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<WriteObjectRequest> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
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()
Returns
getDefaultInstanceForType()
public WriteObjectRequest getDefaultInstanceForType()
Returns
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;
| Type |
Description |
| boolean |
The finishWrite.
|
getFirstMessageCase()
public WriteObjectRequest.FirstMessageCase getFirstMessageCase()
Returns
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()
Returns
Overrides
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
getUploadId()
public String getUploadId()
For resumable uploads. This should be the upload_id returned from a
call to StartResumableWriteResponse.
string upload_id = 1;
| 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;
| 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];
| 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;
| 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;
| 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;
| 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;
| 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;
| Type |
Description |
| boolean |
Whether the writeObjectSpec field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public WriteObjectRequest.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected WriteObjectRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public WriteObjectRequest.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
