Class GetClusterResponse
- java.lang.Object
-
- software.amazon.awssdk.core.SdkResponse
-
- software.amazon.awssdk.awscore.AwsResponse
-
- software.amazon.awssdk.services.dsql.model.DsqlResponse
-
- software.amazon.awssdk.services.dsql.model.GetClusterResponse
-
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<GetClusterResponse.Builder,GetClusterResponse>
@Generated("software.amazon.awssdk:codegen") public final class GetClusterResponse extends DsqlResponse implements ToCopyableBuilder<GetClusterResponse.Builder,GetClusterResponse>
Output Mixin
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceGetClusterResponse.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Stringarn()The ARN of the retrieved cluster.static GetClusterResponse.Builderbuilder()InstantcreationTime()The time of when the cluster was created.BooleandeletionProtectionEnabled()Whether deletion protection is enabled in this cluster.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()booleanhasLinkedClusterArns()For responses, this returns true if the service returned a value for the LinkedClusterArns property.Stringidentifier()The ID of the retrieved cluster.List<String>linkedClusterArns()The ARNs of the clusters linked to the retrieved cluster.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends GetClusterResponse.Builder>serializableBuilderClass()ClusterStatusstatus()The status of the retrieved cluster.StringstatusAsString()The status of the retrieved cluster.GetClusterResponse.BuildertoBuilder()StringtoString()Returns a string representation of this object.StringwitnessRegion()The witness Region of the cluster.-
Methods inherited from class software.amazon.awssdk.services.dsql.model.DsqlResponse
responseMetadata
-
Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse
-
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
-
identifier
public final String identifier()
The ID of the retrieved cluster.
- Returns:
- The ID of the retrieved cluster.
-
arn
public final String arn()
The ARN of the retrieved cluster.
- Returns:
- The ARN of the retrieved cluster.
-
status
public final ClusterStatus status()
The status of the retrieved cluster.
If the service returns an enum value that is not available in the current SDK version,
statuswill returnClusterStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- Returns:
- The status of the retrieved cluster.
- See Also:
ClusterStatus
-
statusAsString
public final String statusAsString()
The status of the retrieved cluster.
If the service returns an enum value that is not available in the current SDK version,
statuswill returnClusterStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- Returns:
- The status of the retrieved cluster.
- See Also:
ClusterStatus
-
creationTime
public final Instant creationTime()
The time of when the cluster was created.
- Returns:
- The time of when the cluster was created.
-
deletionProtectionEnabled
public final Boolean deletionProtectionEnabled()
Whether deletion protection is enabled in this cluster.
- Returns:
- Whether deletion protection is enabled in this cluster.
-
witnessRegion
public final String witnessRegion()
The witness Region of the cluster. Applicable only for multi-Region clusters.
- Returns:
- The witness Region of the cluster. Applicable only for multi-Region clusters.
-
hasLinkedClusterArns
public final boolean hasLinkedClusterArns()
For responses, this returns true if the service returned a value for the LinkedClusterArns 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.
-
linkedClusterArns
public final List<String> linkedClusterArns()
The ARNs of the clusters linked to the retrieved cluster.
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
hasLinkedClusterArns()method.- Returns:
- The ARNs of the clusters linked to the retrieved cluster.
-
toBuilder
public GetClusterResponse.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<GetClusterResponse.Builder,GetClusterResponse>- Specified by:
toBuilderin classAwsResponse
-
builder
public static GetClusterResponse.Builder builder()
-
serializableBuilderClass
public static Class<? extends GetClusterResponse.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsResponse
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsResponse
-
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 classSdkResponse
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-