Class Dataset.Builder (2.44.0)

public static final class Dataset.Builder extends GeneratedMessageV3.Builder<Dataset.Builder> implements DatasetOrBuilder

A singleton resource under a Processor which configures a collection of documents.

Protobuf type google.cloud.documentai.v1beta3.Dataset

Implements

DatasetOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Dataset.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Dataset.Builder
Overrides

build()

public Dataset build()
Returns
TypeDescription
Dataset

buildPartial()

public Dataset buildPartial()
Returns
TypeDescription
Dataset

clear()

public Dataset.Builder clear()
Returns
TypeDescription
Dataset.Builder
Overrides

clearDocumentWarehouseConfig() (deprecated)

public Dataset.Builder clearDocumentWarehouseConfig()

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];

Returns
TypeDescription
Dataset.Builder

clearField(Descriptors.FieldDescriptor field)

public Dataset.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
Dataset.Builder
Overrides

clearGcsManagedConfig()

public Dataset.Builder clearGcsManagedConfig()

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];

Returns
TypeDescription
Dataset.Builder

clearIndexingSource()

public Dataset.Builder clearIndexingSource()
Returns
TypeDescription
Dataset.Builder

clearName()

public Dataset.Builder clearName()

Dataset resource name. Format: projects/{project}/locations/{location}/processors/{processor}/dataset

string name = 1;

Returns
TypeDescription
Dataset.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Dataset.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
Dataset.Builder
Overrides

clearSpannerIndexingConfig()

public Dataset.Builder clearSpannerIndexingConfig()

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];

Returns
TypeDescription
Dataset.Builder

clearState()

public Dataset.Builder clearState()

Required. State of the dataset. Ignored when updating dataset.

.google.cloud.documentai.v1beta3.Dataset.State state = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
Dataset.Builder

This builder for chaining.

clearStorageSource()

public Dataset.Builder clearStorageSource()
Returns
TypeDescription
Dataset.Builder

clearUnmanagedDatasetConfig()

public Dataset.Builder clearUnmanagedDatasetConfig()

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];

Returns
TypeDescription
Dataset.Builder

clone()

public Dataset.Builder clone()
Returns
TypeDescription
Dataset.Builder
Overrides

getDefaultInstanceForType()

public Dataset getDefaultInstanceForType()
Returns
TypeDescription
Dataset

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getDocumentWarehouseConfig() (deprecated)

public Dataset.DocumentWarehouseConfig getDocumentWarehouseConfig()

Deprecated. google.cloud.documentai.v1beta3.Dataset.document_warehouse_config is deprecated. See google/cloud/documentai/v1beta3/dataset.proto;l=98

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];

Returns
TypeDescription
Dataset.DocumentWarehouseConfig

The documentWarehouseConfig.

getDocumentWarehouseConfigBuilder() (deprecated)

public Dataset.DocumentWarehouseConfig.Builder getDocumentWarehouseConfigBuilder()

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];

Returns
TypeDescription
Dataset.DocumentWarehouseConfig.Builder

getDocumentWarehouseConfigOrBuilder() (deprecated)

public Dataset.DocumentWarehouseConfigOrBuilder getDocumentWarehouseConfigOrBuilder()

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];

Returns
TypeDescription
Dataset.DocumentWarehouseConfigOrBuilder

getGcsManagedConfig()

public 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];

Returns
TypeDescription
Dataset.GCSManagedConfig

The gcsManagedConfig.

getGcsManagedConfigBuilder()

public Dataset.GCSManagedConfig.Builder getGcsManagedConfigBuilder()

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];

Returns
TypeDescription
Dataset.GCSManagedConfig.Builder

getGcsManagedConfigOrBuilder()

public Dataset.GCSManagedConfigOrBuilder getGcsManagedConfigOrBuilder()

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];

Returns
TypeDescription
Dataset.GCSManagedConfigOrBuilder

getIndexingSourceCase()

public Dataset.IndexingSourceCase getIndexingSourceCase()
Returns
TypeDescription
Dataset.IndexingSourceCase

getName()

public String getName()

Dataset resource name. Format: projects/{project}/locations/{location}/processors/{processor}/dataset

string name = 1;

Returns
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

Dataset resource name. Format: projects/{project}/locations/{location}/processors/{processor}/dataset

string name = 1;

Returns
TypeDescription
ByteString

The bytes for name.

getSpannerIndexingConfig()

public 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];

Returns
TypeDescription
Dataset.SpannerIndexingConfig

The spannerIndexingConfig.

getSpannerIndexingConfigBuilder()

public Dataset.SpannerIndexingConfig.Builder getSpannerIndexingConfigBuilder()

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];

Returns
TypeDescription
Dataset.SpannerIndexingConfig.Builder

getSpannerIndexingConfigOrBuilder()

public Dataset.SpannerIndexingConfigOrBuilder getSpannerIndexingConfigOrBuilder()

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];

Returns
TypeDescription
Dataset.SpannerIndexingConfigOrBuilder

getState()

public Dataset.State getState()

Required. State of the dataset. Ignored when updating dataset.

.google.cloud.documentai.v1beta3.Dataset.State state = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
Dataset.State

The state.

getStateValue()

public int getStateValue()

Required. State of the dataset. Ignored when updating dataset.

.google.cloud.documentai.v1beta3.Dataset.State state = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
int

The enum numeric value on the wire for state.

getStorageSourceCase()

public Dataset.StorageSourceCase getStorageSourceCase()
Returns
TypeDescription
Dataset.StorageSourceCase

getUnmanagedDatasetConfig()

public 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];

Returns
TypeDescription
Dataset.UnmanagedDatasetConfig

The unmanagedDatasetConfig.

getUnmanagedDatasetConfigBuilder()

public Dataset.UnmanagedDatasetConfig.Builder getUnmanagedDatasetConfigBuilder()

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];

Returns
TypeDescription
Dataset.UnmanagedDatasetConfig.Builder

getUnmanagedDatasetConfigOrBuilder()

public Dataset.UnmanagedDatasetConfigOrBuilder getUnmanagedDatasetConfigOrBuilder()

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];

Returns
TypeDescription
Dataset.UnmanagedDatasetConfigOrBuilder

hasDocumentWarehouseConfig() (deprecated)

public boolean hasDocumentWarehouseConfig()

Deprecated. google.cloud.documentai.v1beta3.Dataset.document_warehouse_config is deprecated. See google/cloud/documentai/v1beta3/dataset.proto;l=98

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];

Returns
TypeDescription
boolean

Whether the documentWarehouseConfig field is set.

hasGcsManagedConfig()

public 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];

Returns
TypeDescription
boolean

Whether the gcsManagedConfig field is set.

hasSpannerIndexingConfig()

public 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];

Returns
TypeDescription
boolean

Whether the spannerIndexingConfig field is set.

hasUnmanagedDatasetConfig()

public 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];

Returns
TypeDescription
boolean

Whether the unmanagedDatasetConfig field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeDocumentWarehouseConfig(Dataset.DocumentWarehouseConfig value) (deprecated)

public Dataset.Builder mergeDocumentWarehouseConfig(Dataset.DocumentWarehouseConfig value)

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];

Parameter
NameDescription
valueDataset.DocumentWarehouseConfig
Returns
TypeDescription
Dataset.Builder

mergeFrom(Dataset other)

public Dataset.Builder mergeFrom(Dataset other)
Parameter
NameDescription
otherDataset
Returns
TypeDescription
Dataset.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Dataset.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Dataset.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public Dataset.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
Dataset.Builder
Overrides

mergeGcsManagedConfig(Dataset.GCSManagedConfig value)

public Dataset.Builder mergeGcsManagedConfig(Dataset.GCSManagedConfig value)

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];

Parameter
NameDescription
valueDataset.GCSManagedConfig
Returns
TypeDescription
Dataset.Builder

mergeSpannerIndexingConfig(Dataset.SpannerIndexingConfig value)

public Dataset.Builder mergeSpannerIndexingConfig(Dataset.SpannerIndexingConfig value)

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];

Parameter
NameDescription
valueDataset.SpannerIndexingConfig
Returns
TypeDescription
Dataset.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Dataset.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Dataset.Builder
Overrides

mergeUnmanagedDatasetConfig(Dataset.UnmanagedDatasetConfig value)

public Dataset.Builder mergeUnmanagedDatasetConfig(Dataset.UnmanagedDatasetConfig value)

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];

