Class WriteObjectRequest.Builder (2.45.0) 

public static final class WriteObjectRequest.Builder extends GeneratedMessageV3.Builder<WriteObjectRequest.Builder> implements WriteObjectRequestOrBuilder

Request message for WriteObject.

Protobuf type google.storage.v2.WriteObjectRequest

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > WriteObjectRequest.Builder

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public WriteObjectRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
WriteObjectRequest.Builder
Overrides

build()

public WriteObjectRequest build()
Returns
Type Description
WriteObjectRequest

buildPartial()

public WriteObjectRequest buildPartial()
Returns
Type Description
WriteObjectRequest

clear()

public WriteObjectRequest.Builder clear()
Returns
Type Description
WriteObjectRequest.Builder
Overrides

clearChecksummedData()

public WriteObjectRequest.Builder clearChecksummedData()

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
WriteObjectRequest.Builder

clearCommonObjectRequestParams()

public WriteObjectRequest.Builder clearCommonObjectRequestParams()

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

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

Returns
Type Description
WriteObjectRequest.Builder

clearData()

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

clearField(Descriptors.FieldDescriptor field)

public WriteObjectRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
WriteObjectRequest.Builder
Overrides

clearFinishWrite()

public WriteObjectRequest.Builder clearFinishWrite()

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
WriteObjectRequest.Builder

This builder for chaining.

clearFirstMessage()

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

clearObjectChecksums()

public WriteObjectRequest.Builder clearObjectChecksums()

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
WriteObjectRequest.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public WriteObjectRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
WriteObjectRequest.Builder
Overrides

clearUploadId()

public WriteObjectRequest.Builder clearUploadId()

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

string upload_id = 1;

Returns
Type Description
WriteObjectRequest.Builder

This builder for chaining.

clearWriteObjectSpec()

public WriteObjectRequest.Builder clearWriteObjectSpec()

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
WriteObjectRequest.Builder

clearWriteOffset()

public WriteObjectRequest.Builder clearWriteOffset()

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
WriteObjectRequest.Builder

This builder for chaining.

clone()

public WriteObjectRequest.Builder clone()
Returns
Type Description
WriteObjectRequest.Builder
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.

getChecksummedDataBuilder()

public ChecksummedData.Builder getChecksummedDataBuilder()

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.Builder

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.

getCommonObjectRequestParamsBuilder()

public CommonObjectRequestParams.Builder getCommonObjectRequestParamsBuilder()

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.Builder

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

getDataCase()

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

getDefaultInstanceForType()

public WriteObjectRequest getDefaultInstanceForType()
Returns
Type Description
WriteObjectRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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 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.

getObjectChecksumsBuilder()

public ObjectChecksums.Builder getObjectChecksumsBuilder()

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.Builder

getObjectChecksumsOrBuilder()

public 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

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.

getWriteObjectSpecBuilder()

public WriteObjectSpec.Builder getWriteObjectSpecBuilder()

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.Builder

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.

hasObjectChecksums()

public 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 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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeChecksummedData(ChecksummedData value)

public WriteObjectRequest.Builder mergeChecksummedData(ChecksummedData value)

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;

Parameter
Name Description
value ChecksummedData
Returns
Type Description
WriteObjectRequest.Builder

mergeCommonObjectRequestParams(CommonObjectRequestParams value)

public WriteObjectRequest.Builder mergeCommonObjectRequestParams(CommonObjectRequestParams value)

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

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

Parameter
Name Description
value CommonObjectRequestParams
Returns
Type Description
WriteObjectRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public WriteObjectRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
WriteObjectRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public WriteObjectRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
WriteObjectRequest.Builder
Overrides

mergeFrom(WriteObjectRequest other)

public WriteObjectRequest.Builder mergeFrom(WriteObjectRequest other)
Parameter
Name Description
other WriteObjectRequest
Returns
Type Description
WriteObjectRequest.Builder

mergeObjectChecksums(ObjectChecksums value)

public WriteObjectRequest.Builder mergeObjectChecksums(ObjectChecksums value)

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;

