public final class FieldConfig extends com.google.protobuf.GeneratedMessageV3 implements FieldConfigOrBuilder
Configurations for fields of a schema. For example, configuring a field is indexable, or searchable.Protobuf type
google.cloud.discoveryengine.v1alpha.FieldConfig| Modifier and Type | Class and Description |
|---|---|
static class |
FieldConfig.AdvancedSiteSearchDataSource
Optional source of the advanced site search field.
|
static class |
FieldConfig.Builder
Configurations for fields of a schema.
|
static class |
FieldConfig.CompletableOption
The setting of Completable options in schema.
|
static class |
FieldConfig.DynamicFacetableOption
The status of the dynamic facetable option of a schema field.
|
static class |
FieldConfig.FieldType
Field value type in the Schema.
|
static class |
FieldConfig.FilterableOption
Sets the filterable option for schema fields.
|
static class |
FieldConfig.IndexableOption
The setting of Indexable options in schema.
|
static class |
FieldConfig.RetrievableOption
The setting of Retrievable options in schema.
|
static class |
FieldConfig.SearchableOption
The setting of Searchable options in schema.
|
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| Modifier and Type | Field and Description |
|---|---|
static int |
ADVANCED_SITE_SEARCH_DATA_SOURCES_FIELD_NUMBER |
static int |
COMPLETABLE_OPTION_FIELD_NUMBER |
static int |
DYNAMIC_FACETABLE_OPTION_FIELD_NUMBER |
static int |
FIELD_PATH_FIELD_NUMBER |
static int |
FIELD_TYPE_FIELD_NUMBER |
static int |
INDEXABLE_OPTION_FIELD_NUMBER |
static int |
KEY_PROPERTY_TYPE_FIELD_NUMBER |
static int |
RECS_FILTERABLE_OPTION_FIELD_NUMBER |
static int |
RETRIEVABLE_OPTION_FIELD_NUMBER |
static int |
SCHEMA_ORG_PATHS_FIELD_NUMBER |
static int |
SEARCHABLE_OPTION_FIELD_NUMBER |
| Modifier and Type | Method and Description |
|---|---|
boolean |
equals(Object obj) |
FieldConfig.AdvancedSiteSearchDataSource |
getAdvancedSiteSearchDataSources(int index)
If this field is set, only the corresponding source will be indexed for
this field.
|
int |
getAdvancedSiteSearchDataSourcesCount()
If this field is set, only the corresponding source will be indexed for
this field.
|
List<FieldConfig.AdvancedSiteSearchDataSource> |
getAdvancedSiteSearchDataSourcesList()
If this field is set, only the corresponding source will be indexed for
this field.
|
int |
getAdvancedSiteSearchDataSourcesValue(int index)
If this field is set, only the corresponding source will be indexed for
this field.
|
List<Integer> |
getAdvancedSiteSearchDataSourcesValueList()
If this field is set, only the corresponding source will be indexed for
this field.
|
FieldConfig.CompletableOption |
getCompletableOption()
If
[completable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.completable_option]
is
[COMPLETABLE_ENABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.CompletableOption.COMPLETABLE_ENABLED],
field values are directly used and returned as suggestions for Autocomplete
in
[CompletionService.CompleteQuery][google.cloud.discoveryengine.v1alpha.CompletionService.CompleteQuery].
|
int |
getCompletableOptionValue()
If
[completable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.completable_option]
is
[COMPLETABLE_ENABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.CompletableOption.COMPLETABLE_ENABLED],
field values are directly used and returned as suggestions for Autocomplete
in
[CompletionService.CompleteQuery][google.cloud.discoveryengine.v1alpha.CompletionService.CompleteQuery].
|
static FieldConfig |
getDefaultInstance() |
FieldConfig |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
FieldConfig.DynamicFacetableOption |
getDynamicFacetableOption()
If
[dynamic_facetable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.dynamic_facetable_option]
is
[DYNAMIC_FACETABLE_ENABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.DynamicFacetableOption.DYNAMIC_FACETABLE_ENABLED],
field values are available for dynamic facet.
|
int |
getDynamicFacetableOptionValue()
If
[dynamic_facetable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.dynamic_facetable_option]
is
[DYNAMIC_FACETABLE_ENABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.DynamicFacetableOption.DYNAMIC_FACETABLE_ENABLED],
field values are available for dynamic facet.
|
String |
getFieldPath()
Required.
|
com.google.protobuf.ByteString |
getFieldPathBytes()
Required.
|
FieldConfig.FieldType |
getFieldType()
Output only.
|
int |
getFieldTypeValue()
Output only.
|
FieldConfig.IndexableOption |
getIndexableOption()
If
[indexable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.indexable_option]
is
[INDEXABLE_ENABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.IndexableOption.INDEXABLE_ENABLED],
field values are indexed so that it can be filtered or faceted in
[SearchService.Search][google.cloud.discoveryengine.v1alpha.SearchService.Search].
|
int |
getIndexableOptionValue()
If
[indexable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.indexable_option]
is
[INDEXABLE_ENABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.IndexableOption.INDEXABLE_ENABLED],
field values are indexed so that it can be filtered or faceted in
[SearchService.Search][google.cloud.discoveryengine.v1alpha.SearchService.Search].
|
String |
getKeyPropertyType()
Output only.
|
com.google.protobuf.ByteString |
getKeyPropertyTypeBytes()
Output only.
|
com.google.protobuf.Parser<FieldConfig> |
getParserForType() |
FieldConfig.FilterableOption |
getRecsFilterableOption()
If
[recs_filterable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.recs_filterable_option]
is
[FILTERABLE_ENABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.FilterableOption.FILTERABLE_ENABLED],
field values are filterable by filter expression in
[RecommendationService.Recommend][google.cloud.discoveryengine.v1alpha.RecommendationService.Recommend].
|
int |
getRecsFilterableOptionValue()
If
[recs_filterable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.recs_filterable_option]
is
[FILTERABLE_ENABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.FilterableOption.FILTERABLE_ENABLED],
field values are filterable by filter expression in
[RecommendationService.Recommend][google.cloud.discoveryengine.v1alpha.RecommendationService.Recommend].
|
FieldConfig.RetrievableOption |
getRetrievableOption()
If
[retrievable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.retrievable_option]
is
[RETRIEVABLE_ENABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.RetrievableOption.RETRIEVABLE_ENABLED],
field values are included in the search results.
|
int |
getRetrievableOptionValue()
If
[retrievable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.retrievable_option]
is
[RETRIEVABLE_ENABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.RetrievableOption.RETRIEVABLE_ENABLED],
field values are included in the search results.
|
String |
getSchemaOrgPaths(int index)
Field paths for indexing custom attribute from schema.org data.
|
com.google.protobuf.ByteString |
getSchemaOrgPathsBytes(int index)
Field paths for indexing custom attribute from schema.org data.
|
int |
getSchemaOrgPathsCount()
Field paths for indexing custom attribute from schema.org data.
|
com.google.protobuf.ProtocolStringList |
getSchemaOrgPathsList()
Field paths for indexing custom attribute from schema.org data.
|
FieldConfig.SearchableOption |
getSearchableOption()
If
[searchable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.searchable_option]
is
[SEARCHABLE_ENABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.SearchableOption.SEARCHABLE_ENABLED],
field values are searchable by text queries in
[SearchService.Search][google.cloud.discoveryengine.v1alpha.SearchService.Search].
|
int |
getSearchableOptionValue()
If
[searchable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.searchable_option]
is
[SEARCHABLE_ENABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.SearchableOption.SEARCHABLE_ENABLED],
field values are searchable by text queries in
[SearchService.Search][google.cloud.discoveryengine.v1alpha.SearchService.Search].
|
int |
getSerializedSize() |
int |
hashCode() |
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
static FieldConfig.Builder |
newBuilder() |
static FieldConfig.Builder |
newBuilder(FieldConfig prototype) |
FieldConfig.Builder |
newBuilderForType() |
protected FieldConfig.Builder |
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) |
protected Object |
newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) |
static FieldConfig |
parseDelimitedFrom(InputStream input) |
static FieldConfig |
parseDelimitedFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static FieldConfig |
parseFrom(byte[] data) |
static FieldConfig |
parseFrom(byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static FieldConfig |
parseFrom(ByteBuffer data) |
static FieldConfig |
parseFrom(ByteBuffer data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static FieldConfig |
parseFrom(com.google.protobuf.ByteString data) |
static FieldConfig |
parseFrom(com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static FieldConfig |
parseFrom(com.google.protobuf.CodedInputStream input) |
static FieldConfig |
parseFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static FieldConfig |
parseFrom(InputStream input) |
static FieldConfig |
parseFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static com.google.protobuf.Parser<FieldConfig> |
parser() |
FieldConfig.Builder |
toBuilder() |
void |
writeTo(com.google.protobuf.CodedOutputStream output) |
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, writeStringNoTagfindInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringaddAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToclone, finalize, getClass, notify, notifyAll, wait, wait, waitpublic static final int FIELD_PATH_FIELD_NUMBER
public static final int FIELD_TYPE_FIELD_NUMBER
public static final int INDEXABLE_OPTION_FIELD_NUMBER
public static final int DYNAMIC_FACETABLE_OPTION_FIELD_NUMBER
public static final int SEARCHABLE_OPTION_FIELD_NUMBER
public static final int RETRIEVABLE_OPTION_FIELD_NUMBER
public static final int COMPLETABLE_OPTION_FIELD_NUMBER
public static final int RECS_FILTERABLE_OPTION_FIELD_NUMBER
public static final int KEY_PROPERTY_TYPE_FIELD_NUMBER
public static final int ADVANCED_SITE_SEARCH_DATA_SOURCES_FIELD_NUMBER
public static final int SCHEMA_ORG_PATHS_FIELD_NUMBER
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
newInstance in class com.google.protobuf.GeneratedMessageV3public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3public String getFieldPath()
Required. Field path of the schema field. For example: `title`, `description`, `release_info.release_year`.
string field_path = 1 [(.google.api.field_behavior) = REQUIRED];getFieldPath in interface FieldConfigOrBuilderpublic com.google.protobuf.ByteString getFieldPathBytes()
Required. Field path of the schema field. For example: `title`, `description`, `release_info.release_year`.
string field_path = 1 [(.google.api.field_behavior) = REQUIRED];getFieldPathBytes in interface FieldConfigOrBuilderpublic int getFieldTypeValue()
Output only. Raw type of the field.
.google.cloud.discoveryengine.v1alpha.FieldConfig.FieldType field_type = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
getFieldTypeValue in interface FieldConfigOrBuilderpublic FieldConfig.FieldType getFieldType()
Output only. Raw type of the field.
.google.cloud.discoveryengine.v1alpha.FieldConfig.FieldType field_type = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
getFieldType in interface FieldConfigOrBuilderpublic int getIndexableOptionValue()
If [indexable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.indexable_option] is [INDEXABLE_ENABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.IndexableOption.INDEXABLE_ENABLED], field values are indexed so that it can be filtered or faceted in [SearchService.Search][google.cloud.discoveryengine.v1alpha.SearchService.Search]. If [indexable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.indexable_option] is unset, the server behavior defaults to [INDEXABLE_DISABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.IndexableOption.INDEXABLE_DISABLED] for fields that support setting indexable options. For those fields that do not support setting indexable options, such as `object` and `boolean` and key properties, the server will skip [indexable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.indexable_option] setting, and setting [indexable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.indexable_option] for those fields will throw `INVALID_ARGUMENT` error.
.google.cloud.discoveryengine.v1alpha.FieldConfig.IndexableOption indexable_option = 3;
getIndexableOptionValue in interface FieldConfigOrBuilderpublic FieldConfig.IndexableOption getIndexableOption()
If [indexable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.indexable_option] is [INDEXABLE_ENABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.IndexableOption.INDEXABLE_ENABLED], field values are indexed so that it can be filtered or faceted in [SearchService.Search][google.cloud.discoveryengine.v1alpha.SearchService.Search]. If [indexable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.indexable_option] is unset, the server behavior defaults to [INDEXABLE_DISABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.IndexableOption.INDEXABLE_DISABLED] for fields that support setting indexable options. For those fields that do not support setting indexable options, such as `object` and `boolean` and key properties, the server will skip [indexable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.indexable_option] setting, and setting [indexable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.indexable_option] for those fields will throw `INVALID_ARGUMENT` error.
.google.cloud.discoveryengine.v1alpha.FieldConfig.IndexableOption indexable_option = 3;
getIndexableOption in interface FieldConfigOrBuilderpublic int getDynamicFacetableOptionValue()
If [dynamic_facetable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.dynamic_facetable_option] is [DYNAMIC_FACETABLE_ENABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.DynamicFacetableOption.DYNAMIC_FACETABLE_ENABLED], field values are available for dynamic facet. Could only be [DYNAMIC_FACETABLE_DISABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.DynamicFacetableOption.DYNAMIC_FACETABLE_DISABLED] if [FieldConfig.indexable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.indexable_option] is [INDEXABLE_DISABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.IndexableOption.INDEXABLE_DISABLED]. Otherwise, an `INVALID_ARGUMENT` error will be returned. If [dynamic_facetable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.dynamic_facetable_option] is unset, the server behavior defaults to [DYNAMIC_FACETABLE_DISABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.DynamicFacetableOption.DYNAMIC_FACETABLE_DISABLED] for fields that support setting dynamic facetable options. For those fields that do not support setting dynamic facetable options, such as `object` and `boolean`, the server will skip dynamic facetable option setting, and setting [dynamic_facetable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.dynamic_facetable_option] for those fields will throw `INVALID_ARGUMENT` error.
.google.cloud.discoveryengine.v1alpha.FieldConfig.DynamicFacetableOption dynamic_facetable_option = 4;
getDynamicFacetableOptionValue in interface FieldConfigOrBuilderpublic FieldConfig.DynamicFacetableOption getDynamicFacetableOption()
If [dynamic_facetable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.dynamic_facetable_option] is [DYNAMIC_FACETABLE_ENABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.DynamicFacetableOption.DYNAMIC_FACETABLE_ENABLED], field values are available for dynamic facet. Could only be [DYNAMIC_FACETABLE_DISABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.DynamicFacetableOption.DYNAMIC_FACETABLE_DISABLED] if [FieldConfig.indexable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.indexable_option] is [INDEXABLE_DISABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.IndexableOption.INDEXABLE_DISABLED]. Otherwise, an `INVALID_ARGUMENT` error will be returned. If [dynamic_facetable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.dynamic_facetable_option] is unset, the server behavior defaults to [DYNAMIC_FACETABLE_DISABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.DynamicFacetableOption.DYNAMIC_FACETABLE_DISABLED] for fields that support setting dynamic facetable options. For those fields that do not support setting dynamic facetable options, such as `object` and `boolean`, the server will skip dynamic facetable option setting, and setting [dynamic_facetable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.dynamic_facetable_option] for those fields will throw `INVALID_ARGUMENT` error.
.google.cloud.discoveryengine.v1alpha.FieldConfig.DynamicFacetableOption dynamic_facetable_option = 4;
getDynamicFacetableOption in interface FieldConfigOrBuilderpublic int getSearchableOptionValue()
If [searchable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.searchable_option] is [SEARCHABLE_ENABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.SearchableOption.SEARCHABLE_ENABLED], field values are searchable by text queries in [SearchService.Search][google.cloud.discoveryengine.v1alpha.SearchService.Search]. If [SEARCHABLE_ENABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.SearchableOption.SEARCHABLE_ENABLED] but field type is numerical, field values will not be searchable by text queries in [SearchService.Search][google.cloud.discoveryengine.v1alpha.SearchService.Search], as there are no text values associated to numerical fields. If [searchable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.searchable_option] is unset, the server behavior defaults to [SEARCHABLE_DISABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.SearchableOption.SEARCHABLE_DISABLED] for fields that support setting searchable options. Only `string` fields that have no key property mapping support setting [searchable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.searchable_option]. For those fields that do not support setting searchable options, the server will skip searchable option setting, and setting [searchable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.searchable_option] for those fields will throw `INVALID_ARGUMENT` error.
.google.cloud.discoveryengine.v1alpha.FieldConfig.SearchableOption searchable_option = 5;
getSearchableOptionValue in interface FieldConfigOrBuilderpublic FieldConfig.SearchableOption getSearchableOption()
If [searchable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.searchable_option] is [SEARCHABLE_ENABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.SearchableOption.SEARCHABLE_ENABLED], field values are searchable by text queries in [SearchService.Search][google.cloud.discoveryengine.v1alpha.SearchService.Search]. If [SEARCHABLE_ENABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.SearchableOption.SEARCHABLE_ENABLED] but field type is numerical, field values will not be searchable by text queries in [SearchService.Search][google.cloud.discoveryengine.v1alpha.SearchService.Search], as there are no text values associated to numerical fields. If [searchable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.searchable_option] is unset, the server behavior defaults to [SEARCHABLE_DISABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.SearchableOption.SEARCHABLE_DISABLED] for fields that support setting searchable options. Only `string` fields that have no key property mapping support setting [searchable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.searchable_option]. For those fields that do not support setting searchable options, the server will skip searchable option setting, and setting [searchable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.searchable_option] for those fields will throw `INVALID_ARGUMENT` error.
.google.cloud.discoveryengine.v1alpha.FieldConfig.SearchableOption searchable_option = 5;
getSearchableOption in interface FieldConfigOrBuilderpublic int getRetrievableOptionValue()
If [retrievable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.retrievable_option] is [RETRIEVABLE_ENABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.RetrievableOption.RETRIEVABLE_ENABLED], field values are included in the search results. If [retrievable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.retrievable_option] is unset, the server behavior defaults to [RETRIEVABLE_DISABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.RetrievableOption.RETRIEVABLE_DISABLED] for fields that support setting retrievable options. For those fields that do not support setting retrievable options, such as `object` and `boolean`, the server will skip retrievable option setting, and setting [retrievable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.retrievable_option] for those fields will throw `INVALID_ARGUMENT` error.
.google.cloud.discoveryengine.v1alpha.FieldConfig.RetrievableOption retrievable_option = 6;
getRetrievableOptionValue in interface FieldConfigOrBuilderpublic FieldConfig.RetrievableOption getRetrievableOption()
If [retrievable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.retrievable_option] is [RETRIEVABLE_ENABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.RetrievableOption.RETRIEVABLE_ENABLED], field values are included in the search results. If [retrievable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.retrievable_option] is unset, the server behavior defaults to [RETRIEVABLE_DISABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.RetrievableOption.RETRIEVABLE_DISABLED] for fields that support setting retrievable options. For those fields that do not support setting retrievable options, such as `object` and `boolean`, the server will skip retrievable option setting, and setting [retrievable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.retrievable_option] for those fields will throw `INVALID_ARGUMENT` error.
.google.cloud.discoveryengine.v1alpha.FieldConfig.RetrievableOption retrievable_option = 6;
getRetrievableOption in interface FieldConfigOrBuilderpublic int getCompletableOptionValue()
If [completable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.completable_option] is [COMPLETABLE_ENABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.CompletableOption.COMPLETABLE_ENABLED], field values are directly used and returned as suggestions for Autocomplete in [CompletionService.CompleteQuery][google.cloud.discoveryengine.v1alpha.CompletionService.CompleteQuery]. If [completable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.completable_option] is unset, the server behavior defaults to [COMPLETABLE_DISABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.CompletableOption.COMPLETABLE_DISABLED] for fields that support setting completable options, which are just `string` fields. For those fields that do not support setting completable options, the server will skip completable option setting, and setting [completable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.completable_option] for those fields will throw `INVALID_ARGUMENT` error.
.google.cloud.discoveryengine.v1alpha.FieldConfig.CompletableOption completable_option = 8;
getCompletableOptionValue in interface FieldConfigOrBuilderpublic FieldConfig.CompletableOption getCompletableOption()
If [completable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.completable_option] is [COMPLETABLE_ENABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.CompletableOption.COMPLETABLE_ENABLED], field values are directly used and returned as suggestions for Autocomplete in [CompletionService.CompleteQuery][google.cloud.discoveryengine.v1alpha.CompletionService.CompleteQuery]. If [completable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.completable_option] is unset, the server behavior defaults to [COMPLETABLE_DISABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.CompletableOption.COMPLETABLE_DISABLED] for fields that support setting completable options, which are just `string` fields. For those fields that do not support setting completable options, the server will skip completable option setting, and setting [completable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.completable_option] for those fields will throw `INVALID_ARGUMENT` error.
.google.cloud.discoveryengine.v1alpha.FieldConfig.CompletableOption completable_option = 8;
getCompletableOption in interface FieldConfigOrBuilderpublic int getRecsFilterableOptionValue()
If [recs_filterable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.recs_filterable_option] is [FILTERABLE_ENABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.FilterableOption.FILTERABLE_ENABLED], field values are filterable by filter expression in [RecommendationService.Recommend][google.cloud.discoveryengine.v1alpha.RecommendationService.Recommend]. If [FILTERABLE_ENABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.FilterableOption.FILTERABLE_ENABLED] but the field type is numerical, field values are not filterable by text queries in [RecommendationService.Recommend][google.cloud.discoveryengine.v1alpha.RecommendationService.Recommend]. Only textual fields are supported. If [recs_filterable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.recs_filterable_option] is unset, the default setting is [FILTERABLE_DISABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.FilterableOption.FILTERABLE_DISABLED] for fields that support setting filterable options. When a field set to [FILTERABLE_DISABLED] is filtered, a warning is generated and an empty result is returned.
.google.cloud.discoveryengine.v1alpha.FieldConfig.FilterableOption recs_filterable_option = 9;
getRecsFilterableOptionValue in interface FieldConfigOrBuilderpublic FieldConfig.FilterableOption getRecsFilterableOption()
If [recs_filterable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.recs_filterable_option] is [FILTERABLE_ENABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.FilterableOption.FILTERABLE_ENABLED], field values are filterable by filter expression in [RecommendationService.Recommend][google.cloud.discoveryengine.v1alpha.RecommendationService.Recommend]. If [FILTERABLE_ENABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.FilterableOption.FILTERABLE_ENABLED] but the field type is numerical, field values are not filterable by text queries in [RecommendationService.Recommend][google.cloud.discoveryengine.v1alpha.RecommendationService.Recommend]. Only textual fields are supported. If [recs_filterable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.recs_filterable_option] is unset, the default setting is [FILTERABLE_DISABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.FilterableOption.FILTERABLE_DISABLED] for fields that support setting filterable options. When a field set to [FILTERABLE_DISABLED] is filtered, a warning is generated and an empty result is returned.
.google.cloud.discoveryengine.v1alpha.FieldConfig.FilterableOption recs_filterable_option = 9;
getRecsFilterableOption in interface FieldConfigOrBuilderpublic String getKeyPropertyType()
Output only. Type of the key property that this field is mapped to. Empty string if this is not annotated as mapped to a key property. Example types are `title`, `description`. Full list is defined by `keyPropertyMapping` in the schema field annotation. If the schema field has a `KeyPropertyMapping` annotation, `indexable_option` and `searchable_option` of this field cannot be modified.
string key_property_type = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];getKeyPropertyType in interface FieldConfigOrBuilderpublic com.google.protobuf.ByteString getKeyPropertyTypeBytes()
Output only. Type of the key property that this field is mapped to. Empty string if this is not annotated as mapped to a key property. Example types are `title`, `description`. Full list is defined by `keyPropertyMapping` in the schema field annotation. If the schema field has a `KeyPropertyMapping` annotation, `indexable_option` and `searchable_option` of this field cannot be modified.
string key_property_type = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];getKeyPropertyTypeBytes in interface FieldConfigOrBuilderpublic List<FieldConfig.AdvancedSiteSearchDataSource> getAdvancedSiteSearchDataSourcesList()
If this field is set, only the corresponding source will be indexed for this field. Otherwise, the values from different sources are merged. Assuming a page with `<author, a>` in meta tag, and `<author, b>` in page map: if this enum is set to METATAGS, we will only index `<author, a>`; if this enum is not set, we will merge them and index `<author, [a, b]>`.
repeated .google.cloud.discoveryengine.v1alpha.FieldConfig.AdvancedSiteSearchDataSource advanced_site_search_data_sources = 10;
getAdvancedSiteSearchDataSourcesList in interface FieldConfigOrBuilderpublic int getAdvancedSiteSearchDataSourcesCount()
If this field is set, only the corresponding source will be indexed for this field. Otherwise, the values from different sources are merged. Assuming a page with `<author, a>` in meta tag, and `<author, b>` in page map: if this enum is set to METATAGS, we will only index `<author, a>`; if this enum is not set, we will merge them and index `<author, [a, b]>`.
repeated .google.cloud.discoveryengine.v1alpha.FieldConfig.AdvancedSiteSearchDataSource advanced_site_search_data_sources = 10;
getAdvancedSiteSearchDataSourcesCount in interface FieldConfigOrBuilderpublic FieldConfig.AdvancedSiteSearchDataSource getAdvancedSiteSearchDataSources(int index)
If this field is set, only the corresponding source will be indexed for this field. Otherwise, the values from different sources are merged. Assuming a page with `<author, a>` in meta tag, and `<author, b>` in page map: if this enum is set to METATAGS, we will only index `<author, a>`; if this enum is not set, we will merge them and index `<author, [a, b]>`.
repeated .google.cloud.discoveryengine.v1alpha.FieldConfig.AdvancedSiteSearchDataSource advanced_site_search_data_sources = 10;
getAdvancedSiteSearchDataSources in interface FieldConfigOrBuilderindex - The index of the element to return.public List<Integer> getAdvancedSiteSearchDataSourcesValueList()
If this field is set, only the corresponding source will be indexed for this field. Otherwise, the values from different sources are merged. Assuming a page with `<author, a>` in meta tag, and `<author, b>` in page map: if this enum is set to METATAGS, we will only index `<author, a>`; if this enum is not set, we will merge them and index `<author, [a, b]>`.
repeated .google.cloud.discoveryengine.v1alpha.FieldConfig.AdvancedSiteSearchDataSource advanced_site_search_data_sources = 10;
getAdvancedSiteSearchDataSourcesValueList in interface FieldConfigOrBuilderpublic int getAdvancedSiteSearchDataSourcesValue(int index)
If this field is set, only the corresponding source will be indexed for this field. Otherwise, the values from different sources are merged. Assuming a page with `<author, a>` in meta tag, and `<author, b>` in page map: if this enum is set to METATAGS, we will only index `<author, a>`; if this enum is not set, we will merge them and index `<author, [a, b]>`.
repeated .google.cloud.discoveryengine.v1alpha.FieldConfig.AdvancedSiteSearchDataSource advanced_site_search_data_sources = 10;
getAdvancedSiteSearchDataSourcesValue in interface FieldConfigOrBuilderindex - The index of the value to return.public com.google.protobuf.ProtocolStringList getSchemaOrgPathsList()
Field paths for indexing custom attribute from schema.org data. More details of schema.org and its defined types can be found at [schema.org](https://schema.org). It is only used on advanced site search schema. Currently only support full path from root. The full path to a field is constructed by concatenating field names, starting from `_root`, with a period `.` as the delimiter. Examples: * Publish date of the root: _root.datePublished * Publish date of the reviews: _root.review.datePublished
repeated string schema_org_paths = 11;getSchemaOrgPathsList in interface FieldConfigOrBuilderpublic int getSchemaOrgPathsCount()
Field paths for indexing custom attribute from schema.org data. More details of schema.org and its defined types can be found at [schema.org](https://schema.org). It is only used on advanced site search schema. Currently only support full path from root. The full path to a field is constructed by concatenating field names, starting from `_root`, with a period `.` as the delimiter. Examples: * Publish date of the root: _root.datePublished * Publish date of the reviews: _root.review.datePublished
repeated string schema_org_paths = 11;getSchemaOrgPathsCount in interface FieldConfigOrBuilderpublic String getSchemaOrgPaths(int index)
Field paths for indexing custom attribute from schema.org data. More details of schema.org and its defined types can be found at [schema.org](https://schema.org). It is only used on advanced site search schema. Currently only support full path from root. The full path to a field is constructed by concatenating field names, starting from `_root`, with a period `.` as the delimiter. Examples: * Publish date of the root: _root.datePublished * Publish date of the reviews: _root.review.datePublished
repeated string schema_org_paths = 11;getSchemaOrgPaths in interface FieldConfigOrBuilderindex - The index of the element to return.public com.google.protobuf.ByteString getSchemaOrgPathsBytes(int index)
Field paths for indexing custom attribute from schema.org data. More details of schema.org and its defined types can be found at [schema.org](https://schema.org). It is only used on advanced site search schema. Currently only support full path from root. The full path to a field is constructed by concatenating field names, starting from `_root`, with a period `.` as the delimiter. Examples: * Publish date of the root: _root.datePublished * Publish date of the reviews: _root.review.datePublished
repeated string schema_org_paths = 11;getSchemaOrgPathsBytes in interface FieldConfigOrBuilderindex - The index of the value to return.public final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3public void writeTo(com.google.protobuf.CodedOutputStream output)
throws IOException
writeTo in interface com.google.protobuf.MessageLitewriteTo in class com.google.protobuf.GeneratedMessageV3IOExceptionpublic int getSerializedSize()
getSerializedSize in interface com.google.protobuf.MessageLitegetSerializedSize in class com.google.protobuf.GeneratedMessageV3public boolean equals(Object obj)
equals in interface com.google.protobuf.Messageequals in class com.google.protobuf.AbstractMessagepublic int hashCode()
hashCode in interface com.google.protobuf.MessagehashCode in class com.google.protobuf.AbstractMessagepublic static FieldConfig parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static FieldConfig parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static FieldConfig parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static FieldConfig parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static FieldConfig parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static FieldConfig parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static FieldConfig parseFrom(InputStream input) throws IOException
IOExceptionpublic static FieldConfig parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static FieldConfig parseDelimitedFrom(InputStream input) throws IOException
IOExceptionpublic static FieldConfig parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static FieldConfig parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
IOExceptionpublic static FieldConfig parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic FieldConfig.Builder newBuilderForType()
newBuilderForType in interface com.google.protobuf.MessagenewBuilderForType in interface com.google.protobuf.MessageLitepublic static FieldConfig.Builder newBuilder()
public static FieldConfig.Builder newBuilder(FieldConfig prototype)
public FieldConfig.Builder toBuilder()
toBuilder in interface com.google.protobuf.MessagetoBuilder in interface com.google.protobuf.MessageLiteprotected FieldConfig.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
newBuilderForType in class com.google.protobuf.GeneratedMessageV3public static FieldConfig getDefaultInstance()
public static com.google.protobuf.Parser<FieldConfig> parser()
public com.google.protobuf.Parser<FieldConfig> getParserForType()
getParserForType in interface com.google.protobuf.MessagegetParserForType in interface com.google.protobuf.MessageLitegetParserForType in class com.google.protobuf.GeneratedMessageV3public FieldConfig getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderCopyright © 2024 Google LLC. All rights reserved.