Class WriteObjectRequest (2.4.5) 

public final class WriteObjectRequest extends GeneratedMessageV3 implements WriteObjectRequestOrBuilder

Request message for WriteObject.

Protobuf type google.storage.v2.WriteObjectRequest

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > 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

COMMON_REQUEST_PARAMS_FIELD_NUMBER

public static final int COMMON_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()
Returns
Type Description
WriteObjectRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static WriteObjectRequest.Builder newBuilder()
Returns
Type Description
WriteObjectRequest.Builder

newBuilder(WriteObjectRequest prototype)

public static WriteObjectRequest.Builder newBuilder(WriteObjectRequest prototype)
Parameter
Name Description
prototype WriteObjectRequest
Returns
Type Description
WriteObjectRequest.Builder

parseDelimitedFrom(InputStream input)

public static WriteObjectRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
WriteObjectRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static WriteObjectRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
WriteObjectRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static WriteObjectRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
WriteObjectRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static WriteObjectRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
WriteObjectRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static WriteObjectRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
WriteObjectRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static WriteObjectRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
WriteObjectRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static WriteObjectRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
WriteObjectRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static WriteObjectRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
WriteObjectRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static WriteObjectRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
WriteObjectRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static WriteObjectRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
WriteObjectRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static WriteObjectRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
WriteObjectRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static WriteObjectRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
WriteObjectRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<WriteObjectRequest> parser()
Returns
Type Description
Parser<WriteObjectRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
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;

Returns
Type Description
ChecksummedData

The checksummedData.

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;

Returns
Type Description
ChecksummedDataOrBuilder

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
Type Description
CommonObjectRequestParams

The commonObjectRequestParams.

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
Type Description
CommonObjectRequestParamsOrBuilder

getCommonRequestParams()

public CommonRequestParams getCommonRequestParams()

A set of parameters common to all Storage API requests.

.google.storage.v2.CommonRequestParams common_request_params = 9;

Returns
Type Description
CommonRequestParams

The commonRequestParams.

getCommonRequestParamsOrBuilder()

public CommonRequestParamsOrBuilder getCommonRequestParamsOrBuilder()

A set of parameters common to all Storage API requests.

.google.storage.v2.CommonRequestParams common_request_params = 9;

Returns
Type Description
CommonRequestParamsOrBuilder

getDataCase()

public WriteObjectRequest.DataCase getDataCase()
Returns
Type Description
WriteObjectRequest.DataCase

getDefaultInstanceForType()

public WriteObjectRequest getDefaultInstanceForType()
Returns
Type Description
WriteObjectRequest

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()
Returns
Type Description
WriteObjectRequest.FirstMessageCase

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;

Returns
Type Description
ObjectChecksums

The objectChecksums.

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;

Returns
Type Description
ObjectChecksumsOrBuilder

getParserForType()

public Parser<WriteObjectRequest> getParserForType()
Returns
Type Description
Parser<WriteObjectRequest>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
Type Description
UnknownFieldSet
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;

Returns
Type Description
WriteObjectSpec

The writeObjectSpec.

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;

Returns
Type Description
WriteObjectSpecOrBuilder

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.

hasCommonRequestParams()

public boolean hasCommonRequestParams()

A set of parameters common to all Storage API requests.

.google.storage.v2.CommonRequestParams common_request_params = 9;

Returns
Type Description
boolean

Whether the commonRequestParams 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()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public WriteObjectRequest.Builder newBuilderForType()
Returns
Type Description
WriteObjectRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected WriteObjectRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
WriteObjectRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public WriteObjectRequest.Builder toBuilder()
Returns
Type Description
WriteObjectRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides Exceptions
Type Description
IOException