com.google.api.services.logging.v2beta1.model.LogMetric Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2010 Google Inc.
 *
 * 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/google/apis-client-generator/
 * (build: 2016-07-08 17:28:43 UTC)
 * on 2016-10-11 at 14:55:20 UTC 
 * Modify at your own risk.
 */

package com.google.api.services.logging.v2beta1.model;

/**
 * Describes a logs-based metric.  The value of the metric is the number of log entries that match a
 * logs filter.
 *
 *  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 Stackdriver Logging 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 LogMetric extends com.google.api.client.json.GenericJson {

  /**
   * Optional. A description of this metric, which is used in documentation.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String description;

  /**
   * Required. An [advanced logs filter](/logging/docs/view/advanced_filters). Example:
   * `"resource.type=gae_app AND severity>=ERROR"`.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String filter;

  /**
   * Required. The client-assigned metric identifier. Example: `"severe_errors"`.  Metric
   * identifiers are limited to 100 characters and can include only the following characters: `A-Z`,
   * `a-z`, `0-9`, and the special characters `_-.,+!*',()%/`.  The forward-slash character (`/`)
   * denotes a hierarchy of name pieces, and it cannot be the first character of the name.  The '%'
   * character is used to URL encode unsafe and reserved characters and must be followed by two
   * hexadecimal digits according to RFC 1738.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String name;

  /**
   * Output only. The API version that created or updated this metric. The version also dictates the
   * syntax of the filter expression. When a value for this field is missing, the default value of
   * V2 should be assumed.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String version;

  /**
   * Optional. A description of this metric, which is used in documentation.
   * @return value or {@code null} for none
   */
  public java.lang.String getDescription() {
    return description;
  }

  /**
   * Optional. A description of this metric, which is used in documentation.
   * @param description description or {@code null} for none
   */
  public LogMetric setDescription(java.lang.String description) {
    this.description = description;
    return this;
  }

  /**
   * Required. An [advanced logs filter](/logging/docs/view/advanced_filters). Example:
   * `"resource.type=gae_app AND severity>=ERROR"`.
   * @return value or {@code null} for none
   */
  public java.lang.String getFilter() {
    return filter;
  }

  /**
   * Required. An [advanced logs filter](/logging/docs/view/advanced_filters). Example:
   * `"resource.type=gae_app AND severity>=ERROR"`.
   * @param filter filter or {@code null} for none
   */
  public LogMetric setFilter(java.lang.String filter) {
    this.filter = filter;
    return this;
  }

  /**
   * Required. The client-assigned metric identifier. Example: `"severe_errors"`.  Metric
   * identifiers are limited to 100 characters and can include only the following characters: `A-Z`,
   * `a-z`, `0-9`, and the special characters `_-.,+!*',()%/`.  The forward-slash character (`/`)
   * denotes a hierarchy of name pieces, and it cannot be the first character of the name.  The '%'
   * character is used to URL encode unsafe and reserved characters and must be followed by two
   * hexadecimal digits according to RFC 1738.
   * @return value or {@code null} for none
   */
  public java.lang.String getName() {
    return name;
  }

  /**
   * Required. The client-assigned metric identifier. Example: `"severe_errors"`.  Metric
   * identifiers are limited to 100 characters and can include only the following characters: `A-Z`,
   * `a-z`, `0-9`, and the special characters `_-.,+!*',()%/`.  The forward-slash character (`/`)
   * denotes a hierarchy of name pieces, and it cannot be the first character of the name.  The '%'
   * character is used to URL encode unsafe and reserved characters and must be followed by two
   * hexadecimal digits according to RFC 1738.
   * @param name name or {@code null} for none
   */
  public LogMetric setName(java.lang.String name) {
    this.name = name;
    return this;
  }

  /**
   * Output only. The API version that created or updated this metric. The version also dictates the
   * syntax of the filter expression. When a value for this field is missing, the default value of
   * V2 should be assumed.
   * @return value or {@code null} for none
   */
  public java.lang.String getVersion() {
    return version;
  }

  /**
   * Output only. The API version that created or updated this metric. The version also dictates the
   * syntax of the filter expression. When a value for this field is missing, the default value of
   * V2 should be assumed.
   * @param version version or {@code null} for none
   */
  public LogMetric setVersion(java.lang.String version) {
    this.version = version;
    return this;
  }

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

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

}