Package com.google.storage.v2

Interface BidiWriteObjectRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
BidiWriteObjectRequest, BidiWriteObjectRequest.Builder
public interface BidiWriteObjectRequestOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

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

    • hasAppendObjectSpec

      boolean hasAppendObjectSpec()
       For appendable uploads. Describes the object to append to.
      .google.storage.v2.AppendObjectSpec append_object_spec = 11;
      Returns:
      Whether the appendObjectSpec field is set.

    • getAppendObjectSpec

      AppendObjectSpec getAppendObjectSpec()
       For appendable uploads. Describes the object to append to.
      .google.storage.v2.AppendObjectSpec append_object_spec = 11;
      Returns:
      The appendObjectSpec.

    • getAppendObjectSpecOrBuilder

      AppendObjectSpecOrBuilder getAppendObjectSpecOrBuilder()
       For appendable uploads. Describes the object to append to.
      .google.storage.v2.AppendObjectSpec append_object_spec = 11;

    • 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 invalid 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()
       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:
      Whether the objectChecksums field is set.

    • getObjectChecksums

      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];
      Returns:
      The objectChecksums.

    • getObjectChecksumsOrBuilder

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

    • getStateLookup

      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:
      The stateLookup.

    • getFlush

      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:
      The flush.

    • getFinishWrite

      boolean getFinishWrite()
       Optional. 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 = 9 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The finishWrite.

    • hasCommonObjectRequestParams

      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:
      Whether the commonObjectRequestParams field is set.

    • getCommonObjectRequestParams

      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];
      Returns:
      The commonObjectRequestParams.

    • getCommonObjectRequestParamsOrBuilder

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

    • getFirstMessageCase

      BidiWriteObjectRequest.FirstMessageCase getFirstMessageCase()

    • getDataCase

      BidiWriteObjectRequest.DataCase getDataCase()