Class protos.google.cloud.discoveryengine.v1beta.Answer.Step (1.7.0)

Represents a Step.

Package

@google-cloud/discoveryengine

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.discoveryengine.v1beta.Answer.IStep);

Constructs a new Step.

Parameter
Name Description
properties IStep

Properties to set

Properties

actions

public actions: google.cloud.discoveryengine.v1beta.Answer.Step.IAction[];

Step actions.

description

public description: string;

Step description.

state

public state: (google.cloud.discoveryengine.v1beta.Answer.Step.State|keyof typeof google.cloud.discoveryengine.v1beta.Answer.Step.State);

Step state.

thought

public thought: string;

Step thought.

Methods

create(properties)

public static create(properties?: google.cloud.discoveryengine.v1beta.Answer.IStep): google.cloud.discoveryengine.v1beta.Answer.Step;

Creates a new Step instance using the specified properties.

Parameter
Name Description
properties IStep

Properties to set

Returns
Type Description
Step

Step instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.discoveryengine.v1beta.Answer.Step;

Decodes a Step 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
Step

Step

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.discoveryengine.v1beta.Answer.Step;

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
Step

Step

encode(message, writer)

public static encode(message: google.cloud.discoveryengine.v1beta.Answer.IStep, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified Step message. Does not implicitly messages.

Parameters
Name Description
message IStep

Step 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.Answer.IStep, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message IStep

Step 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.Answer.Step;

Creates a Step 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
Step

Step

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for Step

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 Step to JSON.

Returns
Type Description
{ [k: string]: any }

JSON object

toObject(message, options)

public static toObject(message: google.cloud.discoveryengine.v1beta.Answer.Step, options?: $protobuf.IConversionOptions): { [k: string]: any };

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

Parameters
Name Description
message Step

Step

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 Step message.

Parameter
Name Description
message { [k: string]: any }

Plain object to verify

Returns
Type Description
(string|null)

null if valid, otherwise the reason why it is not