Class QuotaInfo (0.3.0)

public final class QuotaInfo extends GeneratedMessageV3 implements QuotaInfoOrBuilder

QuotaInfo represents information about a particular quota for a given project, folder or organization.

Protobuf type google.api.cloudquotas.v1.QuotaInfo

Implements

QuotaInfoOrBuilder

Static Fields

CONTAINER_TYPE_FIELD_NUMBER

public static final int CONTAINER_TYPE_FIELD_NUMBER
Field Value
TypeDescription
int

DIMENSIONS_FIELD_NUMBER

public static final int DIMENSIONS_FIELD_NUMBER
Field Value
TypeDescription
int

DIMENSIONS_INFOS_FIELD_NUMBER

public static final int DIMENSIONS_INFOS_FIELD_NUMBER
Field Value
TypeDescription
int

IS_CONCURRENT_FIELD_NUMBER

public static final int IS_CONCURRENT_FIELD_NUMBER
Field Value
TypeDescription
int

IS_FIXED_FIELD_NUMBER

public static final int IS_FIXED_FIELD_NUMBER
Field Value
TypeDescription
int

IS_PRECISE_FIELD_NUMBER

public static final int IS_PRECISE_FIELD_NUMBER
Field Value
TypeDescription
int

METRIC_DISPLAY_NAME_FIELD_NUMBER

public static final int METRIC_DISPLAY_NAME_FIELD_NUMBER
Field Value
TypeDescription
int

METRIC_FIELD_NUMBER

public static final int METRIC_FIELD_NUMBER
Field Value
TypeDescription
int

METRIC_UNIT_FIELD_NUMBER

public static final int METRIC_UNIT_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

QUOTA_DISPLAY_NAME_FIELD_NUMBER

public static final int QUOTA_DISPLAY_NAME_FIELD_NUMBER
Field Value
TypeDescription
int

QUOTA_ID_FIELD_NUMBER

public static final int QUOTA_ID_FIELD_NUMBER
Field Value
TypeDescription
int

QUOTA_INCREASE_ELIGIBILITY_FIELD_NUMBER

public static final int QUOTA_INCREASE_ELIGIBILITY_FIELD_NUMBER
Field Value
TypeDescription
int

REFRESH_INTERVAL_FIELD_NUMBER

public static final int REFRESH_INTERVAL_FIELD_NUMBER
Field Value
TypeDescription
int

SERVICE_FIELD_NUMBER

public static final int SERVICE_FIELD_NUMBER
Field Value
TypeDescription
int

SERVICE_REQUEST_QUOTA_URI_FIELD_NUMBER

public static final int SERVICE_REQUEST_QUOTA_URI_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static QuotaInfo getDefaultInstance()
Returns
TypeDescription
QuotaInfo

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static QuotaInfo.Builder newBuilder()
Returns
TypeDescription
QuotaInfo.Builder

newBuilder(QuotaInfo prototype)

public static QuotaInfo.Builder newBuilder(QuotaInfo prototype)
Parameter
NameDescription
prototypeQuotaInfo
Returns
TypeDescription
QuotaInfo.Builder

parseDelimitedFrom(InputStream input)

public static QuotaInfo parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
QuotaInfo
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static QuotaInfo parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
QuotaInfo
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static QuotaInfo parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
QuotaInfo
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static QuotaInfo parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
QuotaInfo
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static QuotaInfo parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
QuotaInfo
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static QuotaInfo parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
QuotaInfo
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static QuotaInfo parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
QuotaInfo
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static QuotaInfo parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
QuotaInfo
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static QuotaInfo parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
QuotaInfo
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static QuotaInfo parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
QuotaInfo
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static QuotaInfo parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
QuotaInfo
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static QuotaInfo parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
QuotaInfo
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<QuotaInfo> parser()
Returns
TypeDescription
Parser<QuotaInfo>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getContainerType()

public QuotaInfo.ContainerType getContainerType()

The container type of the QuotaInfo.

.google.api.cloudquotas.v1.QuotaInfo.ContainerType container_type = 7;

Returns
TypeDescription
QuotaInfo.ContainerType

The containerType.

getContainerTypeValue()

public int getContainerTypeValue()

The container type of the QuotaInfo.

.google.api.cloudquotas.v1.QuotaInfo.ContainerType container_type = 7;

Returns
TypeDescription
int

The enum numeric value on the wire for containerType.

getDefaultInstanceForType()

public QuotaInfo getDefaultInstanceForType()
Returns
TypeDescription
QuotaInfo

getDimensions(int index)

public String getDimensions(int index)

The dimensions the quota is defined on.

repeated string dimensions = 8;

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The dimensions at the given index.

getDimensionsBytes(int index)

public ByteString getDimensionsBytes(int index)

The dimensions the quota is defined on.

repeated string dimensions = 8;

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the dimensions at the given index.

getDimensionsCount()

public int getDimensionsCount()

The dimensions the quota is defined on.

repeated string dimensions = 8;

Returns
TypeDescription
int

The count of dimensions.

getDimensionsInfos(int index)

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;

Parameter
NameDescription
indexint
Returns
TypeDescription
DimensionsInfo

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;

Returns
TypeDescription
int

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;

Returns
TypeDescription
List<DimensionsInfo>

getDimensionsInfosOrBuilder(int index)

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;

Parameter
NameDescription
indexint
Returns
TypeDescription
DimensionsInfoOrBuilder

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;

