Class protos.google.cloud.contactcenterinsights.v1.Settings (3.6.0)

Represents a Settings.

Package

@google-cloud/contact-center-insights

Constructors

(constructor)(properties)

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

Constructs a new Settings.

Parameter
Name Description
properties ISettings

Properties to set

Properties

analysisConfig

public analysisConfig?: (google.cloud.contactcenterinsights.v1.Settings.IAnalysisConfig|null);

Settings analysisConfig.

conversationTtl

public conversationTtl?: (google.protobuf.IDuration|null);

Settings conversationTtl.

createTime

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

Settings createTime.

languageCode

public languageCode: string;

Settings languageCode.

name

public name: string;

Settings name.

pubsubNotificationSettings

public pubsubNotificationSettings: { [k: string]: string };

Settings pubsubNotificationSettings.

redactionConfig

public redactionConfig?: (google.cloud.contactcenterinsights.v1.IRedactionConfig|null);

Settings redactionConfig.

speechConfig

public speechConfig?: (google.cloud.contactcenterinsights.v1.ISpeechConfig|null);

Settings speechConfig.

updateTime

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

Settings updateTime.

Methods

create(properties)

public static create(properties?: google.cloud.contactcenterinsights.v1.ISettings): google.cloud.contactcenterinsights.v1.Settings;

Creates a new Settings instance using the specified properties.

Parameter
Name Description
properties ISettings

Properties to set

Returns
Type Description
Settings

Settings instance

decode(reader, length)

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

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

Settings

decodeDelimited(reader)

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

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
Settings

Settings

encode(message, writer)

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

Encodes the specified Settings message. Does not implicitly messages.

Parameters
Name Description
message ISettings

Settings 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.ISettings, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message ISettings

Settings 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.Settings;

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

Settings

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for Settings

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

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message Settings

Settings

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