com.google.cloud.securitycenter.v1.MuteConfigOrBuilder 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-v1 Show documentation
Show all versions of proto-google-cloud-securitycenter-v1 Show documentation
PROTO library for proto-google-cloud-securitycenter-v1
/*
* 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/v1/mute_config.proto
// Protobuf Java Version: 3.25.5
package com.google.cloud.securitycenter.v1;
public interface MuteConfigOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.cloud.securitycenter.v1.MuteConfig)
com.google.protobuf.MessageOrBuilder {
/**
*
*
*
* This field will be ignored if provided on config creation. Format
* `organizations/{organization}/muteConfigs/{mute_config}`
* `folders/{folder}/muteConfigs/{mute_config}`
* `projects/{project}/muteConfigs/{mute_config}`
* `organizations/{organization}/locations/global/muteConfigs/{mute_config}`
* `folders/{folder}/locations/global/muteConfigs/{mute_config}`
* `projects/{project}/locations/global/muteConfigs/{mute_config}`
*
*
* string name = 1;
*
* @return The name.
*/
java.lang.String getName();
/**
*
*
*
* This field will be ignored if provided on config creation. Format
* `organizations/{organization}/muteConfigs/{mute_config}`
* `folders/{folder}/muteConfigs/{mute_config}`
* `projects/{project}/muteConfigs/{mute_config}`
* `organizations/{organization}/locations/global/muteConfigs/{mute_config}`
* `folders/{folder}/locations/global/muteConfigs/{mute_config}`
* `projects/{project}/locations/global/muteConfigs/{mute_config}`
*
*
* string name = 1;
*
* @return The bytes for name.
*/
com.google.protobuf.ByteString getNameBytes();
/**
*
*
*
* The human readable name to be displayed for the mute config.
*
*
* string display_name = 2 [deprecated = true];
*
* @deprecated google.cloud.securitycenter.v1.MuteConfig.display_name is deprecated. See
* google/cloud/securitycenter/v1/mute_config.proto;l=74
* @return The displayName.
*/
@java.lang.Deprecated
java.lang.String getDisplayName();
/**
*
*
*
* The human readable name to be displayed for the mute config.
*
*
* string display_name = 2 [deprecated = true];
*
* @deprecated google.cloud.securitycenter.v1.MuteConfig.display_name is deprecated. See
* google/cloud/securitycenter/v1/mute_config.proto;l=74
* @return The bytes for displayName.
*/
@java.lang.Deprecated
com.google.protobuf.ByteString getDisplayNameBytes();
/**
*
*
*
* A description of the mute config.
*
*
* string description = 3;
*
* @return The description.
*/
java.lang.String getDescription();
/**
*
*
*
* A description of the mute config.
*
*
* string description = 3;
*
* @return The bytes for description.
*/
com.google.protobuf.ByteString getDescriptionBytes();
/**
*
*
*
* Required. An expression that defines the filter to apply across
* create/update events of findings. While creating a filter string, be
* mindful of the scope in which the mute configuration is being created.
* E.g., If a filter contains project = X but is created under the project = Y
* scope, it might not match any findings.
*
* The following field and operator combinations are supported:
*
* * severity: `=`, `:`
* * category: `=`, `:`
* * resource.name: `=`, `:`
* * resource.project_name: `=`, `:`
* * resource.project_display_name: `=`, `:`
* * resource.folders.resource_folder: `=`, `:`
* * resource.parent_name: `=`, `:`
* * resource.parent_display_name: `=`, `:`
* * resource.type: `=`, `:`
* * finding_class: `=`, `:`
* * indicator.ip_addresses: `=`, `:`
* * indicator.domains: `=`, `:`
*
*
* string filter = 4 [(.google.api.field_behavior) = REQUIRED];
*
* @return The filter.
*/
java.lang.String getFilter();
/**
*
*
*
* Required. An expression that defines the filter to apply across
* create/update events of findings. While creating a filter string, be
* mindful of the scope in which the mute configuration is being created.
* E.g., If a filter contains project = X but is created under the project = Y
* scope, it might not match any findings.
*
* The following field and operator combinations are supported:
*
* * severity: `=`, `:`
* * category: `=`, `:`
* * resource.name: `=`, `:`
* * resource.project_name: `=`, `:`
* * resource.project_display_name: `=`, `:`
* * resource.folders.resource_folder: `=`, `:`
* * resource.parent_name: `=`, `:`
* * resource.parent_display_name: `=`, `:`
* * resource.type: `=`, `:`
* * finding_class: `=`, `:`
* * indicator.ip_addresses: `=`, `:`
* * indicator.domains: `=`, `:`
*
*
* string filter = 4 [(.google.api.field_behavior) = REQUIRED];
*
* @return The bytes for filter.
*/
com.google.protobuf.ByteString getFilterBytes();
/**
*
*
*
* Output only. The time at which the mute config was created.
* This field is set by the server and will be ignored if provided on config
* creation.
*
*
* .google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return Whether the createTime field is set.
*/
boolean hasCreateTime();
/**
*
*
*
* Output only. The time at which the mute config was created.
* This field is set by the server and will be ignored if provided on config
* creation.
*
*
* .google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The createTime.
*/
com.google.protobuf.Timestamp getCreateTime();
/**
*
*
*
* Output only. The time at which the mute config was created.
* This field is set by the server and will be ignored if provided on config
* creation.
*
*
* .google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*/
com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder();
/**
*
*
*
* Output only. The most recent time at which the mute config was updated.
* This field is set by the server and will be ignored if provided on config
* creation or update.
*
*
* .google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return Whether the updateTime field is set.
*/
boolean hasUpdateTime();
/**
*
*
*
* Output only. The most recent time at which the mute config was updated.
* This field is set by the server and will be ignored if provided on config
* creation or update.
*
*
* .google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The updateTime.
*/
com.google.protobuf.Timestamp getUpdateTime();
/**
*
*
*
* Output only. The most recent time at which the mute config was updated.
* This field is set by the server and will be ignored if provided on config
* creation or update.
*
*
* .google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*/
com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder();
/**
*
*
*
* Output only. Email address of the user who last edited the mute config.
* This field is set by the server and will be ignored if provided on config
* creation or update.
*
*
* string most_recent_editor = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @return The mostRecentEditor.
*/
java.lang.String getMostRecentEditor();
/**
*
*
*
* Output only. Email address of the user who last edited the mute config.
* This field is set by the server and will be ignored if provided on config
* creation or update.
*
*
* string most_recent_editor = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @return The bytes for mostRecentEditor.
*/
com.google.protobuf.ByteString getMostRecentEditorBytes();
/**
*
*
*
* Optional. The type of the mute config, which determines what type of mute
* state the config affects. The static mute state takes precedence over the
* dynamic mute state. Immutable after creation. STATIC by default if not set
* during creation.
*
*
*
* .google.cloud.securitycenter.v1.MuteConfig.MuteConfigType type = 8 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return The enum numeric value on the wire for type.
*/
int getTypeValue();
/**
*
*
*
* Optional. The type of the mute config, which determines what type of mute
* state the config affects. The static mute state takes precedence over the
* dynamic mute state. Immutable after creation. STATIC by default if not set
* during creation.
*
*
*
* .google.cloud.securitycenter.v1.MuteConfig.MuteConfigType type = 8 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return The type.
*/
com.google.cloud.securitycenter.v1.MuteConfig.MuteConfigType getType();
/**
*
*
*
* Optional. The expiry of the mute config. Only applicable for dynamic
* configs. If the expiry is set, when the config expires, it is removed from
* all findings.
*
*
* .google.protobuf.Timestamp expiry_time = 9 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return Whether the expiryTime field is set.
*/
boolean hasExpiryTime();
/**
*
*
*
* Optional. The expiry of the mute config. Only applicable for dynamic
* configs. If the expiry is set, when the config expires, it is removed from
* all findings.
*
*
* .google.protobuf.Timestamp expiry_time = 9 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return The expiryTime.
*/
com.google.protobuf.Timestamp getExpiryTime();
/**
*
*
*
* Optional. The expiry of the mute config. Only applicable for dynamic
* configs. If the expiry is set, when the config expires, it is removed from
* all findings.
*
*
* .google.protobuf.Timestamp expiry_time = 9 [(.google.api.field_behavior) = OPTIONAL];
*
*/
com.google.protobuf.TimestampOrBuilder getExpiryTimeOrBuilder();
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy