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/security_health_analytics_custom_module.proto 18 19 package com.google.cloud.securitycenter.v1; 20 21 public interface SecurityHealthAnalyticsCustomModuleOrBuilder 22 extends 23 // @@protoc_insertion_point(interface_extends:google.cloud.securitycenter.v1.SecurityHealthAnalyticsCustomModule) 24 com.google.protobuf.MessageOrBuilder { 25 26 /** 27 * 28 * 29 * <pre> 30 * Immutable. The resource name of the custom module. 31 * Its format is 32 * "organizations/{organization}/securityHealthAnalyticsSettings/customModules/{customModule}", 33 * or 34 * "folders/{folder}/securityHealthAnalyticsSettings/customModules/{customModule}", 35 * or 36 * "projects/{project}/securityHealthAnalyticsSettings/customModules/{customModule}" 37 * The id {customModule} is server-generated and is not user settable. 38 * It will be a numeric id containing 1-20 digits. 39 * </pre> 40 * 41 * <code>string name = 1 [(.google.api.field_behavior) = IMMUTABLE];</code> 42 * 43 * @return The name. 44 */ getName()45 java.lang.String getName(); 46 /** 47 * 48 * 49 * <pre> 50 * Immutable. The resource name of the custom module. 51 * Its format is 52 * "organizations/{organization}/securityHealthAnalyticsSettings/customModules/{customModule}", 53 * or 54 * "folders/{folder}/securityHealthAnalyticsSettings/customModules/{customModule}", 55 * or 56 * "projects/{project}/securityHealthAnalyticsSettings/customModules/{customModule}" 57 * The id {customModule} is server-generated and is not user settable. 58 * It will be a numeric id containing 1-20 digits. 59 * </pre> 60 * 61 * <code>string name = 1 [(.google.api.field_behavior) = IMMUTABLE];</code> 62 * 63 * @return The bytes for name. 64 */ getNameBytes()65 com.google.protobuf.ByteString getNameBytes(); 66 67 /** 68 * 69 * 70 * <pre> 71 * The display name of the Security Health Analytics custom module. This 72 * display name becomes the finding category for all findings that are 73 * returned by this custom module. The display name must be between 1 and 74 * 128 characters, start with a lowercase letter, and contain alphanumeric 75 * characters or underscores only. 76 * </pre> 77 * 78 * <code>string display_name = 2;</code> 79 * 80 * @return The displayName. 81 */ getDisplayName()82 java.lang.String getDisplayName(); 83 /** 84 * 85 * 86 * <pre> 87 * The display name of the Security Health Analytics custom module. This 88 * display name becomes the finding category for all findings that are 89 * returned by this custom module. The display name must be between 1 and 90 * 128 characters, start with a lowercase letter, and contain alphanumeric 91 * characters or underscores only. 92 * </pre> 93 * 94 * <code>string display_name = 2;</code> 95 * 96 * @return The bytes for displayName. 97 */ getDisplayNameBytes()98 com.google.protobuf.ByteString getDisplayNameBytes(); 99 100 /** 101 * 102 * 103 * <pre> 104 * The enablement state of the custom module. 105 * </pre> 106 * 107 * <code> 108 * .google.cloud.securitycenter.v1.SecurityHealthAnalyticsCustomModule.EnablementState enablement_state = 4; 109 * </code> 110 * 111 * @return The enum numeric value on the wire for enablementState. 112 */ getEnablementStateValue()113 int getEnablementStateValue(); 114 /** 115 * 116 * 117 * <pre> 118 * The enablement state of the custom module. 119 * </pre> 120 * 121 * <code> 122 * .google.cloud.securitycenter.v1.SecurityHealthAnalyticsCustomModule.EnablementState enablement_state = 4; 123 * </code> 124 * 125 * @return The enablementState. 126 */ 127 com.google.cloud.securitycenter.v1.SecurityHealthAnalyticsCustomModule.EnablementState getEnablementState()128 getEnablementState(); 129 130 /** 131 * 132 * 133 * <pre> 134 * Output only. The time at which the custom module was last updated. 135 * </pre> 136 * 137 * <code>.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY]; 138 * </code> 139 * 140 * @return Whether the updateTime field is set. 141 */ hasUpdateTime()142 boolean hasUpdateTime(); 143 /** 144 * 145 * 146 * <pre> 147 * Output only. The time at which the custom module was last updated. 148 * </pre> 149 * 150 * <code>.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY]; 151 * </code> 152 * 153 * @return The updateTime. 154 */ getUpdateTime()155 com.google.protobuf.Timestamp getUpdateTime(); 156 /** 157 * 158 * 159 * <pre> 160 * Output only. The time at which the custom module was last updated. 161 * </pre> 162 * 163 * <code>.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY]; 164 * </code> 165 */ getUpdateTimeOrBuilder()166 com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder(); 167 168 /** 169 * 170 * 171 * <pre> 172 * Output only. The editor that last updated the custom module. 173 * </pre> 174 * 175 * <code>string last_editor = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];</code> 176 * 177 * @return The lastEditor. 178 */ getLastEditor()179 java.lang.String getLastEditor(); 180 /** 181 * 182 * 183 * <pre> 184 * Output only. The editor that last updated the custom module. 185 * </pre> 186 * 187 * <code>string last_editor = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];</code> 188 * 189 * @return The bytes for lastEditor. 190 */ getLastEditorBytes()191 com.google.protobuf.ByteString getLastEditorBytes(); 192 193 /** 194 * 195 * 196 * <pre> 197 * Output only. If empty, indicates that the custom module was created in the 198 * organization, folder, or project in which you are viewing the custom 199 * module. Otherwise, `ancestor_module` specifies the organization or folder 200 * from which the custom module is inherited. 201 * </pre> 202 * 203 * <code> 204 * string ancestor_module = 7 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... } 205 * </code> 206 * 207 * @return The ancestorModule. 208 */ getAncestorModule()209 java.lang.String getAncestorModule(); 210 /** 211 * 212 * 213 * <pre> 214 * Output only. If empty, indicates that the custom module was created in the 215 * organization, folder, or project in which you are viewing the custom 216 * module. Otherwise, `ancestor_module` specifies the organization or folder 217 * from which the custom module is inherited. 218 * </pre> 219 * 220 * <code> 221 * string ancestor_module = 7 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... } 222 * </code> 223 * 224 * @return The bytes for ancestorModule. 225 */ getAncestorModuleBytes()226 com.google.protobuf.ByteString getAncestorModuleBytes(); 227 228 /** 229 * 230 * 231 * <pre> 232 * The user specified custom configuration for the module. 233 * </pre> 234 * 235 * <code>.google.cloud.securitycenter.v1.CustomConfig custom_config = 8;</code> 236 * 237 * @return Whether the customConfig field is set. 238 */ hasCustomConfig()239 boolean hasCustomConfig(); 240 /** 241 * 242 * 243 * <pre> 244 * The user specified custom configuration for the module. 245 * </pre> 246 * 247 * <code>.google.cloud.securitycenter.v1.CustomConfig custom_config = 8;</code> 248 * 249 * @return The customConfig. 250 */ getCustomConfig()251 com.google.cloud.securitycenter.v1.CustomConfig getCustomConfig(); 252 /** 253 * 254 * 255 * <pre> 256 * The user specified custom configuration for the module. 257 * </pre> 258 * 259 * <code>.google.cloud.securitycenter.v1.CustomConfig custom_config = 8;</code> 260 */ getCustomConfigOrBuilder()261 com.google.cloud.securitycenter.v1.CustomConfigOrBuilder getCustomConfigOrBuilder(); 262 } 263