com.google.cloud.securitycenter.v2.SecurityMarksOrBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of proto-google-cloud-securitycenter-v2 Show documentation
Proto library for google-cloud-securitycenter
There is a newer version: 2.62.0
Show newest version
/*
 * 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
 *
 *     https://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.
 */
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: google/cloud/securitycenter/v2/security_marks.proto

// Protobuf Java Version: 3.25.3
package com.google.cloud.securitycenter.v2;

public interface SecurityMarksOrBuilder
    extends
    // @@protoc_insertion_point(interface_extends:google.cloud.securitycenter.v2.SecurityMarks)
    com.google.protobuf.MessageOrBuilder {

  /**
   *
   *
   *    * 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;
   *
   * @return The name.
   */
  java.lang.String getName();
  /**
   *
   *
   *    * 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;
   *
   * @return The bytes for name.
   */
  com.google.protobuf.ByteString getNameBytes();

  /**
   *
   *
   *    * 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;
   */
  int getMarksCount();
  /**
   *
   *
   *    * 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;
   */
  boolean containsMarks(java.lang.String key);
  /** Use {@link #getMarksMap()} instead. */
  @java.lang.Deprecated
  java.util.Map getMarks();
  /**
   *
   *
   *    * 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;
   */
  java.util.Map getMarksMap();
  /**
   *
   *
   *    * 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;
   */
  /* nullable */
  java.lang.String getMarksOrDefault(
      java.lang.String key,
      /* nullable */
      java.lang.String defaultValue);
  /**
   *
   *
   *    * 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;
   */
  java.lang.String getMarksOrThrow(java.lang.String key);

  /**
   *
   *
   *    * 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;
   *
   * @return The canonicalName.
   */
  java.lang.String getCanonicalName();
  /**
   *
   *
   *    * 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;
   *
   * @return The bytes for canonicalName.
   */
  com.google.protobuf.ByteString getCanonicalNameBytes();
}