Represents a SecuritySettings.
Package
@google-cloud/dialogflow-cxConstructors
(constructor)(properties)
constructor(properties?: google.cloud.dialogflow.cx.v3beta1.ISecuritySettings);Constructs a new SecuritySettings.
| Parameter | |
|---|---|
| Name | Description |
properties |
ISecuritySettings
Properties to set |
Properties
audioExportSettings
public audioExportSettings?: (google.cloud.dialogflow.cx.v3beta1.SecuritySettings.IAudioExportSettings|null);SecuritySettings audioExportSettings.
dataRetention
public dataRetention?: ("retentionWindowDays"|"retentionStrategy");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.
retentionStrategy
public retentionStrategy?: (google.cloud.dialogflow.cx.v3beta1.SecuritySettings.RetentionStrategy|keyof typeof google.cloud.dialogflow.cx.v3beta1.SecuritySettings.RetentionStrategy|null);SecuritySettings retentionStrategy.
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 | |
|---|---|
| Name | Description |
properties |
ISecuritySettings
Properties to set |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
message |
ISecuritySettings
SecuritySettings 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.dialogflow.cx.v3beta1.ISecuritySettings, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified SecuritySettings message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
ISecuritySettings
SecuritySettings 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.dialogflow.cx.v3beta1.SecuritySettings;Creates a SecuritySettings 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 |
SecuritySettings | SecuritySettings |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for SecuritySettings
| 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 SecuritySettings to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [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 | |
|---|---|
| Name | Description |
message |
SecuritySettings
SecuritySettings |
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 SecuritySettings message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|