- 0.49.0 (latest)
- 0.48.0
- 0.47.0
- 0.45.0
- 0.44.0
- 0.43.0
- 0.42.0
- 0.41.0
- 0.40.0
- 0.39.0
- 0.38.0
- 0.37.0
- 0.36.0
- 0.35.0
- 0.33.0
- 0.32.0
- 0.31.0
- 0.30.0
- 0.29.0
- 0.28.0
- 0.27.0
- 0.26.0
- 0.25.0
- 0.24.0
- 0.23.0
- 0.20.0
- 0.19.0
- 0.18.0
- 0.17.0
- 0.16.0
- 0.15.0
- 0.14.0
- 0.13.0
- 0.12.0
- 0.11.0
- 0.10.0
- 0.9.0
- 0.8.0
- 0.7.0
- 0.5.0
- 0.4.0
- 0.3.0
- 0.2.0
- 0.1.0
public final class Schema extends GeneratedMessageV3 implements SchemaOrBuilderDefines the structure and layout of a type of document data.
Protobuf type google.cloud.discoveryengine.v1.Schema
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > SchemaImplements
SchemaOrBuilderStatic Fields
JSON_SCHEMA_FIELD_NUMBER
public static final int JSON_SCHEMA_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
STRUCT_SCHEMA_FIELD_NUMBER
public static final int STRUCT_SCHEMA_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
Static Methods
getDefaultInstance()
public static Schema getDefaultInstance()| Returns | |
|---|---|
| Type | Description |
Schema |
|
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
newBuilder()
public static Schema.Builder newBuilder()| Returns | |
|---|---|
| Type | Description |
Schema.Builder |
|
newBuilder(Schema prototype)
public static Schema.Builder newBuilder(Schema prototype)| Parameter | |
|---|---|
| Name | Description |
prototype |
Schema |
| Returns | |
|---|---|
| Type | Description |
Schema.Builder |
|
parseDelimitedFrom(InputStream input)
public static Schema parseDelimitedFrom(InputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
InputStream |
| Returns | |
|---|---|
| Type | Description |
Schema |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static Schema parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Schema |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(byte[] data)
public static Schema parseFrom(byte[] data)| Parameter | |
|---|---|
| Name | Description |
data |
byte[] |
| Returns | |
|---|---|
| Type | Description |
Schema |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Schema parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
byte[] |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Schema |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteString data)
public static Schema parseFrom(ByteString data)| Parameter | |
|---|---|
| Name | Description |
data |
ByteString |
| Returns | |
|---|---|
| Type | Description |
Schema |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Schema parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
ByteString |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Schema |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(CodedInputStream input)
public static Schema parseFrom(CodedInputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
CodedInputStream |
| Returns | |
|---|---|
| Type | Description |
Schema |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static Schema parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Schema |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(InputStream input)
public static Schema parseFrom(InputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
InputStream |
| Returns | |
|---|---|
| Type | Description |
Schema |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static Schema parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Schema |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(ByteBuffer data)
public static Schema parseFrom(ByteBuffer data)| Parameter | |
|---|---|
| Name | Description |
data |
ByteBuffer |
| Returns | |
|---|---|
| Type | Description |
Schema |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Schema parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
ByteBuffer |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Schema |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parser()
public static Parser<Schema> parser()| Returns | |
|---|---|
| Type | Description |
Parser<Schema> |
|
Methods
equals(Object obj)
public boolean equals(Object obj)| Parameter | |
|---|---|
| Name | Description |
obj |
Object |
| Returns | |
|---|---|
| Type | Description |
boolean |
|
getDefaultInstanceForType()
public Schema getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
Schema |
|
getJsonSchema()
public String getJsonSchema()The JSON representation of the schema.
string json_schema = 3;
| Returns | |
|---|---|
| Type | Description |
String |
The jsonSchema. |
getJsonSchemaBytes()
public ByteString getJsonSchemaBytes()The JSON representation of the schema.
string json_schema = 3;
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
ByteString |
The bytes for name. |
getParserForType()
public Parser<Schema> getParserForType()| Returns | |
|---|---|
| Type | Description |
Parser<Schema> |
|
getSchemaCase()
public Schema.SchemaCase getSchemaCase()| Returns | |
|---|---|
| Type | Description |
Schema.SchemaCase |
|
getSerializedSize()
public int getSerializedSize()| Returns | |
|---|---|
| Type | Description |
int |
|
getStructSchema()
public Struct getStructSchema()The structured representation of the schema.
.google.protobuf.Struct struct_schema = 2;
| Returns | |
|---|---|
| Type | Description |
Struct |
The structSchema. |
getStructSchemaOrBuilder()
public StructOrBuilder getStructSchemaOrBuilder()The structured representation of the schema.
.google.protobuf.Struct struct_schema = 2;
| Returns | |
|---|---|
| Type | Description |
StructOrBuilder |
|
hasJsonSchema()
public boolean hasJsonSchema()The JSON representation of the schema.
string json_schema = 3;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the jsonSchema field is set. |
hasStructSchema()
public boolean hasStructSchema()The structured representation of the schema.
.google.protobuf.Struct struct_schema = 2;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the structSchema 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 Schema.Builder newBuilderForType()| Returns | |
|---|---|
| Type | Description |
Schema.Builder |
|
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Schema.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)| Parameter | |
|---|---|
| Name | Description |
parent |
BuilderParent |
| Returns | |
|---|---|
| Type | Description |
Schema.Builder |
|
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)| Parameter | |
|---|---|
| Name | Description |
unused |
UnusedPrivateParameter |
| Returns | |
|---|---|
| Type | Description |
Object |
|
toBuilder()
public Schema.Builder toBuilder()| Returns | |
|---|---|
| Type | Description |
Schema.Builder |
|
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)| Parameter | |
|---|---|
| Name | Description |
output |
CodedOutputStream |
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|