com.google.cloud.documentai.v1beta3.DatasetOrBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of proto-google-cloud-document-ai-v1beta3 Show documentation
PROTO library for proto-google-cloud-document-ai-v1beta3
There is a newer version: 0.71.0
Show newest version
/*
 * Copyright 2024 Google LLC
 *
 * 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
 *
 *     https://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.
 */
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: google/cloud/documentai/v1beta3/dataset.proto

// Protobuf Java Version: 3.25.2
package com.google.cloud.documentai.v1beta3;

public interface DatasetOrBuilder
    extends
    // @@protoc_insertion_point(interface_extends:google.cloud.documentai.v1beta3.Dataset)
    com.google.protobuf.MessageOrBuilder {

  /**
   *
   *
   *    * Optional. User-managed Cloud Storage dataset configuration. Use this
   * configuration if the dataset documents are stored under a user-managed
   * Cloud Storage location.
   * 
   *
   * 
   * .google.cloud.documentai.v1beta3.Dataset.GCSManagedConfig gcs_managed_config = 3 [(.google.api.field_behavior) = OPTIONAL];
   * 
   *
   * @return Whether the gcsManagedConfig field is set.
   */
  boolean hasGcsManagedConfig();
  /**
   *
   *
   *    * Optional. User-managed Cloud Storage dataset configuration. Use this
   * configuration if the dataset documents are stored under a user-managed
   * Cloud Storage location.
   * 
   *
   * 
   * .google.cloud.documentai.v1beta3.Dataset.GCSManagedConfig gcs_managed_config = 3 [(.google.api.field_behavior) = OPTIONAL];
   * 
   *
   * @return The gcsManagedConfig.
   */
  com.google.cloud.documentai.v1beta3.Dataset.GCSManagedConfig getGcsManagedConfig();
  /**
   *
   *
   *    * Optional. User-managed Cloud Storage dataset configuration. Use this
   * configuration if the dataset documents are stored under a user-managed
   * Cloud Storage location.
   * 
   *
   * 
   * .google.cloud.documentai.v1beta3.Dataset.GCSManagedConfig gcs_managed_config = 3 [(.google.api.field_behavior) = OPTIONAL];
   * 
   */
  com.google.cloud.documentai.v1beta3.Dataset.GCSManagedConfigOrBuilder
      getGcsManagedConfigOrBuilder();

  /**
   *
   *
   *    * Optional. Deprecated. Warehouse-based dataset configuration is not
   * supported.
   * 
   *
   * 
   * .google.cloud.documentai.v1beta3.Dataset.DocumentWarehouseConfig document_warehouse_config = 5 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];
   * 
   *
   * @deprecated google.cloud.documentai.v1beta3.Dataset.document_warehouse_config is deprecated.
   *     See google/cloud/documentai/v1beta3/dataset.proto;l=98
   * @return Whether the documentWarehouseConfig field is set.
   */
  @java.lang.Deprecated
  boolean hasDocumentWarehouseConfig();
  /**
   *
   *
   *    * Optional. Deprecated. Warehouse-based dataset configuration is not
   * supported.
   * 
   *
   * 
   * .google.cloud.documentai.v1beta3.Dataset.DocumentWarehouseConfig document_warehouse_config = 5 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];
   * 
   *
   * @deprecated google.cloud.documentai.v1beta3.Dataset.document_warehouse_config is deprecated.
   *     See google/cloud/documentai/v1beta3/dataset.proto;l=98
   * @return The documentWarehouseConfig.
   */
  @java.lang.Deprecated
  com.google.cloud.documentai.v1beta3.Dataset.DocumentWarehouseConfig getDocumentWarehouseConfig();
  /**
   *
   *
   *    * Optional. Deprecated. Warehouse-based dataset configuration is not
   * supported.
   * 
   *
   * 
   * .google.cloud.documentai.v1beta3.Dataset.DocumentWarehouseConfig document_warehouse_config = 5 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];
   * 
   */
  @java.lang.Deprecated
  com.google.cloud.documentai.v1beta3.Dataset.DocumentWarehouseConfigOrBuilder
      getDocumentWarehouseConfigOrBuilder();

  /**
   *
   *
   *    * Optional. Unmanaged dataset configuration. Use this configuration if the
   * dataset documents are managed by the document service internally (not
   * user-managed).
   * 
   *
   * 
   * .google.cloud.documentai.v1beta3.Dataset.UnmanagedDatasetConfig unmanaged_dataset_config = 6 [(.google.api.field_behavior) = OPTIONAL];
   * 
   *
   * @return Whether the unmanagedDatasetConfig field is set.
   */
  boolean hasUnmanagedDatasetConfig();
  /**
   *
   *
   *    * Optional. Unmanaged dataset configuration. Use this configuration if the
   * dataset documents are managed by the document service internally (not
   * user-managed).
   * 
   *
   * 
   * .google.cloud.documentai.v1beta3.Dataset.UnmanagedDatasetConfig unmanaged_dataset_config = 6 [(.google.api.field_behavior) = OPTIONAL];
   * 
   *
   * @return The unmanagedDatasetConfig.
   */
  com.google.cloud.documentai.v1beta3.Dataset.UnmanagedDatasetConfig getUnmanagedDatasetConfig();
  /**
   *
   *
   *    * Optional. Unmanaged dataset configuration. Use this configuration if the
   * dataset documents are managed by the document service internally (not
   * user-managed).
   * 
   *
   * 
   * .google.cloud.documentai.v1beta3.Dataset.UnmanagedDatasetConfig unmanaged_dataset_config = 6 [(.google.api.field_behavior) = OPTIONAL];
   * 
   */
  com.google.cloud.documentai.v1beta3.Dataset.UnmanagedDatasetConfigOrBuilder
      getUnmanagedDatasetConfigOrBuilder();

  /**
   *
   *
   *    * Optional. A lightweight indexing source with low latency and high
   * reliability, but lacking advanced features like CMEK and content-based
   * search.
   * 
   *
   * 
   * .google.cloud.documentai.v1beta3.Dataset.SpannerIndexingConfig spanner_indexing_config = 4 [(.google.api.field_behavior) = OPTIONAL];
   * 
   *
   * @return Whether the spannerIndexingConfig field is set.
   */
  boolean hasSpannerIndexingConfig();
  /**
   *
   *
   *    * Optional. A lightweight indexing source with low latency and high
   * reliability, but lacking advanced features like CMEK and content-based
   * search.
   * 
   *
   * 
   * .google.cloud.documentai.v1beta3.Dataset.SpannerIndexingConfig spanner_indexing_config = 4 [(.google.api.field_behavior) = OPTIONAL];
   * 
   *
   * @return The spannerIndexingConfig.
   */
  com.google.cloud.documentai.v1beta3.Dataset.SpannerIndexingConfig getSpannerIndexingConfig();
  /**
   *
   *
   *    * Optional. A lightweight indexing source with low latency and high
   * reliability, but lacking advanced features like CMEK and content-based
   * search.
   * 
   *
   * 
   * .google.cloud.documentai.v1beta3.Dataset.SpannerIndexingConfig spanner_indexing_config = 4 [(.google.api.field_behavior) = OPTIONAL];
   * 
   */
  com.google.cloud.documentai.v1beta3.Dataset.SpannerIndexingConfigOrBuilder
      getSpannerIndexingConfigOrBuilder();

  /**
   *
   *
   *    * Dataset resource name.
   * Format:
   * `projects/{project}/locations/{location}/processors/{processor}/dataset`
   * 
   *
   * string name = 1;
   *
   * @return The name.
   */
  java.lang.String getName();
  /**
   *
   *
   *    * Dataset resource name.
   * Format:
   * `projects/{project}/locations/{location}/processors/{processor}/dataset`
   * 
   *
   * string name = 1;
   *
   * @return The bytes for name.
   */
  com.google.protobuf.ByteString getNameBytes();

  /**
   *
   *
   *    * Required. State of the dataset. Ignored when updating dataset.
   * 
   *
   * 
   * .google.cloud.documentai.v1beta3.Dataset.State state = 2 [(.google.api.field_behavior) = REQUIRED];
   * 
   *
   * @return The enum numeric value on the wire for state.
   */
  int getStateValue();
  /**
   *
   *
   *    * Required. State of the dataset. Ignored when updating dataset.
   * 
   *
   * 
   * .google.cloud.documentai.v1beta3.Dataset.State state = 2 [(.google.api.field_behavior) = REQUIRED];
   * 
   *
   * @return The state.
   */
  com.google.cloud.documentai.v1beta3.Dataset.State getState();

  com.google.cloud.documentai.v1beta3.Dataset.StorageSourceCase getStorageSourceCase();

  com.google.cloud.documentai.v1beta3.Dataset.IndexingSourceCase getIndexingSourceCase();
}