1 /* 2 * Copyright 2020 Google LLC 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * https://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 // Generated by the protocol buffer compiler. DO NOT EDIT! 17 // source: google/cloud/securitycenter/v1/mute_config.proto 18 19 package com.google.cloud.securitycenter.v1; 20 21 public interface MuteConfigOrBuilder 22 extends 23 // @@protoc_insertion_point(interface_extends:google.cloud.securitycenter.v1.MuteConfig) 24 com.google.protobuf.MessageOrBuilder { 25 26 /** 27 * 28 * 29 * <pre> 30 * This field will be ignored if provided on config creation. Format 31 * "organizations/{organization}/muteConfigs/{mute_config}" 32 * "folders/{folder}/muteConfigs/{mute_config}" 33 * "projects/{project}/muteConfigs/{mute_config}" 34 * </pre> 35 * 36 * <code>string name = 1;</code> 37 * 38 * @return The name. 39 */ getName()40 java.lang.String getName(); 41 /** 42 * 43 * 44 * <pre> 45 * This field will be ignored if provided on config creation. Format 46 * "organizations/{organization}/muteConfigs/{mute_config}" 47 * "folders/{folder}/muteConfigs/{mute_config}" 48 * "projects/{project}/muteConfigs/{mute_config}" 49 * </pre> 50 * 51 * <code>string name = 1;</code> 52 * 53 * @return The bytes for name. 54 */ getNameBytes()55 com.google.protobuf.ByteString getNameBytes(); 56 57 /** 58 * 59 * 60 * <pre> 61 * The human readable name to be displayed for the mute config. 62 * </pre> 63 * 64 * <code>string display_name = 2 [deprecated = true];</code> 65 * 66 * @deprecated google.cloud.securitycenter.v1.MuteConfig.display_name is deprecated. See 67 * google/cloud/securitycenter/v1/mute_config.proto;l=47 68 * @return The displayName. 69 */ 70 @java.lang.Deprecated getDisplayName()71 java.lang.String getDisplayName(); 72 /** 73 * 74 * 75 * <pre> 76 * The human readable name to be displayed for the mute config. 77 * </pre> 78 * 79 * <code>string display_name = 2 [deprecated = true];</code> 80 * 81 * @deprecated google.cloud.securitycenter.v1.MuteConfig.display_name is deprecated. See 82 * google/cloud/securitycenter/v1/mute_config.proto;l=47 83 * @return The bytes for displayName. 84 */ 85 @java.lang.Deprecated getDisplayNameBytes()86 com.google.protobuf.ByteString getDisplayNameBytes(); 87 88 /** 89 * 90 * 91 * <pre> 92 * A description of the mute config. 93 * </pre> 94 * 95 * <code>string description = 3;</code> 96 * 97 * @return The description. 98 */ getDescription()99 java.lang.String getDescription(); 100 /** 101 * 102 * 103 * <pre> 104 * A description of the mute config. 105 * </pre> 106 * 107 * <code>string description = 3;</code> 108 * 109 * @return The bytes for description. 110 */ getDescriptionBytes()111 com.google.protobuf.ByteString getDescriptionBytes(); 112 113 /** 114 * 115 * 116 * <pre> 117 * Required. An expression that defines the filter to apply across 118 * create/update events of findings. While creating a filter string, be 119 * mindful of the scope in which the mute configuration is being created. 120 * E.g., If a filter contains project = X but is created under the project = Y 121 * scope, it might not match any findings. 122 * The following field and operator combinations are supported: 123 * * severity: `=`, `:` 124 * * category: `=`, `:` 125 * * resource.name: `=`, `:` 126 * * resource.project_name: `=`, `:` 127 * * resource.project_display_name: `=`, `:` 128 * * resource.folders.resource_folder: `=`, `:` 129 * * resource.parent_name: `=`, `:` 130 * * resource.parent_display_name: `=`, `:` 131 * * resource.type: `=`, `:` 132 * * finding_class: `=`, `:` 133 * * indicator.ip_addresses: `=`, `:` 134 * * indicator.domains: `=`, `:` 135 * </pre> 136 * 137 * <code>string filter = 4 [(.google.api.field_behavior) = REQUIRED];</code> 138 * 139 * @return The filter. 140 */ getFilter()141 java.lang.String getFilter(); 142 /** 143 * 144 * 145 * <pre> 146 * Required. An expression that defines the filter to apply across 147 * create/update events of findings. While creating a filter string, be 148 * mindful of the scope in which the mute configuration is being created. 149 * E.g., If a filter contains project = X but is created under the project = Y 150 * scope, it might not match any findings. 151 * The following field and operator combinations are supported: 152 * * severity: `=`, `:` 153 * * category: `=`, `:` 154 * * resource.name: `=`, `:` 155 * * resource.project_name: `=`, `:` 156 * * resource.project_display_name: `=`, `:` 157 * * resource.folders.resource_folder: `=`, `:` 158 * * resource.parent_name: `=`, `:` 159 * * resource.parent_display_name: `=`, `:` 160 * * resource.type: `=`, `:` 161 * * finding_class: `=`, `:` 162 * * indicator.ip_addresses: `=`, `:` 163 * * indicator.domains: `=`, `:` 164 * </pre> 165 * 166 * <code>string filter = 4 [(.google.api.field_behavior) = REQUIRED];</code> 167 * 168 * @return The bytes for filter. 169 */ getFilterBytes()170 com.google.protobuf.ByteString getFilterBytes(); 171 172 /** 173 * 174 * 175 * <pre> 176 * Output only. The time at which the mute config was created. 177 * This field is set by the server and will be ignored if provided on config 178 * creation. 179 * </pre> 180 * 181 * <code>.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY]; 182 * </code> 183 * 184 * @return Whether the createTime field is set. 185 */ hasCreateTime()186 boolean hasCreateTime(); 187 /** 188 * 189 * 190 * <pre> 191 * Output only. The time at which the mute config was created. 192 * This field is set by the server and will be ignored if provided on config 193 * creation. 194 * </pre> 195 * 196 * <code>.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY]; 197 * </code> 198 * 199 * @return The createTime. 200 */ getCreateTime()201 com.google.protobuf.Timestamp getCreateTime(); 202 /** 203 * 204 * 205 * <pre> 206 * Output only. The time at which the mute config was created. 207 * This field is set by the server and will be ignored if provided on config 208 * creation. 209 * </pre> 210 * 211 * <code>.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY]; 212 * </code> 213 */ getCreateTimeOrBuilder()214 com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder(); 215 216 /** 217 * 218 * 219 * <pre> 220 * Output only. The most recent time at which the mute config was updated. 221 * This field is set by the server and will be ignored if provided on config 222 * creation or update. 223 * </pre> 224 * 225 * <code>.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY]; 226 * </code> 227 * 228 * @return Whether the updateTime field is set. 229 */ hasUpdateTime()230 boolean hasUpdateTime(); 231 /** 232 * 233 * 234 * <pre> 235 * Output only. The most recent time at which the mute config was updated. 236 * This field is set by the server and will be ignored if provided on config 237 * creation or update. 238 * </pre> 239 * 240 * <code>.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY]; 241 * </code> 242 * 243 * @return The updateTime. 244 */ getUpdateTime()245 com.google.protobuf.Timestamp getUpdateTime(); 246 /** 247 * 248 * 249 * <pre> 250 * Output only. The most recent time at which the mute config was updated. 251 * This field is set by the server and will be ignored if provided on config 252 * creation or update. 253 * </pre> 254 * 255 * <code>.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY]; 256 * </code> 257 */ getUpdateTimeOrBuilder()258 com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder(); 259 260 /** 261 * 262 * 263 * <pre> 264 * Output only. Email address of the user who last edited the mute config. 265 * This field is set by the server and will be ignored if provided on config 266 * creation or update. 267 * </pre> 268 * 269 * <code>string most_recent_editor = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];</code> 270 * 271 * @return The mostRecentEditor. 272 */ getMostRecentEditor()273 java.lang.String getMostRecentEditor(); 274 /** 275 * 276 * 277 * <pre> 278 * Output only. Email address of the user who last edited the mute config. 279 * This field is set by the server and will be ignored if provided on config 280 * creation or update. 281 * </pre> 282 * 283 * <code>string most_recent_editor = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];</code> 284 * 285 * @return The bytes for mostRecentEditor. 286 */ getMostRecentEditorBytes()287 com.google.protobuf.ByteString getMostRecentEditorBytes(); 288 } 289