Class DocumentOutputConfig.GcsOutputConfig (2.47.0)

public static final class DocumentOutputConfig.GcsOutputConfig extends GeneratedMessageV3 implements DocumentOutputConfig.GcsOutputConfigOrBuilder

The configuration used when outputting documents.

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

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > DocumentOutputConfig.GcsOutputConfig

Static Fields

FIELD_MASK_FIELD_NUMBER

public static final int FIELD_MASK_FIELD_NUMBER
Field Value
Type Description
int

GCS_URI_FIELD_NUMBER

public static final int GCS_URI_FIELD_NUMBER
Field Value
Type Description
int

SHARDING_CONFIG_FIELD_NUMBER

public static final int SHARDING_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static DocumentOutputConfig.GcsOutputConfig getDefaultInstance()
Returns
Type Description
DocumentOutputConfig.GcsOutputConfig

getDescriptor()

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

newBuilder()

public static DocumentOutputConfig.GcsOutputConfig.Builder newBuilder()
Returns
Type Description
DocumentOutputConfig.GcsOutputConfig.Builder

newBuilder(DocumentOutputConfig.GcsOutputConfig prototype)

public static DocumentOutputConfig.GcsOutputConfig.Builder newBuilder(DocumentOutputConfig.GcsOutputConfig prototype)
Parameter
Name Description
prototype DocumentOutputConfig.GcsOutputConfig
Returns
Type Description
DocumentOutputConfig.GcsOutputConfig.Builder

parseDelimitedFrom(InputStream input)

public static DocumentOutputConfig.GcsOutputConfig parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
DocumentOutputConfig.GcsOutputConfig
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DocumentOutputConfig.GcsOutputConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DocumentOutputConfig.GcsOutputConfig
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static DocumentOutputConfig.GcsOutputConfig parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
DocumentOutputConfig.GcsOutputConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static DocumentOutputConfig.GcsOutputConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DocumentOutputConfig.GcsOutputConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static DocumentOutputConfig.GcsOutputConfig parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
DocumentOutputConfig.GcsOutputConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static DocumentOutputConfig.GcsOutputConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DocumentOutputConfig.GcsOutputConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static DocumentOutputConfig.GcsOutputConfig parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
DocumentOutputConfig.GcsOutputConfig
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static DocumentOutputConfig.GcsOutputConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DocumentOutputConfig.GcsOutputConfig
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static DocumentOutputConfig.GcsOutputConfig parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
DocumentOutputConfig.GcsOutputConfig
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DocumentOutputConfig.GcsOutputConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DocumentOutputConfig.GcsOutputConfig
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static DocumentOutputConfig.GcsOutputConfig parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
DocumentOutputConfig.GcsOutputConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static DocumentOutputConfig.GcsOutputConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DocumentOutputConfig.GcsOutputConfig
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<DocumentOutputConfig.GcsOutputConfig> parser()
Returns
Type Description
Parser<GcsOutputConfig>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

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

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.

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.

getParserForType()

public Parser<DocumentOutputConfig.GcsOutputConfig> getParserForType()
Returns
Type Description
Parser<GcsOutputConfig>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getShardingConfig()

public DocumentOutputConfig.GcsOutputConfig.ShardingConfig getShardingConfig()

Specifies the sharding config for the output document.

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

Returns
Type Description
DocumentOutputConfig.GcsOutputConfig.ShardingConfig

The shardingConfig.

getShardingConfigOrBuilder()

public DocumentOutputConfig.GcsOutputConfig.ShardingConfigOrBuilder getShardingConfigOrBuilder()

Specifies the sharding config for the output document.

.google.cloud.documentai.v1beta3.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.v1beta3.DocumentOutputConfig.GcsOutputConfig.ShardingConfig sharding_config = 3;

Returns
Type Description
boolean

Whether the shardingConfig field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public DocumentOutputConfig.GcsOutputConfig.Builder newBuilderForType()
Returns
Type Description
DocumentOutputConfig.GcsOutputConfig.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected DocumentOutputConfig.GcsOutputConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
DocumentOutputConfig.GcsOutputConfig.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public DocumentOutputConfig.GcsOutputConfig.Builder toBuilder()
Returns
Type Description
DocumentOutputConfig.GcsOutputConfig.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException