com.google.api.servicecontrol.v1

Enum QuotaOperation.QuotaMode

java.lang.Object

java.lang.Enum<QuotaOperation.QuotaMode>

com.google.api.servicecontrol.v1.QuotaOperation.QuotaMode

All Implemented Interfaces:

com.google.protobuf.Internal.EnumLite, com.google.protobuf.ProtocolMessageEnum, java.io.Serializable, java.lang.Comparable<QuotaOperation.QuotaMode>

Enclosing class:

QuotaOperation

public static enum QuotaOperation.QuotaMode
extends java.lang.Enum<QuotaOperation.QuotaMode>
implements com.google.protobuf.ProtocolMessageEnum

 Supported quota modes. This can be specified only when the operation is
 associated with a AllocateQuota and ReleaseQuota request.
 

Protobuf enum google.api.servicecontrol.v1.QuotaOperation.QuotaMode

Enum Constant Summary

Enum Constants

Enum Constant and Description
BEST_EFFORT For AllocateQuota request, this mode is supported only for imprecise quota limits.
CHECK_ONLY For AllocateQuota request, only checks if there is enough quota available and does not change the available quota.
NORMAL For AllocateQuota request, allocates quota for the amount specified in the service configuration or specified using the quota metrics.
UNRECOGNIZED
UNSPECIFIED UNSPECIFIED = 0;

Field Summary

Fields

Modifier and Type	Field and Description
static int	BEST_EFFORT_VALUE For AllocateQuota request, this mode is supported only for imprecise quota limits.
static int	CHECK_ONLY_VALUE For AllocateQuota request, only checks if there is enough quota available and does not change the available quota.
static int	NORMAL_VALUE For AllocateQuota request, allocates quota for the amount specified in the service configuration or specified using the quota metrics.
static int	UNSPECIFIED_VALUE UNSPECIFIED = 0;

Method Summary

Modifier and Type	Method and Description
static QuotaOperation.QuotaMode	forNumber(int value)
static com.google.protobuf.Descriptors.EnumDescriptor	getDescriptor()
com.google.protobuf.Descriptors.EnumDescriptor	getDescriptorForType()
int	getNumber()
com.google.protobuf.Descriptors.EnumValueDescriptor	getValueDescriptor()
static com.google.protobuf.Internal.EnumLiteMap<QuotaOperation.QuotaMode>	internalGetValueMap()
static QuotaOperation.QuotaMode	valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc)
static QuotaOperation.QuotaMode	valueOf(int value) Deprecated. Use forNumber(int) instead.
static QuotaOperation.QuotaMode	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static QuotaOperation.QuotaMode[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

UNSPECIFIED

public static final QuotaOperation.QuotaMode UNSPECIFIED

UNSPECIFIED = 0;

NORMAL

public static final QuotaOperation.QuotaMode NORMAL

 For AllocateQuota request, allocates quota for the amount specified in
 the service configuration or specified using the quota metrics. If the
 amount is higher than the available quota, allocation error will be
 returned and no quota will be allocated.
 For ReleaseQuota request, this mode is supported only for precise quota
 limits. In this case, this operation releases quota for the amount
 specified in the service configuration or specified using the quota
 metrics. If the release can make available quota negative, release error
 will be returned and no quota will be released.
 

NORMAL = 1;

BEST_EFFORT

public static final QuotaOperation.QuotaMode BEST_EFFORT

 For AllocateQuota request, this mode is supported only for imprecise
 quota limits. In this case, the operation allocates quota for the amount
 specified in the service configuration or specified using the quota
 metrics. If the amount is higher than the available quota, request does
 not fail but all available quota will be allocated.
 For ReleaseQuota request, this mode is supported for both precise quota
 limits and imprecise quota limits. In this case, this operation releases
 quota for the amount specified in the service configuration or specified
 using the quota metrics. If the release can make available quota
 negative, request does not fail but only the available quota will be
 released. After the ReleaseQuota request completes, the available quota
 will be 0, and never goes to negative.
 

BEST_EFFORT = 2;

CHECK_ONLY

public static final QuotaOperation.QuotaMode CHECK_ONLY

 For AllocateQuota request, only checks if there is enough quota
 available and does not change the available quota. No lock is placed on
 the available quota either. Not supported for ReleaseQuota request.
 

CHECK_ONLY = 3;

UNRECOGNIZED

public static final QuotaOperation.QuotaMode UNRECOGNIZED

Field Detail

UNSPECIFIED_VALUE

public static final int UNSPECIFIED_VALUE

UNSPECIFIED = 0;

See Also:

Constant Field Values

NORMAL_VALUE

public static final int NORMAL_VALUE

 For AllocateQuota request, allocates quota for the amount specified in
 the service configuration or specified using the quota metrics. If the
 amount is higher than the available quota, allocation error will be
 returned and no quota will be allocated.
 For ReleaseQuota request, this mode is supported only for precise quota
 limits. In this case, this operation releases quota for the amount
 specified in the service configuration or specified using the quota
 metrics. If the release can make available quota negative, release error
 will be returned and no quota will be released.
 

NORMAL = 1;

See Also:

Constant Field Values

BEST_EFFORT_VALUE

public static final int BEST_EFFORT_VALUE

 For AllocateQuota request, this mode is supported only for imprecise
 quota limits. In this case, the operation allocates quota for the amount
 specified in the service configuration or specified using the quota
 metrics. If the amount is higher than the available quota, request does
 not fail but all available quota will be allocated.
 For ReleaseQuota request, this mode is supported for both precise quota
 limits and imprecise quota limits. In this case, this operation releases
 quota for the amount specified in the service configuration or specified
 using the quota metrics. If the release can make available quota
 negative, request does not fail but only the available quota will be
 released. After the ReleaseQuota request completes, the available quota
 will be 0, and never goes to negative.
 

BEST_EFFORT = 2;

See Also:

Constant Field Values

CHECK_ONLY_VALUE

public static final int CHECK_ONLY_VALUE

 For AllocateQuota request, only checks if there is enough quota
 available and does not change the available quota. No lock is placed on
 the available quota either. Not supported for ReleaseQuota request.
 

CHECK_ONLY = 3;

See Also:

Constant Field Values

Method Detail

values

public static QuotaOperation.QuotaMode[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (QuotaOperation.QuotaMode c : QuotaOperation.QuotaMode.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static QuotaOperation.QuotaMode valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getNumber

public final int getNumber()

Specified by:

getNumber in interface com.google.protobuf.Internal.EnumLite

Specified by:

getNumber in interface com.google.protobuf.ProtocolMessageEnum

valueOf

@Deprecated
public static QuotaOperation.QuotaMode valueOf(int value)

Deprecated. Use forNumber(int) instead.

forNumber

public static QuotaOperation.QuotaMode forNumber(int value)

internalGetValueMap

public static com.google.protobuf.Internal.EnumLiteMap<QuotaOperation.QuotaMode> internalGetValueMap()

getValueDescriptor

public final com.google.protobuf.Descriptors.EnumValueDescriptor getValueDescriptor()

Specified by:

getValueDescriptor in interface com.google.protobuf.ProtocolMessageEnum

getDescriptorForType

public final com.google.protobuf.Descriptors.EnumDescriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.ProtocolMessageEnum

getDescriptor

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

valueOf

public static QuotaOperation.QuotaMode valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc)