com.google.cloud.discoveryengine.v1alpha

Class Schema

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.discoveryengine.v1alpha.Schema

All Implemented Interfaces:

SchemaOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class Schema
extends com.google.protobuf.GeneratedMessageV3
implements SchemaOrBuilder

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

Protobuf type google.cloud.discoveryengine.v1alpha.Schema

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Schema.Builder Defines the structure and layout of a type of document data.
static class	Schema.SchemaCase

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	FIELD_CONFIGS_FIELD_NUMBER
static int	JSON_SCHEMA_FIELD_NUMBER
static int	NAME_FIELD_NUMBER
static int	STRUCT_SCHEMA_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
static Schema	getDefaultInstance()
Schema	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
FieldConfig	getFieldConfigs(int index) Output only.
int	getFieldConfigsCount() Output only.
List<FieldConfig>	getFieldConfigsList() Output only.
FieldConfigOrBuilder	getFieldConfigsOrBuilder(int index) Output only.
List<? extends FieldConfigOrBuilder>	getFieldConfigsOrBuilderList() Output only.
String	getJsonSchema() The JSON representation of the schema.
com.google.protobuf.ByteString	getJsonSchemaBytes() The JSON representation of the schema.
String	getName() Immutable.
com.google.protobuf.ByteString	getNameBytes() Immutable.
com.google.protobuf.Parser<Schema>	getParserForType()
Schema.SchemaCase	getSchemaCase()
int	getSerializedSize()
com.google.protobuf.Struct	getStructSchema() The structured representation of the schema.
com.google.protobuf.StructOrBuilder	getStructSchemaOrBuilder() The structured representation of the schema.
int	hashCode()
boolean	hasJsonSchema() The JSON representation of the schema.
boolean	hasStructSchema() The structured representation of the schema.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static Schema.Builder	newBuilder()
static Schema.Builder	newBuilder(Schema prototype)
Schema.Builder	newBuilderForType()
protected Schema.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static Schema	parseDelimitedFrom(InputStream input)
static Schema	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Schema	parseFrom(byte[] data)
static Schema	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Schema	parseFrom(ByteBuffer data)
static Schema	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Schema	parseFrom(com.google.protobuf.ByteString data)
static Schema	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Schema	parseFrom(com.google.protobuf.CodedInputStream input)
static Schema	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Schema	parseFrom(InputStream input)
static Schema	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<Schema>	parser()
Schema.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

STRUCT_SCHEMA_FIELD_NUMBER

public static final int STRUCT_SCHEMA_FIELD_NUMBER

See Also:

Constant Field Values

JSON_SCHEMA_FIELD_NUMBER

public static final int JSON_SCHEMA_FIELD_NUMBER

See Also:

Constant Field Values

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

See Also:

Constant Field Values

FIELD_CONFIGS_FIELD_NUMBER

public static final int FIELD_CONFIGS_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getSchemaCase

public Schema.SchemaCase getSchemaCase()

Specified by:

getSchemaCase in interface SchemaOrBuilder

hasStructSchema

public boolean hasStructSchema()

 The structured representation of the schema.
 

.google.protobuf.Struct struct_schema = 2;

Specified by:

hasStructSchema in interface SchemaOrBuilder

Returns:

Whether the structSchema field is set.

getStructSchema

public com.google.protobuf.Struct getStructSchema()

 The structured representation of the schema.
 

.google.protobuf.Struct struct_schema = 2;

Specified by:

getStructSchema in interface SchemaOrBuilder

Returns:

The structSchema.

getStructSchemaOrBuilder

public com.google.protobuf.StructOrBuilder getStructSchemaOrBuilder()

 The structured representation of the schema.
 

.google.protobuf.Struct struct_schema = 2;

Specified by:

getStructSchemaOrBuilder in interface SchemaOrBuilder

hasJsonSchema

public boolean hasJsonSchema()

 The JSON representation of the schema.
 

