com.google.api.serviceusage.v1beta1.ConsumerQuotaLimitOrBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of proto-google-cloud-service-usage-v1beta1 Show documentation
Proto library for google-cloud-service-usage
The newest version!
/*
 * Copyright 2024 Google LLC
 *
 * 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
 *
 *     https://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.
 */
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: google/api/serviceusage/v1beta1/resources.proto

// Protobuf Java Version: 3.25.5
package com.google.api.serviceusage.v1beta1;

public interface ConsumerQuotaLimitOrBuilder
    extends
    // @@protoc_insertion_point(interface_extends:google.api.serviceusage.v1beta1.ConsumerQuotaLimit)
    com.google.protobuf.MessageOrBuilder {

  /**
   *
   *
   *    * The resource name of the quota limit.
   *
   * An example name would be:
   * `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion`
   *
   * The resource name is intended to be opaque and should not be parsed for
   * its component strings, since its representation could change in the future.
   * 
   *
   * string name = 1;
   *
   * @return The name.
   */
  java.lang.String getName();
  /**
   *
   *
   *    * The resource name of the quota limit.
   *
   * An example name would be:
   * `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion`
   *
   * The resource name is intended to be opaque and should not be parsed for
   * its component strings, since its representation could change in the future.
   * 
   *
   * string name = 1;
   *
   * @return The bytes for name.
   */
  com.google.protobuf.ByteString getNameBytes();

  /**
   *
   *
   *    * The name of the parent metric of this limit.
   *
   * An example name would be:
   * `compute.googleapis.com/cpus`
   * 
   *
   * string metric = 8;
   *
   * @return The metric.
   */
  java.lang.String getMetric();
  /**
   *
   *
   *    * The name of the parent metric of this limit.
   *
   * An example name would be:
   * `compute.googleapis.com/cpus`
   * 
   *
   * string metric = 8;
   *
   * @return The bytes for metric.
   */
  com.google.protobuf.ByteString getMetricBytes();

  /**
   *
   *
   *    * The limit unit.
   *
   * An example unit would be
   * `1/{project}/{region}`
   * Note that `{project}` and `{region}` are not placeholders in this example;
   * the literal characters `{` and `}` occur in the string.
   * 
   *
   * string unit = 2;
   *
   * @return The unit.
   */
  java.lang.String getUnit();
  /**
   *
   *
   *    * The limit unit.
   *
   * An example unit would be
   * `1/{project}/{region}`
   * Note that `{project}` and `{region}` are not placeholders in this example;
   * the literal characters `{` and `}` occur in the string.
   * 
   *
   * string unit = 2;
   *
   * @return The bytes for unit.
   */
  com.google.protobuf.ByteString getUnitBytes();

  /**
   *
   *
   *    * Whether this limit is precise or imprecise.
   * 
   *
   * bool is_precise = 3;
   *
   * @return The isPrecise.
   */
  boolean getIsPrecise();

  /**
   *
   *
   *    * Whether admin overrides are allowed on this limit
   * 
   *
   * bool allows_admin_overrides = 7;
   *
   * @return The allowsAdminOverrides.
   */
  boolean getAllowsAdminOverrides();

  /**
   *
   *
   *    * Summary of the enforced quota buckets, organized by quota dimension,
   * ordered from least specific to most specific (for example, the global
   * default bucket, with no quota dimensions, will always appear first).
   * 
   *
   * repeated .google.api.serviceusage.v1beta1.QuotaBucket quota_buckets = 9;
   */
  java.util.List getQuotaBucketsList();
  /**
   *
   *
   *    * Summary of the enforced quota buckets, organized by quota dimension,
   * ordered from least specific to most specific (for example, the global
   * default bucket, with no quota dimensions, will always appear first).
   * 
   *
   * repeated .google.api.serviceusage.v1beta1.QuotaBucket quota_buckets = 9;
   */
  com.google.api.serviceusage.v1beta1.QuotaBucket getQuotaBuckets(int index);
  /**
   *
   *
   *    * Summary of the enforced quota buckets, organized by quota dimension,
   * ordered from least specific to most specific (for example, the global
   * default bucket, with no quota dimensions, will always appear first).
   * 
   *
   * repeated .google.api.serviceusage.v1beta1.QuotaBucket quota_buckets = 9;
   */
  int getQuotaBucketsCount();
  /**
   *
   *
   *    * Summary of the enforced quota buckets, organized by quota dimension,
   * ordered from least specific to most specific (for example, the global
   * default bucket, with no quota dimensions, will always appear first).
   * 
   *
   * repeated .google.api.serviceusage.v1beta1.QuotaBucket quota_buckets = 9;
   */
  java.util.List
      getQuotaBucketsOrBuilderList();
  /**
   *
   *
   *    * Summary of the enforced quota buckets, organized by quota dimension,
   * ordered from least specific to most specific (for example, the global
   * default bucket, with no quota dimensions, will always appear first).
   * 
   *
   * repeated .google.api.serviceusage.v1beta1.QuotaBucket quota_buckets = 9;
   */
  com.google.api.serviceusage.v1beta1.QuotaBucketOrBuilder getQuotaBucketsOrBuilder(int index);

  /**
   *
   *
   *    * List of all supported locations.
   * This field is present only if the limit has a {region} or {zone} dimension.
   * 
   *
   * repeated string supported_locations = 11;
   *
   * @return A list containing the supportedLocations.
   */
  java.util.List getSupportedLocationsList();
  /**
   *
   *
   *    * List of all supported locations.
   * This field is present only if the limit has a {region} or {zone} dimension.
   * 
   *
   * repeated string supported_locations = 11;
   *
   * @return The count of supportedLocations.
   */
  int getSupportedLocationsCount();
  /**
   *
   *
   *    * List of all supported locations.
   * This field is present only if the limit has a {region} or {zone} dimension.
   * 
   *
   * repeated string supported_locations = 11;
   *
   * @param index The index of the element to return.
   * @return The supportedLocations at the given index.
   */
  java.lang.String getSupportedLocations(int index);
  /**
   *
   *
   *    * List of all supported locations.
   * This field is present only if the limit has a {region} or {zone} dimension.
   * 
   *
   * repeated string supported_locations = 11;
   *
   * @param index The index of the value to return.
   * @return The bytes of the supportedLocations at the given index.
   */
  com.google.protobuf.ByteString getSupportedLocationsBytes(int index);
}