com.google.api.services.retail.v2.model.GoogleCloudRetailV2SetDefaultBranchRequest Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of google-api-services-retail Show documentation
There is a newer version: v2-rev20241220-2.0.0
Show newest version
/*
 * 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
 *
 * http://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.
 */
/*
 * This code was generated by https://github.com/googleapis/google-api-java-client-services/
 * Modify at your own risk.
 */

package com.google.api.services.retail.v2.model;

/**
 * Request message to set a specified branch as new default_branch.
 *
 *  This is the Java data model class that specifies how to parse/serialize into the JSON that is
 * transmitted over HTTP when working with the Retail API. For a detailed explanation see:
 * https://developers.google.com/api-client-library/java/google-http-java-client/json
 * 
 *
 * @author Google, Inc.
 */
@SuppressWarnings("javadoc")
public final class GoogleCloudRetailV2SetDefaultBranchRequest extends com.google.api.client.json.GenericJson {

  /**
   * 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 is not set, a FAILED_PRECONDITION error is returned.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String branchId;

  /**
   * If set to true, it permits switching to a branch with branch_id even if it has no sufficient
   * active products.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Boolean force;

  /**
   * Some note on this request, this can be retrieved by 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.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String note;

  /**
   * 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 is not set, a FAILED_PRECONDITION error is returned.
   * @return value or {@code null} for none
   */
  public java.lang.String getBranchId() {
    return branchId;
  }

  /**
   * 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 is not set, a FAILED_PRECONDITION error is returned.
   * @param branchId branchId or {@code null} for none
   */
  public GoogleCloudRetailV2SetDefaultBranchRequest setBranchId(java.lang.String branchId) {
    this.branchId = branchId;
    return this;
  }

  /**
   * If set to true, it permits switching to a branch with branch_id even if it has no sufficient
   * active products.
   * @return value or {@code null} for none
   */
  public java.lang.Boolean getForce() {
    return force;
  }

  /**
   * If set to true, it permits switching to a branch with branch_id even if it has no sufficient
   * active products.
   * @param force force or {@code null} for none
   */
  public GoogleCloudRetailV2SetDefaultBranchRequest setForce(java.lang.Boolean force) {
    this.force = force;
    return this;
  }

  /**
   * Some note on this request, this can be retrieved by 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.
   * @return value or {@code null} for none
   */
  public java.lang.String getNote() {
    return note;
  }

  /**
   * Some note on this request, this can be retrieved by 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.
   * @param note note or {@code null} for none
   */
  public GoogleCloudRetailV2SetDefaultBranchRequest setNote(java.lang.String note) {
    this.note = note;
    return this;
  }

  @Override
  public GoogleCloudRetailV2SetDefaultBranchRequest set(String fieldName, Object value) {
    return (GoogleCloudRetailV2SetDefaultBranchRequest) super.set(fieldName, value);
  }

  @Override
  public GoogleCloudRetailV2SetDefaultBranchRequest clone() {
    return (GoogleCloudRetailV2SetDefaultBranchRequest) super.clone();
  }

}