Class protos.google.cloud.dialogflow.cx.v3beta1.SecuritySettings

Represents a SecuritySettings.

Package

@google-cloud/dialogflow-cx

Constructors

(constructor)(properties)

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

Constructs a new SecuritySettings.

Parameter
NameDescription
properties ISecuritySettings

Properties to set

Properties

dataRetention

public dataRetention?: "retentionWindowDays";

SecuritySettings dataRetention.

deidentifyTemplate

public deidentifyTemplate: string;

SecuritySettings deidentifyTemplate.

displayName

public displayName: string;

SecuritySettings displayName.

insightsExportSettings

public insightsExportSettings?: (google.cloud.dialogflow.cx.v3beta1.SecuritySettings.IInsightsExportSettings|null);

SecuritySettings insightsExportSettings.

inspectTemplate

public inspectTemplate: string;

SecuritySettings inspectTemplate.

name

public name: string;

SecuritySettings name.

purgeDataTypes

public purgeDataTypes: google.cloud.dialogflow.cx.v3beta1.SecuritySettings.PurgeDataType[];

SecuritySettings purgeDataTypes.

redactionScope

public redactionScope: (google.cloud.dialogflow.cx.v3beta1.SecuritySettings.RedactionScope|keyof typeof google.cloud.dialogflow.cx.v3beta1.SecuritySettings.RedactionScope);

SecuritySettings redactionScope.

redactionStrategy

public redactionStrategy: (google.cloud.dialogflow.cx.v3beta1.SecuritySettings.RedactionStrategy|keyof typeof google.cloud.dialogflow.cx.v3beta1.SecuritySettings.RedactionStrategy);

SecuritySettings redactionStrategy.

retentionWindowDays

public retentionWindowDays?: (number|null);

SecuritySettings retentionWindowDays.

Methods

create(properties)

public static create(properties?: google.cloud.dialogflow.cx.v3beta1.ISecuritySettings): google.cloud.dialogflow.cx.v3beta1.SecuritySettings;

Creates a new SecuritySettings instance using the specified properties.

Parameter
NameDescription
properties ISecuritySettings

Properties to set

Returns
TypeDescription
google.cloud.dialogflow.cx.v3beta1.SecuritySettings

SecuritySettings instance

decode(reader, length)

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

Decodes a SecuritySettings message from the specified reader or buffer.

Parameters
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
google.cloud.dialogflow.cx.v3beta1.SecuritySettings

SecuritySettings

decodeDelimited(reader)

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

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

Parameter
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
google.cloud.dialogflow.cx.v3beta1.SecuritySettings

SecuritySettings

encode(message, writer)

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

Encodes the specified SecuritySettings message. Does not implicitly messages.

Parameters
NameDescription
message ISecuritySettings

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

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

Parameters
NameDescription
message ISecuritySettings

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

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

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

Plain object

Returns
TypeDescription
google.cloud.dialogflow.cx.v3beta1.SecuritySettings

SecuritySettings

toJSON()

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

Converts this SecuritySettings to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message google.cloud.dialogflow.cx.v3beta1.SecuritySettings

SecuritySettings

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