Class protos.google.cloud.dialogflow.cx.v3beta1.Generator (4.6.0)

Represents a Generator.

Package

@google-cloud/dialogflow-cx

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.dialogflow.cx.v3beta1.IGenerator);

Constructs a new Generator.

Parameter
NameDescription
properties IGenerator

Properties to set

Properties

displayName

public displayName: string;

Generator displayName.

llmModelSettings

public llmModelSettings?: (google.cloud.dialogflow.cx.v3beta1.ILlmModelSettings|null);

Generator llmModelSettings.

name

public name: string;

Generator name.

placeholders

public placeholders: google.cloud.dialogflow.cx.v3beta1.Generator.IPlaceholder[];

Generator placeholders.

promptText

public promptText?: (google.cloud.dialogflow.cx.v3beta1.IPhrase|null);

Generator promptText.

Methods

create(properties)

public static create(properties?: google.cloud.dialogflow.cx.v3beta1.IGenerator): google.cloud.dialogflow.cx.v3beta1.Generator;

Creates a new Generator instance using the specified properties.

Parameter
NameDescription
properties IGenerator

Properties to set

Returns
TypeDescription
Generator

Generator instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.dialogflow.cx.v3beta1.Generator;

Decodes a Generator message from the specified reader or buffer.

Parameters
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
Generator

Generator

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.dialogflow.cx.v3beta1.Generator;

Decodes a Generator message from the specified reader or buffer, length delimited.

Parameter
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
Generator

Generator

encode(message, writer)

public static encode(message: google.cloud.dialogflow.cx.v3beta1.IGenerator, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified Generator message. Does not implicitly messages.

Parameters
NameDescription
message IGenerator

Generator message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.cloud.dialogflow.cx.v3beta1.IGenerator, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified Generator message, length delimited. Does not implicitly messages.

Parameters
NameDescription
message IGenerator

Generator message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.cloud.dialogflow.cx.v3beta1.Generator;

Creates a Generator message from a plain object. Also converts values to their respective internal types.

Parameter
NameDescription
object { [k: string]: any }

Plain object

Returns
TypeDescription
Generator

Generator

getTypeUrl(typeUrlPrefix)

public static getTypeUrl(typeUrlPrefix?: string): string;

Gets the default type url for Generator

Parameter
NameDescription
typeUrlPrefix string

your custom typeUrlPrefix(default "type.googleapis.com")

Returns
TypeDescription
string

The default type url

toJSON()

public toJSON(): { [k: string]: any };

Converts this Generator to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

public static toObject(message: google.cloud.dialogflow.cx.v3beta1.Generator, options?: $protobuf.IConversionOptions): { [k: string]: any };

Creates a plain object from a Generator message. Also converts values to other types if specified.

Parameters
NameDescription
message Generator

Generator

options $protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies a Generator message.

Parameter
NameDescription
message { [k: string]: any }

Plain object to verify

Returns
TypeDescription
(string|null)

null if valid, otherwise the reason why it is not