Represents a ServingConfig.
Package
@google-cloud/discoveryengineConstructors
(constructor)(properties)
constructor(properties?: google.cloud.discoveryengine.v1beta.IServingConfig);Constructs a new ServingConfig.
| Parameter | |
|---|---|
| Name | Description |
properties |
IServingConfig
Properties to set |
Properties
boostControlIds
public boostControlIds: string[];ServingConfig boostControlIds.
createTime
public createTime?: (google.protobuf.ITimestamp|null);ServingConfig createTime.
displayName
public displayName: string;ServingConfig displayName.
dissociateControlIds
public dissociateControlIds: string[];ServingConfig dissociateControlIds.
diversityLevel
public diversityLevel: string;ServingConfig diversityLevel.
embeddingConfig
public embeddingConfig?: (google.cloud.discoveryengine.v1beta.IEmbeddingConfig|null);ServingConfig embeddingConfig.
filterControlIds
public filterControlIds: string[];ServingConfig filterControlIds.
genericConfig
public genericConfig?: (google.cloud.discoveryengine.v1beta.ServingConfig.IGenericConfig|null);ServingConfig genericConfig.
ignoreControlIds
public ignoreControlIds: string[];ServingConfig ignoreControlIds.
mediaConfig
public mediaConfig?: (google.cloud.discoveryengine.v1beta.ServingConfig.IMediaConfig|null);ServingConfig mediaConfig.
modelId
public modelId: string;ServingConfig modelId.
name
public name: string;ServingConfig name.
onewaySynonymsControlIds
public onewaySynonymsControlIds: string[];ServingConfig onewaySynonymsControlIds.
rankingExpression
public rankingExpression: string;ServingConfig rankingExpression.
redirectControlIds
public redirectControlIds: string[];ServingConfig redirectControlIds.
replacementControlIds
public replacementControlIds: string[];ServingConfig replacementControlIds.
solutionType
public solutionType: (google.cloud.discoveryengine.v1beta.SolutionType|keyof typeof google.cloud.discoveryengine.v1beta.SolutionType);ServingConfig solutionType.
synonymsControlIds
public synonymsControlIds: string[];ServingConfig synonymsControlIds.
updateTime
public updateTime?: (google.protobuf.ITimestamp|null);ServingConfig updateTime.
verticalConfig
public verticalConfig?: ("mediaConfig"|"genericConfig");ServingConfig verticalConfig.
Methods
create(properties)
public static create(properties?: google.cloud.discoveryengine.v1beta.IServingConfig): google.cloud.discoveryengine.v1beta.ServingConfig;Creates a new ServingConfig instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IServingConfig
Properties to set |
| Returns | |
|---|---|
| Type | Description |
ServingConfig |
ServingConfig instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.discoveryengine.v1beta.ServingConfig;Decodes a ServingConfig 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 |
ServingConfig |
ServingConfig |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.discoveryengine.v1beta.ServingConfig;Decodes a ServingConfig message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
ServingConfig |
ServingConfig |
encode(message, writer)
public static encode(message: google.cloud.discoveryengine.v1beta.IServingConfig, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified ServingConfig message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IServingConfig
ServingConfig 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.v1beta.IServingConfig, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified ServingConfig message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IServingConfig
ServingConfig 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.v1beta.ServingConfig;Creates a ServingConfig 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 |
ServingConfig |
ServingConfig |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for ServingConfig
| 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 ServingConfig to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
JSON object |
toObject(message, options)
public static toObject(message: google.cloud.discoveryengine.v1beta.ServingConfig, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a ServingConfig message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
ServingConfig
ServingConfig |
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 ServingConfig message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|