Package software.amazon.awssdk.services.finspace.model

Class KxScalingGroup

java.lang.Object

software.amazon.awssdk.services.finspace.model.KxScalingGroup

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<KxScalingGroup.Builder,KxScalingGroup>

@Generated("software.amazon.awssdk:codegen")
public final class KxScalingGroup
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<KxScalingGroup.Builder,KxScalingGroup>

A structure for storing metadata of scaling group.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	KxScalingGroup.Builder

Method Summary

Modifier and Type	Method	Description
String	availabilityZoneId()	The identifier of the availability zones.
static KxScalingGroup.Builder	builder()
List<String>	clusters()	The list of clusters currently active in a given scaling group.
Instant	createdTimestamp()	The timestamp at which the scaling group was created in FinSpace.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasClusters()	For responses, this returns true if the service returned a value for the Clusters property.
int	hashCode()
String	hostType()	The memory and CPU capabilities of the scaling group host on which FinSpace Managed kdb clusters will be placed.
Instant	lastModifiedTimestamp()	The last time that the scaling group was updated in FinSpace.
String	scalingGroupName()	A unique identifier for the kdb scaling group.
List<SdkField<?>>	sdkFields()
static Class<? extends KxScalingGroup.Builder>	serializableBuilderClass()
KxScalingGroupStatus	status()	The status of scaling groups.
String	statusAsString()	The status of scaling groups.
String	statusReason()	The error message when a failed state occurs.
KxScalingGroup.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

scalingGroupName

public final String scalingGroupName()

A unique identifier for the kdb scaling group.

Returns:

A unique identifier for the kdb 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.

Returns:

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

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 clusters currently active in a 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 clusters currently active in a 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 groups.

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 groups.

See Also:

KxScalingGroupStatus

statusAsString

public final String statusAsString()

The status of scaling groups.

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 groups.

See Also:

KxScalingGroupStatus

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 KxScalingGroup.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<KxScalingGroup.Builder,KxScalingGroup>

builder

public static KxScalingGroup.Builder builder()

serializableBuilderClass

public static Class<? extends KxScalingGroup.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