Class FieldConfig
java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.discoveryengine.v1alpha.FieldConfig
- All Implemented Interfaces:
FieldConfigOrBuilder,com.google.protobuf.Message,com.google.protobuf.MessageLite,com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder,Serializable
@Generated
public final class FieldConfig
extends com.google.protobuf.GeneratedMessage
implements FieldConfigOrBuilder
Configurations for fields of a schema. For example, configuring a field is indexable, or searchable.Protobuf type
google.cloud.discoveryengine.v1alpha.FieldConfig- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic enumOptional source of the advanced site search field.static final classConfigurations for fields of a schema.static enumThe setting of Completable options in schema.static enumThe status of the dynamic facetable option of a schema field.static enumField value type in the Schema.static enumSets the filterable option for schema fields.static enumThe setting of Indexable options in schema.static enumThe setting of Retrievable options in schema.static enumThe setting of Searchable options in schema.Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage
com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT, BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message, T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage
com.google.protobuf.AbstractMessage.BuilderParentNested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intFields inherited from class com.google.protobuf.GeneratedMessage
alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFieldsFields inherited from class com.google.protobuf.AbstractMessage
memoizedSizeFields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode -
Method Summary
Modifier and TypeMethodDescriptionbooleangetAdvancedSiteSearchDataSources(int index) If this field is set, only the corresponding source will be indexed for this field.intIf this field is set, only the corresponding source will be indexed for this field.If this field is set, only the corresponding source will be indexed for this field.intgetAdvancedSiteSearchDataSourcesValue(int index) If this field is set, only the corresponding source will be indexed for this field.If this field is set, only the corresponding source will be indexed for this field.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].intIf [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 FieldConfigstatic final com.google.protobuf.Descriptors.DescriptorIf [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.intIf [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.Required.com.google.protobuf.ByteStringRequired.Output only.intOutput only.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].intIf [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].Output only.com.google.protobuf.ByteStringOutput only.com.google.protobuf.Parser<FieldConfig>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].intIf [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 [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.intIf [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.getSchemaOrgPaths(int index) Field paths for indexing custom attribute from schema.org data.com.google.protobuf.ByteStringgetSchemaOrgPathsBytes(int index) Field paths for indexing custom attribute from schema.org data.intField paths for indexing custom attribute from schema.org data.com.google.protobuf.ProtocolStringListField paths for indexing custom attribute from schema.org data.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].intIf [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].intinthashCode()protected com.google.protobuf.GeneratedMessage.FieldAccessorTablefinal booleanstatic FieldConfig.Builderstatic FieldConfig.BuildernewBuilder(FieldConfig prototype) protected FieldConfig.BuildernewBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent) static FieldConfigparseDelimitedFrom(InputStream input) static FieldConfigparseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static FieldConfigparseFrom(byte[] data) static FieldConfigparseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static FieldConfigparseFrom(com.google.protobuf.ByteString data) static FieldConfigparseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static FieldConfigparseFrom(com.google.protobuf.CodedInputStream input) static FieldConfigparseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static FieldConfigparseFrom(InputStream input) static FieldConfigparseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static FieldConfigparseFrom(ByteBuffer data) static FieldConfigparseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static com.google.protobuf.Parser<FieldConfig>parser()voidwriteTo(com.google.protobuf.CodedOutputStream output) Methods inherited from class com.google.protobuf.GeneratedMessage
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, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagMethods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashFields, toStringMethods inherited from class com.google.protobuf.AbstractMessageLite
addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Field Details
-
FIELD_PATH_FIELD_NUMBER
public static final int FIELD_PATH_FIELD_NUMBER- See Also:
-
FIELD_TYPE_FIELD_NUMBER
public static final int FIELD_TYPE_FIELD_NUMBER- See Also:
-
INDEXABLE_OPTION_FIELD_NUMBER
public static final int INDEXABLE_OPTION_FIELD_NUMBER- See Also:
-
DYNAMIC_FACETABLE_OPTION_FIELD_NUMBER
public static final int DYNAMIC_FACETABLE_OPTION_FIELD_NUMBER- See Also:
-
SEARCHABLE_OPTION_FIELD_NUMBER
public static final int SEARCHABLE_OPTION_FIELD_NUMBER- See Also:
-
RETRIEVABLE_OPTION_FIELD_NUMBER
public static final int RETRIEVABLE_OPTION_FIELD_NUMBER- See Also:
-
COMPLETABLE_OPTION_FIELD_NUMBER
public static final int COMPLETABLE_OPTION_FIELD_NUMBER- See Also:
-
RECS_FILTERABLE_OPTION_FIELD_NUMBER
public static final int RECS_FILTERABLE_OPTION_FIELD_NUMBER- See Also:
-
KEY_PROPERTY_TYPE_FIELD_NUMBER
public static final int KEY_PROPERTY_TYPE_FIELD_NUMBER- See Also:
-
ADVANCED_SITE_SEARCH_DATA_SOURCES_FIELD_NUMBER
public static final int ADVANCED_SITE_SEARCH_DATA_SOURCES_FIELD_NUMBER- See Also:
-
SCHEMA_ORG_PATHS_FIELD_NUMBER
public static final int SCHEMA_ORG_PATHS_FIELD_NUMBER- See Also:
-
-
Method Details
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessage
-
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];- Specified by:
getFieldPathin interfaceFieldConfigOrBuilder- Returns:
- The fieldPath.
-
getFieldPathBytes
public 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];- Specified by:
getFieldPathBytesin interfaceFieldConfigOrBuilder- Returns:
- The bytes for fieldPath.
-
getFieldTypeValue
public int getFieldTypeValue()Output only. Raw type of the field.
.google.cloud.discoveryengine.v1alpha.FieldConfig.FieldType field_type = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getFieldTypeValuein interfaceFieldConfigOrBuilder- Returns:
- The enum numeric value on the wire for fieldType.
-
getFieldType
Output only. Raw type of the field.
.google.cloud.discoveryengine.v1alpha.FieldConfig.FieldType field_type = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getFieldTypein interfaceFieldConfigOrBuilder- Returns:
- The fieldType.
-
getIndexableOptionValue
public 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;- Specified by:
getIndexableOptionValuein interfaceFieldConfigOrBuilder- Returns:
- The enum numeric value on the wire for 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;- Specified by:
getIndexableOptionin interfaceFieldConfigOrBuilder- Returns:
- The indexableOption.
-
getDynamicFacetableOptionValue
public 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;- Specified by:
getDynamicFacetableOptionValuein interfaceFieldConfigOrBuilder- Returns:
- The enum numeric value on the wire for 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;- Specified by:
getDynamicFacetableOptionin interfaceFieldConfigOrBuilder- Returns:
- The dynamicFacetableOption.
-
getSearchableOptionValue
public 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;- Specified by:
getSearchableOptionValuein interfaceFieldConfigOrBuilder- Returns:
- The enum numeric value on the wire for 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;- Specified by:
getSearchableOptionin interfaceFieldConfigOrBuilder- Returns:
- The searchableOption.
-
getRetrievableOptionValue
public 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;- Specified by:
getRetrievableOptionValuein interfaceFieldConfigOrBuilder- Returns:
- The enum numeric value on the wire for 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;- Specified by:
getRetrievableOptionin interfaceFieldConfigOrBuilder- Returns:
- The retrievableOption.
-
getCompletableOptionValue
public 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;- Specified by:
getCompletableOptionValuein interfaceFieldConfigOrBuilder- Returns:
- The enum numeric value on the wire for 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;- Specified by:
getCompletableOptionin interfaceFieldConfigOrBuilder- Returns:
- The completableOption.
-
getRecsFilterableOptionValue
public 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;- Specified by:
getRecsFilterableOptionValuein interfaceFieldConfigOrBuilder- Returns:
- The enum numeric value on the wire for recsFilterableOption.
-
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;- Specified by:
getRecsFilterableOptionin interfaceFieldConfigOrBuilder- Returns:
- The recsFilterableOption.
-
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];- Specified by:
getKeyPropertyTypein interfaceFieldConfigOrBuilder- Returns:
- The keyPropertyType.
-
getKeyPropertyTypeBytes
public 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];- Specified by:
getKeyPropertyTypeBytesin interfaceFieldConfigOrBuilder- Returns:
- The bytes for keyPropertyType.
-
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;- Specified by:
getAdvancedSiteSearchDataSourcesListin interfaceFieldConfigOrBuilder- Returns:
- A list containing the advancedSiteSearchDataSources.
-
getAdvancedSiteSearchDataSourcesCount
public 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;- Specified by:
getAdvancedSiteSearchDataSourcesCountin interfaceFieldConfigOrBuilder- Returns:
- The count of advancedSiteSearchDataSources.
-
getAdvancedSiteSearchDataSources
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;- Specified by:
getAdvancedSiteSearchDataSourcesin interfaceFieldConfigOrBuilder- Parameters:
index- The index of the element to return.- Returns:
- The advancedSiteSearchDataSources at the given index.
-
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;- Specified by:
getAdvancedSiteSearchDataSourcesValueListin interfaceFieldConfigOrBuilder- Returns:
- A list containing the enum numeric values on the wire for advancedSiteSearchDataSources.
-
getAdvancedSiteSearchDataSourcesValue
public 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;- Specified by:
getAdvancedSiteSearchDataSourcesValuein interfaceFieldConfigOrBuilder- Parameters:
index- The index of the value to return.- Returns:
- The enum numeric value on the wire of advancedSiteSearchDataSources at the given index.
-
getSchemaOrgPathsList
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;- Specified by:
getSchemaOrgPathsListin interfaceFieldConfigOrBuilder- Returns:
- A list containing the schemaOrgPaths.
-
getSchemaOrgPathsCount
public 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;- Specified by:
getSchemaOrgPathsCountin interfaceFieldConfigOrBuilder- Returns:
- The count of schemaOrgPaths.
-
getSchemaOrgPaths
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;- Specified by:
getSchemaOrgPathsin interfaceFieldConfigOrBuilder- Parameters:
index- The index of the element to return.- Returns:
- The schemaOrgPaths at the given index.
-
getSchemaOrgPathsBytes
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;- Specified by:
getSchemaOrgPathsBytesin interfaceFieldConfigOrBuilder- Parameters:
index- The index of the value to return.- Returns:
- The bytes of the schemaOrgPaths at the given index.
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessage
-
writeTo
- Specified by:
writeToin interfacecom.google.protobuf.MessageLite- Overrides:
writeToin classcom.google.protobuf.GeneratedMessage- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()- Specified by:
getSerializedSizein interfacecom.google.protobuf.MessageLite- Overrides:
getSerializedSizein classcom.google.protobuf.GeneratedMessage
-
equals
- Specified by:
equalsin interfacecom.google.protobuf.Message- Overrides:
equalsin classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()- Specified by:
hashCodein interfacecom.google.protobuf.Message- Overrides:
hashCodein classcom.google.protobuf.AbstractMessage
-
parseFrom
public static FieldConfig parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static FieldConfig parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static FieldConfig parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static FieldConfig parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static FieldConfig parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static FieldConfig parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
- Throws:
IOException
-
parseFrom
public static FieldConfig parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
- Throws:
IOException
-
parseDelimitedFrom
public static FieldConfig parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseFrom
- Throws:
IOException
-
parseFrom
public static FieldConfig parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
newBuilderForType
- Specified by:
newBuilderForTypein interfacecom.google.protobuf.Message- Specified by:
newBuilderForTypein interfacecom.google.protobuf.MessageLite
-
newBuilder
-
newBuilder
-
toBuilder
- Specified by:
toBuilderin interfacecom.google.protobuf.Message- Specified by:
toBuilderin interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected FieldConfig.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent) - Overrides:
newBuilderForTypein classcom.google.protobuf.AbstractMessage
-
getDefaultInstance
-
parser
-
getParserForType
- Specified by:
getParserForTypein interfacecom.google.protobuf.Message- Specified by:
getParserForTypein interfacecom.google.protobuf.MessageLite- Overrides:
getParserForTypein classcom.google.protobuf.GeneratedMessage
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-