Interface BidiWriteObjectRequestOrBuilder (2.30.1)

Version 2.30.1

• 2.46.0 (latest)
• 2.45.0
• 2.44.1
• 2.43.2
• 2.42.0
• 2.41.0
• 2.40.1
• 2.39.0
• 2.38.0
• 2.37.0
• 2.36.1
• 2.34.0
• 2.33.0
• 2.32.1
• 2.30.1
• 2.29.1
• 2.28.0
• 2.27.1
• 2.24.0
• 2.23.0
• 2.22.6
• 2.21.0
• 2.20.2
• 2.19.0
• 2.18.0
• 2.17.2
• 2.16.0
• 2.15.1
• 2.14.0
• 2.13.1
• 2.12.0
• 2.11.3
• 2.10.0
• 2.9.3
• 2.8.1
• 2.7.1
• 2.6.1
• 2.5.1
• 2.4.5
• 2.3.0
• 2.2.3
• 2.1.10

public interface BidiWriteObjectRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getChecksummedData()

public abstract 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 abstract 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 abstract CommonObjectRequestParams getCommonObjectRequestParams()

A set of parameters common to Storage API requests concerning an object.

.google.storage.v2.CommonObjectRequestParams common_object_request_params = 10;

Returns
Type	Description
CommonObjectRequestParams	The commonObjectRequestParams.

getCommonObjectRequestParamsOrBuilder()

public abstract CommonObjectRequestParamsOrBuilder getCommonObjectRequestParamsOrBuilder()

A set of parameters common to Storage API requests concerning an object.

.google.storage.v2.CommonObjectRequestParams common_object_request_params = 10;

Returns
Type	Description
CommonObjectRequestParamsOrBuilder

getDataCase()

public abstract BidiWriteObjectRequest.DataCase getDataCase()

Returns
Type	Description
BidiWriteObjectRequest.DataCase

getFinishWrite()

public abstract 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 = 9;

Returns
Type	Description
boolean	The finishWrite.

getFirstMessageCase()

public abstract BidiWriteObjectRequest.FirstMessageCase getFirstMessageCase()

Returns
Type	Description
BidiWriteObjectRequest.FirstMessageCase

getFlush()

public abstract boolean getFlush()

Persists data written on the stream, up to and including the current message, to permanent storage. This option should be used sparingly as it may reduce performance. Ongoing writes will periodically be persisted on the server even when flush is not set.

bool flush = 8;

Returns
Type	Description
boolean	The flush.

getObjectChecksums()

public abstract ObjectChecksums getObjectChecksums()

Checksums for the complete object. If the checksums computed by the service don't match the specified 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 abstract ObjectChecksumsOrBuilder getObjectChecksumsOrBuilder()

Checksums for the complete object. If the checksums computed by the service don't match the specified 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

getStateLookup()

public abstract boolean getStateLookup()

For each BidiWriteObjectRequest where state_lookup is true or the client closes the stream, the service will send a BidiWriteObjectResponse containing the current persisted size. The persisted size sent in responses covers all the bytes the server has persisted thus far and can be used to decide what data is safe for the client to drop. Note that the object's current size reported by the BidiWriteObjectResponse may lag behind the number of bytes written by the client.

bool state_lookup = 7;

Returns
Type	Description
boolean	The stateLookup.

getUploadId()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 invalid value will cause an error.

int64 write_offset = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
long	The writeOffset.

hasChecksummedData()

public abstract 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 abstract boolean hasCommonObjectRequestParams()

A set of parameters common to Storage API requests concerning an object.

.google.storage.v2.CommonObjectRequestParams common_object_request_params = 10;

Returns
Type	Description
boolean	Whether the commonObjectRequestParams field is set.

hasObjectChecksums()

public abstract boolean hasObjectChecksums()

Checksums for the complete object. If the checksums computed by the service don't match the specified 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 abstract 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 abstract 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.