Class protos.google.cloud.contactcenterinsights.v1.PhraseMatcher (1.6.0)

Represents a PhraseMatcher.

Package

@google-cloud/contact-center-insights!

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.contactcenterinsights.v1.IPhraseMatcher);

Constructs a new PhraseMatcher.

Parameter
Name Description
properties IPhraseMatcher

Properties to set

Properties

activationUpdateTime

public activationUpdateTime?: (google.protobuf.ITimestamp|null);

PhraseMatcher activationUpdateTime.

Property Value
Type Description
(google.protobuf.ITimestamp|null)

active

public active: boolean;

PhraseMatcher active.

Property Value
Type Description
boolean

displayName

public displayName: string;

PhraseMatcher displayName.

Property Value
Type Description
string

name

public name: string;

PhraseMatcher name.

Property Value
Type Description
string

phraseMatchRuleGroups

public phraseMatchRuleGroups: google.cloud.contactcenterinsights.v1.IPhraseMatchRuleGroup[];

PhraseMatcher phraseMatchRuleGroups.

Property Value
Type Description
google.cloud.contactcenterinsights.v1.IPhraseMatchRuleGroup[]

revisionCreateTime

public revisionCreateTime?: (google.protobuf.ITimestamp|null);

PhraseMatcher revisionCreateTime.

Property Value
Type Description
(google.protobuf.ITimestamp|null)

revisionId

public revisionId: string;

PhraseMatcher revisionId.

Property Value
Type Description
string

roleMatch

public roleMatch: (google.cloud.contactcenterinsights.v1.ConversationParticipant.Role|keyof typeof google.cloud.contactcenterinsights.v1.ConversationParticipant.Role);

PhraseMatcher roleMatch.

Property Value
Type Description
(google.cloud.contactcenterinsights.v1.ConversationParticipant.Role|keyof typeof google.cloud.contactcenterinsights.v1.ConversationParticipant.Role)

type

public type: (google.cloud.contactcenterinsights.v1.PhraseMatcher.PhraseMatcherType|keyof typeof google.cloud.contactcenterinsights.v1.PhraseMatcher.PhraseMatcherType);

PhraseMatcher type.

Property Value
Type Description
(google.cloud.contactcenterinsights.v1.PhraseMatcher.PhraseMatcherType|keyof typeof google.cloud.contactcenterinsights.v1.PhraseMatcher.PhraseMatcherType)

updateTime

public updateTime?: (google.protobuf.ITimestamp|null);

PhraseMatcher updateTime.

Property Value
Type Description
(google.protobuf.ITimestamp|null)

versionTag

public versionTag: string;

PhraseMatcher versionTag.

Property Value
Type Description
string

Methods

create(properties)

public static create(properties?: google.cloud.contactcenterinsights.v1.IPhraseMatcher): google.cloud.contactcenterinsights.v1.PhraseMatcher;

Creates a new PhraseMatcher instance using the specified properties.

Parameter
Name Description
properties IPhraseMatcher

Properties to set
Returns
Type Description
google.cloud.contactcenterinsights.v1.PhraseMatcher

PhraseMatcher instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.contactcenterinsights.v1.PhraseMatcher;

Decodes a PhraseMatcher message from the specified reader or buffer.

Parameters
Name Description
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from
length number

Message length if known beforehand
Returns
Type Description
google.cloud.contactcenterinsights.v1.PhraseMatcher

PhraseMatcher

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.contactcenterinsights.v1.PhraseMatcher;

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

Parameter
Name Description
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from
Returns
Type Description
google.cloud.contactcenterinsights.v1.PhraseMatcher

PhraseMatcher

encode(message, writer)

public static encode(message: google.cloud.contactcenterinsights.v1.IPhraseMatcher, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified PhraseMatcher message. Does not implicitly messages.

Parameters
Name Description
message IPhraseMatcher

PhraseMatcher 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.contactcenterinsights.v1.IPhraseMatcher, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message IPhraseMatcher

PhraseMatcher 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.contactcenterinsights.v1.PhraseMatcher;

Creates a PhraseMatcher 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
google.cloud.contactcenterinsights.v1.PhraseMatcher

PhraseMatcher

toJSON()

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

Converts this PhraseMatcher to JSON.

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

JSON object

toObject(message, options)

public static toObject(message: google.cloud.contactcenterinsights.v1.PhraseMatcher, options?: $protobuf.IConversionOptions): { [k: string]: any };

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

Parameters
Name Description
message google.cloud.contactcenterinsights.v1.PhraseMatcher

PhraseMatcher
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 PhraseMatcher 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