/*
 * 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.beyondcorp.v1alpha.model;

/**
 * Field metadata. Commonly understandable name and description for the field. Multiple such fields
 * constitute the Insight.
 *
 * <p> 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 BeyondCorp API. For a detailed explanation see:
 * <a href="https://developers.google.com/api-client-library/java/google-http-java-client/json">https://developers.google.com/api-client-library/java/google-http-java-client/json</a>
 * </p>
 *
 * @author Google, Inc.
 */
@SuppressWarnings("javadoc")
public final class GoogleCloudBeyondcorpSaasplatformInsightsV1alphaInsightMetadataField extends com.google.api.client.json.GenericJson {

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

  /**
   * Output only. Name of the field.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String displayName;

  /**
   * Output only. Field name to be used in filter while requesting configured insight filtered on
   * this field.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String filterAlias;

  /**
   * Output only. Indicates whether the field can be used for filtering.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Boolean filterable;

  /**
   * Output only. Indicates whether the field can be used for grouping in custom grouping request.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Boolean groupable;

  /**
   * Output only. Field id for which this is the metadata.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String id;

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

  /**
   * Output only. Description of the field.
   * @param description description or {@code null} for none
   */
  public GoogleCloudBeyondcorpSaasplatformInsightsV1alphaInsightMetadataField setDescription(java.lang.String description) {
    this.description = description;
    return this;
  }

  /**
   * Output only. Name of the field.
   * @return value or {@code null} for none
   */
  public java.lang.String getDisplayName() {
    return displayName;
  }

  /**
   * Output only. Name of the field.
   * @param displayName displayName or {@code null} for none
   */
  public GoogleCloudBeyondcorpSaasplatformInsightsV1alphaInsightMetadataField setDisplayName(java.lang.String displayName) {
    this.displayName = displayName;
    return this;
  }

  /**
   * Output only. Field name to be used in filter while requesting configured insight filtered on
   * this field.
   * @return value or {@code null} for none
   */
  public java.lang.String getFilterAlias() {
    return filterAlias;
  }

  /**
   * Output only. Field name to be used in filter while requesting configured insight filtered on
   * this field.
   * @param filterAlias filterAlias or {@code null} for none
   */
  public GoogleCloudBeyondcorpSaasplatformInsightsV1alphaInsightMetadataField setFilterAlias(java.lang.String filterAlias) {
    this.filterAlias = filterAlias;
    return this;
  }

  /**
   * Output only. Indicates whether the field can be used for filtering.
   * @return value or {@code null} for none
   */
  public java.lang.Boolean getFilterable() {
    return filterable;
  }

  /**
   * Output only. Indicates whether the field can be used for filtering.
   * @param filterable filterable or {@code null} for none
   */
  public GoogleCloudBeyondcorpSaasplatformInsightsV1alphaInsightMetadataField setFilterable(java.lang.Boolean filterable) {
    this.filterable = filterable;
    return this;
  }

  /**
   * Output only. Indicates whether the field can be used for grouping in custom grouping request.
   * @return value or {@code null} for none
   */
  public java.lang.Boolean getGroupable() {
    return groupable;
  }

  /**
   * Output only. Indicates whether the field can be used for grouping in custom grouping request.
   * @param groupable groupable or {@code null} for none
   */
  public GoogleCloudBeyondcorpSaasplatformInsightsV1alphaInsightMetadataField setGroupable(java.lang.Boolean groupable) {
    this.groupable = groupable;
    return this;
  }

  /**
   * Output only. Field id for which this is the metadata.
   * @return value or {@code null} for none
   */
  public java.lang.String getId() {
    return id;
  }

  /**
   * Output only. Field id for which this is the metadata.
   * @param id id or {@code null} for none
   */
  public GoogleCloudBeyondcorpSaasplatformInsightsV1alphaInsightMetadataField setId(java.lang.String id) {
    this.id = id;
    return this;
  }

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

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

}
