google.cloud.dialogflow.cx.v3.security_settings.proto Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of proto-google-cloud-dialogflow-cx-v3 Show documentation
Show all versions of proto-google-cloud-dialogflow-cx-v3 Show documentation
PROTO library for proto-google-cloud-dialogflow-cx-v3
// Copyright 2021 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
syntax = "proto3";
package google.cloud.dialogflow.cx.v3;
import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
import "google/longrunning/operations.proto";
import "google/protobuf/empty.proto";
import "google/protobuf/field_mask.proto";
option cc_enable_arenas = true;
option csharp_namespace = "Google.Cloud.Dialogflow.Cx.V3";
option go_package = "google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3;cx";
option java_multiple_files = true;
option java_outer_classname = "SecuritySettingsProto";
option java_package = "com.google.cloud.dialogflow.cx.v3";
option objc_class_prefix = "DF";
option ruby_package = "Google::Cloud::Dialogflow::CX::V3";
option (google.api.resource_definition) = {
type: "dlp.googleapis.com/InspectTemplate"
pattern: "organizations/{organization}/locations/{location}/inspectTemplates/{inspect_template}"
pattern: "projects/{project}/locations/{location}/inspectTemplates/{inspect_template}"
};
option (google.api.resource_definition) = {
type: "dlp.googleapis.com/DeidentifyTemplate"
pattern: "organizations/{organization}/locations/{location}/deidentifyTemplates/{deidentify_template}"
pattern: "projects/{project}/locations/{location}/deidentifyTemplates/{deidentify_template}"
};
// Service for managing security settings for Dialogflow.
service SecuritySettingsService {
option (google.api.default_host) = "dialogflow.googleapis.com";
option (google.api.oauth_scopes) =
"https://www.googleapis.com/auth/cloud-platform,"
"https://www.googleapis.com/auth/dialogflow";
// Create security settings in the specified location.
rpc CreateSecuritySettings(CreateSecuritySettingsRequest) returns (SecuritySettings) {
option (google.api.http) = {
post: "/v3/{parent=projects/*/locations/*}/securitySettings"
body: "security_settings"
};
option (google.api.method_signature) = "parent,security_settings";
}
// Retrieves the specified [SecuritySettings][google.cloud.dialogflow.cx.v3.SecuritySettings].
// The returned settings may be stale by up to 1 minute.
rpc GetSecuritySettings(GetSecuritySettingsRequest) returns (SecuritySettings) {
option (google.api.http) = {
get: "/v3/{name=projects/*/locations/*/securitySettings/*}"
};
option (google.api.method_signature) = "name";
}
// Updates the specified [SecuritySettings][google.cloud.dialogflow.cx.v3.SecuritySettings].
rpc UpdateSecuritySettings(UpdateSecuritySettingsRequest) returns (SecuritySettings) {
option (google.api.http) = {
patch: "/v3/{security_settings.name=projects/*/locations/*/securitySettings/*}"
body: "security_settings"
};
option (google.api.method_signature) = "security_settings,update_mask";
}
// Returns the list of all security settings in the specified location.
rpc ListSecuritySettings(ListSecuritySettingsRequest) returns (ListSecuritySettingsResponse) {
option (google.api.http) = {
get: "/v3/{parent=projects/*/locations/*}/securitySettings"
};
option (google.api.method_signature) = "parent";
}
// Deletes the specified [SecuritySettings][google.cloud.dialogflow.cx.v3.SecuritySettings].
rpc DeleteSecuritySettings(DeleteSecuritySettingsRequest) returns (google.protobuf.Empty) {
option (google.api.http) = {
delete: "/v3/{name=projects/*/locations/*/securitySettings/*}"
};
option (google.api.method_signature) = "name";
}
}
// The request message for [SecuritySettingsService.GetSecuritySettings][google.cloud.dialogflow.cx.v3.SecuritySettingsService.GetSecuritySettings].
message GetSecuritySettingsRequest {
// Required. Resource name of the settings.
// Format: `projects//locations//securitySettings/`.
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "dialogflow.googleapis.com/SecuritySettings"
}
];
}
// The request message for [SecuritySettingsService.UpdateSecuritySettings][google.cloud.dialogflow.cx.v3.SecuritySettingsService.UpdateSecuritySettings].
message UpdateSecuritySettingsRequest {
// Required. [SecuritySettings] object that contains values for each of the
// fields to update.
SecuritySettings security_settings = 1 [(google.api.field_behavior) = REQUIRED];
// Required. The mask to control which fields get updated. If the mask is not present,
// all fields will be updated.
google.protobuf.FieldMask update_mask = 2 [(google.api.field_behavior) = REQUIRED];
}
// The request message for [SecuritySettings.ListSecuritySettings][].
message ListSecuritySettingsRequest {
// Required. The location to list all security settings for.
// Format: `projects//locations/`.
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
child_type: "dialogflow.googleapis.com/SecuritySettings"
}
];
// The maximum number of items to return in a single page. By default 20 and
// at most 100.
int32 page_size = 2;
// The next_page_token value returned from a previous list request.
string page_token = 3;
}
// The response message for [SecuritySettings.ListSecuritySettings][].
message ListSecuritySettingsResponse {
// The list of security settings.
repeated SecuritySettings security_settings = 1;
// Token to retrieve the next page of results, or empty if there are no more
// results in the list.
string next_page_token = 2;
}
// The request message for [SecuritySettings.CreateSecuritySettings][].
message CreateSecuritySettingsRequest {
// Required. The location to create an [SecuritySettings][google.cloud.dialogflow.cx.v3.SecuritySettings] for.
// Format: `projects//locations/`.
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
child_type: "dialogflow.googleapis.com/SecuritySettings"
}
];
// Required. The security settings to create.
SecuritySettings security_settings = 2 [(google.api.field_behavior) = REQUIRED];
}
// The request message for [SecuritySettings.DeleteSecuritySettings][].
message DeleteSecuritySettingsRequest {
// Required. The name of the [SecuritySettings][google.cloud.dialogflow.cx.v3.SecuritySettings] to delete.
// Format: `projects//locations//securitySettings/`.
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "dialogflow.googleapis.com/SecuritySettings"
}
];
}
// Represents the settings related to security issues, such as data redaction
// and data retention. It may take hours for updates on the settings to
// propagate to all the related components and take effect.
message SecuritySettings {
option (google.api.resource) = {
type: "dialogflow.googleapis.com/SecuritySettings"
pattern: "projects/{project}/locations/{location}/securitySettings/{security_settings}"
};
// Settings for exporting conversations to
// [Insights](https://cloud.google.com/dialogflow/priv/docs/insights).
message InsightsExportSettings {
// If enabled, we will automatically exports
// conversations to Insights and Insights runs its analyzers.
bool enable_insights_export = 1;
}
// Defines how we redact data.
enum RedactionStrategy {
// Do not redact.
REDACTION_STRATEGY_UNSPECIFIED = 0;
// Call redaction service to clean up the data to be persisted.
REDACT_WITH_SERVICE = 1;
}
// Defines what types of data to redact.
enum RedactionScope {
// Don't redact any kind of data.
REDACTION_SCOPE_UNSPECIFIED = 0;
// On data to be written to disk or similar devices that are capable of
// holding data even if power is disconnected. This includes data that are
// temporarily saved on disk.
REDACT_DISK_STORAGE = 2;
}
// Type of data we purge after retention settings triggers purge.
enum PurgeDataType {
// Unspecified. Do not use.
PURGE_DATA_TYPE_UNSPECIFIED = 0;
// Dialogflow history. This does not include Cloud logging, which is
// owned by the user - not Dialogflow.
DIALOGFLOW_HISTORY = 1;
}
// Required. Resource name of the settings.
// Format: `projects//locations//securitySettings/`.
string name = 1 [(google.api.field_behavior) = REQUIRED];
// Required. The human-readable name of the security settings, unique within the
// location.
string display_name = 2 [(google.api.field_behavior) = REQUIRED];
// Strategy that defines how we do redaction.
RedactionStrategy redaction_strategy = 3;
// Defines the data for which Dialogflow applies redaction. Dialogflow does
// not redact data that it does not have access to – for example, Cloud
// logging.
RedactionScope redaction_scope = 4;
// [DLP](https://cloud.google.com/dlp/docs) inspect template name. Use this
// template to define inspect base settings.
//
// If empty, we use the default DLP inspect config.
//
// The template name will have one of the following formats:
// `projects//locations//inspectTemplates/` OR `organizations//locations//inspectTemplates/`
//
// Note: `inspect_template` must be located in the same region as the
// `SecuritySettings`.
string inspect_template = 9 [(google.api.resource_reference) = {
type: "dlp.googleapis.com/InspectTemplate"
}];
// [DLP](https://cloud.google.com/dlp/docs) deidentify template name. Use this
// template to define de-identification configuration for the content.
//
// If empty, Dialogflow replaces sensitive info with `[redacted]` text.
//
// The template name will have one of the following formats:
// `projects//locations//deidentifyTemplates/` OR `organizations//locations//deidentifyTemplates/`
//
// Note: `deidentify_template` must be located in the same region as the
// `SecuritySettings`.
string deidentify_template = 17 [(google.api.resource_reference) = {
type: "dlp.googleapis.com/DeidentifyTemplate"
}];
// Specifies how data is retained. Note that even if the data is
// purged due to retention policy, we may still hold it in backup storage for
// a few days without allowing direct readings.
oneof data_retention {
// Retains data in interaction logging for the specified number of days.
// This does not apply to Cloud logging, which is owned by the user - not
// Dialogflow.
// User must Set a value lower than Dialogflow's default 30d TTL. Setting a
// value higher than that has no effect.
// A missing value or setting to 0 also means we use Dialogflow's default
// TTL.
// Note: Interaction logging is a limited access feature. Talk to your
// Google representative to check availability for you.
int32 retention_window_days = 6;
}
// List of types of data to remove when retention settings triggers purge.
repeated PurgeDataType purge_data_types = 8;
// Controls conversation exporting settings to Insights after conversation is
// completed.
//
// If [retention_strategy][google.cloud.dialogflow.cx.v3.SecuritySettings.retention_strategy] is set to REMOVE_AFTER_CONVERSATION,
// Insights export is disabled no matter what you configure here.
InsightsExportSettings insights_export_settings = 13;
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy