com.google.api.services.privateca.v1.model.CaOptions Maven / Gradle / Ivy

Go to download
/*
 * 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.privateca.v1.model;

/**
 * Describes values that are relevant in a CA certificate.
 *
 *  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 Certificate Authority 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 CaOptions extends com.google.api.client.json.GenericJson {

  /**
   * Optional. Refers to the "CA" X.509 extension, which is a boolean value. When this value is
   * missing, the extension will be omitted from the CA certificate.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Boolean isCa;

  /**
   * Optional. Refers to the path length restriction X.509 extension. For a CA certificate, this
   * value describes the depth of subordinate CA certificates that are allowed. If this value is
   * less than 0, the request will fail. If this value is missing, the max path length will be
   * omitted from the CA certificate.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Integer maxIssuerPathLength;

  /**
   * Optional. Refers to the "CA" X.509 extension, which is a boolean value. When this value is
   * missing, the extension will be omitted from the CA certificate.
   * @return value or {@code null} for none
   */
  public java.lang.Boolean getIsCa() {
    return isCa;
  }

  /**
   * Optional. Refers to the "CA" X.509 extension, which is a boolean value. When this value is
   * missing, the extension will be omitted from the CA certificate.
   * @param isCa isCa or {@code null} for none
   */
  public CaOptions setIsCa(java.lang.Boolean isCa) {
    this.isCa = isCa;
    return this;
  }

  /**
   * Optional. Refers to the path length restriction X.509 extension. For a CA certificate, this
   * value describes the depth of subordinate CA certificates that are allowed. If this value is
   * less than 0, the request will fail. If this value is missing, the max path length will be
   * omitted from the CA certificate.
   * @return value or {@code null} for none
   */
  public java.lang.Integer getMaxIssuerPathLength() {
    return maxIssuerPathLength;
  }

  /**
   * Optional. Refers to the path length restriction X.509 extension. For a CA certificate, this
   * value describes the depth of subordinate CA certificates that are allowed. If this value is
   * less than 0, the request will fail. If this value is missing, the max path length will be
   * omitted from the CA certificate.
   * @param maxIssuerPathLength maxIssuerPathLength or {@code null} for none
   */
  public CaOptions setMaxIssuerPathLength(java.lang.Integer maxIssuerPathLength) {
    this.maxIssuerPathLength = maxIssuerPathLength;
    return this;
  }

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

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

}