com.google.api.services.securitycenter.v1.model.BulkMuteFindingsRequest 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;

/**
 * Request message for bulk findings update. Note: 1. If multiple bulk update requests match the
 * same resource, the order in which they get executed is not defined. 2. Once a bulk operation is
 * started, there is no way to stop it.
 *
 *  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 BulkMuteFindingsRequest extends com.google.api.client.json.GenericJson {

  /**
   * Expression that identifies findings that should be updated. The expression is a list of zero or
   * more restrictions combined via logical operators `AND` and `OR`. Parentheses are supported, and
   * `OR` has higher precedence than `AND`. Restrictions have the form ` ` and may have a `-`
   * character in front of them to indicate negation. The fields map to those defined in the
   * corresponding resource. The supported operators are: * `=` for all value types. * `>`, `<`,
   * `>=`, `<=` for integer values. * `:`, meaning substring matching, for strings. The supported
   * value types are: * string literals in quotes. * integer literals without quotes. * boolean
   * literals `true` and `false` without quotes.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String filter;

  /**
   * This can be a mute configuration name or any identifier for mute/unmute of findings based on
   * the filter.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String muteAnnotation;

  /**
   * Optional. All findings matching the given filter will have their mute state set to this value.
   * The default value is `MUTED`. Setting this to `UNDEFINED` will clear the mute state on all
   * matching findings.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String muteState;

  /**
   * Expression that identifies findings that should be updated. The expression is a list of zero or
   * more restrictions combined via logical operators `AND` and `OR`. Parentheses are supported, and
   * `OR` has higher precedence than `AND`. Restrictions have the form ` ` and may have a `-`
   * character in front of them to indicate negation. The fields map to those defined in the
   * corresponding resource. The supported operators are: * `=` for all value types. * `>`, `<`,
   * `>=`, `<=` for integer values. * `:`, meaning substring matching, for strings. The supported
   * value types are: * string literals in quotes. * integer literals without quotes. * boolean
   * literals `true` and `false` without quotes.
   * @return value or {@code null} for none
   */
  public java.lang.String getFilter() {
    return filter;
  }

  /**
   * Expression that identifies findings that should be updated. The expression is a list of zero or
   * more restrictions combined via logical operators `AND` and `OR`. Parentheses are supported, and
   * `OR` has higher precedence than `AND`. Restrictions have the form ` ` and may have a `-`
   * character in front of them to indicate negation. The fields map to those defined in the
   * corresponding resource. The supported operators are: * `=` for all value types. * `>`, `<`,
   * `>=`, `<=` for integer values. * `:`, meaning substring matching, for strings. The supported
   * value types are: * string literals in quotes. * integer literals without quotes. * boolean
   * literals `true` and `false` without quotes.
   * @param filter filter or {@code null} for none
   */
  public BulkMuteFindingsRequest setFilter(java.lang.String filter) {
    this.filter = filter;
    return this;
  }

  /**
   * This can be a mute configuration name or any identifier for mute/unmute of findings based on
   * the filter.
   * @return value or {@code null} for none
   */
  public java.lang.String getMuteAnnotation() {
    return muteAnnotation;
  }

  /**
   * This can be a mute configuration name or any identifier for mute/unmute of findings based on
   * the filter.
   * @param muteAnnotation muteAnnotation or {@code null} for none
   */
  public BulkMuteFindingsRequest setMuteAnnotation(java.lang.String muteAnnotation) {
    this.muteAnnotation = muteAnnotation;
    return this;
  }

  /**
   * Optional. All findings matching the given filter will have their mute state set to this value.
   * The default value is `MUTED`. Setting this to `UNDEFINED` will clear the mute state on all
   * matching findings.
   * @return value or {@code null} for none
   */
  public java.lang.String getMuteState() {
    return muteState;
  }

  /**
   * Optional. All findings matching the given filter will have their mute state set to this value.
   * The default value is `MUTED`. Setting this to `UNDEFINED` will clear the mute state on all
   * matching findings.
   * @param muteState muteState or {@code null} for none
   */
  public BulkMuteFindingsRequest setMuteState(java.lang.String muteState) {
    this.muteState = muteState;
    return this;
  }

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

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

}