com.google.cloud.discoveryengine.v1alpha

Interface SchemaOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

Schema, Schema.Builder

public interface SchemaOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
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.
Schema.SchemaCase	getSchemaCase()
com.google.protobuf.Struct	getStructSchema() The structured representation of the schema.
com.google.protobuf.StructOrBuilder	getStructSchemaOrBuilder() The structured representation of the schema.
boolean	hasJsonSchema() The JSON representation of the schema.
boolean	hasStructSchema() The structured representation of the schema.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

hasStructSchema

boolean hasStructSchema()

 The structured representation of the schema.
 

.google.protobuf.Struct struct_schema = 2;

Returns:

Whether the structSchema field is set.

getStructSchema

com.google.protobuf.Struct getStructSchema()

 The structured representation of the schema.
 

.google.protobuf.Struct struct_schema = 2;

Returns:

The structSchema.

getStructSchemaOrBuilder

com.google.protobuf.StructOrBuilder getStructSchemaOrBuilder()

 The structured representation of the schema.
 

.google.protobuf.Struct struct_schema = 2;

hasJsonSchema

boolean hasJsonSchema()

 The JSON representation of the schema.
 

string json_schema = 3;

Returns:

Whether the jsonSchema field is set.

getJsonSchema

String getJsonSchema()

 The JSON representation of the schema.
 

string json_schema = 3;

Returns:

The jsonSchema.

getJsonSchemaBytes

com.google.protobuf.ByteString getJsonSchemaBytes()

 The JSON representation of the schema.
 

string json_schema = 3;

Returns:

The bytes for jsonSchema.

getName

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:

The name.

getNameBytes

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

Returns:

The bytes for name.

getFieldConfigsList

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

getFieldConfigs

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

getFieldConfigsCount

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

getFieldConfigsOrBuilderList

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

getFieldConfigsOrBuilder

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

getSchemaCase

Schema.SchemaCase getSchemaCase()