Parameter
NameDescription
valueDataset.UnmanagedDatasetConfig
Returns
TypeDescription
Dataset.Builder

setDocumentWarehouseConfig(Dataset.DocumentWarehouseConfig value) (deprecated)

public Dataset.Builder setDocumentWarehouseConfig(Dataset.DocumentWarehouseConfig value)

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];

Parameter
NameDescription
valueDataset.DocumentWarehouseConfig
Returns
TypeDescription
Dataset.Builder

setDocumentWarehouseConfig(Dataset.DocumentWarehouseConfig.Builder builderForValue) (deprecated)

public Dataset.Builder setDocumentWarehouseConfig(Dataset.DocumentWarehouseConfig.Builder builderForValue)

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];

Parameter
NameDescription
builderForValueDataset.DocumentWarehouseConfig.Builder
Returns
TypeDescription
Dataset.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public Dataset.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Dataset.Builder
Overrides

setGcsManagedConfig(Dataset.GCSManagedConfig value)

public Dataset.Builder setGcsManagedConfig(Dataset.GCSManagedConfig value)

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];

Parameter
NameDescription
valueDataset.GCSManagedConfig
Returns
TypeDescription
Dataset.Builder

setGcsManagedConfig(Dataset.GCSManagedConfig.Builder builderForValue)

public Dataset.Builder setGcsManagedConfig(Dataset.GCSManagedConfig.Builder builderForValue)

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];

Parameter
NameDescription
builderForValueDataset.GCSManagedConfig.Builder
Returns
TypeDescription
Dataset.Builder

setName(String value)

public Dataset.Builder setName(String value)

Dataset resource name. Format: projects/{project}/locations/{location}/processors/{processor}/dataset

string name = 1;

Parameter
NameDescription
valueString

The name to set.

Returns
TypeDescription
Dataset.Builder

This builder for chaining.

setNameBytes(ByteString value)

public Dataset.Builder setNameBytes(ByteString value)

Dataset resource name. Format: projects/{project}/locations/{location}/processors/{processor}/dataset

string name = 1;

Parameter
NameDescription
valueByteString

The bytes for name to set.

Returns
TypeDescription
Dataset.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Dataset.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
Dataset.Builder
Overrides

setSpannerIndexingConfig(Dataset.SpannerIndexingConfig value)

public Dataset.Builder setSpannerIndexingConfig(Dataset.SpannerIndexingConfig value)

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];

Parameter
NameDescription
valueDataset.SpannerIndexingConfig
Returns
TypeDescription
Dataset.Builder

setSpannerIndexingConfig(Dataset.SpannerIndexingConfig.Builder builderForValue)

public Dataset.Builder setSpannerIndexingConfig(Dataset.SpannerIndexingConfig.Builder builderForValue)

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];

Parameter
NameDescription
builderForValueDataset.SpannerIndexingConfig.Builder
Returns
TypeDescription
Dataset.Builder

setState(Dataset.State value)

public Dataset.Builder setState(Dataset.State value)

Required. State of the dataset. Ignored when updating dataset.

.google.cloud.documentai.v1beta3.Dataset.State state = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
valueDataset.State

The state to set.

Returns
TypeDescription
Dataset.Builder

This builder for chaining.

setStateValue(int value)

public Dataset.Builder setStateValue(int value)

Required. State of the dataset. Ignored when updating dataset.

.google.cloud.documentai.v1beta3.Dataset.State state = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
valueint

The enum numeric value on the wire for state to set.

Returns
TypeDescription
Dataset.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final Dataset.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Dataset.Builder
Overrides

setUnmanagedDatasetConfig(Dataset.UnmanagedDatasetConfig value)

public Dataset.Builder setUnmanagedDatasetConfig(Dataset.UnmanagedDatasetConfig value)

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];

Parameter
NameDescription
valueDataset.UnmanagedDatasetConfig
Returns
TypeDescription
Dataset.Builder

setUnmanagedDatasetConfig(Dataset.UnmanagedDatasetConfig.Builder builderForValue)

public Dataset.Builder setUnmanagedDatasetConfig(Dataset.UnmanagedDatasetConfig.Builder builderForValue)

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];

Parameter
NameDescription
builderForValueDataset.UnmanagedDatasetConfig.Builder
Returns
TypeDescription
Dataset.Builder