- 2.57.0 (latest)
- 2.56.0
- 2.55.0
- 2.53.0
- 2.52.0
- 2.51.0
- 2.50.0
- 2.49.0
- 2.48.0
- 2.47.0
- 2.46.0
- 2.45.0
- 2.44.0
- 2.43.0
- 2.41.0
- 2.40.0
- 2.39.0
- 2.38.0
- 2.37.0
- 2.36.0
- 2.35.0
- 2.34.0
- 2.33.0
- 2.32.0
- 2.31.0
- 2.28.0
- 2.27.0
- 2.26.0
- 2.25.0
- 2.24.0
- 2.23.0
- 2.22.0
- 2.21.0
- 2.20.0
- 2.19.0
- 2.18.0
- 2.17.0
- 2.16.0
- 2.15.0
- 2.13.0
- 2.12.0
- 2.11.0
- 2.10.0
- 2.9.0
- 2.8.0
- 2.7.5
- 2.6.2
- 2.5.1
- 2.4.3
- 2.3.1
- 2.2.1
- 2.1.9
public final class DocumentSchema extends GeneratedMessageV3 implements DocumentSchemaOrBuilder
The schema defines the output of the processed document by a processor.
Protobuf type google.cloud.documentai.v1.DocumentSchema
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > DocumentSchemaImplements
DocumentSchemaOrBuilderStatic Fields
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
DISPLAY_NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
ENTITY_TYPES_FIELD_NUMBER
public static final int ENTITY_TYPES_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
METADATA_FIELD_NUMBER
public static final int METADATA_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
Static Methods
getDefaultInstance()
public static DocumentSchema getDefaultInstance()
Returns | |
---|---|
Type | Description |
DocumentSchema |
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
Descriptor |
newBuilder()
public static DocumentSchema.Builder newBuilder()
Returns | |
---|---|
Type | Description |
DocumentSchema.Builder |
newBuilder(DocumentSchema prototype)
public static DocumentSchema.Builder newBuilder(DocumentSchema prototype)
Parameter | |
---|---|
Name | Description |
prototype |
DocumentSchema |
Returns | |
---|---|
Type | Description |
DocumentSchema.Builder |
parseDelimitedFrom(InputStream input)
public static DocumentSchema parseDelimitedFrom(InputStream input)
Parameter | |
---|---|
Name | Description |
input |
InputStream |
Returns | |
---|---|
Type | Description |
DocumentSchema |
Exceptions | |
---|---|
Type | Description |
IOException |
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static DocumentSchema parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
DocumentSchema |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(byte[] data)
public static DocumentSchema parseFrom(byte[] data)
Parameter | |
---|---|
Name | Description |
data |
byte[] |
Returns | |
---|---|
Type | Description |
DocumentSchema |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static DocumentSchema parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
data |
byte[] |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
DocumentSchema |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteString data)
public static DocumentSchema parseFrom(ByteString data)
Parameter | |
---|---|
Name | Description |
data |
ByteString |
Returns | |
---|---|
Type | Description |
DocumentSchema |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static DocumentSchema parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
data |
ByteString |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
DocumentSchema |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(CodedInputStream input)
public static DocumentSchema parseFrom(CodedInputStream input)
Parameter | |
---|---|
Name | Description |
input |
CodedInputStream |
Returns | |
---|---|
Type | Description |
DocumentSchema |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static DocumentSchema parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
DocumentSchema |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(InputStream input)
public static DocumentSchema parseFrom(InputStream input)
Parameter | |
---|---|
Name | Description |
input |
InputStream |
Returns | |
---|---|
Type | Description |
DocumentSchema |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static DocumentSchema parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
DocumentSchema |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(ByteBuffer data)
public static DocumentSchema parseFrom(ByteBuffer data)
Parameter | |
---|---|
Name | Description |
data |
ByteBuffer |
Returns | |
---|---|
Type | Description |
DocumentSchema |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static DocumentSchema parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
data |
ByteBuffer |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
DocumentSchema |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parser()
public static Parser<DocumentSchema> parser()
Returns | |
---|---|
Type | Description |
Parser<DocumentSchema> |
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter | |
---|---|
Name | Description |
obj |
Object |
Returns | |
---|---|
Type | Description |
boolean |
getDefaultInstanceForType()
public DocumentSchema getDefaultInstanceForType()
Returns | |
---|---|
Type | Description |
DocumentSchema |
getDescription()
public String getDescription()
Description of the schema.
string description = 2;
Returns | |
---|---|
Type | Description |
String |
The description. |
getDescriptionBytes()
public ByteString getDescriptionBytes()
Description of the schema.
string description = 2;
Returns | |
---|---|
Type | Description |
ByteString |
The bytes for description. |
getDisplayName()
public String getDisplayName()
Display name to show to users.
string display_name = 1;
Returns | |
---|---|
Type | Description |
String |
The displayName. |
getDisplayNameBytes()
public ByteString getDisplayNameBytes()
Display name to show to users.
string display_name = 1;
Returns | |
---|---|
Type | Description |
ByteString |
The bytes for displayName. |
getEntityTypes(int index)
public DocumentSchema.EntityType getEntityTypes(int index)
Entity types of the schema.
repeated .google.cloud.documentai.v1.DocumentSchema.EntityType entity_types = 3;
Parameter | |
---|---|
Name | Description |
index |
int |
Returns | |
---|---|
Type | Description |
DocumentSchema.EntityType |
getEntityTypesCount()
public int getEntityTypesCount()
Entity types of the schema.
repeated .google.cloud.documentai.v1.DocumentSchema.EntityType entity_types = 3;
Returns | |
---|---|
Type | Description |
int |
getEntityTypesList()
public List<DocumentSchema.EntityType> getEntityTypesList()
Entity types of the schema.
repeated .google.cloud.documentai.v1.DocumentSchema.EntityType entity_types = 3;
Returns | |
---|---|
Type | Description |
List<EntityType> |
getEntityTypesOrBuilder(int index)
public DocumentSchema.EntityTypeOrBuilder getEntityTypesOrBuilder(int index)
Entity types of the schema.
repeated .google.cloud.documentai.v1.DocumentSchema.EntityType entity_types = 3;
Parameter | |
---|---|
Name | Description |
index |
int |
Returns | |
---|---|
Type | Description |
DocumentSchema.EntityTypeOrBuilder |
getEntityTypesOrBuilderList()
public List<? extends DocumentSchema.EntityTypeOrBuilder> getEntityTypesOrBuilderList()
Entity types of the schema.
repeated .google.cloud.documentai.v1.DocumentSchema.EntityType entity_types = 3;
Returns | |
---|---|
Type | Description |
List<? extends com.google.cloud.documentai.v1.DocumentSchema.EntityTypeOrBuilder> |
getMetadata()
public DocumentSchema.Metadata getMetadata()
Metadata of the schema.
.google.cloud.documentai.v1.DocumentSchema.Metadata metadata = 4;
Returns | |
---|---|
Type | Description |
DocumentSchema.Metadata |
The metadata. |
getMetadataOrBuilder()
public DocumentSchema.MetadataOrBuilder getMetadataOrBuilder()
Metadata of the schema.
.google.cloud.documentai.v1.DocumentSchema.Metadata metadata = 4;
Returns | |
---|---|
Type | Description |
DocumentSchema.MetadataOrBuilder |
getParserForType()
public Parser<DocumentSchema> getParserForType()
Returns | |
---|---|
Type | Description |
Parser<DocumentSchema> |
getSerializedSize()
public int getSerializedSize()
Returns | |
---|---|
Type | Description |
int |
hasMetadata()
public boolean hasMetadata()
Metadata of the schema.
.google.cloud.documentai.v1.DocumentSchema.Metadata metadata = 4;
Returns | |
---|---|
Type | Description |
boolean |
Whether the metadata field is set. |
hashCode()
public int hashCode()
Returns | |
---|---|
Type | Description |
int |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns | |
---|---|
Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()
Returns | |
---|---|
Type | Description |
boolean |
newBuilderForType()
public DocumentSchema.Builder newBuilderForType()
Returns | |
---|---|
Type | Description |
DocumentSchema.Builder |
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected DocumentSchema.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter | |
---|---|
Name | Description |
parent |
BuilderParent |
Returns | |
---|---|
Type | Description |
DocumentSchema.Builder |
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter | |
---|---|
Name | Description |
unused |
UnusedPrivateParameter |
Returns | |
---|---|
Type | Description |
Object |
toBuilder()
public DocumentSchema.Builder toBuilder()
Returns | |
---|---|
Type | Description |
DocumentSchema.Builder |
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter | |
---|---|
Name | Description |
output |
CodedOutputStream |
Exceptions | |
---|---|
Type | Description |
IOException |