com.google.api.serviceusage.v1beta1.QuotaBucketOrBuilder 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 QuotaBucketOrBuilder
    extends
    // @@protoc_insertion_point(interface_extends:google.api.serviceusage.v1beta1.QuotaBucket)
    com.google.protobuf.MessageOrBuilder {

  /**
   *
   *
   *    * The effective limit of this quota bucket. Equal to default_limit if there
   * are no overrides.
   * 
   *
   * int64 effective_limit = 1;
   *
   * @return The effectiveLimit.
   */
  long getEffectiveLimit();

  /**
   *
   *
   *    * The default limit of this quota bucket, as specified by the service
   * configuration.
   * 
   *
   * int64 default_limit = 2;
   *
   * @return The defaultLimit.
   */
  long getDefaultLimit();

  /**
   *
   *
   *    * Producer override on this quota bucket.
   * 
   *
   * .google.api.serviceusage.v1beta1.QuotaOverride producer_override = 3;
   *
   * @return Whether the producerOverride field is set.
   */
  boolean hasProducerOverride();
  /**
   *
   *
   *    * Producer override on this quota bucket.
   * 
   *
   * .google.api.serviceusage.v1beta1.QuotaOverride producer_override = 3;
   *
   * @return The producerOverride.
   */
  com.google.api.serviceusage.v1beta1.QuotaOverride getProducerOverride();
  /**
   *
   *
   *    * Producer override on this quota bucket.
   * 
   *
   * .google.api.serviceusage.v1beta1.QuotaOverride producer_override = 3;
   */
  com.google.api.serviceusage.v1beta1.QuotaOverrideOrBuilder getProducerOverrideOrBuilder();

  /**
   *
   *
   *    * Consumer override on this quota bucket.
   * 
   *
   * .google.api.serviceusage.v1beta1.QuotaOverride consumer_override = 4;
   *
   * @return Whether the consumerOverride field is set.
   */
  boolean hasConsumerOverride();
  /**
   *
   *
   *    * Consumer override on this quota bucket.
   * 
   *
   * .google.api.serviceusage.v1beta1.QuotaOverride consumer_override = 4;
   *
   * @return The consumerOverride.
   */
  com.google.api.serviceusage.v1beta1.QuotaOverride getConsumerOverride();
  /**
   *
   *
   *    * Consumer override on this quota bucket.
   * 
   *
   * .google.api.serviceusage.v1beta1.QuotaOverride consumer_override = 4;
   */
  com.google.api.serviceusage.v1beta1.QuotaOverrideOrBuilder getConsumerOverrideOrBuilder();

  /**
   *
   *
   *    * Admin override on this quota bucket.
   * 
   *
   * .google.api.serviceusage.v1beta1.QuotaOverride admin_override = 5;
   *
   * @return Whether the adminOverride field is set.
   */
  boolean hasAdminOverride();
  /**
   *
   *
   *    * Admin override on this quota bucket.
   * 
   *
   * .google.api.serviceusage.v1beta1.QuotaOverride admin_override = 5;
   *
   * @return The adminOverride.
   */
  com.google.api.serviceusage.v1beta1.QuotaOverride getAdminOverride();
  /**
   *
   *
   *    * Admin override on this quota bucket.
   * 
   *
   * .google.api.serviceusage.v1beta1.QuotaOverride admin_override = 5;
   */
  com.google.api.serviceusage.v1beta1.QuotaOverrideOrBuilder getAdminOverrideOrBuilder();

  /**
   *
   *
   *    * Producer policy inherited from the closet ancestor of the current consumer.
   * 
   *
   * .google.api.serviceusage.v1beta1.ProducerQuotaPolicy producer_quota_policy = 7;
   *
   * @return Whether the producerQuotaPolicy field is set.
   */
  boolean hasProducerQuotaPolicy();
  /**
   *
   *
   *    * Producer policy inherited from the closet ancestor of the current consumer.
   * 
   *
   * .google.api.serviceusage.v1beta1.ProducerQuotaPolicy producer_quota_policy = 7;
   *
   * @return The producerQuotaPolicy.
   */
  com.google.api.serviceusage.v1beta1.ProducerQuotaPolicy getProducerQuotaPolicy();
  /**
   *
   *
   *    * Producer policy inherited from the closet ancestor of the current consumer.
   * 
   *
   * .google.api.serviceusage.v1beta1.ProducerQuotaPolicy producer_quota_policy = 7;
   */
  com.google.api.serviceusage.v1beta1.ProducerQuotaPolicyOrBuilder
      getProducerQuotaPolicyOrBuilder();

  /**
   *
   *
   *    * The dimensions of this quota bucket.
   *
   * If this map is empty, this is the global bucket, which is the default quota
   * value applied to all requests that do not have a more specific override.
   *
   * If this map is nonempty, the default limit, effective limit, and quota
   * overrides apply only to requests that have the dimensions given in the map.
   *
   * For example, if the map has key `region` and value `us-east-1`, then the
   * specified effective limit is only effective in that region, and the
   * specified overrides apply only in that region.
   * 
   *
   * map<string, string> dimensions = 6;
   */
  int getDimensionsCount();
  /**
   *
   *
   *    * The dimensions of this quota bucket.
   *
   * If this map is empty, this is the global bucket, which is the default quota
   * value applied to all requests that do not have a more specific override.
   *
   * If this map is nonempty, the default limit, effective limit, and quota
   * overrides apply only to requests that have the dimensions given in the map.
   *
   * For example, if the map has key `region` and value `us-east-1`, then the
   * specified effective limit is only effective in that region, and the
   * specified overrides apply only in that region.
   * 
   *
   * map<string, string> dimensions = 6;
   */
  boolean containsDimensions(java.lang.String key);
  /** Use {@link #getDimensionsMap()} instead. */
  @java.lang.Deprecated
  java.util.Map getDimensions();
  /**
   *
   *
   *    * The dimensions of this quota bucket.
   *
   * If this map is empty, this is the global bucket, which is the default quota
   * value applied to all requests that do not have a more specific override.
   *
   * If this map is nonempty, the default limit, effective limit, and quota
   * overrides apply only to requests that have the dimensions given in the map.
   *
   * For example, if the map has key `region` and value `us-east-1`, then the
   * specified effective limit is only effective in that region, and the
   * specified overrides apply only in that region.
   * 
   *
   * map<string, string> dimensions = 6;
   */
  java.util.Map getDimensionsMap();
  /**
   *
   *
   *    * The dimensions of this quota bucket.
   *
   * If this map is empty, this is the global bucket, which is the default quota
   * value applied to all requests that do not have a more specific override.
   *
   * If this map is nonempty, the default limit, effective limit, and quota
   * overrides apply only to requests that have the dimensions given in the map.
   *
   * For example, if the map has key `region` and value `us-east-1`, then the
   * specified effective limit is only effective in that region, and the
   * specified overrides apply only in that region.
   * 
   *
   * map<string, string> dimensions = 6;
   */
  /* nullable */
  java.lang.String getDimensionsOrDefault(
      java.lang.String key,
      /* nullable */
      java.lang.String defaultValue);
  /**
   *
   *
   *    * The dimensions of this quota bucket.
   *
   * If this map is empty, this is the global bucket, which is the default quota
   * value applied to all requests that do not have a more specific override.
   *
   * If this map is nonempty, the default limit, effective limit, and quota
   * overrides apply only to requests that have the dimensions given in the map.
   *
   * For example, if the map has key `region` and value `us-east-1`, then the
   * specified effective limit is only effective in that region, and the
   * specified overrides apply only in that region.
   * 
   *
   * map<string, string> dimensions = 6;
   */
  java.lang.String getDimensionsOrThrow(java.lang.String key);
}