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

/**
 * A singleton resource under a Processor which configures a collection of documents.
 *
 *  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 GoogleCloudDocumentaiV1beta3Dataset extends com.google.api.client.json.GenericJson {

  /**
   * Optional. Deprecated. Warehouse-based dataset configuration is not supported.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private GoogleCloudDocumentaiV1beta3DatasetDocumentWarehouseConfig documentWarehouseConfig;

  /**
   * Optional. User-managed Cloud Storage dataset configuration. Use this configuration if the
   * dataset documents are stored under a user-managed Cloud Storage location.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private GoogleCloudDocumentaiV1beta3DatasetGCSManagedConfig gcsManagedConfig;

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

  /**
   * 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;

  /**
   * Optional. A lightweight indexing source with low latency and high reliability, but lacking
   * advanced features like CMEK and content-based search.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private GoogleCloudDocumentaiV1beta3DatasetSpannerIndexingConfig spannerIndexingConfig;

  /**
   * Required. State of the dataset. Ignored when updating dataset.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String state;

  /**
   * Optional. Unmanaged dataset configuration. Use this configuration if the dataset documents are
   * managed by the document service internally (not user-managed).
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private GoogleCloudDocumentaiV1beta3DatasetUnmanagedDatasetConfig unmanagedDatasetConfig;

  /**
   * Optional. Deprecated. Warehouse-based dataset configuration is not supported.
   * @return value or {@code null} for none
   */
  public GoogleCloudDocumentaiV1beta3DatasetDocumentWarehouseConfig getDocumentWarehouseConfig() {
    return documentWarehouseConfig;
  }

  /**
   * Optional. Deprecated. Warehouse-based dataset configuration is not supported.
   * @param documentWarehouseConfig documentWarehouseConfig or {@code null} for none
   */
  public GoogleCloudDocumentaiV1beta3Dataset setDocumentWarehouseConfig(GoogleCloudDocumentaiV1beta3DatasetDocumentWarehouseConfig documentWarehouseConfig) {
    this.documentWarehouseConfig = documentWarehouseConfig;
    return this;
  }

  /**
   * Optional. User-managed Cloud Storage dataset configuration. Use this configuration if the
   * dataset documents are stored under a user-managed Cloud Storage location.
   * @return value or {@code null} for none
   */
  public GoogleCloudDocumentaiV1beta3DatasetGCSManagedConfig getGcsManagedConfig() {
    return gcsManagedConfig;
  }

  /**
   * Optional. User-managed Cloud Storage dataset configuration. Use this configuration if the
   * dataset documents are stored under a user-managed Cloud Storage location.
   * @param gcsManagedConfig gcsManagedConfig or {@code null} for none
   */
  public GoogleCloudDocumentaiV1beta3Dataset setGcsManagedConfig(GoogleCloudDocumentaiV1beta3DatasetGCSManagedConfig gcsManagedConfig) {
    this.gcsManagedConfig = gcsManagedConfig;
    return this;
  }

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

  /**
   * Dataset resource name. Format:
   * `projects/{project}/locations/{location}/processors/{processor}/dataset`
   * @param name name or {@code null} for none
   */
  public GoogleCloudDocumentaiV1beta3Dataset setName(java.lang.String name) {
    this.name = name;
    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 GoogleCloudDocumentaiV1beta3Dataset 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 GoogleCloudDocumentaiV1beta3Dataset setSatisfiesPzs(java.lang.Boolean satisfiesPzs) {
    this.satisfiesPzs = satisfiesPzs;
    return this;
  }

  /**
   * Optional. A lightweight indexing source with low latency and high reliability, but lacking
   * advanced features like CMEK and content-based search.
   * @return value or {@code null} for none
   */
  public GoogleCloudDocumentaiV1beta3DatasetSpannerIndexingConfig getSpannerIndexingConfig() {
    return spannerIndexingConfig;
  }

  /**
   * Optional. A lightweight indexing source with low latency and high reliability, but lacking
   * advanced features like CMEK and content-based search.
   * @param spannerIndexingConfig spannerIndexingConfig or {@code null} for none
   */
  public GoogleCloudDocumentaiV1beta3Dataset setSpannerIndexingConfig(GoogleCloudDocumentaiV1beta3DatasetSpannerIndexingConfig spannerIndexingConfig) {
    this.spannerIndexingConfig = spannerIndexingConfig;
    return this;
  }

  /**
   * Required. State of the dataset. Ignored when updating dataset.
   * @return value or {@code null} for none
   */
  public java.lang.String getState() {
    return state;
  }

  /**
   * Required. State of the dataset. Ignored when updating dataset.
   * @param state state or {@code null} for none
   */
  public GoogleCloudDocumentaiV1beta3Dataset setState(java.lang.String state) {
    this.state = state;
    return this;
  }

  /**
   * Optional. Unmanaged dataset configuration. Use this configuration if the dataset documents are
   * managed by the document service internally (not user-managed).
   * @return value or {@code null} for none
   */
  public GoogleCloudDocumentaiV1beta3DatasetUnmanagedDatasetConfig getUnmanagedDatasetConfig() {
    return unmanagedDatasetConfig;
  }

  /**
   * Optional. Unmanaged dataset configuration. Use this configuration if the dataset documents are
   * managed by the document service internally (not user-managed).
   * @param unmanagedDatasetConfig unmanagedDatasetConfig or {@code null} for none
   */
  public GoogleCloudDocumentaiV1beta3Dataset setUnmanagedDatasetConfig(GoogleCloudDocumentaiV1beta3DatasetUnmanagedDatasetConfig unmanagedDatasetConfig) {
    this.unmanagedDatasetConfig = unmanagedDatasetConfig;
    return this;
  }

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

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

}