string json_schema = 3;

Specified by:

hasJsonSchema in interface SchemaOrBuilder

Returns:

Whether the jsonSchema field is set.

getJsonSchema

public String getJsonSchema()

 The JSON representation of the schema.
 

string json_schema = 3;

Specified by:

getJsonSchema in interface SchemaOrBuilder

Returns:

The jsonSchema.

getJsonSchemaBytes

public com.google.protobuf.ByteString getJsonSchemaBytes()

 The JSON representation of the schema.
 

string json_schema = 3;

Specified by:

getJsonSchemaBytes in interface SchemaOrBuilder

Returns:

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];

Specified by:

getName in interface SchemaOrBuilder

Returns:

The name.

getNameBytes

public com.google.protobuf.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];

Specified by:

getNameBytes in interface SchemaOrBuilder

Returns:

The bytes for name.

getFieldConfigsList

public List<FieldConfig> getFieldConfigsList()

 Output only. Configurations for fields of the schema.
 

repeated .google.cloud.discoveryengine.v1alpha.FieldConfig field_configs = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Specified by:

getFieldConfigsList in interface SchemaOrBuilder

getFieldConfigsOrBuilderList

public List<? extends FieldConfigOrBuilder> getFieldConfigsOrBuilderList()

 Output only. Configurations for fields of the schema.
 

repeated .google.cloud.discoveryengine.v1alpha.FieldConfig field_configs = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Specified by:

getFieldConfigsOrBuilderList in interface SchemaOrBuilder

getFieldConfigsCount

public int getFieldConfigsCount()

 Output only. Configurations for fields of the schema.
 

repeated .google.cloud.discoveryengine.v1alpha.FieldConfig field_configs = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Specified by:

getFieldConfigsCount in interface SchemaOrBuilder

getFieldConfigs

public FieldConfig getFieldConfigs(int index)

 Output only. Configurations for fields of the schema.
 

repeated .google.cloud.discoveryengine.v1alpha.FieldConfig field_configs = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Specified by:

getFieldConfigs in interface SchemaOrBuilder

getFieldConfigsOrBuilder

public FieldConfigOrBuilder getFieldConfigsOrBuilder(int index)

 Output only. Configurations for fields of the schema.
 

repeated .google.cloud.discoveryengine.v1alpha.FieldConfig field_configs = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Specified by:

getFieldConfigsOrBuilder in interface SchemaOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static Schema parseFrom(ByteBuffer data)
                        throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Schema parseFrom(ByteBuffer data,
                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                        throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Schema parseFrom(com.google.protobuf.ByteString data)
                        throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Schema parseFrom(com.google.protobuf.ByteString data,
                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                        throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Schema parseFrom(byte[] data)
                        throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Schema parseFrom(byte[] data,
                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                        throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Schema parseFrom(InputStream input)
                        throws IOException

Throws:

IOException

parseFrom

public static Schema parseFrom(InputStream input,
                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                        throws IOException

Throws:

IOException

parseDelimitedFrom

public static Schema parseDelimitedFrom(InputStream input)
                                 throws IOException

Throws:

IOException

parseDelimitedFrom

public static Schema parseDelimitedFrom(InputStream input,
                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws IOException

Throws:

IOException

parseFrom

public static Schema parseFrom(com.google.protobuf.CodedInputStream input)
                        throws IOException

Throws:

IOException

parseFrom

public static Schema parseFrom(com.google.protobuf.CodedInputStream input,
                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                        throws IOException

Throws:

IOException

newBuilderForType

public Schema.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static Schema.Builder newBuilder()

newBuilder

public static Schema.Builder newBuilder(Schema prototype)

toBuilder

public Schema.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected Schema.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static Schema getDefaultInstance()

parser

public static com.google.protobuf.Parser<Schema> parser()

getParserForType

public com.google.protobuf.Parser<Schema> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public Schema getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder