com.google.storage.v2.WriteObjectRequestOrBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of proto-google-cloud-storage-v2 Show documentation
PROTO library for proto-google-cloud-storage-v2
There is a newer version: 2.46.0-beta
Show newest version
/*
 * Copyright 2024 Google LLC
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: google/storage/v2/storage.proto

// Protobuf Java Version: 3.25.2
package com.google.storage.v2;

public interface WriteObjectRequestOrBuilder
    extends
    // @@protoc_insertion_point(interface_extends:google.storage.v2.WriteObjectRequest)
    com.google.protobuf.MessageOrBuilder {

  /**
   *
   *
   *    * For resumable uploads. This should be the `upload_id` returned from a
   * call to `StartResumableWriteResponse`.
   * 
   *
   * string upload_id = 1;
   *
   * @return Whether the uploadId field is set.
   */
  boolean hasUploadId();
  /**
   *
   *
   *    * For resumable uploads. This should be the `upload_id` returned from a
   * call to `StartResumableWriteResponse`.
   * 
   *
   * string upload_id = 1;
   *
   * @return The uploadId.
   */
  java.lang.String getUploadId();
  /**
   *
   *
   *    * For resumable uploads. This should be the `upload_id` returned from a
   * call to `StartResumableWriteResponse`.
   * 
   *
   * string upload_id = 1;
   *
   * @return The bytes for uploadId.
   */
  com.google.protobuf.ByteString getUploadIdBytes();

  /**
   *
   *
   *    * 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;
   *
   * @return Whether the writeObjectSpec field is set.
   */
  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;
   *
   * @return The writeObjectSpec.
   */
  com.google.storage.v2.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;
   */
  com.google.storage.v2.WriteObjectSpecOrBuilder getWriteObjectSpecOrBuilder();

  /**
   *
   *
   *    * 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];
   *
   * @return The writeOffset.
   */
  long getWriteOffset();

  /**
   *
   *
   *    * 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;
   *
   * @return Whether the checksummedData field is set.
   */
  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;
   *
   * @return The checksummedData.
   */
  com.google.storage.v2.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;
   */
  com.google.storage.v2.ChecksummedDataOrBuilder getChecksummedDataOrBuilder();

  /**
   *
   *
   *    * 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;
   *
   * @return Whether the objectChecksums field is set.
   */
  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;
   *
   * @return The objectChecksums.
   */
  com.google.storage.v2.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;
   */
  com.google.storage.v2.ObjectChecksumsOrBuilder getObjectChecksumsOrBuilder();

  /**
   *
   *
   *    * 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 = 7;
   *
   * @return The finishWrite.
   */
  boolean getFinishWrite();

  /**
   *
   *
   *    * A set of parameters common to Storage API requests concerning an object.
   * 
   *
   * .google.storage.v2.CommonObjectRequestParams common_object_request_params = 8;
   *
   * @return Whether the commonObjectRequestParams field is set.
   */
  boolean hasCommonObjectRequestParams();
  /**
   *
   *
   *    * A set of parameters common to Storage API requests concerning an object.
   * 
   *
   * .google.storage.v2.CommonObjectRequestParams common_object_request_params = 8;
   *
   * @return The commonObjectRequestParams.
   */
  com.google.storage.v2.CommonObjectRequestParams getCommonObjectRequestParams();
  /**
   *
   *
   *    * A set of parameters common to Storage API requests concerning an object.
   * 
   *
   * .google.storage.v2.CommonObjectRequestParams common_object_request_params = 8;
   */
  com.google.storage.v2.CommonObjectRequestParamsOrBuilder getCommonObjectRequestParamsOrBuilder();

  com.google.storage.v2.WriteObjectRequest.FirstMessageCase getFirstMessageCase();

  com.google.storage.v2.WriteObjectRequest.DataCase getDataCase();
}