com.google.api.services.cloudchannel.v1.model.GoogleCloudChannelV1TransferEntitlementsRequest Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of google-api-services-cloudchannel Show documentation
There is a newer version: v1-rev20241202-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.cloudchannel.v1.model;

/**
 * Request message for CloudChannelService.TransferEntitlements.
 *
 *  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 Cloud Channel 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 GoogleCloudChannelV1TransferEntitlementsRequest extends com.google.api.client.json.GenericJson {

  /**
   * The super admin of the resold customer generates this token to authorize a reseller to access
   * their Cloud Identity and purchase entitlements on their behalf. You can omit this token after
   * authorization. See https://support.google.com/a/answer/7643790 for more details.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String authToken;

  /**
   * Required. The new entitlements to create or transfer.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.util.List entitlements;

  static {
    // hack to force ProGuard to consider GoogleCloudChannelV1Entitlement used, since otherwise it would be stripped out
    // see https://github.com/google/google-api-java-client/issues/543
    com.google.api.client.util.Data.nullOf(GoogleCloudChannelV1Entitlement.class);
  }

  /**
   * Optional. You can specify an optional unique request ID, and if you need to retry your request,
   * the server will know to ignore the request if it's complete. For example, 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 it received the original operation with the same request ID. If it did, it
   * will ignore the second request. The request ID must be a valid
   * [UUID](https://tools.ietf.org/html/rfc4122) with the exception that zero UUID is not supported
   * (`00000000-0000-0000-0000-000000000000`).
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String requestId;

  /**
   * The super admin of the resold customer generates this token to authorize a reseller to access
   * their Cloud Identity and purchase entitlements on their behalf. You can omit this token after
   * authorization. See https://support.google.com/a/answer/7643790 for more details.
   * @return value or {@code null} for none
   */
  public java.lang.String getAuthToken() {
    return authToken;
  }

  /**
   * The super admin of the resold customer generates this token to authorize a reseller to access
   * their Cloud Identity and purchase entitlements on their behalf. You can omit this token after
   * authorization. See https://support.google.com/a/answer/7643790 for more details.
   * @param authToken authToken or {@code null} for none
   */
  public GoogleCloudChannelV1TransferEntitlementsRequest setAuthToken(java.lang.String authToken) {
    this.authToken = authToken;
    return this;
  }

  /**
   * Required. The new entitlements to create or transfer.
   * @return value or {@code null} for none
   */
  public java.util.List getEntitlements() {
    return entitlements;
  }

  /**
   * Required. The new entitlements to create or transfer.
   * @param entitlements entitlements or {@code null} for none
   */
  public GoogleCloudChannelV1TransferEntitlementsRequest setEntitlements(java.util.List entitlements) {
    this.entitlements = entitlements;
    return this;
  }

  /**
   * Optional. You can specify an optional unique request ID, and if you need to retry your request,
   * the server will know to ignore the request if it's complete. For example, 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 it received the original operation with the same request ID. If it did, it
   * will ignore the second request. The request ID must be a valid
   * [UUID](https://tools.ietf.org/html/rfc4122) with the exception that zero UUID is not supported
   * (`00000000-0000-0000-0000-000000000000`).
   * @return value or {@code null} for none
   */
  public java.lang.String getRequestId() {
    return requestId;
  }

  /**
   * Optional. You can specify an optional unique request ID, and if you need to retry your request,
   * the server will know to ignore the request if it's complete. For example, 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 it received the original operation with the same request ID. If it did, it
   * will ignore the second request. The request ID must be a valid
   * [UUID](https://tools.ietf.org/html/rfc4122) with the exception that zero UUID is not supported
   * (`00000000-0000-0000-0000-000000000000`).
   * @param requestId requestId or {@code null} for none
   */
  public GoogleCloudChannelV1TransferEntitlementsRequest setRequestId(java.lang.String requestId) {
    this.requestId = requestId;
    return this;
  }

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

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

}