com.google.api.services.privateca.v1.model.X509Parameters 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;

/**
 * An X509Parameters is used to describe certain fields of an X.509 certificate, such as the key
 * usage fields, fields specific to CA certificates, certificate policy extensions and custom
 * extensions.
 *
 *  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 X509Parameters extends com.google.api.client.json.GenericJson {

  /**
   * Optional. Describes custom X.509 extensions.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.util.List additionalExtensions;

  static {
    // hack to force ProGuard to consider X509Extension 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(X509Extension.class);
  }

  /**
   * Optional. Describes Online Certificate Status Protocol (OCSP) endpoint addresses that appear in
   * the "Authority Information Access" extension in the certificate.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.util.List aiaOcspServers;

  /**
   * Optional. Describes options in this X509Parameters that are relevant in a CA certificate.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private CaOptions caOptions;

  /**
   * Optional. Indicates the intended use for keys that correspond to a certificate.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private KeyUsage keyUsage;

  /**
   * Optional. Describes the X.509 name constraints extension.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private NameConstraints nameConstraints;

  /**
   * Optional. Describes the X.509 certificate policy object identifiers, per
   * https://tools.ietf.org/html/rfc5280#section-4.2.1.4.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.util.List policyIds;

  static {
    // hack to force ProGuard to consider ObjectId 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(ObjectId.class);
  }

  /**
   * Optional. Describes custom X.509 extensions.
   * @return value or {@code null} for none
   */
  public java.util.List getAdditionalExtensions() {
    return additionalExtensions;
  }

  /**
   * Optional. Describes custom X.509 extensions.
   * @param additionalExtensions additionalExtensions or {@code null} for none
   */
  public X509Parameters setAdditionalExtensions(java.util.List additionalExtensions) {
    this.additionalExtensions = additionalExtensions;
    return this;
  }

  /**
   * Optional. Describes Online Certificate Status Protocol (OCSP) endpoint addresses that appear in
   * the "Authority Information Access" extension in the certificate.
   * @return value or {@code null} for none
   */
  public java.util.List getAiaOcspServers() {
    return aiaOcspServers;
  }

  /**
   * Optional. Describes Online Certificate Status Protocol (OCSP) endpoint addresses that appear in
   * the "Authority Information Access" extension in the certificate.
   * @param aiaOcspServers aiaOcspServers or {@code null} for none
   */
  public X509Parameters setAiaOcspServers(java.util.List aiaOcspServers) {
    this.aiaOcspServers = aiaOcspServers;
    return this;
  }

  /**
   * Optional. Describes options in this X509Parameters that are relevant in a CA certificate.
   * @return value or {@code null} for none
   */
  public CaOptions getCaOptions() {
    return caOptions;
  }

  /**
   * Optional. Describes options in this X509Parameters that are relevant in a CA certificate.
   * @param caOptions caOptions or {@code null} for none
   */
  public X509Parameters setCaOptions(CaOptions caOptions) {
    this.caOptions = caOptions;
    return this;
  }

  /**
   * Optional. Indicates the intended use for keys that correspond to a certificate.
   * @return value or {@code null} for none
   */
  public KeyUsage getKeyUsage() {
    return keyUsage;
  }

  /**
   * Optional. Indicates the intended use for keys that correspond to a certificate.
   * @param keyUsage keyUsage or {@code null} for none
   */
  public X509Parameters setKeyUsage(KeyUsage keyUsage) {
    this.keyUsage = keyUsage;
    return this;
  }

  /**
   * Optional. Describes the X.509 name constraints extension.
   * @return value or {@code null} for none
   */
  public NameConstraints getNameConstraints() {
    return nameConstraints;
  }

  /**
   * Optional. Describes the X.509 name constraints extension.
   * @param nameConstraints nameConstraints or {@code null} for none
   */
  public X509Parameters setNameConstraints(NameConstraints nameConstraints) {
    this.nameConstraints = nameConstraints;
    return this;
  }

  /**
   * Optional. Describes the X.509 certificate policy object identifiers, per
   * https://tools.ietf.org/html/rfc5280#section-4.2.1.4.
   * @return value or {@code null} for none
   */
  public java.util.List getPolicyIds() {
    return policyIds;
  }

  /**
   * Optional. Describes the X.509 certificate policy object identifiers, per
   * https://tools.ietf.org/html/rfc5280#section-4.2.1.4.
   * @param policyIds policyIds or {@code null} for none
   */
  public X509Parameters setPolicyIds(java.util.List policyIds) {
    this.policyIds = policyIds;
    return this;
  }

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

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

}