Class DocumentOutputConfig.GcsOutputConfig.Builder (2.49.0)

public static final class DocumentOutputConfig.GcsOutputConfig.Builder extends GeneratedMessageV3.Builder<DocumentOutputConfig.GcsOutputConfig.Builder> implements DocumentOutputConfig.GcsOutputConfigOrBuilder

The configuration used when outputting documents.

Protobuf type google.cloud.documentai.v1.DocumentOutputConfig.GcsOutputConfig

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public DocumentOutputConfig.GcsOutputConfig.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
DocumentOutputConfig.GcsOutputConfig.Builder
Overrides

build()

public DocumentOutputConfig.GcsOutputConfig build()
Returns
Type Description
DocumentOutputConfig.GcsOutputConfig

buildPartial()

public DocumentOutputConfig.GcsOutputConfig buildPartial()
Returns
Type Description
DocumentOutputConfig.GcsOutputConfig

clear()

public DocumentOutputConfig.GcsOutputConfig.Builder clear()
Returns
Type Description
DocumentOutputConfig.GcsOutputConfig.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public DocumentOutputConfig.GcsOutputConfig.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
DocumentOutputConfig.GcsOutputConfig.Builder
Overrides

clearFieldMask()

public DocumentOutputConfig.GcsOutputConfig.Builder clearFieldMask()

Specifies which fields to include in the output documents. Only supports top level document and pages field so it must be in the form of {document_field_name} or pages.{page_field_name}.

.google.protobuf.FieldMask field_mask = 2;

Returns
Type Description
DocumentOutputConfig.GcsOutputConfig.Builder

clearGcsUri()

public DocumentOutputConfig.GcsOutputConfig.Builder clearGcsUri()

The Cloud Storage uri (a directory) of the output.

string gcs_uri = 1;

Returns
Type Description
DocumentOutputConfig.GcsOutputConfig.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public DocumentOutputConfig.GcsOutputConfig.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
DocumentOutputConfig.GcsOutputConfig.Builder
Overrides

clearShardingConfig()

public DocumentOutputConfig.GcsOutputConfig.Builder clearShardingConfig()

Specifies the sharding config for the output document.

.google.cloud.documentai.v1.DocumentOutputConfig.GcsOutputConfig.ShardingConfig sharding_config = 3;

Returns
Type Description
DocumentOutputConfig.GcsOutputConfig.Builder

clone()

public DocumentOutputConfig.GcsOutputConfig.Builder clone()
Returns
Type Description
DocumentOutputConfig.GcsOutputConfig.Builder
Overrides

getDefaultInstanceForType()

public DocumentOutputConfig.GcsOutputConfig getDefaultInstanceForType()
Returns
Type Description
DocumentOutputConfig.GcsOutputConfig

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getFieldMask()

public FieldMask getFieldMask()

Specifies which fields to include in the output documents. Only supports top level document and pages field so it must be in the form of {document_field_name} or pages.{page_field_name}.

.google.protobuf.FieldMask field_mask = 2;

Returns
Type Description
FieldMask

The fieldMask.

getFieldMaskBuilder()

public FieldMask.Builder getFieldMaskBuilder()

Specifies which fields to include in the output documents. Only supports top level document and pages field so it must be in the form of {document_field_name} or pages.{page_field_name}.

.google.protobuf.FieldMask field_mask = 2;

Returns
Type Description
Builder

getFieldMaskOrBuilder()

public FieldMaskOrBuilder getFieldMaskOrBuilder()

Specifies which fields to include in the output documents. Only supports top level document and pages field so it must be in the form of {document_field_name} or pages.{page_field_name}.

.google.protobuf.FieldMask field_mask = 2;

Returns
Type Description
FieldMaskOrBuilder

getGcsUri()

public String getGcsUri()

The Cloud Storage uri (a directory) of the output.

string gcs_uri = 1;

Returns
Type Description
String

The gcsUri.

getGcsUriBytes()

public ByteString getGcsUriBytes()

The Cloud Storage uri (a directory) of the output.

string gcs_uri = 1;

Returns
Type Description
ByteString

The bytes for gcsUri.

getShardingConfig()

public DocumentOutputConfig.GcsOutputConfig.ShardingConfig getShardingConfig()

Specifies the sharding config for the output document.

.google.cloud.documentai.v1.DocumentOutputConfig.GcsOutputConfig.ShardingConfig sharding_config = 3;

Returns
Type Description
DocumentOutputConfig.GcsOutputConfig.ShardingConfig

The shardingConfig.

getShardingConfigBuilder()

public DocumentOutputConfig.GcsOutputConfig.ShardingConfig.Builder getShardingConfigBuilder()

Specifies the sharding config for the output document.

.google.cloud.documentai.v1.DocumentOutputConfig.GcsOutputConfig.ShardingConfig sharding_config = 3;

Returns
Type Description
DocumentOutputConfig.GcsOutputConfig.ShardingConfig.Builder

getShardingConfigOrBuilder()

public DocumentOutputConfig.GcsOutputConfig.ShardingConfigOrBuilder getShardingConfigOrBuilder()

Specifies the sharding config for the output document.

.google.cloud.documentai.v1.DocumentOutputConfig.GcsOutputConfig.ShardingConfig sharding_config = 3;

Returns
Type Description
DocumentOutputConfig.GcsOutputConfig.ShardingConfigOrBuilder

hasFieldMask()

public boolean hasFieldMask()

Specifies which fields to include in the output documents. Only supports top level document and pages field so it must be in the form of {document_field_name} or pages.{page_field_name}.

