com.google.cloud.securitycenter.v1.EventThreatDetectionCustomModuleOrBuilder 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
PROTO library for proto-google-cloud-securitycenter-v1
The 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/v1/event_threat_detection_custom_module.proto

// Protobuf Java Version: 3.25.5
package com.google.cloud.securitycenter.v1;

public interface EventThreatDetectionCustomModuleOrBuilder
    extends
    // @@protoc_insertion_point(interface_extends:google.cloud.securitycenter.v1.EventThreatDetectionCustomModule)
    com.google.protobuf.MessageOrBuilder {

  /**
   *
   *
   *    * Immutable. The resource name of the Event Threat Detection custom module.
   *
   * Its format is:
   *
   *   * `organizations/{organization}/eventThreatDetectionSettings/customModules/{module}`.
   *   * `folders/{folder}/eventThreatDetectionSettings/customModules/{module}`.
   *   * `projects/{project}/eventThreatDetectionSettings/customModules/{module}`.
   * 
   *
   * string name = 1 [(.google.api.field_behavior) = IMMUTABLE];
   *
   * @return The name.
   */
  java.lang.String getName();
  /**
   *
   *
   *    * Immutable. The resource name of the Event Threat Detection custom module.
   *
   * Its format is:
   *
   *   * `organizations/{organization}/eventThreatDetectionSettings/customModules/{module}`.
   *   * `folders/{folder}/eventThreatDetectionSettings/customModules/{module}`.
   *   * `projects/{project}/eventThreatDetectionSettings/customModules/{module}`.
   * 
   *
   * string name = 1 [(.google.api.field_behavior) = IMMUTABLE];
   *
   * @return The bytes for name.
   */
  com.google.protobuf.ByteString getNameBytes();

  /**
   *
   *
   *    * Config for the module. For the resident module, its config value is defined
   * at this level. For the inherited module, its config value is inherited from
   * the ancestor module.
   * 
   *
   * .google.protobuf.Struct config = 2;
   *
   * @return Whether the config field is set.
   */
  boolean hasConfig();
  /**
   *
   *
   *    * Config for the module. For the resident module, its config value is defined
   * at this level. For the inherited module, its config value is inherited from
   * the ancestor module.
   * 
   *
   * .google.protobuf.Struct config = 2;
   *
   * @return The config.
   */
  com.google.protobuf.Struct getConfig();
  /**
   *
   *
   *    * Config for the module. For the resident module, its config value is defined
   * at this level. For the inherited module, its config value is inherited from
   * the ancestor module.
   * 
   *
   * .google.protobuf.Struct config = 2;
   */
  com.google.protobuf.StructOrBuilder getConfigOrBuilder();

  /**
   *
   *
   *    * Output only. The closest ancestor module that this module inherits the
   * enablement state from. The format is the same as the
   * EventThreatDetectionCustomModule resource name.
   * 
   *
   * 
   * string ancestor_module = 3 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
   * 
   *
   * @return The ancestorModule.
   */
  java.lang.String getAncestorModule();
  /**
   *
   *
   *    * Output only. The closest ancestor module that this module inherits the
   * enablement state from. The format is the same as the
   * EventThreatDetectionCustomModule resource name.
   * 
   *
   * 
   * string ancestor_module = 3 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
   * 
   *
   * @return The bytes for ancestorModule.
   */
  com.google.protobuf.ByteString getAncestorModuleBytes();

  /**
   *
   *
   *    * The state of enablement for the module at the given level of the hierarchy.
   * 
   *
   * 
   * .google.cloud.securitycenter.v1.EventThreatDetectionCustomModule.EnablementState enablement_state = 4;
   * 
   *
   * @return The enum numeric value on the wire for enablementState.
   */
  int getEnablementStateValue();
  /**
   *
   *
   *    * The state of enablement for the module at the given level of the hierarchy.
   * 
   *
   * 
   * .google.cloud.securitycenter.v1.EventThreatDetectionCustomModule.EnablementState enablement_state = 4;
   * 
   *
   * @return The enablementState.
   */
  com.google.cloud.securitycenter.v1.EventThreatDetectionCustomModule.EnablementState
      getEnablementState();

  /**
   *
   *
   *    * Type for the module. e.g. CONFIGURABLE_BAD_IP.
   * 
   *
   * string type = 5;
   *
   * @return The type.
   */
  java.lang.String getType();
  /**
   *
   *
   *    * Type for the module. e.g. CONFIGURABLE_BAD_IP.
   * 
   *
   * string type = 5;
   *
   * @return The bytes for type.
   */
  com.google.protobuf.ByteString getTypeBytes();

  /**
   *
   *
   *    * The human readable name to be displayed for the module.
   * 
   *
   * string display_name = 6;
   *
   * @return The displayName.
   */
  java.lang.String getDisplayName();
  /**
   *
   *
   *    * The human readable name to be displayed for the module.
   * 
   *
   * string display_name = 6;
   *
   * @return The bytes for displayName.
   */
  com.google.protobuf.ByteString getDisplayNameBytes();

  /**
   *
   *
   *    * The description for the module.
   * 
   *
   * string description = 7;
   *
   * @return The description.
   */
  java.lang.String getDescription();
  /**
   *
   *
   *    * The description for the module.
   * 
   *
   * string description = 7;
   *
   * @return The bytes for description.
   */
  com.google.protobuf.ByteString getDescriptionBytes();

  /**
   *
   *
   *    * Output only. The time the module was last updated.
   * 
   *
   * .google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * 
   *
   * @return Whether the updateTime field is set.
   */
  boolean hasUpdateTime();
  /**
   *
   *
   *    * Output only. The time the module was last updated.
   * 
   *
   * .google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * 
   *
   * @return The updateTime.
   */
  com.google.protobuf.Timestamp getUpdateTime();
  /**
   *
   *
   *    * Output only. The time the module was last updated.
   * 
   *
   * .google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * 
   */
  com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder();

  /**
   *
   *
   *    * Output only. The editor the module was last updated by.
   * 
   *
   * string last_editor = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
   *
   * @return The lastEditor.
   */
  java.lang.String getLastEditor();
  /**
   *
   *
   *    * Output only. The editor the module was last updated by.
   * 
   *
   * string last_editor = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
   *
   * @return The bytes for lastEditor.
   */
  com.google.protobuf.ByteString getLastEditorBytes();
}