Returns
TypeDescription
List<? extends com.google.api.cloudquotas.v1.DimensionsInfoOrBuilder>

getDimensionsList()

public ProtocolStringList getDimensionsList()

The dimensions the quota is defined on.

repeated string dimensions = 8;

Returns
TypeDescription
ProtocolStringList

A list containing the dimensions.

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;

Returns
TypeDescription
boolean

The isConcurrent.

getIsFixed()

public boolean getIsFixed()

Whether the quota value is fixed or adjustable

bool is_fixed = 13;

Returns
TypeDescription
boolean

The isFixed.

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;

Returns
TypeDescription
boolean

The isPrecise.

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;

Returns
TypeDescription
String

The metric.

getMetricBytes()

public 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;

Returns
TypeDescription
ByteString

The bytes for metric.

getMetricDisplayName()

public String getMetricDisplayName()

The display name of the quota metric

string metric_display_name = 9;

Returns
TypeDescription
String

The metricDisplayName.

getMetricDisplayNameBytes()

public ByteString getMetricDisplayNameBytes()

The display name of the quota metric

string metric_display_name = 9;

Returns
TypeDescription
ByteString

The bytes for metricDisplayName.

getMetricUnit()

public String getMetricUnit()

The unit in which the metric value is reported, e.g., "MByte".

string metric_unit = 11;

Returns
TypeDescription
String

The metricUnit.

getMetricUnitBytes()

public ByteString getMetricUnitBytes()

The unit in which the metric value is reported, e.g., "MByte".

string metric_unit = 11;

Returns
TypeDescription
ByteString

The bytes for metricUnit.

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;

Returns
TypeDescription
String

The name.

getNameBytes()

public 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;

Returns
TypeDescription
ByteString

The bytes for name.

getParserForType()

public Parser<QuotaInfo> getParserForType()
Returns
TypeDescription
Parser<QuotaInfo>
Overrides

getQuotaDisplayName()

public String getQuotaDisplayName()

The display name of the quota.

string quota_display_name = 10;

Returns
TypeDescription
String

The quotaDisplayName.

getQuotaDisplayNameBytes()

public ByteString getQuotaDisplayNameBytes()

The display name of the quota.

string quota_display_name = 10;

Returns
TypeDescription
ByteString

The bytes for quotaDisplayName.

getQuotaId()

public String getQuotaId()

The id of the quota, which is unquie within the service. Example: CpusPerProjectPerRegion

string quota_id = 2;

Returns
TypeDescription
String

The quotaId.

getQuotaIdBytes()

public ByteString getQuotaIdBytes()

The id of the quota, which is unquie within the service. Example: CpusPerProjectPerRegion

string quota_id = 2;

Returns
TypeDescription
ByteString

The bytes for quotaId.

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;

Returns
TypeDescription
QuotaIncreaseEligibility

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;

Returns
TypeDescription
QuotaIncreaseEligibilityOrBuilder

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;

Returns
TypeDescription
String

The refreshInterval.

getRefreshIntervalBytes()

public 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;

Returns
TypeDescription
ByteString

The bytes for refreshInterval.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getService()

public String getService()

The name of the service in which the quota is defined. Example: compute.googleapis.com

string service = 4;

Returns
TypeDescription
String

The service.

getServiceBytes()

public ByteString getServiceBytes()

The name of the service in which the quota is defined. Example: compute.googleapis.com

string service = 4;

Returns
TypeDescription
ByteString

The bytes for service.

getServiceRequestQuotaUri()

public String getServiceRequestQuotaUri()

URI to the page where the user can request more quotas for the cloud service, such as https://docs.google.com/spreadsheet/viewform?formkey=abc123&entry_0={email}&entry_1={id}. Google Developers Console UI replace {email} with the current user's e-mail, {id} with the current project number, or organization ID with "organizations/" prefix. For example, https://docs.google.com/spreadsheet/viewform?formkey=abc123&entry_0=johndoe@gmail.com&entry_1=25463754, or https://docs.google.com/spreadsheet/viewform?formkey=abc123&entry_0=johndoe@gmail.com&entry_1=organizations/26474422.

string service_request_quota_uri = 17;

Returns
TypeDescription
String

The serviceRequestQuotaUri.

getServiceRequestQuotaUriBytes()

public ByteString getServiceRequestQuotaUriBytes()

URI to the page where the user can request more quotas for the cloud service, such as https://docs.google.com/spreadsheet/viewform?formkey=abc123&entry_0={email}&entry_1={id}. Google Developers Console UI replace {email} with the current user's e-mail, {id} with the current project number, or organization ID with "organizations/" prefix. For example, https://docs.google.com/spreadsheet/viewform?formkey=abc123&entry_0=johndoe@gmail.com&entry_1=25463754, or https://docs.google.com/spreadsheet/viewform?formkey=abc123&entry_0=johndoe@gmail.com&entry_1=organizations/26474422.

string service_request_quota_uri = 17;

Returns
TypeDescription
ByteString

The bytes for serviceRequestQuotaUri.

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;

Returns
TypeDescription
boolean

Whether the quotaIncreaseEligibility field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public QuotaInfo.Builder newBuilderForType()
Returns
TypeDescription
QuotaInfo.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected QuotaInfo.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
QuotaInfo.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public QuotaInfo.Builder toBuilder()
Returns
TypeDescription
QuotaInfo.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException