Class Schema (0.35.0)

public final class Schema extends GeneratedMessageV3 implements SchemaOrBuilder

Defines the structure and layout of a type of document data.

Protobuf type google.cloud.discoveryengine.v1.Schema

Implements

SchemaOrBuilder

Static Fields

JSON_SCHEMA_FIELD_NUMBER

public static final int JSON_SCHEMA_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

STRUCT_SCHEMA_FIELD_NUMBER

public static final int STRUCT_SCHEMA_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static Schema getDefaultInstance()
Returns
TypeDescription
Schema

getDescriptor()

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

newBuilder()

public static Schema.Builder newBuilder()
Returns
TypeDescription
Schema.Builder

newBuilder(Schema prototype)

public static Schema.Builder newBuilder(Schema prototype)
Parameter
NameDescription
prototypeSchema
Returns
TypeDescription
Schema.Builder

parseDelimitedFrom(InputStream input)

public static Schema parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Schema
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

public static Schema parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
Schema
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

public static Schema parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
Schema
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

public static Schema parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Schema
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

public static Schema parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
Schema
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

public static Parser<Schema> parser()
Returns
TypeDescription
Parser<Schema>

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public Schema getDefaultInstanceForType()
Returns
TypeDescription
Schema

getJsonSchema()

public String getJsonSchema()

The JSON representation of the schema.

string json_schema = 3;

Returns
TypeDescription
String

The jsonSchema.

getJsonSchemaBytes()

public ByteString getJsonSchemaBytes()

The JSON representation of the schema.

string json_schema = 3;

Returns
TypeDescription
ByteString

The bytes for jsonSchema.

getName()

public String getName()

Immutable. The full resource name of the schema, in the format of projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}.

This field must be a UTF-8 encoded string with a length limit of 1024 characters.

string name = 1 [(.google.api.field_behavior) = IMMUTABLE];

Returns
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

Immutable. The full resource name of the schema, in the format of projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}.

This field must be a UTF-8 encoded string with a length limit of 1024 characters.

string name = 1 [(.google.api.field_behavior) = IMMUTABLE];

Returns
TypeDescription
ByteString

The bytes for name.

getParserForType()

public Parser<Schema> getParserForType()
Returns
TypeDescription
Parser<Schema>
Overrides

getSchemaCase()

public Schema.SchemaCase getSchemaCase()
Returns
TypeDescription
Schema.SchemaCase

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getStructSchema()

public Struct getStructSchema()

The structured representation of the schema.

.google.protobuf.Struct struct_schema = 2;

Returns
TypeDescription
Struct

The structSchema.

getStructSchemaOrBuilder()

public StructOrBuilder getStructSchemaOrBuilder()

The structured representation of the schema.

.google.protobuf.Struct struct_schema = 2;

Returns
TypeDescription
StructOrBuilder

hasJsonSchema()

public boolean hasJsonSchema()

The JSON representation of the schema.

string json_schema = 3;

Returns
TypeDescription
boolean

Whether the jsonSchema field is set.

hasStructSchema()

public boolean hasStructSchema()

The structured representation of the schema.

.google.protobuf.Struct struct_schema = 2;

Returns
TypeDescription
boolean

Whether the structSchema 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 Schema.Builder newBuilderForType()
Returns
TypeDescription
Schema.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

public Schema.Builder toBuilder()
Returns
TypeDescription
Schema.Builder

writeTo(CodedOutputStream output)

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