Class DocumentOutputConfig.GcsOutputConfig (2.37.0)

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

The configuration used when outputting documents.

Protobuf type google.cloud.documentai.v1.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
TypeDescription
int

GCS_URI_FIELD_NUMBER

public static final int GCS_URI_FIELD_NUMBER
Field Value
TypeDescription
int

SHARDING_CONFIG_FIELD_NUMBER

public static final int SHARDING_CONFIG_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static DocumentOutputConfig.GcsOutputConfig getDefaultInstance()
Returns
TypeDescription
DocumentOutputConfig.GcsOutputConfig

getDescriptor()

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

newBuilder()

public static DocumentOutputConfig.GcsOutputConfig.Builder newBuilder()
Returns
TypeDescription
DocumentOutputConfig.GcsOutputConfig.Builder

newBuilder(DocumentOutputConfig.GcsOutputConfig prototype)

public static DocumentOutputConfig.GcsOutputConfig.Builder newBuilder(DocumentOutputConfig.GcsOutputConfig prototype)
Parameter
NameDescription
prototypeDocumentOutputConfig.GcsOutputConfig
Returns
TypeDescription
DocumentOutputConfig.GcsOutputConfig.Builder

parseDelimitedFrom(InputStream input)

public static DocumentOutputConfig.GcsOutputConfig parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
DocumentOutputConfig.GcsOutputConfig
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DocumentOutputConfig.GcsOutputConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DocumentOutputConfig.GcsOutputConfig
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static DocumentOutputConfig.GcsOutputConfig parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
DocumentOutputConfig.GcsOutputConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static DocumentOutputConfig.GcsOutputConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DocumentOutputConfig.GcsOutputConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static DocumentOutputConfig.GcsOutputConfig parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
DocumentOutputConfig.GcsOutputConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static DocumentOutputConfig.GcsOutputConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DocumentOutputConfig.GcsOutputConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static DocumentOutputConfig.GcsOutputConfig parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
DocumentOutputConfig.GcsOutputConfig
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static DocumentOutputConfig.GcsOutputConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DocumentOutputConfig.GcsOutputConfig
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static DocumentOutputConfig.GcsOutputConfig parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
DocumentOutputConfig.GcsOutputConfig
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DocumentOutputConfig.GcsOutputConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DocumentOutputConfig.GcsOutputConfig
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static DocumentOutputConfig.GcsOutputConfig parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
DocumentOutputConfig.GcsOutputConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static DocumentOutputConfig.GcsOutputConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DocumentOutputConfig.GcsOutputConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

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

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public DocumentOutputConfig.GcsOutputConfig getDefaultInstanceForType()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
FieldMaskOrBuilder

getGcsUri()

public String getGcsUri()

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

string gcs_uri = 1;

Returns
TypeDescription
String

The gcsUri.

getGcsUriBytes()

public ByteString getGcsUriBytes()

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

string gcs_uri = 1;

Returns
TypeDescription
ByteString

The bytes for gcsUri.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

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
TypeDescription
DocumentOutputConfig.GcsOutputConfig.ShardingConfig

The shardingConfig.

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
TypeDescription
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
TypeDescription
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
TypeDescription
boolean

Whether the shardingConfig field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public DocumentOutputConfig.GcsOutputConfig.Builder newBuilderForType()
Returns
TypeDescription
DocumentOutputConfig.GcsOutputConfig.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected DocumentOutputConfig.GcsOutputConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
DocumentOutputConfig.GcsOutputConfig.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public DocumentOutputConfig.GcsOutputConfig.Builder toBuilder()
Returns
TypeDescription
DocumentOutputConfig.GcsOutputConfig.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException