public static final class BidiWriteObjectRequest.Builder extends GeneratedMessageV3.Builder<BidiWriteObjectRequest.Builder> implements BidiWriteObjectRequestOrBuilderRequest message for BidiWriteObject.
Protobuf type google.storage.v2.BidiWriteObjectRequest
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > BidiWriteObjectRequest.BuilderImplements
BidiWriteObjectRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public BidiWriteObjectRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
value | Object |
| Returns | |
|---|---|
| Type | Description |
BidiWriteObjectRequest.Builder | |
build()
public BidiWriteObjectRequest build()| Returns | |
|---|---|
| Type | Description |
BidiWriteObjectRequest | |
buildPartial()
public BidiWriteObjectRequest buildPartial()| Returns | |
|---|---|
| Type | Description |
BidiWriteObjectRequest | |
clear()
public BidiWriteObjectRequest.Builder clear()| Returns | |
|---|---|
| Type | Description |
BidiWriteObjectRequest.Builder | |
clearChecksummedData()
public BidiWriteObjectRequest.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 |
BidiWriteObjectRequest.Builder | |
clearCommonObjectRequestParams()
public BidiWriteObjectRequest.Builder clearCommonObjectRequestParams()A set of parameters common to Storage API requests concerning an object.
.google.storage.v2.CommonObjectRequestParams common_object_request_params = 10;
| Returns | |
|---|---|
| Type | Description |
BidiWriteObjectRequest.Builder | |
clearData()
public BidiWriteObjectRequest.Builder clearData()| Returns | |
|---|---|
| Type | Description |
BidiWriteObjectRequest.Builder | |
clearField(Descriptors.FieldDescriptor field)
public BidiWriteObjectRequest.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field | FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
BidiWriteObjectRequest.Builder | |
clearFinishWrite()
public BidiWriteObjectRequest.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 = 9;
| Returns | |
|---|---|
| Type | Description |
BidiWriteObjectRequest.Builder | This builder for chaining. |
clearFirstMessage()
public BidiWriteObjectRequest.Builder clearFirstMessage()| Returns | |
|---|---|
| Type | Description |
BidiWriteObjectRequest.Builder | |
clearFlush()
public BidiWriteObjectRequest.Builder clearFlush() 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. This field is ignored if
finish_write is set to true since there's no need to checkpoint or flush
if this message completes the write.
bool flush = 8;
| Returns | |
|---|---|
| Type | Description |
BidiWriteObjectRequest.Builder | This builder for chaining. |
clearObjectChecksums()
public BidiWriteObjectRequest.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 |
BidiWriteObjectRequest.Builder | |
clearOneof(Descriptors.OneofDescriptor oneof)
public BidiWriteObjectRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof | OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
BidiWriteObjectRequest.Builder | |
clearStateLookup()
public BidiWriteObjectRequest.Builder clearStateLookup() 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. This field is ignored if
finish_write is set to true.
bool state_lookup = 7;
| Returns | |
|---|---|
| Type | Description |
BidiWriteObjectRequest.Builder | This builder for chaining. |
clearUploadId()
public BidiWriteObjectRequest.Builder clearUploadId() For resumable uploads. This should be the upload_id returned from a
call to StartResumableWriteResponse.
string upload_id = 1;
| Returns | |
|---|---|
| Type | Description |
BidiWriteObjectRequest.Builder | This builder for chaining. |
clearWriteObjectSpec()
public BidiWriteObjectRequest.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 |
BidiWriteObjectRequest.Builder | |
clearWriteOffset()
public BidiWriteObjectRequest.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 invalid value will cause an error.
int64 write_offset = 3 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
BidiWriteObjectRequest.Builder | This builder for chaining. |
clone()
public BidiWriteObjectRequest.Builder clone()| Returns | |
|---|---|
| Type | Description |
BidiWriteObjectRequest.Builder | |
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 = 10;
| 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 = 10;
| 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 = 10;
| Returns | |
|---|---|
| Type | Description |
CommonObjectRequestParamsOrBuilder | |
getDataCase()
public BidiWriteObjectRequest.DataCase getDataCase()| Returns | |
|---|---|
| Type | Description |
BidiWriteObjectRequest.DataCase | |
getDefaultInstanceForType()
public BidiWriteObjectRequest getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
BidiWriteObjectRequest | |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
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 = 9;
| Returns | |
|---|---|
| Type | Description |
boolean | The finishWrite. |
getFirstMessageCase()
public BidiWriteObjectRequest.FirstMessageCase getFirstMessageCase()| Returns | |
|---|---|
| Type | Description |
BidiWriteObjectRequest.FirstMessageCase | |
getFlush()
public 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. This field is ignored if
finish_write is set to true since there's no need to checkpoint or flush
if this message completes the write.
bool flush = 8;
| Returns | |
|---|---|
| Type | Description |
boolean | The flush. |
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 | |
getStateLookup()
public 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. This field is ignored if
finish_write is set to true.
bool state_lookup = 7;
| Returns | |
|---|---|
| Type | Description |
boolean | The stateLookup. |
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 invalid 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 = 10;
| 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 | |
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean | |
mergeChecksummedData(ChecksummedData value)
public BidiWriteObjectRequest.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 |
BidiWriteObjectRequest.Builder | |
mergeCommonObjectRequestParams(CommonObjectRequestParams value)
public BidiWriteObjectRequest.Builder mergeCommonObjectRequestParams(CommonObjectRequestParams value)A set of parameters common to Storage API requests concerning an object.
.google.storage.v2.CommonObjectRequestParams common_object_request_params = 10;
| Parameter | |
|---|---|
| Name | Description |
value | CommonObjectRequestParams |
| Returns | |
|---|---|
| Type | Description |
BidiWriteObjectRequest.Builder | |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public BidiWriteObjectRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
BidiWriteObjectRequest.Builder | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
mergeFrom(Message other)
public BidiWriteObjectRequest.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other | Message |
| Returns | |
|---|---|
| Type | Description |
BidiWriteObjectRequest.Builder | |
mergeFrom(BidiWriteObjectRequest other)
public BidiWriteObjectRequest.Builder mergeFrom(BidiWriteObjectRequest other)| Parameter | |
|---|---|
| Name | Description |
other | BidiWriteObjectRequest |
| Returns | |
|---|---|
| Type | Description |
BidiWriteObjectRequest.Builder | |
mergeObjectChecksums(ObjectChecksums value)
public BidiWriteObjectRequest.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 |
BidiWriteObjectRequest.Builder | |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final BidiWriteObjectRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
BidiWriteObjectRequest.Builder | |
mergeWriteObjectSpec(WriteObjectSpec value)
public BidiWriteObjectRequest.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 |
BidiWriteObjectRequest.Builder | |
setChecksummedData(ChecksummedData value)
public BidiWriteObjectRequest.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 |
BidiWriteObjectRequest.Builder | |
setChecksummedData(ChecksummedData.Builder builderForValue)
public BidiWriteObjectRequest.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 |
BidiWriteObjectRequest.Builder | |
setCommonObjectRequestParams(CommonObjectRequestParams value)
public BidiWriteObjectRequest.Builder setCommonObjectRequestParams(CommonObjectRequestParams value)A set of parameters common to Storage API requests concerning an object.
.google.storage.v2.CommonObjectRequestParams common_object_request_params = 10;
| Parameter | |
|---|---|
| Name | Description |
value | CommonObjectRequestParams |
| Returns | |
|---|---|
| Type | Description |
BidiWriteObjectRequest.Builder | |
setCommonObjectRequestParams(CommonObjectRequestParams.Builder builderForValue)
public BidiWriteObjectRequest.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 = 10;
| Parameter | |
|---|---|
| Name | Description |
builderForValue | CommonObjectRequestParams.Builder |
| Returns | |
|---|---|
| Type | Description |
BidiWriteObjectRequest.Builder | |
setField(Descriptors.FieldDescriptor field, Object value)
public BidiWriteObjectRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
value | Object |
| Returns | |
|---|---|
| Type | Description |
BidiWriteObjectRequest.Builder | |
setFinishWrite(boolean value)
public BidiWriteObjectRequest.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 = 9;
| Parameter | |
|---|---|
| Name | Description |
value | booleanThe finishWrite to set. |
| Returns | |
|---|---|
| Type | Description |
BidiWriteObjectRequest.Builder | This builder for chaining. |
setFlush(boolean value)
public BidiWriteObjectRequest.Builder setFlush(boolean value) 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. This field is ignored if
finish_write is set to true since there's no need to checkpoint or flush
if this message completes the write.
bool flush = 8;
| Parameter | |
|---|---|
| Name | Description |
value | booleanThe flush to set. |
| Returns | |
|---|---|
| Type | Description |
BidiWriteObjectRequest.Builder | This builder for chaining. |
setObjectChecksums(ObjectChecksums value)
public BidiWriteObjectRequest.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 |
BidiWriteObjectRequest.Builder | |
setObjectChecksums(ObjectChecksums.Builder builderForValue)
public BidiWriteObjectRequest.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 |
BidiWriteObjectRequest.Builder | |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public BidiWriteObjectRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
index | int |
value | Object |
| Returns | |
|---|---|
| Type | Description |
BidiWriteObjectRequest.Builder | |
setStateLookup(boolean value)
public BidiWriteObjectRequest.Builder setStateLookup(boolean value) 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. This field is ignored if
finish_write is set to true.
bool state_lookup = 7;
| Parameter | |
|---|---|
| Name | Description |
value | booleanThe stateLookup to set. |
| Returns | |
|---|---|
| Type | Description |
BidiWriteObjectRequest.Builder | This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final BidiWriteObjectRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
BidiWriteObjectRequest.Builder | |
setUploadId(String value)
public BidiWriteObjectRequest.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 | StringThe uploadId to set. |
| Returns | |
|---|---|
| Type | Description |
BidiWriteObjectRequest.Builder | This builder for chaining. |
setUploadIdBytes(ByteString value)
public BidiWriteObjectRequest.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 | ByteStringThe bytes for uploadId to set. |
| Returns | |
|---|---|
| Type | Description |
BidiWriteObjectRequest.Builder | This builder for chaining. |
setWriteObjectSpec(WriteObjectSpec value)
public BidiWriteObjectRequest.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 |
BidiWriteObjectRequest.Builder | |
setWriteObjectSpec(WriteObjectSpec.Builder builderForValue)
public BidiWriteObjectRequest.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 |
BidiWriteObjectRequest.Builder | |
setWriteOffset(long value)
public BidiWriteObjectRequest.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 invalid value will cause an error.
int64 write_offset = 3 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value | longThe writeOffset to set. |
| Returns | |
|---|---|
| Type | Description |
BidiWriteObjectRequest.Builder | This builder for chaining. |