public static final class Schema.Builder extends GeneratedMessageV3.Builder<Schema.Builder> implements SchemaOrBuilderDefines the structure and layout of a type of document data.
Protobuf type google.cloud.discoveryengine.v1beta.Schema
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Schema.BuilderImplements
SchemaOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public Schema.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
Schema.Builder |
|
build()
public Schema build()| Returns | |
|---|---|
| Type | Description |
Schema |
|
buildPartial()
public Schema buildPartial()| Returns | |
|---|---|
| Type | Description |
Schema |
|
clear()
public Schema.Builder clear()| Returns | |
|---|---|
| Type | Description |
Schema.Builder |
|
clearField(Descriptors.FieldDescriptor field)
public Schema.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
Schema.Builder |
|
clearJsonSchema()
public Schema.Builder clearJsonSchema()The JSON representation of the schema.
string json_schema = 3;
| Returns | |
|---|---|
| Type | Description |
Schema.Builder |
This builder for chaining. |
clearName()
public Schema.Builder clearName() 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 |
Schema.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public Schema.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
Schema.Builder |
|
clearSchema()
public Schema.Builder clearSchema()| Returns | |
|---|---|
| Type | Description |
Schema.Builder |
|
clearStructSchema()
public Schema.Builder clearStructSchema()The structured representation of the schema.
.google.protobuf.Struct struct_schema = 2;
| Returns | |
|---|---|
| Type | Description |
Schema.Builder |
|
clone()
public Schema.Builder clone()| Returns | |
|---|---|
| Type | Description |
Schema.Builder |
|
getDefaultInstanceForType()
public Schema getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
Schema |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
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. |
getSchemaCase()
public Schema.SchemaCase getSchemaCase()| Returns | |
|---|---|
| Type | Description |
Schema.SchemaCase |
|
getStructSchema()
public Struct getStructSchema()The structured representation of the schema.
.google.protobuf.Struct struct_schema = 2;
| Returns | |
|---|---|
| Type | Description |
Struct |
The structSchema. |
getStructSchemaBuilder()
public Struct.Builder getStructSchemaBuilder()The structured representation of the schema.
.google.protobuf.Struct struct_schema = 2;
| Returns | |
|---|---|
| Type | Description |
Builder |
|
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. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeFrom(Schema other)
public Schema.Builder mergeFrom(Schema other)| Parameter | |
|---|---|
| Name | Description |
other |
Schema |
| Returns | |
|---|---|
| Type | Description |
Schema.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public Schema.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Schema.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public Schema.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
Schema.Builder |
|
mergeStructSchema(Struct value)
public Schema.Builder mergeStructSchema(Struct value)The structured representation of the schema.
.google.protobuf.Struct struct_schema = 2;
| Parameter | |
|---|---|
| Name | Description |
value |
Struct |
| Returns | |
|---|---|
| Type | Description |
Schema.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final Schema.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
Schema.Builder |
|
setField(Descriptors.FieldDescriptor field, Object value)
public Schema.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
Schema.Builder |
|
setJsonSchema(String value)
public Schema.Builder setJsonSchema(String value)The JSON representation of the schema.
string json_schema = 3;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe jsonSchema to set. |
| Returns | |
|---|---|
| Type | Description |
Schema.Builder |
This builder for chaining. |
setJsonSchemaBytes(ByteString value)
public Schema.Builder setJsonSchemaBytes(ByteString value)The JSON representation of the schema.
string json_schema = 3;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for jsonSchema to set. |
| Returns | |
|---|---|
| Type | Description |
Schema.Builder |
This builder for chaining. |
setName(String value)
public Schema.Builder setName(String value) 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];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe name to set. |
| Returns | |
|---|---|
| Type | Description |
Schema.Builder |
This builder for chaining. |
setNameBytes(ByteString value)
public Schema.Builder setNameBytes(ByteString value) 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];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for name to set. |
| Returns | |
|---|---|
| Type | Description |
Schema.Builder |
This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public Schema.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
Schema.Builder |
|
setStructSchema(Struct value)
public Schema.Builder setStructSchema(Struct value)The structured representation of the schema.
.google.protobuf.Struct struct_schema = 2;
| Parameter | |
|---|---|
| Name | Description |
value |
Struct |
| Returns | |
|---|---|
| Type | Description |
Schema.Builder |
|
setStructSchema(Struct.Builder builderForValue)
public Schema.Builder setStructSchema(Struct.Builder builderForValue)The structured representation of the schema.
.google.protobuf.Struct struct_schema = 2;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Builder |
| Returns | |
|---|---|
| Type | Description |
Schema.Builder |
|
setUnknownFields(UnknownFieldSet unknownFields)
public final Schema.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
Schema.Builder |
|