Class WriteObjectRequest.Builder (2.36.1)

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

Request message for WriteObject.

Protobuf type google.storage.v2.WriteObjectRequest

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public WriteObjectRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
WriteObjectRequest.Builder
Overrides

build()

public WriteObjectRequest build()
Returns
TypeDescription
WriteObjectRequest

buildPartial()

public WriteObjectRequest buildPartial()
Returns
TypeDescription
WriteObjectRequest

clear()

public WriteObjectRequest.Builder clear()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
WriteObjectRequest.Builder

clearData()

public WriteObjectRequest.Builder clearData()
Returns
TypeDescription
WriteObjectRequest.Builder

clearField(Descriptors.FieldDescriptor field)

public WriteObjectRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
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
TypeDescription
WriteObjectRequest.Builder

This builder for chaining.

clearFirstMessage()

public WriteObjectRequest.Builder clearFirstMessage()
Returns
TypeDescription
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
TypeDescription
WriteObjectRequest.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public WriteObjectRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
WriteObjectRequest.Builder

This builder for chaining.

clone()

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

getDataCase()

public WriteObjectRequest.DataCase getDataCase()
Returns
TypeDescription
WriteObjectRequest.DataCase

getDefaultInstanceForType()

public WriteObjectRequest getDefaultInstanceForType()
Returns
TypeDescription
WriteObjectRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
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
TypeDescription
boolean

The finishWrite.

getFirstMessageCase()

public WriteObjectRequest.FirstMessageCase getFirstMessageCase()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
boolean

Whether the writeObjectSpec field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
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
NameDescription
valueChecksummedData
Returns
TypeDescription
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
NameDescription
valueCommonObjectRequestParams
Returns
TypeDescription
WriteObjectRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public WriteObjectRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
WriteObjectRequest.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public WriteObjectRequest.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
WriteObjectRequest.Builder
Overrides

mergeFrom(WriteObjectRequest other)

public WriteObjectRequest.Builder mergeFrom(WriteObjectRequest other)
Parameter
NameDescription
otherWriteObjectRequest
Returns
TypeDescription
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
NameDescription
valueObjectChecksums
Returns
TypeDescription
WriteObjectRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final WriteObjectRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
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
NameDescription
valueWriteObjectSpec
Returns
TypeDescription
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
NameDescription
valueChecksummedData
Returns
TypeDescription
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
NameDescription
builderForValueChecksummedData.Builder
Returns
TypeDescription
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
NameDescription
valueCommonObjectRequestParams
Returns
TypeDescription
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
NameDescription
builderForValueCommonObjectRequestParams.Builder
Returns
TypeDescription
WriteObjectRequest.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public WriteObjectRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
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
NameDescription
valueboolean

The finishWrite to set.

Returns
TypeDescription
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
NameDescription
valueObjectChecksums
Returns
TypeDescription
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
NameDescription
builderForValueObjectChecksums.Builder
Returns
TypeDescription
WriteObjectRequest.Builder

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

public WriteObjectRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
WriteObjectRequest.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final WriteObjectRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
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
NameDescription
valueString

The uploadId to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for uploadId to set.

Returns
TypeDescription
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
NameDescription
valueWriteObjectSpec
Returns
TypeDescription
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
NameDescription
builderForValueWriteObjectSpec.Builder
Returns
TypeDescription
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
NameDescription
valuelong

The writeOffset to set.

Returns
TypeDescription
WriteObjectRequest.Builder

This builder for chaining.