Class QuotaContextInfo
- java.lang.Object
-
- software.amazon.awssdk.services.servicequotas.model.QuotaContextInfo
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<QuotaContextInfo.Builder,QuotaContextInfo>
@Generated("software.amazon.awssdk:codegen") public final class QuotaContextInfo extends Object implements SdkPojo, Serializable, ToCopyableBuilder<QuotaContextInfo.Builder,QuotaContextInfo>
A structure that describes the context for a resource-level quota. For resource-level quotas, such as
Instances per OpenSearch Service Domain, you can apply the quota value at the resource-level for each OpenSearch Service Domain in your Amazon Web Services account. Together the attributes of this structure help you understand how the quota is implemented by Amazon Web Services and how you can manage it. For quotas such asAmazon OpenSearch Service Domainswhich can be managed at the account-level for each Amazon Web Services Region, theQuotaContextfield is absent. See the attribute descriptions below to further understand how to use them.- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceQuotaContextInfo.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static QuotaContextInfo.Builderbuilder()StringcontextId()Specifies the resource, or resources, to which the quota applies.QuotaContextScopecontextScope()Specifies the scope to which the quota value is applied.StringcontextScopeAsString()Specifies the scope to which the quota value is applied.StringcontextScopeType()Specifies the resource type to which the quota can be applied.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends QuotaContextInfo.Builder>serializableBuilderClass()QuotaContextInfo.BuildertoBuilder()StringtoString()Returns a string representation of this object.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
contextScope
public final QuotaContextScope contextScope()
Specifies the scope to which the quota value is applied. If the scope is
RESOURCE, the quota value is applied to each resource in the Amazon Web Services account. If the scope isACCOUNT, the quota value is applied to the Amazon Web Services account.If the service returns an enum value that is not available in the current SDK version,
contextScopewill returnQuotaContextScope.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromcontextScopeAsString().- Returns:
- Specifies the scope to which the quota value is applied. If the scope is
RESOURCE, the quota value is applied to each resource in the Amazon Web Services account. If the scope isACCOUNT, the quota value is applied to the Amazon Web Services account. - See Also:
QuotaContextScope
-
contextScopeAsString
public final String contextScopeAsString()
Specifies the scope to which the quota value is applied. If the scope is
RESOURCE, the quota value is applied to each resource in the Amazon Web Services account. If the scope isACCOUNT, the quota value is applied to the Amazon Web Services account.If the service returns an enum value that is not available in the current SDK version,
contextScopewill returnQuotaContextScope.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromcontextScopeAsString().- Returns:
- Specifies the scope to which the quota value is applied. If the scope is
RESOURCE, the quota value is applied to each resource in the Amazon Web Services account. If the scope isACCOUNT, the quota value is applied to the Amazon Web Services account. - See Also:
QuotaContextScope
-
contextScopeType
public final String contextScopeType()
Specifies the resource type to which the quota can be applied.
- Returns:
- Specifies the resource type to which the quota can be applied.
-
contextId
public final String contextId()
Specifies the resource, or resources, to which the quota applies. The value for this field is either an Amazon Resource Name (ARN) or *. If the value is an ARN, the quota value applies to that resource. If the value is *, then the quota value applies to all resources listed in the
ContextScopeTypefield. The quota value applies to all resources for which you haven’t previously applied a quota value, and any new resources you create in your Amazon Web Services account.- Returns:
- Specifies the resource, or resources, to which the quota applies. The value for this field is either an
Amazon Resource Name (ARN) or *. If the value is an ARN, the quota value applies to that resource. If the
value is *, then the quota value applies to all resources listed in the
ContextScopeTypefield. The quota value applies to all resources for which you haven’t previously applied a quota value, and any new resources you create in your Amazon Web Services account.
-
toBuilder
public QuotaContextInfo.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<QuotaContextInfo.Builder,QuotaContextInfo>
-
builder
public static QuotaContextInfo.Builder builder()
-
serializableBuilderClass
public static Class<? extends QuotaContextInfo.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
toString
public final String toString()
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-