com.google.api.services.securitycenter.v1.model.EffectiveEventThreatDetectionCustomModule Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of google-api-services-securitycenter Show documentation
There is a newer version: v1-rev20241111-2.0.0
Show newest version
/*
 * 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
 *
 * http://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.
 */
/*
 * This code was generated by https://github.com/googleapis/google-api-java-client-services/
 * Modify at your own risk.
 */

package com.google.api.services.securitycenter.v1.model;

/**
 * An EffectiveEventThreatDetectionCustomModule is the representation of an Event Threat Detection
 * custom module at a specified level of the resource hierarchy: organization, folder, or project.
 * If a custom module is inherited from a parent organization or folder, the value of the
 * `enablement_state` property in EffectiveEventThreatDetectionCustomModule is set to the value that
 * is effective in the parent, instead of `INHERITED`. For example, if the module is enabled in a
 * parent organization or folder, the effective `enablement_state` for the module in all child
 * folders or projects is also `enabled`. EffectiveEventThreatDetectionCustomModule is read-only.
 *
 *  This is the Java data model class that specifies how to parse/serialize into the JSON that is
 * transmitted over HTTP when working with the Security Command Center API. For a detailed
 * explanation see:
 * https://developers.google.com/api-client-library/java/google-http-java-client/json
 * 
 *
 * @author Google, Inc.
 */
@SuppressWarnings("javadoc")
public final class EffectiveEventThreatDetectionCustomModule extends com.google.api.client.json.GenericJson {

  /**
   * Output only. Config for the effective module.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.util.Map config;

  /**
   * Output only. The description for the module.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String description;

  /**
   * Output only. The human readable name to be displayed for the module.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String displayName;

  /**
   * Output only. The effective state of enablement for the module at the given level of the
   * hierarchy.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String enablementState;

  /**
   * Output only. The resource name of the effective ETD custom module. Its format is: *
   * `organizations/{organization}/eventThreatDetectionSettings/effectiveCustomModules/{module}`. *
   * `folders/{folder}/eventThreatDetectionSettings/effectiveCustomModules/{module}`. *
   * `projects/{project}/eventThreatDetectionSettings/effectiveCustomModules/{module}`.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String name;

  /**
   * Output only. Type for the module. e.g. CONFIGURABLE_BAD_IP.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String type;

  /**
   * Output only. Config for the effective module.
   * @return value or {@code null} for none
   */
  public java.util.Map getConfig() {
    return config;
  }

  /**
   * Output only. Config for the effective module.
   * @param config config or {@code null} for none
   */
  public EffectiveEventThreatDetectionCustomModule setConfig(java.util.Map config) {
    this.config = config;
    return this;
  }

  /**
   * Output only. The description for the module.
   * @return value or {@code null} for none
   */
  public java.lang.String getDescription() {
    return description;
  }

  /**
   * Output only. The description for the module.
   * @param description description or {@code null} for none
   */
  public EffectiveEventThreatDetectionCustomModule setDescription(java.lang.String description) {
    this.description = description;
    return this;
  }

  /**
   * Output only. The human readable name to be displayed for the module.
   * @return value or {@code null} for none
   */
  public java.lang.String getDisplayName() {
    return displayName;
  }

  /**
   * Output only. The human readable name to be displayed for the module.
   * @param displayName displayName or {@code null} for none
   */
  public EffectiveEventThreatDetectionCustomModule setDisplayName(java.lang.String displayName) {
    this.displayName = displayName;
    return this;
  }

  /**
   * Output only. The effective state of enablement for the module at the given level of the
   * hierarchy.
   * @return value or {@code null} for none
   */
  public java.lang.String getEnablementState() {
    return enablementState;
  }

  /**
   * Output only. The effective state of enablement for the module at the given level of the
   * hierarchy.
   * @param enablementState enablementState or {@code null} for none
   */
  public EffectiveEventThreatDetectionCustomModule setEnablementState(java.lang.String enablementState) {
    this.enablementState = enablementState;
    return this;
  }

  /**
   * Output only. The resource name of the effective ETD custom module. Its format is: *
   * `organizations/{organization}/eventThreatDetectionSettings/effectiveCustomModules/{module}`. *
   * `folders/{folder}/eventThreatDetectionSettings/effectiveCustomModules/{module}`. *
   * `projects/{project}/eventThreatDetectionSettings/effectiveCustomModules/{module}`.
   * @return value or {@code null} for none
   */
  public java.lang.String getName() {
    return name;
  }

  /**
   * Output only. The resource name of the effective ETD custom module. Its format is: *
   * `organizations/{organization}/eventThreatDetectionSettings/effectiveCustomModules/{module}`. *
   * `folders/{folder}/eventThreatDetectionSettings/effectiveCustomModules/{module}`. *
   * `projects/{project}/eventThreatDetectionSettings/effectiveCustomModules/{module}`.
   * @param name name or {@code null} for none
   */
  public EffectiveEventThreatDetectionCustomModule setName(java.lang.String name) {
    this.name = name;
    return this;
  }

  /**
   * Output only. Type for the module. e.g. CONFIGURABLE_BAD_IP.
   * @return value or {@code null} for none
   */
  public java.lang.String getType() {
    return type;
  }

  /**
   * Output only. Type for the module. e.g. CONFIGURABLE_BAD_IP.
   * @param type type or {@code null} for none
   */
  public EffectiveEventThreatDetectionCustomModule setType(java.lang.String type) {
    this.type = type;
    return this;
  }

  @Override
  public EffectiveEventThreatDetectionCustomModule set(String fieldName, Object value) {
    return (EffectiveEventThreatDetectionCustomModule) super.set(fieldName, value);
  }

  @Override
  public EffectiveEventThreatDetectionCustomModule clone() {
    return (EffectiveEventThreatDetectionCustomModule) super.clone();
  }

}