com.google.api.servicecontrol.v1

Class QuotaOperation

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessage

com.google.api.servicecontrol.v1.QuotaOperation

All Implemented Interfaces:

QuotaOperationOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.io.Serializable

public final class QuotaOperation
extends com.google.protobuf.GeneratedMessage
implements QuotaOperationOrBuilder

 Represents information regarding a quota operation.
 

Protobuf type google.api.servicecontrol.v1.QuotaOperation

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	QuotaOperation.Builder Represents information regarding a quota operation.
static class	QuotaOperation.QuotaMode Supported quota modes.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

com.google.protobuf.GeneratedMessage.BuilderParent, com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessage.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessage.ExtendableMessage>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessage.ExtendableMessage>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingType extends com.google.protobuf.Message,Type>

Field Summary

Fields

Modifier and Type	Field and Description
static int	CONSUMER_ID_FIELD_NUMBER
static int	LABELS_FIELD_NUMBER
static int	METHOD_NAME_FIELD_NUMBER
static int	OPERATION_ID_FIELD_NUMBER
static int	QUOTA_METRICS_FIELD_NUMBER
static int	QUOTA_MODE_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessage

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	containsLabels(java.lang.String key) Labels describing the operation.
boolean	equals(java.lang.Object obj)
java.lang.String	getConsumerId() Identity of the consumer for whom this quota operation is being performed.
com.google.protobuf.ByteString	getConsumerIdBytes() Identity of the consumer for whom this quota operation is being performed.
static QuotaOperation	getDefaultInstance()
QuotaOperation	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
java.util.Map<java.lang.String,java.lang.String>	getLabels() Deprecated.
int	getLabelsCount() Labels describing the operation.
java.util.Map<java.lang.String,java.lang.String>	getLabelsMap() Labels describing the operation.
java.lang.String	getLabelsOrDefault(java.lang.String key, java.lang.String defaultValue) Labels describing the operation.
java.lang.String	getLabelsOrThrow(java.lang.String key) Labels describing the operation.
java.lang.String	getMethodName() Fully qualified name of the API method for which this quota operation is requested.
com.google.protobuf.ByteString	getMethodNameBytes() Fully qualified name of the API method for which this quota operation is requested.
java.lang.String	getOperationId() Identity of the operation.
com.google.protobuf.ByteString	getOperationIdBytes() Identity of the operation.
com.google.protobuf.Parser<QuotaOperation>	getParserForType()
MetricValueSet	getQuotaMetrics(int index) Represents information about this operation.
int	getQuotaMetricsCount() Represents information about this operation.
java.util.List<MetricValueSet>	getQuotaMetricsList() Represents information about this operation.
MetricValueSetOrBuilder	getQuotaMetricsOrBuilder(int index) Represents information about this operation.
java.util.List<? extends MetricValueSetOrBuilder>	getQuotaMetricsOrBuilderList() Represents information about this operation.
QuotaOperation.QuotaMode	getQuotaMode() Quota mode for this operation.
int	getQuotaModeValue() Quota mode for this operation.
int	getSerializedSize()
com.google.protobuf.UnknownFieldSet	getUnknownFields()
int	hashCode()
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable	internalGetFieldAccessorTable()
protected com.google.protobuf.MapField	internalGetMapField(int number)
boolean	isInitialized()
static QuotaOperation.Builder	newBuilder()
static QuotaOperation.Builder	newBuilder(QuotaOperation prototype)
QuotaOperation.Builder	newBuilderForType()
protected QuotaOperation.Builder	newBuilderForType(com.google.protobuf.GeneratedMessage.BuilderParent parent)
static QuotaOperation	parseDelimitedFrom(java.io.InputStream input)
static QuotaOperation	parseDelimitedFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static QuotaOperation	parseFrom(byte[] data)
static QuotaOperation	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static QuotaOperation	parseFrom(com.google.protobuf.ByteString data)
static QuotaOperation	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static QuotaOperation	parseFrom(com.google.protobuf.CodedInputStream input)
static QuotaOperation	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static QuotaOperation	parseFrom(java.io.InputStream input)
static QuotaOperation	parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<QuotaOperation>	parser()
QuotaOperation.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessage

computeStringSize, computeStringSizeNoTag, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, makeExtensionsImmutable, newBuilderForType, newFileScopedGeneratedExtension, newFileScopedGeneratedExtension, newMessageScopedGeneratedExtension, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

OPERATION_ID_FIELD_NUMBER

public static final int OPERATION_ID_FIELD_NUMBER

See Also:

Constant Field Values

METHOD_NAME_FIELD_NUMBER

public static final int METHOD_NAME_FIELD_NUMBER

See Also:

Constant Field Values

CONSUMER_ID_FIELD_NUMBER

public static final int CONSUMER_ID_FIELD_NUMBER

See Also:

Constant Field Values

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER

See Also:

Constant Field Values

QUOTA_METRICS_FIELD_NUMBER

public static final int QUOTA_METRICS_FIELD_NUMBER

See Also:

Constant Field Values

QUOTA_MODE_FIELD_NUMBER

public static final int QUOTA_MODE_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessage

getDescriptor

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

internalGetMapField

protected com.google.protobuf.MapField internalGetMapField(int number)

Overrides:

internalGetMapField in class com.google.protobuf.GeneratedMessage

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

getOperationId

public java.lang.String getOperationId()

 Identity of the operation. This must be unique within the scope of the
 service that generated the operation. If the service calls AllocateQuota
 and ReleaseQuota on the same operation, the two calls should carry the
 same ID.
 UUID version 4 is recommended, though not required. In scenarios where an
 operation is computed from existing information and an idempotent id is
 desirable for deduplication purpose, UUID version 5 is recommended. See
 RFC 4122 for details.
 

optional string operation_id = 1;

Specified by:

getOperationId in interface QuotaOperationOrBuilder

getOperationIdBytes

public com.google.protobuf.ByteString getOperationIdBytes()

 Identity of the operation. This must be unique within the scope of the
 service that generated the operation. If the service calls AllocateQuota
 and ReleaseQuota on the same operation, the two calls should carry the
 same ID.
 UUID version 4 is recommended, though not required. In scenarios where an
 operation is computed from existing information and an idempotent id is
 desirable for deduplication purpose, UUID version 5 is recommended. See
 RFC 4122 for details.
 

optional string operation_id = 1;

Specified by:

getOperationIdBytes in interface QuotaOperationOrBuilder

getMethodName

public java.lang.String getMethodName()

 Fully qualified name of the API method for which this quota operation is
 requested. This name is used for matching quota rules or metric rules and
 billing status rules defined in service configuration. This field is not
 required if the quota operation is performed on non-API resources.
 Example of an RPC method name:
     google.example.library.v1.LibraryService.CreateShelf
 

optional string method_name = 2;

Specified by:

getMethodName in interface QuotaOperationOrBuilder

getMethodNameBytes

public com.google.protobuf.ByteString getMethodNameBytes()

 Fully qualified name of the API method for which this quota operation is
 requested. This name is used for matching quota rules or metric rules and
 billing status rules defined in service configuration. This field is not
 required if the quota operation is performed on non-API resources.
 Example of an RPC method name:
     google.example.library.v1.LibraryService.CreateShelf
 

optional string method_name = 2;

Specified by:

getMethodNameBytes in interface QuotaOperationOrBuilder

getConsumerId

public java.lang.String getConsumerId()

 Identity of the consumer for whom this quota operation is being performed.
 This can be in one of the following formats:
   project:<project_id>,
   project_number:<project_number>,
   api_key:<api_key>.
 (--GOOGLE_INTERNAL:
   spatula_header:<spatula_header> and
   loas:<loas_role> are also accepted.
 --)
 

optional string consumer_id = 3;

Specified by:

getConsumerId in interface QuotaOperationOrBuilder

getConsumerIdBytes

public com.google.protobuf.ByteString getConsumerIdBytes()

 Identity of the consumer for whom this quota operation is being performed.
 This can be in one of the following formats:
   project:<project_id>,
   project_number:<project_number>,
   api_key:<api_key>.
 (--GOOGLE_INTERNAL:
   spatula_header:<spatula_header> and
   loas:<loas_role> are also accepted.
 --)
 

optional string consumer_id = 3;

Specified by:

getConsumerIdBytes in interface QuotaOperationOrBuilder

getLabelsCount

public int getLabelsCount()

Description copied from interface: QuotaOperationOrBuilder

 Labels describing the operation.
 

map<string, string> labels = 4;

Specified by:

getLabelsCount in interface QuotaOperationOrBuilder

containsLabels

public boolean containsLabels(java.lang.String key)

 Labels describing the operation.
 

map<string, string> labels = 4;

Specified by:

containsLabels in interface QuotaOperationOrBuilder

getLabels

@Deprecated
public java.util.Map<java.lang.String,java.lang.String> getLabels()

Deprecated.

Use getLabelsMap() instead.

Specified by:

getLabels in interface QuotaOperationOrBuilder

getLabelsMap

public java.util.Map<java.lang.String,java.lang.String> getLabelsMap()

 Labels describing the operation.
 

map<string, string> labels = 4;

Specified by:

getLabelsMap in interface QuotaOperationOrBuilder

getLabelsOrDefault

public java.lang.String getLabelsOrDefault(java.lang.String key,
                                           java.lang.String defaultValue)

 Labels describing the operation.
 

map<string, string> labels = 4;

Specified by:

getLabelsOrDefault in interface QuotaOperationOrBuilder

getLabelsOrThrow

public java.lang.String getLabelsOrThrow(java.lang.String key)

 Labels describing the operation.
 

map<string, string> labels = 4;

Specified by:

getLabelsOrThrow in interface QuotaOperationOrBuilder

getQuotaMetricsList

public java.util.List<MetricValueSet> getQuotaMetricsList()

 Represents information about this operation. Each MetricValueSet
 corresponds to a metric defined in the service configuration.
 The data type used in the MetricValueSet must agree with
 the data type specified in the metric definition.
 Within a single operation, it is not allowed to have more than one
 MetricValue instances that have the same metric names and identical
 label value combinations. If a request has such duplicated MetricValue
 instances, the entire request is rejected with
 an invalid argument error.
 