.google.protobuf.FieldMask field_mask = 2;

Returns
Type Description
boolean

Whether the fieldMask field is set.

hasShardingConfig()

public boolean hasShardingConfig()

Specifies the sharding config for the output document.

.google.cloud.documentai.v1.DocumentOutputConfig.GcsOutputConfig.ShardingConfig sharding_config = 3;

Returns
Type Description
boolean

Whether the shardingConfig field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFieldMask(FieldMask value)

public DocumentOutputConfig.GcsOutputConfig.Builder mergeFieldMask(FieldMask value)

Specifies which fields to include in the output documents. Only supports top level document and pages field so it must be in the form of {document_field_name} or pages.{page_field_name}.

.google.protobuf.FieldMask field_mask = 2;

Parameter
Name Description
value FieldMask
Returns
Type Description
DocumentOutputConfig.GcsOutputConfig.Builder

mergeFrom(DocumentOutputConfig.GcsOutputConfig other)

public DocumentOutputConfig.GcsOutputConfig.Builder mergeFrom(DocumentOutputConfig.GcsOutputConfig other)
Parameter
Name Description
other DocumentOutputConfig.GcsOutputConfig
Returns
Type Description
DocumentOutputConfig.GcsOutputConfig.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public DocumentOutputConfig.GcsOutputConfig.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DocumentOutputConfig.GcsOutputConfig.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public DocumentOutputConfig.GcsOutputConfig.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
DocumentOutputConfig.GcsOutputConfig.Builder
Overrides

mergeShardingConfig(DocumentOutputConfig.GcsOutputConfig.ShardingConfig value)

public DocumentOutputConfig.GcsOutputConfig.Builder mergeShardingConfig(DocumentOutputConfig.GcsOutputConfig.ShardingConfig value)

Specifies the sharding config for the output document.

.google.cloud.documentai.v1.DocumentOutputConfig.GcsOutputConfig.ShardingConfig sharding_config = 3;

Parameter
Name Description
value DocumentOutputConfig.GcsOutputConfig.ShardingConfig
Returns
Type Description
DocumentOutputConfig.GcsOutputConfig.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final DocumentOutputConfig.GcsOutputConfig.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
DocumentOutputConfig.GcsOutputConfig.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public DocumentOutputConfig.GcsOutputConfig.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
DocumentOutputConfig.GcsOutputConfig.Builder
Overrides

setFieldMask(FieldMask value)

public DocumentOutputConfig.GcsOutputConfig.Builder setFieldMask(FieldMask value)

Specifies which fields to include in the output documents. Only supports top level document and pages field so it must be in the form of {document_field_name} or pages.{page_field_name}.

.google.protobuf.FieldMask field_mask = 2;

Parameter
Name Description
value FieldMask
Returns
Type Description
DocumentOutputConfig.GcsOutputConfig.Builder

setFieldMask(FieldMask.Builder builderForValue)

public DocumentOutputConfig.GcsOutputConfig.Builder setFieldMask(FieldMask.Builder builderForValue)

Specifies which fields to include in the output documents. Only supports top level document and pages field so it must be in the form of {document_field_name} or pages.{page_field_name}.

.google.protobuf.FieldMask field_mask = 2;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
DocumentOutputConfig.GcsOutputConfig.Builder

setGcsUri(String value)

public DocumentOutputConfig.GcsOutputConfig.Builder setGcsUri(String value)

The Cloud Storage uri (a directory) of the output.

string gcs_uri = 1;

Parameter
Name Description
value String

The gcsUri to set.

Returns
Type Description
DocumentOutputConfig.GcsOutputConfig.Builder

This builder for chaining.

setGcsUriBytes(ByteString value)

public DocumentOutputConfig.GcsOutputConfig.Builder setGcsUriBytes(ByteString value)

The Cloud Storage uri (a directory) of the output.

string gcs_uri = 1;

Parameter
Name Description
value ByteString

The bytes for gcsUri to set.

Returns
Type Description
DocumentOutputConfig.GcsOutputConfig.Builder

This builder for chaining.

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

public DocumentOutputConfig.GcsOutputConfig.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
DocumentOutputConfig.GcsOutputConfig.Builder
Overrides

setShardingConfig(DocumentOutputConfig.GcsOutputConfig.ShardingConfig value)

public DocumentOutputConfig.GcsOutputConfig.Builder setShardingConfig(DocumentOutputConfig.GcsOutputConfig.ShardingConfig value)

Specifies the sharding config for the output document.

.google.cloud.documentai.v1.DocumentOutputConfig.GcsOutputConfig.ShardingConfig sharding_config = 3;

Parameter
Name Description
value DocumentOutputConfig.GcsOutputConfig.ShardingConfig
Returns
Type Description
DocumentOutputConfig.GcsOutputConfig.Builder

setShardingConfig(DocumentOutputConfig.GcsOutputConfig.ShardingConfig.Builder builderForValue)

public DocumentOutputConfig.GcsOutputConfig.Builder setShardingConfig(DocumentOutputConfig.GcsOutputConfig.ShardingConfig.Builder builderForValue)

Specifies the sharding config for the output document.

.google.cloud.documentai.v1.DocumentOutputConfig.GcsOutputConfig.ShardingConfig sharding_config = 3;

Parameter
Name Description
builderForValue DocumentOutputConfig.GcsOutputConfig.ShardingConfig.Builder
Returns
Type Description
DocumentOutputConfig.GcsOutputConfig.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final DocumentOutputConfig.GcsOutputConfig.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
DocumentOutputConfig.GcsOutputConfig.Builder
Overrides