Class CreateQuotaShareRequest
- java.lang.Object
-
- software.amazon.awssdk.core.SdkRequest
-
- software.amazon.awssdk.awscore.AwsRequest
-
- software.amazon.awssdk.services.batch.model.BatchRequest
-
- software.amazon.awssdk.services.batch.model.CreateQuotaShareRequest
-
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<CreateQuotaShareRequest.Builder,CreateQuotaShareRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateQuotaShareRequest extends BatchRequest implements ToCopyableBuilder<CreateQuotaShareRequest.Builder,CreateQuotaShareRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceCreateQuotaShareRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static CreateQuotaShareRequest.Builderbuilder()List<QuotaShareCapacityLimit>capacityLimits()A list that specifies the quantity and type of compute capacity allocated to the quota share.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasCapacityLimits()For responses, this returns true if the service returned a value for the CapacityLimits property.inthashCode()booleanhasTags()For responses, this returns true if the service returned a value for the Tags property.StringjobQueue()The Batch job queue associated with the quota share.QuotaSharePreemptionConfigurationpreemptionConfiguration()Specifies the preemption behavior for jobs in a quota share.StringquotaShareName()The name of the quota share.QuotaShareResourceSharingConfigurationresourceSharingConfiguration()Specifies whether a quota share reserves, lends, or both lends and borrows idle compute capacity.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends CreateQuotaShareRequest.Builder>serializableBuilderClass()QuotaShareStatestate()The state of the quota share.StringstateAsString()The state of the quota share.Map<String,String>tags()The tags that you apply to the quota share to help you categorize and organize your resources.CreateQuotaShareRequest.BuildertoBuilder()StringtoString()Returns a string representation of this object.-
Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
-
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
-
quotaShareName
public final String quotaShareName()
The name of the quota share. It can be up to 128 characters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).
- Returns:
- The name of the quota share. It can be up to 128 characters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).
-
jobQueue
public final String jobQueue()
The Batch job queue associated with the quota share. This can be the job queue name or ARN. A job queue must be in the
VALIDstate before you can associate it with a quota share.- Returns:
- The Batch job queue associated with the quota share. This can be the job queue name or ARN. A job queue
must be in the
VALIDstate before you can associate it with a quota share.
-
hasCapacityLimits
public final boolean hasCapacityLimits()
For responses, this returns true if the service returned a value for the CapacityLimits property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
capacityLimits
public final List<QuotaShareCapacityLimit> capacityLimits()
A list that specifies the quantity and type of compute capacity allocated to the quota share.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasCapacityLimits()method.- Returns:
- A list that specifies the quantity and type of compute capacity allocated to the quota share.
-
resourceSharingConfiguration
public final QuotaShareResourceSharingConfiguration resourceSharingConfiguration()
Specifies whether a quota share reserves, lends, or both lends and borrows idle compute capacity.
- Returns:
- Specifies whether a quota share reserves, lends, or both lends and borrows idle compute capacity.
-
preemptionConfiguration
public final QuotaSharePreemptionConfiguration preemptionConfiguration()
Specifies the preemption behavior for jobs in a quota share.
- Returns:
- Specifies the preemption behavior for jobs in a quota share.
-
state
public final QuotaShareState state()
The state of the quota share. If the quota share is
ENABLED, it is able to accept jobs. If the quota share isDISABLED, new jobs won't be accepted but jobs already submitted can finish. The default state isENABLED.If the service returns an enum value that is not available in the current SDK version,
statewill returnQuotaShareState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstateAsString().- Returns:
- The state of the quota share. If the quota share is
ENABLED, it is able to accept jobs. If the quota share isDISABLED, new jobs won't be accepted but jobs already submitted can finish. The default state isENABLED. - See Also:
QuotaShareState
-
stateAsString
public final String stateAsString()
The state of the quota share. If the quota share is
ENABLED, it is able to accept jobs. If the quota share isDISABLED, new jobs won't be accepted but jobs already submitted can finish. The default state isENABLED.If the service returns an enum value that is not available in the current SDK version,
statewill returnQuotaShareState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstateAsString().- Returns:
- The state of the quota share. If the quota share is
ENABLED, it is able to accept jobs. If the quota share isDISABLED, new jobs won't be accepted but jobs already submitted can finish. The default state isENABLED. - See Also:
QuotaShareState
-
hasTags
public final boolean hasTags()
For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
tags
public final Map<String,String> tags()
The tags that you apply to the quota share to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see Tagging your Batch resources in Batch User Guide.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasTags()method.- Returns:
- The tags that you apply to the quota share to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see Tagging your Batch resources in Batch User Guide.
-
toBuilder
public CreateQuotaShareRequest.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<CreateQuotaShareRequest.Builder,CreateQuotaShareRequest>- Specified by:
toBuilderin classBatchRequest
-
builder
public static CreateQuotaShareRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends CreateQuotaShareRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsRequest
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForFieldin classSdkRequest
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-