java.lang.Object
- software.amazon.awssdk.services.ec2.model.CapacityManagerDimension

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<CapacityManagerDimension.Builder,CapacityManagerDimension>
```
@Generated("software.amazon.awssdk:codegen")
public final class CapacityManagerDimension
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<CapacityManagerDimension.Builder,CapacityManagerDimension>
```
Represents dimension values for capacity metrics, including resource identifiers, geographic information, and reservation details used for grouping and filtering capacity data.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface CapacityManagerDimension.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`accountId()`	The Amazon Web Services account ID that owns the capacity resource.
`String`	`accountName()`	The name of the Amazon Web Services account that owns the capacity resource.
`String`	`availabilityZoneId()`	The unique identifier of the Availability Zone where the capacity resource is located.
`static CapacityManagerDimension.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasTags()`	For responses, this returns true if the service returned a value for the Tags property.
`String`	`instanceFamily()`	The EC2 instance family of the capacity resource.
`String`	`instancePlatform()`	The platform or operating system of the instance.
`String`	`instanceType()`	The specific EC2 instance type of the capacity resource.
`String`	`reservationArn()`	The Amazon Resource Name (ARN) of the capacity reservation.
`Instant`	`reservationCreateTimestamp()`	The timestamp when the capacity reservation was originally created, in milliseconds since epoch.
`ReservationEndDateType`	`reservationEndDateType()`	The type of end date for the capacity reservation.
`String`	`reservationEndDateTypeAsString()`	The type of end date for the capacity reservation.
`Instant`	`reservationEndTimestamp()`	The timestamp when the capacity reservation expires and is no longer available, in milliseconds since epoch.
`String`	`reservationId()`	The unique identifier of the capacity reservation.
`String`	`reservationInstanceMatchCriteria()`	The instance matching criteria for the capacity reservation, determining how instances are matched to the reservation.
`Instant`	`reservationStartTimestamp()`	The timestamp when the capacity reservation becomes active and available for use, in milliseconds since epoch.
`ReservationState`	`reservationState()`	The current state of the capacity reservation.
`String`	`reservationStateAsString()`	The current state of the capacity reservation.
`ReservationType`	`reservationType()`	The type of capacity reservation.
`String`	`reservationTypeAsString()`	The type of capacity reservation.
`String`	`reservationUnusedFinancialOwner()`	The Amazon Web Services account ID that is financially responsible for unused capacity reservation costs.
`String`	`resourceRegion()`	The Amazon Web Services Region where the capacity resource is located.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends CapacityManagerDimension.Builder>`	`serializableBuilderClass()`
`List<CapacityManagerTagDimension>`	`tags()`	The tags associated with the capacity resource, represented as key-value pairs.
`CapacityTenancy`	`tenancy()`	The tenancy of the EC2 instances associated with this capacity dimension.
`String`	`tenancyAsString()`	The tenancy of the EC2 instances associated with this capacity dimension.
`CapacityManagerDimension.Builder`	`toBuilder()`
`String`	`toString()`	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
  - resourceRegion
```
public final String resourceRegion()
```
    The Amazon Web Services Region where the capacity resource is located.
    
    Returns:
    
    The Amazon Web Services Region where the capacity resource is located.
  - availabilityZoneId
```
public final String availabilityZoneId()
```
    The unique identifier of the Availability Zone where the capacity resource is located.
    
    Returns:
    
    The unique identifier of the Availability Zone where the capacity resource is located.
  - accountId
```
public final String accountId()
```
    The Amazon Web Services account ID that owns the capacity resource.
    
    Returns:
    
    The Amazon Web Services account ID that owns the capacity resource.
  - accountName
```
public final String accountName()
```
    The name of the Amazon Web Services account that owns the capacity resource. This dimension is only available when Organizations access is enabled for Capacity Manager.
    
    Returns:
    
    The name of the Amazon Web Services account that owns the capacity resource. This dimension is only available when Organizations access is enabled for Capacity Manager.
  - instanceFamily
```
public final String instanceFamily()
```
    The EC2 instance family of the capacity resource.
    
    Returns:
    
    The EC2 instance family of the capacity resource.
  - instanceType
```
public final String instanceType()
```
    The specific EC2 instance type of the capacity resource.
    
    Returns:
    
    The specific EC2 instance type of the capacity resource.
  - instancePlatform
```
public final String instancePlatform()
```
    The platform or operating system of the instance.
    
    Returns:
    
    The platform or operating system of the instance.
  - reservationArn
```
public final String reservationArn()
```
    The Amazon Resource Name (ARN) of the capacity reservation. This provides a unique identifier that can be used across Amazon Web Services services to reference the specific reservation.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the capacity reservation. This provides a unique identifier that can be used across Amazon Web Services services to reference the specific reservation.
  - reservationId
```
public final String reservationId()
```
    The unique identifier of the capacity reservation.
    
    Returns:
    
    The unique identifier of the capacity reservation.
  - reservationType
```
public final ReservationType reservationType()
```
    The type of capacity reservation.
    
    If the service returns an enum value that is not available in the current SDK version, reservationType will return ReservationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from reservationTypeAsString().
    
    Returns:
    
    The type of capacity reservation.
    
    See Also:
    
    ReservationType
  - reservationTypeAsString
```
public final String reservationTypeAsString()
```
    The type of capacity reservation.
    
    If the service returns an enum value that is not available in the current SDK version, reservationType will return ReservationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from reservationTypeAsString().
    
    Returns:
    
    The type of capacity reservation.
    
    See Also:
    
    ReservationType
  - reservationCreateTimestamp
```
public final Instant reservationCreateTimestamp()
```
    The timestamp when the capacity reservation was originally created, in milliseconds since epoch. This differs from the start timestamp as reservations can be created before they become active.
    
    Returns:
    
    The timestamp when the capacity reservation was originally created, in milliseconds since epoch. This differs from the start timestamp as reservations can be created before they become active.
  - reservationStartTimestamp
```
public final Instant reservationStartTimestamp()
```
    The timestamp when the capacity reservation becomes active and available for use, in milliseconds since epoch. This is when the reservation begins providing capacity.
    
    Returns:
    
    The timestamp when the capacity reservation becomes active and available for use, in milliseconds since epoch. This is when the reservation begins providing capacity.
  - reservationEndTimestamp
```
public final Instant reservationEndTimestamp()
```
    The timestamp when the capacity reservation expires and is no longer available, in milliseconds since epoch. After this time, the reservation will not provide any capacity.
    
    Returns:
    
    The timestamp when the capacity reservation expires and is no longer available, in milliseconds since epoch. After this time, the reservation will not provide any capacity.
  - reservationEndDateType
```
public final ReservationEndDateType reservationEndDateType()
```
    The type of end date for the capacity reservation. This indicates whether the reservation has a fixed end date, is open-ended, or follows a specific termination pattern.
    
    If the service returns an enum value that is not available in the current SDK version, reservationEndDateType will return ReservationEndDateType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from reservationEndDateTypeAsString().
    
    Returns:
    
    The type of end date for the capacity reservation. This indicates whether the reservation has a fixed end date, is open-ended, or follows a specific termination pattern.
    
    See Also:
    
    ReservationEndDateType
  - reservationEndDateTypeAsString
```
public final String reservationEndDateTypeAsString()
```
    The type of end date for the capacity reservation. This indicates whether the reservation has a fixed end date, is open-ended, or follows a specific termination pattern.
    
    If the service returns an enum value that is not available in the current SDK version, reservationEndDateType will return ReservationEndDateType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from reservationEndDateTypeAsString().
    
    Returns:
    
    The type of end date for the capacity reservation. This indicates whether the reservation has a fixed end date, is open-ended, or follows a specific termination pattern.
    
    See Also:
    
    ReservationEndDateType
  - tenancy
```
public final CapacityTenancy tenancy()
```
    The tenancy of the EC2 instances associated with this capacity dimension. Valid values are 'default' for shared tenancy, 'dedicated' for dedicated instances, or 'host' for dedicated hosts.
    
    If the service returns an enum value that is not available in the current SDK version, tenancy will return CapacityTenancy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from tenancyAsString().
    
    Returns:
    
    The tenancy of the EC2 instances associated with this capacity dimension. Valid values are 'default' for shared tenancy, 'dedicated' for dedicated instances, or 'host' for dedicated hosts.
    
    See Also:
    
    CapacityTenancy
  - tenancyAsString
```
public final String tenancyAsString()
```
    The tenancy of the EC2 instances associated with this capacity dimension. Valid values are 'default' for shared tenancy, 'dedicated' for dedicated instances, or 'host' for dedicated hosts.
    
    If the service returns an enum value that is not available in the current SDK version, tenancy will return CapacityTenancy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from tenancyAsString().
    
    Returns:
    
    The tenancy of the EC2 instances associated with this capacity dimension. Valid values are 'default' for shared tenancy, 'dedicated' for dedicated instances, or 'host' for dedicated hosts.
    
    See Also:
    
    CapacityTenancy
  - reservationState
```
public final ReservationState reservationState()
```
    The current state of the capacity reservation.
    
    If the service returns an enum value that is not available in the current SDK version, reservationState will return ReservationState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from reservationStateAsString().
    
    Returns:
    
    The current state of the capacity reservation.
    
    See Also:
    
    ReservationState
  - reservationStateAsString
```
public final String reservationStateAsString()
```
    The current state of the capacity reservation.
    
    If the service returns an enum value that is not available in the current SDK version, reservationState will return ReservationState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from reservationStateAsString().
    
    Returns:
    
    The current state of the capacity reservation.
    
    See Also:
    
    ReservationState
  - reservationInstanceMatchCriteria
```
public final String reservationInstanceMatchCriteria()
```
    The instance matching criteria for the capacity reservation, determining how instances are matched to the reservation.
    
    Returns:
    
    The instance matching criteria for the capacity reservation, determining how instances are matched to the reservation.
  - reservationUnusedFinancialOwner
```
public final String reservationUnusedFinancialOwner()
```
    The Amazon Web Services account ID that is financially responsible for unused capacity reservation costs.
    
    Returns:
    
    The Amazon Web Services account ID that is financially responsible for unused capacity reservation costs.
  - 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 the isEmpty() 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 List<CapacityManagerTagDimension> tags()
```
    The tags associated with the capacity resource, represented as key-value pairs. Only tags that have been activated for monitoring via UpdateCapacityManagerMonitoredTagKeys are included.
    
    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 associated with the capacity resource, represented as key-value pairs. Only tags that have been activated for monitoring via UpdateCapacityManagerMonitoredTagKeys are included.
  - toBuilder
```
public CapacityManagerDimension.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CapacityManagerDimension.Builder,CapacityManagerDimension>
  - builder
```
public static CapacityManagerDimension.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CapacityManagerDimension.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class CapacityManagerDimension

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

resourceRegion

availabilityZoneId

accountId

accountName

instanceFamily

instanceType

instancePlatform

reservationArn

reservationId

reservationType

reservationTypeAsString

reservationCreateTimestamp

reservationStartTimestamp

reservationEndTimestamp

reservationEndDateType

reservationEndDateTypeAsString

tenancy

tenancyAsString

reservationState

reservationStateAsString

reservationInstanceMatchCriteria

reservationUnusedFinancialOwner

hasTags

tags

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField