com.google.cloud.retail.v2alpha.SetDefaultBranchRequestOrBuilder 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/catalog_service.proto

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

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

  /**
   *
   *
   *    * Full resource name of the catalog, such as
   * `projects/*/locations/global/catalogs/default_catalog`.
   * 
   *
   * string catalog = 1 [(.google.api.resource_reference) = { ... }
   *
   * @return The catalog.
   */
  java.lang.String getCatalog();
  /**
   *
   *
   *    * Full resource name of the catalog, such as
   * `projects/*/locations/global/catalogs/default_catalog`.
   * 
   *
   * string catalog = 1 [(.google.api.resource_reference) = { ... }
   *
   * @return The bytes for catalog.
   */
  com.google.protobuf.ByteString getCatalogBytes();

  /**
   *
   *
   *    * The final component of the resource name of a branch.
   *
   * This field must be one of "0", "1" or "2". Otherwise, an INVALID_ARGUMENT
   * error is returned.
   *
   * If there are no sufficient active products in the targeted branch and
   * [force][google.cloud.retail.v2alpha.SetDefaultBranchRequest.force] is not
   * set, a FAILED_PRECONDITION error is returned.
   * 
   *
   * string branch_id = 2 [(.google.api.resource_reference) = { ... }
   *
   * @return The branchId.
   */
  java.lang.String getBranchId();
  /**
   *
   *
   *    * The final component of the resource name of a branch.
   *
   * This field must be one of "0", "1" or "2". Otherwise, an INVALID_ARGUMENT
   * error is returned.
   *
   * If there are no sufficient active products in the targeted branch and
   * [force][google.cloud.retail.v2alpha.SetDefaultBranchRequest.force] is not
   * set, a FAILED_PRECONDITION error is returned.
   * 
   *
   * string branch_id = 2 [(.google.api.resource_reference) = { ... }
   *
   * @return The bytes for branchId.
   */
  com.google.protobuf.ByteString getBranchIdBytes();

  /**
   *
   *
   *    * Some note on this request, this can be retrieved by
   * [CatalogService.GetDefaultBranch][google.cloud.retail.v2alpha.CatalogService.GetDefaultBranch]
   * before next valid default branch set occurs.
   *
   * This field must be a UTF-8 encoded string with a length limit of 1,000
   * characters. Otherwise, an INVALID_ARGUMENT error is returned.
   * 
   *
   * string note = 3;
   *
   * @return The note.
   */
  java.lang.String getNote();
  /**
   *
   *
   *    * Some note on this request, this can be retrieved by
   * [CatalogService.GetDefaultBranch][google.cloud.retail.v2alpha.CatalogService.GetDefaultBranch]
   * before next valid default branch set occurs.
   *
   * This field must be a UTF-8 encoded string with a length limit of 1,000
   * characters. Otherwise, an INVALID_ARGUMENT error is returned.
   * 
   *
   * string note = 3;
   *
   * @return The bytes for note.
   */
  com.google.protobuf.ByteString getNoteBytes();

  /**
   *
   *
   *    * If set to true, it permits switching to a branch with
   * [branch_id][google.cloud.retail.v2alpha.SetDefaultBranchRequest.branch_id]
   * even if it has no sufficient active products.
   * 
   *
   * bool force = 4;
   *
   * @return The force.
   */
  boolean getForce();
}