google/cloud/securitycenter/v1beta1/source.proto

// Copyright 2018 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.v1beta1;

import "google/api/annotations.proto";

option go_package = "google.golang.org/genproto/googleapis/cloud/securitycenter/v1beta1;securitycenter";
option java_package = "com.google.cloud.securitycenter.v1beta1";

// Security Center's finding source. A finding source is an entity or a
// mechanism that can produce a finding. A source can also be thought of as a
// container of findings that come from the same scanner, logger, monitor, etc.
message Source {
  // The relative resource name of this source. See:
  // https://cloud.google.com/apis/design/resource_names#relative_resource_name
  // Example:
  // "organizations/123/sources/456"
  string name = 1;

  // The source’s display name.
  // A source’s display name must be unique amongst its siblings, e.g.
  // no two sources with the same parent can share the same display name.
  // The display name must start and end with a letter or digit, may contain
  // letters, digits, spaces, hyphens and underscores and can be no longer
  // than 30 characters. This is captured by the regular expression:
  // [\p{L}\p{N}]({\p{L}\p{N}_- ]{0,28}[\p{L}\p{N}])?.
  string display_name = 2;

  // The description of the source (max of 1024 characters).
  // Example:
  // "Cloud Security Scanner is a web security scanner for common
  // vulnerabilities in Google App Engine applications. It can automatically
  // scan and detect four common vulnerabilities, including cross-site-scripting
  // (XSS), Flash injection, mixed content (HTTP in HTTPS), and
  // outdated/insecure libraries."
  string description = 3;
}