com.google.storage.v2

Interface WriteObjectRequestOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

WriteObjectRequest, WriteObjectRequest.Builder

public interface WriteObjectRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
ChecksummedData	getChecksummedData() The data to insert.
ChecksummedDataOrBuilder	getChecksummedDataOrBuilder() The data to insert.
CommonObjectRequestParams	getCommonObjectRequestParams() A set of parameters common to Storage API requests concerning an object.
CommonObjectRequestParamsOrBuilder	getCommonObjectRequestParamsOrBuilder() A set of parameters common to Storage API requests concerning an object.
WriteObjectRequest.DataCase	getDataCase()
boolean	getFinishWrite() If `true`, this indicates that the write is complete.
WriteObjectRequest.FirstMessageCase	getFirstMessageCase()
ObjectChecksums	getObjectChecksums() Checksums for the complete object.
ObjectChecksumsOrBuilder	getObjectChecksumsOrBuilder() Checksums for the complete object.
String	getUploadId() For resumable uploads.
com.google.protobuf.ByteString	getUploadIdBytes() For resumable uploads.
WriteObjectSpec	getWriteObjectSpec() For non-resumable uploads.
WriteObjectSpecOrBuilder	getWriteObjectSpecOrBuilder() For non-resumable uploads.
long	getWriteOffset() Required.
boolean	hasChecksummedData() The data to insert.
boolean	hasCommonObjectRequestParams() A set of parameters common to Storage API requests concerning an object.
boolean	hasObjectChecksums() Checksums for the complete object.
boolean	hasUploadId() For resumable uploads.
boolean	hasWriteObjectSpec() For non-resumable uploads.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

hasUploadId

boolean hasUploadId()

 For resumable uploads. This should be the `upload_id` returned from a
 call to `StartResumableWriteResponse`.
 

string upload_id = 1;

Returns:

Whether the uploadId field is set.

getUploadId

String getUploadId()

 For resumable uploads. This should be the `upload_id` returned from a
 call to `StartResumableWriteResponse`.
 

string upload_id = 1;

Returns:

The uploadId.

getUploadIdBytes

com.google.protobuf.ByteString getUploadIdBytes()

 For resumable uploads. This should be the `upload_id` returned from a
 call to `StartResumableWriteResponse`.
 

string upload_id = 1;

Returns:

The bytes for uploadId.

hasWriteObjectSpec

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:

Whether the writeObjectSpec field is set.

getWriteObjectSpec

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:

The writeObjectSpec.

getWriteObjectSpecOrBuilder

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

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:

The writeOffset.

hasChecksummedData

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:

Whether the checksummedData field is set.

getChecksummedData

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:

The checksummedData.

getChecksummedDataOrBuilder

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;

hasObjectChecksums

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:

Whether the objectChecksums field is set.

getObjectChecksums

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:

The objectChecksums.

getObjectChecksumsOrBuilder

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;

getFinishWrite

boolean getFinishWrite()

 If `true`, this indicates that the write is complete. Sending any
 `WriteObjectRequest`s 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:

The finishWrite.

hasCommonObjectRequestParams

boolean hasCommonObjectRequestParams()

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

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

Returns:

Whether the commonObjectRequestParams field is set.

getCommonObjectRequestParams

CommonObjectRequestParams getCommonObjectRequestParams()

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

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

Returns:

The commonObjectRequestParams.

getCommonObjectRequestParamsOrBuilder

CommonObjectRequestParamsOrBuilder getCommonObjectRequestParamsOrBuilder()

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

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

getFirstMessageCase

WriteObjectRequest.FirstMessageCase getFirstMessageCase()

getDataCase

WriteObjectRequest.DataCase getDataCase()