com.google.api.services.securitycenter.v1.model.GoogleCloudSecuritycenterV1EffectiveSecurityHealthAnalyticsCustomModule 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 EffectiveSecurityHealthAnalyticsCustomModule is the representation of a Security Health
 * Analytics 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
 * `enablementState` property in EffectiveSecurityHealthAnalyticsCustomModule 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`. EffectiveSecurityHealthAnalyticsCustomModule 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 GoogleCloudSecuritycenterV1EffectiveSecurityHealthAnalyticsCustomModule extends com.google.api.client.json.GenericJson {

  /**
   * Output only. The user-specified configuration for the module.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private GoogleCloudSecuritycenterV1CustomConfig customConfig;

  /**
   * Output only. The display name for the custom module. The name must be between 1 and 128
   * characters, start with a lowercase letter, and contain alphanumeric characters or underscores
   * only.
   * 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 custom module. Its format is "organizations/{organization
   * }/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}", or
   * "folders/{folder}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}", or
   * "projects/{project}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}"
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String name;

  /**
   * Output only. The user-specified configuration for the module.
   * @return value or {@code null} for none
   */
  public GoogleCloudSecuritycenterV1CustomConfig getCustomConfig() {
    return customConfig;
  }

  /**
   * Output only. The user-specified configuration for the module.
   * @param customConfig customConfig or {@code null} for none
   */
  public GoogleCloudSecuritycenterV1EffectiveSecurityHealthAnalyticsCustomModule setCustomConfig(GoogleCloudSecuritycenterV1CustomConfig customConfig) {
    this.customConfig = customConfig;
    return this;
  }

  /**
   * Output only. The display name for the custom module. The name must be between 1 and 128
   * characters, start with a lowercase letter, and contain alphanumeric characters or underscores
   * only.
   * @return value or {@code null} for none
   */
  public java.lang.String getDisplayName() {
    return displayName;
  }

  /**
   * Output only. The display name for the custom module. The name must be between 1 and 128
   * characters, start with a lowercase letter, and contain alphanumeric characters or underscores
   * only.
   * @param displayName displayName or {@code null} for none
   */
  public GoogleCloudSecuritycenterV1EffectiveSecurityHealthAnalyticsCustomModule 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 GoogleCloudSecuritycenterV1EffectiveSecurityHealthAnalyticsCustomModule setEnablementState(java.lang.String enablementState) {
    this.enablementState = enablementState;
    return this;
  }

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

  /**
   * Output only. The resource name of the custom module. Its format is "organizations/{organization
   * }/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}", or
   * "folders/{folder}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}", or
   * "projects/{project}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}"
   * @param name name or {@code null} for none
   */
  public GoogleCloudSecuritycenterV1EffectiveSecurityHealthAnalyticsCustomModule setName(java.lang.String name) {
    this.name = name;
    return this;
  }

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

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

}