repeated .google.api.servicecontrol.v1.MetricValueSet quota_metrics = 5;

Specified by:

getQuotaMetricsList in interface QuotaOperationOrBuilder

getQuotaMetricsOrBuilderList

public java.util.List<? extends MetricValueSetOrBuilder> getQuotaMetricsOrBuilderList()

 Represents information about this operation. Each MetricValueSet
 corresponds to a metric defined in the service configuration.
 The data type used in the MetricValueSet must agree with
 the data type specified in the metric definition.
 Within a single operation, it is not allowed to have more than one
 MetricValue instances that have the same metric names and identical
 label value combinations. If a request has such duplicated MetricValue
 instances, the entire request is rejected with
 an invalid argument error.
 

repeated .google.api.servicecontrol.v1.MetricValueSet quota_metrics = 5;

Specified by:

getQuotaMetricsOrBuilderList in interface QuotaOperationOrBuilder

getQuotaMetricsCount

public int getQuotaMetricsCount()

 Represents information about this operation. Each MetricValueSet
 corresponds to a metric defined in the service configuration.
 The data type used in the MetricValueSet must agree with
 the data type specified in the metric definition.
 Within a single operation, it is not allowed to have more than one
 MetricValue instances that have the same metric names and identical
 label value combinations. If a request has such duplicated MetricValue
 instances, the entire request is rejected with
 an invalid argument error.
 

repeated .google.api.servicecontrol.v1.MetricValueSet quota_metrics = 5;

Specified by:

getQuotaMetricsCount in interface QuotaOperationOrBuilder

getQuotaMetrics

public MetricValueSet getQuotaMetrics(int index)

 Represents information about this operation. Each MetricValueSet
 corresponds to a metric defined in the service configuration.
 The data type used in the MetricValueSet must agree with
 the data type specified in the metric definition.
 Within a single operation, it is not allowed to have more than one
 MetricValue instances that have the same metric names and identical
 label value combinations. If a request has such duplicated MetricValue
 instances, the entire request is rejected with
 an invalid argument error.
 

repeated .google.api.servicecontrol.v1.MetricValueSet quota_metrics = 5;

Specified by:

getQuotaMetrics in interface QuotaOperationOrBuilder

getQuotaMetricsOrBuilder

public MetricValueSetOrBuilder getQuotaMetricsOrBuilder(int index)

 Represents information about this operation. Each MetricValueSet
 corresponds to a metric defined in the service configuration.
 The data type used in the MetricValueSet must agree with
 the data type specified in the metric definition.
 Within a single operation, it is not allowed to have more than one
 MetricValue instances that have the same metric names and identical
 label value combinations. If a request has such duplicated MetricValue
 instances, the entire request is rejected with
 an invalid argument error.
 

repeated .google.api.servicecontrol.v1.MetricValueSet quota_metrics = 5;

Specified by:

getQuotaMetricsOrBuilder in interface QuotaOperationOrBuilder

getQuotaModeValue

public int getQuotaModeValue()

 Quota mode for this operation.
 

optional .google.api.servicecontrol.v1.QuotaOperation.QuotaMode quota_mode = 6;

Specified by:

getQuotaModeValue in interface QuotaOperationOrBuilder

getQuotaMode

public QuotaOperation.QuotaMode getQuotaMode()

 Quota mode for this operation.
 

optional .google.api.servicecontrol.v1.QuotaOperation.QuotaMode quota_mode = 6;

Specified by:

getQuotaMode in interface QuotaOperationOrBuilder

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 java.io.IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessage

Throws:

java.io.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(java.lang.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 QuotaOperation parseFrom(com.google.protobuf.ByteString data)
                                throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static QuotaOperation parseFrom(byte[] data)
                                throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static QuotaOperation parseFrom(java.io.InputStream input)
                                throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static QuotaOperation parseFrom(java.io.InputStream input,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws java.io.IOException

Throws:

java.io.IOException

parseDelimitedFrom

public static QuotaOperation parseDelimitedFrom(java.io.InputStream input)
                                         throws java.io.IOException

Throws:

java.io.IOException

parseDelimitedFrom

public static QuotaOperation parseDelimitedFrom(java.io.InputStream input,
                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                         throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static QuotaOperation parseFrom(com.google.protobuf.CodedInputStream input)
                                throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static QuotaOperation parseFrom(com.google.protobuf.CodedInputStream input,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws java.io.IOException

Throws:

java.io.IOException

newBuilderForType

public QuotaOperation.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static QuotaOperation.Builder newBuilder()

newBuilder

public static QuotaOperation.Builder newBuilder(QuotaOperation prototype)

toBuilder

public QuotaOperation.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected QuotaOperation.Builder newBuilderForType(com.google.protobuf.GeneratedMessage.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessage

getDefaultInstance

public static QuotaOperation getDefaultInstance()

parser

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

getParserForType

public com.google.protobuf.Parser<QuotaOperation> 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 QuotaOperation getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder