Class DataSchema (0.12.0)

public final class DataSchema extends GeneratedMessageV3 implements DataSchemaOrBuilder

Data schema indicates how the user specified annotation is interpreted in the system.

Protobuf type google.cloud.visionai.v1.DataSchema

Implements

DataSchemaOrBuilder

Static Fields

KEY_FIELD_NUMBER

public static final int KEY_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

SCHEMA_DETAILS_FIELD_NUMBER

public static final int SCHEMA_DETAILS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static DataSchema getDefaultInstance()
Returns
Type Description
DataSchema

getDescriptor()

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

newBuilder()

public static DataSchema.Builder newBuilder()
Returns
Type Description
DataSchema.Builder

newBuilder(DataSchema prototype)

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

parseDelimitedFrom(InputStream input)

public static DataSchema parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
DataSchema
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

public static DataSchema parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
DataSchema
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

public static DataSchema parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
DataSchema
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

public static DataSchema parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
DataSchema
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

public static DataSchema parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
DataSchema
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

public static Parser<DataSchema> parser()
Returns
Type Description
Parser<DataSchema>

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public DataSchema getDefaultInstanceForType()
Returns
Type Description
DataSchema

getKey()

public String getKey()

Required. The key of this data schema. This key should be matching the key of user specified annotation and unique inside corpus. This value can be up to 63 characters, and valid characters are /a-z-/. The first character must be a letter, the last could be a letter or a number.

string key = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The key.

getKeyBytes()

public ByteString getKeyBytes()

Required. The key of this data schema. This key should be matching the key of user specified annotation and unique inside corpus. This value can be up to 63 characters, and valid characters are /a-z-/. The first character must be a letter, the last could be a letter or a number.

string key = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for key.

getName()

public String getName()

Resource name of the data schema in the form of: projects/{project_number}/locations/{location}/corpora/{corpus}/dataSchemas/{data_schema} where {data_schema} part should be the same as the key field below.

string name = 1;

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Resource name of the data schema in the form of: projects/{project_number}/locations/{location}/corpora/{corpus}/dataSchemas/{data_schema} where {data_schema} part should be the same as the key field below.

string name = 1;

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

public Parser<DataSchema> getParserForType()
Returns
Type Description
Parser<DataSchema>
Overrides

getSchemaDetails()

public DataSchemaDetails getSchemaDetails()

The schema details mapping to the key.

.google.cloud.visionai.v1.DataSchemaDetails schema_details = 3;

Returns
Type Description
DataSchemaDetails

The schemaDetails.

getSchemaDetailsOrBuilder()

public DataSchemaDetailsOrBuilder getSchemaDetailsOrBuilder()

The schema details mapping to the key.

.google.cloud.visionai.v1.DataSchemaDetails schema_details = 3;

Returns
Type Description
DataSchemaDetailsOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasSchemaDetails()

public boolean hasSchemaDetails()

The schema details mapping to the key.

.google.cloud.visionai.v1.DataSchemaDetails schema_details = 3;

Returns
Type Description
boolean

Whether the schemaDetails 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 DataSchema.Builder newBuilderForType()
Returns
Type Description
DataSchema.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

public DataSchema.Builder toBuilder()
Returns
Type Description
DataSchema.Builder

writeTo(CodedOutputStream output)

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