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

/**
 * The first-class citizen for Document AI. Each processor defines how to extract structural
 * information from a document.
 *
 *  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 Document AI 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 GoogleCloudDocumentaiV1Processor extends com.google.api.client.json.GenericJson {

  /**
   * The time the processor was created.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private String createTime;

  /**
   * The default processor version.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String defaultProcessorVersion;

  /**
   * The display name of the processor.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String displayName;

  /**
   * The [KMS key](https://cloud.google.com/security-key-management) used for encryption and
   * decryption in CMEK scenarios.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String kmsKeyName;

  /**
   * Output only. Immutable. The resource name of the processor. Format:
   * `projects/{project}/locations/{location}/processors/{processor}`
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String name;

  /**
   * Output only. Immutable. The http endpoint that can be called to invoke processing.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String processEndpoint;

  /**
   * Output only. The processor version aliases.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.util.List processorVersionAliases;

  /**
   * Output only. Reserved for future use.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Boolean satisfiesPzi;

  /**
   * Output only. Reserved for future use.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Boolean satisfiesPzs;

  /**
   * Output only. The state of the processor.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String state;

  /**
   * The processor type, such as: `OCR_PROCESSOR`, `INVOICE_PROCESSOR`. To get a list of processor
   * types, see FetchProcessorTypes.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String type;

  /**
   * The time the processor was created.
   * @return value or {@code null} for none
   */
  public String getCreateTime() {
    return createTime;
  }

  /**
   * The time the processor was created.
   * @param createTime createTime or {@code null} for none
   */
  public GoogleCloudDocumentaiV1Processor setCreateTime(String createTime) {
    this.createTime = createTime;
    return this;
  }

  /**
   * The default processor version.
   * @return value or {@code null} for none
   */
  public java.lang.String getDefaultProcessorVersion() {
    return defaultProcessorVersion;
  }

  /**
   * The default processor version.
   * @param defaultProcessorVersion defaultProcessorVersion or {@code null} for none
   */
  public GoogleCloudDocumentaiV1Processor setDefaultProcessorVersion(java.lang.String defaultProcessorVersion) {
    this.defaultProcessorVersion = defaultProcessorVersion;
    return this;
  }

  /**
   * The display name of the processor.
   * @return value or {@code null} for none
   */
  public java.lang.String getDisplayName() {
    return displayName;
  }

  /**
   * The display name of the processor.
   * @param displayName displayName or {@code null} for none
   */
  public GoogleCloudDocumentaiV1Processor setDisplayName(java.lang.String displayName) {
    this.displayName = displayName;
    return this;
  }

  /**
   * The [KMS key](https://cloud.google.com/security-key-management) used for encryption and
   * decryption in CMEK scenarios.
   * @return value or {@code null} for none
   */
  public java.lang.String getKmsKeyName() {
    return kmsKeyName;
  }

  /**
   * The [KMS key](https://cloud.google.com/security-key-management) used for encryption and
   * decryption in CMEK scenarios.
   * @param kmsKeyName kmsKeyName or {@code null} for none
   */
  public GoogleCloudDocumentaiV1Processor setKmsKeyName(java.lang.String kmsKeyName) {
    this.kmsKeyName = kmsKeyName;
    return this;
  }

  /**
   * Output only. Immutable. The resource name of the processor. Format:
   * `projects/{project}/locations/{location}/processors/{processor}`
   * @return value or {@code null} for none
   */
  public java.lang.String getName() {
    return name;
  }

  /**
   * Output only. Immutable. The resource name of the processor. Format:
   * `projects/{project}/locations/{location}/processors/{processor}`
   * @param name name or {@code null} for none
   */
  public GoogleCloudDocumentaiV1Processor setName(java.lang.String name) {
    this.name = name;
    return this;
  }

  /**
   * Output only. Immutable. The http endpoint that can be called to invoke processing.
   * @return value or {@code null} for none
   */
  public java.lang.String getProcessEndpoint() {
    return processEndpoint;
  }

  /**
   * Output only. Immutable. The http endpoint that can be called to invoke processing.
   * @param processEndpoint processEndpoint or {@code null} for none
   */
  public GoogleCloudDocumentaiV1Processor setProcessEndpoint(java.lang.String processEndpoint) {
    this.processEndpoint = processEndpoint;
    return this;
  }

  /**
   * Output only. The processor version aliases.
   * @return value or {@code null} for none
   */
  public java.util.List getProcessorVersionAliases() {
    return processorVersionAliases;
  }

  /**
   * Output only. The processor version aliases.
   * @param processorVersionAliases processorVersionAliases or {@code null} for none
   */
  public GoogleCloudDocumentaiV1Processor setProcessorVersionAliases(java.util.List processorVersionAliases) {
    this.processorVersionAliases = processorVersionAliases;
    return this;
  }

  /**
   * Output only. Reserved for future use.
   * @return value or {@code null} for none
   */
  public java.lang.Boolean getSatisfiesPzi() {
    return satisfiesPzi;
  }

  /**
   * Output only. Reserved for future use.
   * @param satisfiesPzi satisfiesPzi or {@code null} for none
   */
  public GoogleCloudDocumentaiV1Processor setSatisfiesPzi(java.lang.Boolean satisfiesPzi) {
    this.satisfiesPzi = satisfiesPzi;
    return this;
  }

  /**
   * Output only. Reserved for future use.
   * @return value or {@code null} for none
   */
  public java.lang.Boolean getSatisfiesPzs() {
    return satisfiesPzs;
  }

  /**
   * Output only. Reserved for future use.
   * @param satisfiesPzs satisfiesPzs or {@code null} for none
   */
  public GoogleCloudDocumentaiV1Processor setSatisfiesPzs(java.lang.Boolean satisfiesPzs) {
    this.satisfiesPzs = satisfiesPzs;
    return this;
  }

  /**
   * Output only. The state of the processor.
   * @return value or {@code null} for none
   */
  public java.lang.String getState() {
    return state;
  }

  /**
   * Output only. The state of the processor.
   * @param state state or {@code null} for none
   */
  public GoogleCloudDocumentaiV1Processor setState(java.lang.String state) {
    this.state = state;
    return this;
  }

  /**
   * The processor type, such as: `OCR_PROCESSOR`, `INVOICE_PROCESSOR`. To get a list of processor
   * types, see FetchProcessorTypes.
   * @return value or {@code null} for none
   */
  public java.lang.String getType() {
    return type;
  }

  /**
   * The processor type, such as: `OCR_PROCESSOR`, `INVOICE_PROCESSOR`. To get a list of processor
   * types, see FetchProcessorTypes.
   * @param type type or {@code null} for none
   */
  public GoogleCloudDocumentaiV1Processor setType(java.lang.String type) {
    this.type = type;
    return this;
  }

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

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

}