public final class BidiWriteObjectRequest extends GeneratedMessageV3 implements BidiWriteObjectRequestOrBuilder
Request message for BidiWriteObject.
Protobuf type google.storage.v2.BidiWriteObjectRequest
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
APPEND_OBJECT_SPEC_FIELD_NUMBER
public static final int APPEND_OBJECT_SPEC_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
CHECKSUMMED_DATA_FIELD_NUMBER
public static final int CHECKSUMMED_DATA_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
COMMON_OBJECT_REQUEST_PARAMS_FIELD_NUMBER
public static final int COMMON_OBJECT_REQUEST_PARAMS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
FINISH_WRITE_FIELD_NUMBER
public static final int FINISH_WRITE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
FLUSH_FIELD_NUMBER
public static final int FLUSH_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
OBJECT_CHECKSUMS_FIELD_NUMBER
public static final int OBJECT_CHECKSUMS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
STATE_LOOKUP_FIELD_NUMBER
public static final int STATE_LOOKUP_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
UPLOAD_ID_FIELD_NUMBER
public static final int UPLOAD_ID_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
WRITE_OBJECT_SPEC_FIELD_NUMBER
public static final int WRITE_OBJECT_SPEC_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
WRITE_OFFSET_FIELD_NUMBER
public static final int WRITE_OFFSET_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static BidiWriteObjectRequest getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static BidiWriteObjectRequest.Builder newBuilder()
newBuilder(BidiWriteObjectRequest prototype)
public static BidiWriteObjectRequest.Builder newBuilder(BidiWriteObjectRequest prototype)
public static BidiWriteObjectRequest parseDelimitedFrom(InputStream input)
public static BidiWriteObjectRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static BidiWriteObjectRequest parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static BidiWriteObjectRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static BidiWriteObjectRequest parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static BidiWriteObjectRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static BidiWriteObjectRequest parseFrom(CodedInputStream input)
public static BidiWriteObjectRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static BidiWriteObjectRequest parseFrom(InputStream input)
public static BidiWriteObjectRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static BidiWriteObjectRequest parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static BidiWriteObjectRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<BidiWriteObjectRequest> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getAppendObjectSpec()
public AppendObjectSpec getAppendObjectSpec()
For appendable uploads. Describes the object to append to.
.google.storage.v2.AppendObjectSpec append_object_spec = 11;
getAppendObjectSpecOrBuilder()
public AppendObjectSpecOrBuilder getAppendObjectSpecOrBuilder()
For appendable uploads. Describes the object to append to.
.google.storage.v2.AppendObjectSpec append_object_spec = 11;
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;
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;
getCommonObjectRequestParams()
public CommonObjectRequestParams getCommonObjectRequestParams()
Optional. A set of parameters common to Storage API requests concerning an
object.
.google.storage.v2.CommonObjectRequestParams common_object_request_params = 10 [(.google.api.field_behavior) = OPTIONAL];
getCommonObjectRequestParamsOrBuilder()
public CommonObjectRequestParamsOrBuilder getCommonObjectRequestParamsOrBuilder()
Optional. A set of parameters common to Storage API requests concerning an
object.
.google.storage.v2.CommonObjectRequestParams common_object_request_params = 10 [(.google.api.field_behavior) = OPTIONAL];
getDataCase()
public BidiWriteObjectRequest.DataCase getDataCase()
getDefaultInstanceForType()
public BidiWriteObjectRequest getDefaultInstanceForType()
getFinishWrite()
public boolean getFinishWrite()
Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
boolean |
The finishWrite.
|
getFirstMessageCase()
public BidiWriteObjectRequest.FirstMessageCase getFirstMessageCase()
getFlush()
public boolean getFlush()
Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
boolean |
The flush.
|
getObjectChecksums()
public ObjectChecksums getObjectChecksums()
Optional. 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 request or the last request (with
finish_write set).
.google.storage.v2.ObjectChecksums object_checksums = 6 [(.google.api.field_behavior) = OPTIONAL];
getObjectChecksumsOrBuilder()
public ObjectChecksumsOrBuilder getObjectChecksumsOrBuilder()
Optional. 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 request or the last request (with
finish_write set).
.google.storage.v2.ObjectChecksums object_checksums = 6 [(.google.api.field_behavior) = OPTIONAL];
getParserForType()
public Parser<BidiWriteObjectRequest> getParserForType()
Overrides
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
getStateLookup()
public boolean getStateLookup()
Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
| 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;
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;
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.
|
hasAppendObjectSpec()
public boolean hasAppendObjectSpec()
For appendable uploads. Describes the object to append to.
.google.storage.v2.AppendObjectSpec append_object_spec = 11;
| Returns |
| Type |
Description |
boolean |
Whether the appendObjectSpec field is set.
|
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()
Optional. A set of parameters common to Storage API requests concerning an
object.
.google.storage.v2.CommonObjectRequestParams common_object_request_params = 10 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
boolean |
Whether the commonObjectRequestParams field is set.
|
hasObjectChecksums()
public boolean hasObjectChecksums()
Optional. 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 request or the last request (with
finish_write set).
.google.storage.v2.ObjectChecksums object_checksums = 6 [(.google.api.field_behavior) = OPTIONAL];
| 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.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public BidiWriteObjectRequest.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected BidiWriteObjectRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public BidiWriteObjectRequest.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
