Class GetKxScalingGroupResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.finspace.model.FinspaceResponse
software.amazon.awssdk.services.finspace.model.GetKxScalingGroupResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetKxScalingGroupResponse.Builder,GetKxScalingGroupResponse>
@Generated("software.amazon.awssdk:codegen") public final class GetKxScalingGroupResponse extends FinspaceResponse implements ToCopyableBuilder<GetKxScalingGroupResponse.Builder,GetKxScalingGroupResponse>

  • Method Details

    • scalingGroupName

      public final String scalingGroupName()

      A unique identifier for the kdb scaling group.

      Returns:
      A unique identifier for the kdb scaling group.

    • scalingGroupArn

      public final String scalingGroupArn()

      The ARN identifier for the scaling group.

      Returns:
      The ARN identifier for the scaling group.

    • hostType

      public final String hostType()

      The memory and CPU capabilities of the scaling group host on which FinSpace Managed kdb clusters will be placed.

      It can have one of the following values:

      • kx.sg.large – The host type with a configuration of 16 GiB memory and 2 vCPUs.

      • kx.sg.xlarge – The host type with a configuration of 32 GiB memory and 4 vCPUs.

      • kx.sg.2xlarge – The host type with a configuration of 64 GiB memory and 8 vCPUs.

      • kx.sg.4xlarge – The host type with a configuration of 108 GiB memory and 16 vCPUs.

      • kx.sg.8xlarge – The host type with a configuration of 216 GiB memory and 32 vCPUs.

      • kx.sg.16xlarge – The host type with a configuration of 432 GiB memory and 64 vCPUs.

      • kx.sg.32xlarge – The host type with a configuration of 864 GiB memory and 128 vCPUs.

      • kx.sg1.16xlarge – The host type with a configuration of 1949 GiB memory and 64 vCPUs.

      • kx.sg1.24xlarge – The host type with a configuration of 2948 GiB memory and 96 vCPUs.

      Returns:
      The memory and CPU capabilities of the scaling group host on which FinSpace Managed kdb clusters will be placed.

      It can have one of the following values:

      • kx.sg.large – The host type with a configuration of 16 GiB memory and 2 vCPUs.

      • kx.sg.xlarge – The host type with a configuration of 32 GiB memory and 4 vCPUs.

      • kx.sg.2xlarge – The host type with a configuration of 64 GiB memory and 8 vCPUs.

      • kx.sg.4xlarge – The host type with a configuration of 108 GiB memory and 16 vCPUs.

      • kx.sg.8xlarge – The host type with a configuration of 216 GiB memory and 32 vCPUs.

      • kx.sg.16xlarge – The host type with a configuration of 432 GiB memory and 64 vCPUs.

      • kx.sg.32xlarge – The host type with a configuration of 864 GiB memory and 128 vCPUs.

      • kx.sg1.16xlarge – The host type with a configuration of 1949 GiB memory and 64 vCPUs.

      • kx.sg1.24xlarge – The host type with a configuration of 2948 GiB memory and 96 vCPUs.

    • hasClusters

      public final boolean hasClusters()
      For responses, this returns true if the service returned a value for the Clusters 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.

    • clusters

      public final List<String> clusters()

      The list of Managed kdb clusters that are currently active in the given scaling group.

      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 hasClusters() method.

      Returns:
      The list of Managed kdb clusters that are currently active in the given scaling group.

    • availabilityZoneId

      public final String availabilityZoneId()

      The identifier of the availability zones.

      Returns:
      The identifier of the availability zones.

    • status

      public final KxScalingGroupStatus status()

      The status of scaling group.

      • CREATING – The scaling group creation is in progress.

      • CREATE_FAILED – The scaling group creation has failed.

      • ACTIVE – The scaling group is active.

      • UPDATING – The scaling group is in the process of being updated.

      • UPDATE_FAILED – The update action failed.

      • DELETING – The scaling group is in the process of being deleted.

      • DELETE_FAILED – The system failed to delete the scaling group.

      • DELETED – The scaling group is successfully deleted.

      If the service returns an enum value that is not available in the current SDK version, status will return KxScalingGroupStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      The status of scaling group.

      • CREATING – The scaling group creation is in progress.

      • CREATE_FAILED – The scaling group creation has failed.

      • ACTIVE – The scaling group is active.

      • UPDATING – The scaling group is in the process of being updated.

      • UPDATE_FAILED – The update action failed.

      • DELETING – The scaling group is in the process of being deleted.

      • DELETE_FAILED – The system failed to delete the scaling group.

      • DELETED – The scaling group is successfully deleted.

      See Also:

    • statusAsString

      public final String statusAsString()

      The status of scaling group.

      • CREATING – The scaling group creation is in progress.

      • CREATE_FAILED – The scaling group creation has failed.

      • ACTIVE – The scaling group is active.

      • UPDATING – The scaling group is in the process of being updated.

      • UPDATE_FAILED – The update action failed.

      • DELETING – The scaling group is in the process of being deleted.

      • DELETE_FAILED – The system failed to delete the scaling group.

      • DELETED – The scaling group is successfully deleted.

      If the service returns an enum value that is not available in the current SDK version, status will return KxScalingGroupStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      The status of scaling group.

      • CREATING – The scaling group creation is in progress.

      • CREATE_FAILED – The scaling group creation has failed.

      • ACTIVE – The scaling group is active.

      • UPDATING – The scaling group is in the process of being updated.

      • UPDATE_FAILED – The update action failed.

      • DELETING – The scaling group is in the process of being deleted.

      • DELETE_FAILED – The system failed to delete the scaling group.

      • DELETED – The scaling group is successfully deleted.

      See Also:

    • statusReason

      public final String statusReason()

      The error message when a failed state occurs.

      Returns:
      The error message when a failed state occurs.

    • lastModifiedTimestamp

      public final Instant lastModifiedTimestamp()

      The last time that the scaling group was updated in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

      Returns:
      The last time that the scaling group was updated in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

    • createdTimestamp

      public final Instant createdTimestamp()

      The timestamp at which the scaling group was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

      Returns:
      The timestamp at which the scaling group was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

    • toBuilder

      public GetKxScalingGroupResponse.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<GetKxScalingGroupResponse.Builder,GetKxScalingGroupResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static GetKxScalingGroupResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends GetKxScalingGroupResponse.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.