com.google.cloud.visionai.v1.UpdateDraftRequestOrBuilder Maven / Gradle / Ivy

Go to download
/*
 * 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/cloud/visionai/v1/platform.proto

// Protobuf Java Version: 3.25.3
package com.google.cloud.visionai.v1;

public interface UpdateDraftRequestOrBuilder
    extends
    // @@protoc_insertion_point(interface_extends:google.cloud.visionai.v1.UpdateDraftRequest)
    com.google.protobuf.MessageOrBuilder {

  /**
   *
   *
   *    * Optional. Field mask is used to specify the fields to be overwritten in the
   * Draft resource by the update.
   * The fields specified in the update_mask are relative to the resource, not
   * the full request. A field will be overwritten if it is in the mask. If the
   * user does not provide a mask then all fields will be overwritten.
   * 
   *
   * .google.protobuf.FieldMask update_mask = 1 [(.google.api.field_behavior) = OPTIONAL];
   * 
   *
   * @return Whether the updateMask field is set.
   */
  boolean hasUpdateMask();
  /**
   *
   *
   *    * Optional. Field mask is used to specify the fields to be overwritten in the
   * Draft resource by the update.
   * The fields specified in the update_mask are relative to the resource, not
   * the full request. A field will be overwritten if it is in the mask. If the
   * user does not provide a mask then all fields will be overwritten.
   * 
   *
   * .google.protobuf.FieldMask update_mask = 1 [(.google.api.field_behavior) = OPTIONAL];
   * 
   *
   * @return The updateMask.
   */
  com.google.protobuf.FieldMask getUpdateMask();
  /**
   *
   *
   *    * Optional. Field mask is used to specify the fields to be overwritten in the
   * Draft resource by the update.
   * The fields specified in the update_mask are relative to the resource, not
   * the full request. A field will be overwritten if it is in the mask. If the
   * user does not provide a mask then all fields will be overwritten.
   * 
   *
   * .google.protobuf.FieldMask update_mask = 1 [(.google.api.field_behavior) = OPTIONAL];
   * 
   */
  com.google.protobuf.FieldMaskOrBuilder getUpdateMaskOrBuilder();

  /**
   *
   *
   *    * Required. The resource being updated.
   * 
   *
   * .google.cloud.visionai.v1.Draft draft = 2 [(.google.api.field_behavior) = REQUIRED];
   * 
   *
   * @return Whether the draft field is set.
   */
  boolean hasDraft();
  /**
   *
   *
   *    * Required. The resource being updated.
   * 
   *
   * .google.cloud.visionai.v1.Draft draft = 2 [(.google.api.field_behavior) = REQUIRED];
   * 
   *
   * @return The draft.
   */
  com.google.cloud.visionai.v1.Draft getDraft();
  /**
   *
   *
   *    * Required. The resource being updated.
   * 
   *
   * .google.cloud.visionai.v1.Draft draft = 2 [(.google.api.field_behavior) = REQUIRED];
   * 
   */
  com.google.cloud.visionai.v1.DraftOrBuilder getDraftOrBuilder();

  /**
   *
   *
   *    * Optional. An optional request ID to identify requests. Specify a unique
   * request ID so that if you must retry your request, the server will know to
   * ignore the request if it has already been completed. The server will
   * guarantee that for at least 60 minutes since the first request.
   *
   * For example, consider a situation where you make an initial request and
   * the request times out. If you make the request again with the same request
   * ID, the server can check if original operation with the same request ID
   * was received, and if so, will ignore the second request. This prevents
   * clients from accidentally creating duplicate commitments.
   *
   * The request ID must be a valid UUID with the exception that zero UUID is
   * not supported (00000000-0000-0000-0000-000000000000).
   * 
   *
   * string request_id = 3 [(.google.api.field_behavior) = OPTIONAL];
   *
   * @return The requestId.
   */
  java.lang.String getRequestId();
  /**
   *
   *
   *    * Optional. An optional request ID to identify requests. Specify a unique
   * request ID so that if you must retry your request, the server will know to
   * ignore the request if it has already been completed. The server will
   * guarantee that for at least 60 minutes since the first request.
   *
   * For example, consider a situation where you make an initial request and
   * the request times out. If you make the request again with the same request
   * ID, the server can check if original operation with the same request ID
   * was received, and if so, will ignore the second request. This prevents
   * clients from accidentally creating duplicate commitments.
   *
   * The request ID must be a valid UUID with the exception that zero UUID is
   * not supported (00000000-0000-0000-0000-000000000000).
   * 
   *
   * string request_id = 3 [(.google.api.field_behavior) = OPTIONAL];
   *
   * @return The bytes for requestId.
   */
  com.google.protobuf.ByteString getRequestIdBytes();

  /**
   *
   *
   *    * If true, UpdateDraftRequest will create one resource if the target resource
   * doesn't exist, this time, the field_mask will be ignored.
   * 
   *
   * bool allow_missing = 4;
   *
   * @return The allowMissing.
   */
  boolean getAllowMissing();
}