Parameter
Name Description
value ObjectChecksums
Returns
Type Description
WriteObjectRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final WriteObjectRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
WriteObjectRequest.Builder
Overrides

mergeWriteObjectSpec(WriteObjectSpec value)

public WriteObjectRequest.Builder mergeWriteObjectSpec(WriteObjectSpec value)

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;

Parameter
Name Description
value WriteObjectSpec
Returns
Type Description
WriteObjectRequest.Builder

setChecksummedData(ChecksummedData value)

public WriteObjectRequest.Builder setChecksummedData(ChecksummedData value)

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;

Parameter
Name Description
value ChecksummedData
Returns
Type Description
WriteObjectRequest.Builder

setChecksummedData(ChecksummedData.Builder builderForValue)

public WriteObjectRequest.Builder setChecksummedData(ChecksummedData.Builder builderForValue)

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;

Parameter
Name Description
builderForValue ChecksummedData.Builder
Returns
Type Description
WriteObjectRequest.Builder

setCommonObjectRequestParams(CommonObjectRequestParams value)

public WriteObjectRequest.Builder setCommonObjectRequestParams(CommonObjectRequestParams value)

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

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

Parameter
Name Description
value CommonObjectRequestParams
Returns
Type Description
WriteObjectRequest.Builder

setCommonObjectRequestParams(CommonObjectRequestParams.Builder builderForValue)

public WriteObjectRequest.Builder setCommonObjectRequestParams(CommonObjectRequestParams.Builder builderForValue)

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

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

Parameter
Name Description
builderForValue CommonObjectRequestParams.Builder
Returns
Type Description
WriteObjectRequest.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public WriteObjectRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
WriteObjectRequest.Builder
Overrides

setFinishWrite(boolean value)

public WriteObjectRequest.Builder setFinishWrite(boolean value)

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;

Parameter
Name Description
value boolean

The finishWrite to set.
Returns
Type Description
WriteObjectRequest.Builder

This builder for chaining.

setObjectChecksums(ObjectChecksums value)

public WriteObjectRequest.Builder setObjectChecksums(ObjectChecksums value)

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;

Parameter
Name Description
value ObjectChecksums
Returns
Type Description
WriteObjectRequest.Builder

setObjectChecksums(ObjectChecksums.Builder builderForValue)

public WriteObjectRequest.Builder setObjectChecksums(ObjectChecksums.Builder builderForValue)

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;

Parameter
Name Description
builderForValue ObjectChecksums.Builder
Returns
Type Description
WriteObjectRequest.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public WriteObjectRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
WriteObjectRequest.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final WriteObjectRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
WriteObjectRequest.Builder
Overrides

setUploadId(String value)

public WriteObjectRequest.Builder setUploadId(String value)

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

string upload_id = 1;

Parameter
Name Description
value String

The uploadId to set.
Returns
Type Description
WriteObjectRequest.Builder

This builder for chaining.

setUploadIdBytes(ByteString value)

public WriteObjectRequest.Builder setUploadIdBytes(ByteString value)

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

string upload_id = 1;

Parameter
Name Description
value ByteString

The bytes for uploadId to set.
Returns
Type Description
WriteObjectRequest.Builder

This builder for chaining.

setWriteObjectSpec(WriteObjectSpec value)

public WriteObjectRequest.Builder setWriteObjectSpec(WriteObjectSpec value)

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;

Parameter
Name Description
value WriteObjectSpec
Returns
Type Description
WriteObjectRequest.Builder

setWriteObjectSpec(WriteObjectSpec.Builder builderForValue)

public WriteObjectRequest.Builder setWriteObjectSpec(WriteObjectSpec.Builder builderForValue)

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;

Parameter
Name Description
builderForValue WriteObjectSpec.Builder
Returns
Type Description
WriteObjectRequest.Builder

setWriteOffset(long value)

public WriteObjectRequest.Builder setWriteOffset(long value)

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];

Parameter
Name Description
value long

The writeOffset to set.
Returns
Type Description
WriteObjectRequest.Builder

This builder for chaining.