Package com.google.api.cloudquotas.v1

Class QuotaInfo

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.api.cloudquotas.v1.QuotaInfo
All Implemented Interfaces:
QuotaInfoOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class QuotaInfo extends com.google.protobuf.GeneratedMessage implements QuotaInfoOrBuilder
 QuotaInfo represents information about a particular quota for a given
 project, folder or organization.
Protobuf type google.api.cloudquotas.v1.QuotaInfo
See Also:

  • Field Details

    • NAME_FIELD_NUMBER

      public static final int NAME_FIELD_NUMBER
      See Also:

    • QUOTA_ID_FIELD_NUMBER

      public static final int QUOTA_ID_FIELD_NUMBER
      See Also:

    • METRIC_FIELD_NUMBER

      public static final int METRIC_FIELD_NUMBER
      See Also:

    • SERVICE_FIELD_NUMBER

      public static final int SERVICE_FIELD_NUMBER
      See Also:

    • IS_PRECISE_FIELD_NUMBER

      public static final int IS_PRECISE_FIELD_NUMBER
      See Also:

    • REFRESH_INTERVAL_FIELD_NUMBER

      public static final int REFRESH_INTERVAL_FIELD_NUMBER
      See Also:

    • CONTAINER_TYPE_FIELD_NUMBER

      public static final int CONTAINER_TYPE_FIELD_NUMBER
      See Also:

    • DIMENSIONS_FIELD_NUMBER

      public static final int DIMENSIONS_FIELD_NUMBER
      See Also:

    • METRIC_DISPLAY_NAME_FIELD_NUMBER

      public static final int METRIC_DISPLAY_NAME_FIELD_NUMBER
      See Also:

    • QUOTA_DISPLAY_NAME_FIELD_NUMBER

      public static final int QUOTA_DISPLAY_NAME_FIELD_NUMBER
      See Also:

    • METRIC_UNIT_FIELD_NUMBER

      public static final int METRIC_UNIT_FIELD_NUMBER
      See Also:

    • QUOTA_INCREASE_ELIGIBILITY_FIELD_NUMBER

      public static final int QUOTA_INCREASE_ELIGIBILITY_FIELD_NUMBER
      See Also:

    • IS_FIXED_FIELD_NUMBER

      public static final int IS_FIXED_FIELD_NUMBER
      See Also:

    • DIMENSIONS_INFOS_FIELD_NUMBER

      public static final int DIMENSIONS_INFOS_FIELD_NUMBER
      See Also:

    • IS_CONCURRENT_FIELD_NUMBER

      public static final int IS_CONCURRENT_FIELD_NUMBER
      See Also:

    • SERVICE_REQUEST_QUOTA_URI_FIELD_NUMBER

      public static final int SERVICE_REQUEST_QUOTA_URI_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • getName

      public String getName()
       Resource name of this QuotaInfo.
 The ID component following "locations/" must be "global".
 Example:
 `projects/123/locations/global/services/compute.googleapis.com/quotaInfos/CpusPerProjectPerRegion`
      string name = 1;
      Specified by:
      getName in interface QuotaInfoOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
       Resource name of this QuotaInfo.
 The ID component following "locations/" must be "global".
 Example:
 `projects/123/locations/global/services/compute.googleapis.com/quotaInfos/CpusPerProjectPerRegion`
      string name = 1;
      Specified by:
      getNameBytes in interface QuotaInfoOrBuilder
      Returns:
      The bytes for name.

    • getQuotaId

      public String getQuotaId()
       The id of the quota, which is unique within the service.
 Example: `CpusPerProjectPerRegion`
      string quota_id = 2;
      Specified by:
      getQuotaId in interface QuotaInfoOrBuilder
      Returns:
      The quotaId.

    • getQuotaIdBytes

      public com.google.protobuf.ByteString getQuotaIdBytes()
       The id of the quota, which is unique within the service.
 Example: `CpusPerProjectPerRegion`
      string quota_id = 2;
      Specified by:
      getQuotaIdBytes in interface QuotaInfoOrBuilder
      Returns:
      The bytes for quotaId.

    • getMetric

      public String getMetric()
       The metric of the quota. It specifies the resources consumption the quota
 is defined for.
 Example: `compute.googleapis.com/cpus`
      string metric = 3;
      Specified by:
      getMetric in interface QuotaInfoOrBuilder
      Returns:
      The metric.

    • getMetricBytes

      public com.google.protobuf.ByteString getMetricBytes()
       The metric of the quota. It specifies the resources consumption the quota
 is defined for.
 Example: `compute.googleapis.com/cpus`
      string metric = 3;
      Specified by:
      getMetricBytes in interface QuotaInfoOrBuilder
      Returns:
      The bytes for metric.

    • getService

      public String getService()
       The name of the service in which the quota is defined.
 Example: `compute.googleapis.com`
      string service = 4;
      Specified by:
      getService in interface QuotaInfoOrBuilder
      Returns:
      The service.

    • getServiceBytes

      public com.google.protobuf.ByteString getServiceBytes()
       The name of the service in which the quota is defined.
 Example: `compute.googleapis.com`
      string service = 4;
      Specified by:
      getServiceBytes in interface QuotaInfoOrBuilder
      Returns:
      The bytes for service.

    • getIsPrecise

      public boolean getIsPrecise()
       Whether this is a precise quota. A precise quota is tracked with absolute
 precision. In contrast, an imprecise quota is not tracked with precision.
      bool is_precise = 5;
      Specified by:
      getIsPrecise in interface QuotaInfoOrBuilder
      Returns:
      The isPrecise.

    • getRefreshInterval

      public String getRefreshInterval()
       The reset time interval for the quota. Refresh interval applies to rate
 quota only.
 Example: "minute" for per minute, "day" for per day, or "10 seconds" for
 every 10 seconds.
      string refresh_interval = 6;
      Specified by:
      getRefreshInterval in interface QuotaInfoOrBuilder
      Returns:
      The refreshInterval.

    • getRefreshIntervalBytes

      public com.google.protobuf.ByteString getRefreshIntervalBytes()
       The reset time interval for the quota. Refresh interval applies to rate
 quota only.
 Example: "minute" for per minute, "day" for per day, or "10 seconds" for
 every 10 seconds.
      string refresh_interval = 6;
      Specified by:
      getRefreshIntervalBytes in interface QuotaInfoOrBuilder
      Returns:
      The bytes for refreshInterval.

    • getContainerTypeValue

      public int getContainerTypeValue()
       The container type of the QuotaInfo.
      .google.api.cloudquotas.v1.QuotaInfo.ContainerType container_type = 7;
      Specified by:
      getContainerTypeValue in interface QuotaInfoOrBuilder
      Returns:
      The enum numeric value on the wire for containerType.

    • getContainerType

      public QuotaInfo.ContainerType getContainerType()
       The container type of the QuotaInfo.
      .google.api.cloudquotas.v1.QuotaInfo.ContainerType container_type = 7;
      Specified by:
      getContainerType in interface QuotaInfoOrBuilder
      Returns:
      The containerType.

    • getDimensionsList

      public com.google.protobuf.ProtocolStringList getDimensionsList()
       The dimensions the quota is defined on.
      repeated string dimensions = 8;
      Specified by:
      getDimensionsList in interface QuotaInfoOrBuilder
      Returns:
      A list containing the dimensions.

    • getDimensionsCount

      public int getDimensionsCount()
       The dimensions the quota is defined on.
      repeated string dimensions = 8;
      Specified by:
      getDimensionsCount in interface QuotaInfoOrBuilder
      Returns:
      The count of dimensions.

    • getDimensions

      public String getDimensions(int index)
       The dimensions the quota is defined on.
      repeated string dimensions = 8;
      Specified by:
      getDimensions in interface QuotaInfoOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The dimensions at the given index.

    • getDimensionsBytes

      public com.google.protobuf.ByteString getDimensionsBytes(int index)
       The dimensions the quota is defined on.
      repeated string dimensions = 8;
      Specified by:
      getDimensionsBytes in interface QuotaInfoOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the dimensions at the given index.

    • getMetricDisplayName

      public String getMetricDisplayName()
       The display name of the quota metric
      string metric_display_name = 9;
      Specified by:
      getMetricDisplayName in interface QuotaInfoOrBuilder
      Returns:
      The metricDisplayName.

    • getMetricDisplayNameBytes

      public com.google.protobuf.ByteString getMetricDisplayNameBytes()
       The display name of the quota metric
      string metric_display_name = 9;
      Specified by:
      getMetricDisplayNameBytes in interface QuotaInfoOrBuilder
      Returns:
      The bytes for metricDisplayName.

    • getQuotaDisplayName

      public String getQuotaDisplayName()
       The display name of the quota.
      string quota_display_name = 10;
      Specified by:
      getQuotaDisplayName in interface QuotaInfoOrBuilder
      Returns:
      The quotaDisplayName.

    • getQuotaDisplayNameBytes

      public com.google.protobuf.ByteString getQuotaDisplayNameBytes()
       The display name of the quota.
      string quota_display_name = 10;
      Specified by:
      getQuotaDisplayNameBytes in interface QuotaInfoOrBuilder
      Returns:
      The bytes for quotaDisplayName.

    • getMetricUnit

      public String getMetricUnit()
       The unit in which the metric value is reported, e.g., "MByte".
      string metric_unit = 11;
      Specified by:
      getMetricUnit in interface QuotaInfoOrBuilder
      Returns:
      The metricUnit.

    • getMetricUnitBytes

      public com.google.protobuf.ByteString getMetricUnitBytes()
       The unit in which the metric value is reported, e.g., "MByte".
      string metric_unit = 11;
      Specified by:
      getMetricUnitBytes in interface QuotaInfoOrBuilder
      Returns:
      The bytes for metricUnit.

    • hasQuotaIncreaseEligibility

      public boolean hasQuotaIncreaseEligibility()
       Whether it is eligible to request a higher quota value for this quota.
      .google.api.cloudquotas.v1.QuotaIncreaseEligibility quota_increase_eligibility = 12;
      Specified by:
      hasQuotaIncreaseEligibility in interface QuotaInfoOrBuilder
      Returns:
      Whether the quotaIncreaseEligibility field is set.

    • getQuotaIncreaseEligibility

      public QuotaIncreaseEligibility getQuotaIncreaseEligibility()
       Whether it is eligible to request a higher quota value for this quota.
      .google.api.cloudquotas.v1.QuotaIncreaseEligibility quota_increase_eligibility = 12;
      Specified by:
      getQuotaIncreaseEligibility in interface QuotaInfoOrBuilder
      Returns:
      The quotaIncreaseEligibility.

    • getQuotaIncreaseEligibilityOrBuilder

      public QuotaIncreaseEligibilityOrBuilder getQuotaIncreaseEligibilityOrBuilder()
       Whether it is eligible to request a higher quota value for this quota.
      .google.api.cloudquotas.v1.QuotaIncreaseEligibility quota_increase_eligibility = 12;
      Specified by:
      getQuotaIncreaseEligibilityOrBuilder in interface QuotaInfoOrBuilder

    • getIsFixed

      public boolean getIsFixed()
       Whether the quota value is fixed or adjustable
      bool is_fixed = 13;
      Specified by:
      getIsFixed in interface QuotaInfoOrBuilder
      Returns:
      The isFixed.

    • getDimensionsInfosList

      public List<DimensionsInfo> getDimensionsInfosList()
       The collection of dimensions info ordered by their dimensions from more
 specific ones to less specific ones.
      repeated .google.api.cloudquotas.v1.DimensionsInfo dimensions_infos = 14;
      Specified by:
      getDimensionsInfosList in interface QuotaInfoOrBuilder

    • getDimensionsInfosOrBuilderList

      public List<? extends DimensionsInfoOrBuilder> getDimensionsInfosOrBuilderList()
       The collection of dimensions info ordered by their dimensions from more
 specific ones to less specific ones.
      repeated .google.api.cloudquotas.v1.DimensionsInfo dimensions_infos = 14;
      Specified by:
      getDimensionsInfosOrBuilderList in interface QuotaInfoOrBuilder

    • getDimensionsInfosCount

      public int getDimensionsInfosCount()
       The collection of dimensions info ordered by their dimensions from more
 specific ones to less specific ones.
      repeated .google.api.cloudquotas.v1.DimensionsInfo dimensions_infos = 14;
      Specified by:
      getDimensionsInfosCount in interface QuotaInfoOrBuilder

    • getDimensionsInfos

      public DimensionsInfo getDimensionsInfos(int index)
       The collection of dimensions info ordered by their dimensions from more
 specific ones to less specific ones.
      repeated .google.api.cloudquotas.v1.DimensionsInfo dimensions_infos = 14;
      Specified by:
      getDimensionsInfos in interface QuotaInfoOrBuilder

    • getDimensionsInfosOrBuilder

      public DimensionsInfoOrBuilder getDimensionsInfosOrBuilder(int index)
       The collection of dimensions info ordered by their dimensions from more
 specific ones to less specific ones.
      repeated .google.api.cloudquotas.v1.DimensionsInfo dimensions_infos = 14;
      Specified by:
      getDimensionsInfosOrBuilder in interface QuotaInfoOrBuilder

    • getIsConcurrent

      public boolean getIsConcurrent()
       Whether the quota is a concurrent quota. Concurrent quotas are enforced
 on the total number of concurrent operations in flight at any given time.
      bool is_concurrent = 15;
      Specified by:
      getIsConcurrent in interface QuotaInfoOrBuilder
      Returns:
      The isConcurrent.

    • getServiceRequestQuotaUri

      public String getServiceRequestQuotaUri()
       URI to the page where users can request more quota for the cloud
 service—for example,
 https://console.cloud.google.com/iam-admin/quotas.
      string service_request_quota_uri = 17;
      Specified by:
      getServiceRequestQuotaUri in interface QuotaInfoOrBuilder
      Returns:
      The serviceRequestQuotaUri.

    • getServiceRequestQuotaUriBytes

      public com.google.protobuf.ByteString getServiceRequestQuotaUriBytes()
       URI to the page where users can request more quota for the cloud
 service—for example,
 https://console.cloud.google.com/iam-admin/quotas.
      string service_request_quota_uri = 17;
      Specified by:
      getServiceRequestQuotaUriBytes in interface QuotaInfoOrBuilder
      Returns:
      The bytes for serviceRequestQuotaUri.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static QuotaInfo parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static QuotaInfo parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static QuotaInfo parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static QuotaInfo parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static QuotaInfo parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static QuotaInfo parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static QuotaInfo parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static QuotaInfo parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static QuotaInfo parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static QuotaInfo parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static QuotaInfo parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static QuotaInfo parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public QuotaInfo.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static QuotaInfo.Builder newBuilder()

    • newBuilder

      public static QuotaInfo.Builder newBuilder(QuotaInfo prototype)

    • toBuilder

      public QuotaInfo.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected QuotaInfo.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static QuotaInfo getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<QuotaInfo> parser()

    • getParserForType

      public com.google.protobuf.Parser<QuotaInfo> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public QuotaInfo getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder