com.google.api.services.serviceusage.v1.model.Monitoring Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of google-api-services-serviceusage Show documentation
There is a newer version: v1-rev20241025-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.serviceusage.v1.model;

/**
 * Monitoring configuration of the service. The example below shows how to configure monitored
 * resources and metrics for monitoring. In the example, a monitored resource and two metrics are
 * defined. The `library.googleapis.com/book/returned_count` metric is sent to both producer and
 * consumer projects, whereas the `library.googleapis.com/book/num_overdue` metric is only sent to
 * the consumer project. monitored_resources: - type: library.googleapis.com/Branch display_name:
 * "Library Branch" description: "A branch of a library." launch_stage: GA labels: - key:
 * resource_container description: "The Cloud container (ie. project id) for the Branch." - key:
 * location description: "The location of the library branch." - key: branch_id description: "The id
 * of the branch." metrics: - name: library.googleapis.com/book/returned_count display_name: "Books
 * Returned" description: "The count of books that have been returned." launch_stage: GA
 * metric_kind: DELTA value_type: INT64 unit: "1" labels: - key: customer_id description: "The id of
 * the customer." - name: library.googleapis.com/book/num_overdue display_name: "Books Overdue"
 * description: "The current number of overdue books." launch_stage: GA metric_kind: GAUGE
 * value_type: INT64 unit: "1" labels: - key: customer_id description: "The id of the customer."
 * monitoring: producer_destinations: - monitored_resource: library.googleapis.com/Branch metrics: -
 * library.googleapis.com/book/returned_count consumer_destinations: - monitored_resource:
 * library.googleapis.com/Branch metrics: - library.googleapis.com/book/returned_count -
 * library.googleapis.com/book/num_overdue
 *
 *  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 Service Usage 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 Monitoring extends com.google.api.client.json.GenericJson {

  /**
   * Monitoring configurations for sending metrics to the consumer project. There can be multiple
   * consumer destinations. A monitored resource type may appear in multiple monitoring destinations
   * if different aggregations are needed for different sets of metrics associated with that
   * monitored resource type. A monitored resource and metric pair may only be used once in the
   * Monitoring configuration.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.util.List consumerDestinations;

  /**
   * Monitoring configurations for sending metrics to the producer project. There can be multiple
   * producer destinations. A monitored resource type may appear in multiple monitoring destinations
   * if different aggregations are needed for different sets of metrics associated with that
   * monitored resource type. A monitored resource and metric pair may only be used once in the
   * Monitoring configuration.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.util.List producerDestinations;

  /**
   * Monitoring configurations for sending metrics to the consumer project. There can be multiple
   * consumer destinations. A monitored resource type may appear in multiple monitoring destinations
   * if different aggregations are needed for different sets of metrics associated with that
   * monitored resource type. A monitored resource and metric pair may only be used once in the
   * Monitoring configuration.
   * @return value or {@code null} for none
   */
  public java.util.List getConsumerDestinations() {
    return consumerDestinations;
  }

  /**
   * Monitoring configurations for sending metrics to the consumer project. There can be multiple
   * consumer destinations. A monitored resource type may appear in multiple monitoring destinations
   * if different aggregations are needed for different sets of metrics associated with that
   * monitored resource type. A monitored resource and metric pair may only be used once in the
   * Monitoring configuration.
   * @param consumerDestinations consumerDestinations or {@code null} for none
   */
  public Monitoring setConsumerDestinations(java.util.List consumerDestinations) {
    this.consumerDestinations = consumerDestinations;
    return this;
  }

  /**
   * Monitoring configurations for sending metrics to the producer project. There can be multiple
   * producer destinations. A monitored resource type may appear in multiple monitoring destinations
   * if different aggregations are needed for different sets of metrics associated with that
   * monitored resource type. A monitored resource and metric pair may only be used once in the
   * Monitoring configuration.
   * @return value or {@code null} for none
   */
  public java.util.List getProducerDestinations() {
    return producerDestinations;
  }

  /**
   * Monitoring configurations for sending metrics to the producer project. There can be multiple
   * producer destinations. A monitored resource type may appear in multiple monitoring destinations
   * if different aggregations are needed for different sets of metrics associated with that
   * monitored resource type. A monitored resource and metric pair may only be used once in the
   * Monitoring configuration.
   * @param producerDestinations producerDestinations or {@code null} for none
   */
  public Monitoring setProducerDestinations(java.util.List producerDestinations) {
    this.producerDestinations = producerDestinations;
    return this;
  }

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

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

}