com.google.cloud.retail.v2alpha.UpdateProductRequestOrBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of proto-google-cloud-retail-v2alpha Show documentation
Proto library for google-cloud-retail
There is a newer version: 2.55.0
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/cloud/retail/v2alpha/product_service.proto

// Protobuf Java Version: 3.25.5
package com.google.cloud.retail.v2alpha;

public interface UpdateProductRequestOrBuilder
    extends
    // @@protoc_insertion_point(interface_extends:google.cloud.retail.v2alpha.UpdateProductRequest)
    com.google.protobuf.MessageOrBuilder {

  /**
   *
   *
   *    * Required. The product to update/create.
   *
   * If the caller does not have permission to update the
   * [Product][google.cloud.retail.v2alpha.Product], regardless of whether or
   * not it exists, a PERMISSION_DENIED error is returned.
   *
   * If the [Product][google.cloud.retail.v2alpha.Product] to update does not
   * exist and
   * [allow_missing][google.cloud.retail.v2alpha.UpdateProductRequest.allow_missing]
   * is not set, a NOT_FOUND error is returned.
   * 
   *
   * 
   * .google.cloud.retail.v2alpha.Product product = 1 [(.google.api.field_behavior) = REQUIRED];
   * 
   *
   * @return Whether the product field is set.
   */
  boolean hasProduct();
  /**
   *
   *
   *    * Required. The product to update/create.
   *
   * If the caller does not have permission to update the
   * [Product][google.cloud.retail.v2alpha.Product], regardless of whether or
   * not it exists, a PERMISSION_DENIED error is returned.
   *
   * If the [Product][google.cloud.retail.v2alpha.Product] to update does not
   * exist and
   * [allow_missing][google.cloud.retail.v2alpha.UpdateProductRequest.allow_missing]
   * is not set, a NOT_FOUND error is returned.
   * 
   *
   * 
   * .google.cloud.retail.v2alpha.Product product = 1 [(.google.api.field_behavior) = REQUIRED];
   * 
   *
   * @return The product.
   */
  com.google.cloud.retail.v2alpha.Product getProduct();
  /**
   *
   *
   *    * Required. The product to update/create.
   *
   * If the caller does not have permission to update the
   * [Product][google.cloud.retail.v2alpha.Product], regardless of whether or
   * not it exists, a PERMISSION_DENIED error is returned.
   *
   * If the [Product][google.cloud.retail.v2alpha.Product] to update does not
   * exist and
   * [allow_missing][google.cloud.retail.v2alpha.UpdateProductRequest.allow_missing]
   * is not set, a NOT_FOUND error is returned.
   * 
   *
   * 
   * .google.cloud.retail.v2alpha.Product product = 1 [(.google.api.field_behavior) = REQUIRED];
   * 
   */
  com.google.cloud.retail.v2alpha.ProductOrBuilder getProductOrBuilder();

  /**
   *
   *
   *    * Indicates which fields in the provided
   * [Product][google.cloud.retail.v2alpha.Product] to update. The immutable and
   * output only fields are NOT supported. If not set, all supported fields (the
   * fields that are neither immutable nor output only) are updated.
   *
   * If an unsupported or unknown field is provided, an INVALID_ARGUMENT error
   * is returned.
   *
   * The attribute key can be updated by setting the mask path as
   * "attributes.${key_name}". If a key name is present in the mask but not in
   * the patching product from the request, this key will be deleted after the
   * update.
   * 
   *
   * .google.protobuf.FieldMask update_mask = 2;
   *
   * @return Whether the updateMask field is set.
   */
  boolean hasUpdateMask();
  /**
   *
   *
   *    * Indicates which fields in the provided
   * [Product][google.cloud.retail.v2alpha.Product] to update. The immutable and
   * output only fields are NOT supported. If not set, all supported fields (the
   * fields that are neither immutable nor output only) are updated.
   *
   * If an unsupported or unknown field is provided, an INVALID_ARGUMENT error
   * is returned.
   *
   * The attribute key can be updated by setting the mask path as
   * "attributes.${key_name}". If a key name is present in the mask but not in
   * the patching product from the request, this key will be deleted after the
   * update.
   * 
   *
   * .google.protobuf.FieldMask update_mask = 2;
   *
   * @return The updateMask.
   */
  com.google.protobuf.FieldMask getUpdateMask();
  /**
   *
   *
   *    * Indicates which fields in the provided
   * [Product][google.cloud.retail.v2alpha.Product] to update. The immutable and
   * output only fields are NOT supported. If not set, all supported fields (the
   * fields that are neither immutable nor output only) are updated.
   *
   * If an unsupported or unknown field is provided, an INVALID_ARGUMENT error
   * is returned.
   *
   * The attribute key can be updated by setting the mask path as
   * "attributes.${key_name}". If a key name is present in the mask but not in
   * the patching product from the request, this key will be deleted after the
   * update.
   * 
   *
   * .google.protobuf.FieldMask update_mask = 2;
   */
  com.google.protobuf.FieldMaskOrBuilder getUpdateMaskOrBuilder();

  /**
   *
   *
   *    * If set to true, and the [Product][google.cloud.retail.v2alpha.Product] is
   * not found, a new [Product][google.cloud.retail.v2alpha.Product] will be
   * created. In this situation, `update_mask` is ignored.
   * 
   *
   * bool allow_missing = 3;
   *
   * @return The allowMissing.
   */
  boolean getAllowMissing();
}