// Copyright 2024 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.securitycenter.v2;

import "google/api/resource.proto";

option csharp_namespace = "Google.Cloud.SecurityCenter.V2";
option go_package = "cloud.google.com/go/securitycenter/apiv2/securitycenterpb;securitycenterpb";
option java_multiple_files = true;
option java_outer_classname = "SecurityMarksProto";
option java_package = "com.google.cloud.securitycenter.v2";
option php_namespace = "Google\\Cloud\\SecurityCenter\\V2";
option ruby_package = "Google::Cloud::SecurityCenter::V2";

// User specified security marks that are attached to the parent Security
// Command Center resource. Security marks are scoped within a Security Command
// Center organization -- they can be modified and viewed by all users who have
// proper permissions on the organization.
message SecurityMarks {
  option (google.api.resource) = {
    type: "securitycenter.googleapis.com/SecurityMarks"
    pattern: "organizations/{organization}/assets/{asset}/securityMarks"
    pattern: "organizations/{organization}/sources/{source}/findings/{finding}/securityMarks"
    pattern: "organizations/{organization}/sources/{source}/locations/{location}/findings/{finding}/securityMarks"
    pattern: "folders/{folder}/assets/{asset}/securityMarks"
    pattern: "folders/{folder}/sources/{source}/findings/{finding}/securityMarks"
    pattern: "folders/{folder}/sources/{source}/locations/{location}/findings/{finding}/securityMarks"
    pattern: "projects/{project}/assets/{asset}/securityMarks"
    pattern: "projects/{project}/sources/{source}/findings/{finding}/securityMarks"
    pattern: "projects/{project}/sources/{source}/locations/{location}/findings/{finding}/securityMarks"
  };

  // The relative resource name of the SecurityMarks. See:
  // https://cloud.google.com/apis/design/resource_names#relative_resource_name
  // The following list shows some examples:
  //
  // + `organizations/{organization_id}/assets/{asset_id}/securityMarks`
  // +
  // `organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks`
  // +
  // `organizations/{organization_id}/sources/{source_id}/locations/{location}/findings/{finding_id}/securityMarks`
  string name = 1;

  // Mutable user specified security marks belonging to the parent resource.
  // Constraints are as follows:
  //
  //   * Keys and values are treated as case insensitive
  //   * Keys must be between 1 - 256 characters (inclusive)
  //   * Keys must be letters, numbers, underscores, or dashes
  //   * Values have leading and trailing whitespace trimmed, remaining
  //     characters must be between 1 - 4096 characters (inclusive)
  map<string, string> marks = 2;

  // The canonical name of the marks. The following list shows some examples:
  //
  // + `organizations/{organization_id}/assets/{asset_id}/securityMarks`
  // +
  // `organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks`
  // +
  // `organizations/{organization_id}/sources/{source_id}/locations/{location}/findings/{finding_id}/securityMarks`
  // + `folders/{folder_id}/assets/{asset_id}/securityMarks`
  // +
  // `folders/{folder_id}/sources/{source_id}/findings/{finding_id}/securityMarks`
  // +
  // `folders/{folder_id}/sources/{source_id}/locations/{location}/findings/{finding_id}/securityMarks`
  // + `projects/{project_number}/assets/{asset_id}/securityMarks`
  // +
  // `projects/{project_number}/sources/{source_id}/findings/{finding_id}/securityMarks`
  // +
  // `projects/{project_number}/sources/{source_id}/locations/{location}/findings/{finding_id}/securityMarks`
  string canonical_name = 3;
}
