Represents a FieldConfig.
Package
@google-cloud/discoveryengineConstructors
(constructor)(properties)
constructor(properties?: google.cloud.discoveryengine.v1alpha.IFieldConfig);Constructs a new FieldConfig.
| Parameter | |
|---|---|
| Name | Description |
properties |
IFieldConfig
Properties to set |
Properties
completableOption
public completableOption: (google.cloud.discoveryengine.v1alpha.FieldConfig.CompletableOption|keyof typeof google.cloud.discoveryengine.v1alpha.FieldConfig.CompletableOption);FieldConfig completableOption.
dynamicFacetableOption
public dynamicFacetableOption: (google.cloud.discoveryengine.v1alpha.FieldConfig.DynamicFacetableOption|keyof typeof google.cloud.discoveryengine.v1alpha.FieldConfig.DynamicFacetableOption);FieldConfig dynamicFacetableOption.
fieldPath
public fieldPath: string;FieldConfig fieldPath.
fieldType
public fieldType: (google.cloud.discoveryengine.v1alpha.FieldConfig.FieldType|keyof typeof google.cloud.discoveryengine.v1alpha.FieldConfig.FieldType);FieldConfig fieldType.
indexableOption
public indexableOption: (google.cloud.discoveryengine.v1alpha.FieldConfig.IndexableOption|keyof typeof google.cloud.discoveryengine.v1alpha.FieldConfig.IndexableOption);FieldConfig indexableOption.
keyPropertyType
public keyPropertyType: string;FieldConfig keyPropertyType.
recsFilterableOption
public recsFilterableOption: (google.cloud.discoveryengine.v1alpha.FieldConfig.FilterableOption|keyof typeof google.cloud.discoveryengine.v1alpha.FieldConfig.FilterableOption);FieldConfig recsFilterableOption.
retrievableOption
public retrievableOption: (google.cloud.discoveryengine.v1alpha.FieldConfig.RetrievableOption|keyof typeof google.cloud.discoveryengine.v1alpha.FieldConfig.RetrievableOption);FieldConfig retrievableOption.
searchableOption
public searchableOption: (google.cloud.discoveryengine.v1alpha.FieldConfig.SearchableOption|keyof typeof google.cloud.discoveryengine.v1alpha.FieldConfig.SearchableOption);FieldConfig searchableOption.
Methods
create(properties)
public static create(properties?: google.cloud.discoveryengine.v1alpha.IFieldConfig): google.cloud.discoveryengine.v1alpha.FieldConfig;Creates a new FieldConfig instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IFieldConfig
Properties to set |
| Returns | |
|---|---|
| Type | Description |
FieldConfig | FieldConfig instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.discoveryengine.v1alpha.FieldConfig;Decodes a FieldConfig message from the specified reader or buffer.
| Parameters | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
| Returns | |
|---|---|
| Type | Description |
FieldConfig | FieldConfig |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.discoveryengine.v1alpha.FieldConfig;Decodes a FieldConfig message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
FieldConfig | FieldConfig |
encode(message, writer)
public static encode(message: google.cloud.discoveryengine.v1alpha.IFieldConfig, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified FieldConfig message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IFieldConfig
FieldConfig message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer | Writer |
encodeDelimited(message, writer)
public static encodeDelimited(message: google.cloud.discoveryengine.v1alpha.IFieldConfig, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified FieldConfig message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IFieldConfig
FieldConfig message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer | Writer |
fromObject(object)
public static fromObject(object: { [k: string]: any }): google.cloud.discoveryengine.v1alpha.FieldConfig;Creates a FieldConfig message from a plain object. Also converts values to their respective internal types.
| Parameter | |
|---|---|
| Name | Description |
object |
{ [k: string]: any }
Plain object |
| Returns | |
|---|---|
| Type | Description |
FieldConfig | FieldConfig |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for FieldConfig
| Parameter | |
|---|---|
| Name | Description |
typeUrlPrefix |
string
your custom typeUrlPrefix(default "type.googleapis.com") |
| Returns | |
|---|---|
| Type | Description |
string | The default type url |
toJSON()
public toJSON(): { [k: string]: any };Converts this FieldConfig to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
public static toObject(message: google.cloud.discoveryengine.v1alpha.FieldConfig, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a FieldConfig message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
FieldConfig
FieldConfig |
options |
$protobuf.IConversionOptions
Conversion options |
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | Plain object |
verify(message)
public static verify(message: { [k: string]: any }): (string|null);Verifies a FieldConfig message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|