Class ModifyDbClusterEndpointResponse
- java.lang.Object
-
- software.amazon.awssdk.core.SdkResponse
-
- software.amazon.awssdk.awscore.AwsResponse
-
- software.amazon.awssdk.services.rds.model.RdsResponse
-
- software.amazon.awssdk.services.rds.model.ModifyDbClusterEndpointResponse
-
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<ModifyDbClusterEndpointResponse.Builder,ModifyDbClusterEndpointResponse>
@Generated("software.amazon.awssdk:codegen") public final class ModifyDbClusterEndpointResponse extends RdsResponse implements ToCopyableBuilder<ModifyDbClusterEndpointResponse.Builder,ModifyDbClusterEndpointResponse>
This data type represents the information you need to connect to an Amazon Aurora DB cluster. This data type is used as a response element in the following actions:
-
CreateDBClusterEndpoint -
DescribeDBClusterEndpoints -
ModifyDBClusterEndpoint -
DeleteDBClusterEndpoint
For the data structure that represents Amazon RDS DB instance endpoints, see
Endpoint.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceModifyDbClusterEndpointResponse.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static ModifyDbClusterEndpointResponse.Builderbuilder()StringcustomEndpointType()The type associated with a custom endpoint.StringdbClusterEndpointArn()The Amazon Resource Name (ARN) for the endpoint.StringdbClusterEndpointIdentifier()The identifier associated with the endpoint.StringdbClusterEndpointResourceIdentifier()A unique system-generated identifier for an endpoint.StringdbClusterIdentifier()The DB cluster identifier of the DB cluster associated with the endpoint.Stringendpoint()The DNS address of the endpoint.StringendpointType()The type of the endpoint.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)List<String>excludedMembers()List of DB instance identifiers that aren't part of the custom endpoint group.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasExcludedMembers()For responses, this returns true if the service returned a value for the ExcludedMembers property.inthashCode()booleanhasStaticMembers()For responses, this returns true if the service returned a value for the StaticMembers property.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends ModifyDbClusterEndpointResponse.Builder>serializableBuilderClass()List<String>staticMembers()List of DB instance identifiers that are part of the custom endpoint group.Stringstatus()The current status of the endpoint.ModifyDbClusterEndpointResponse.BuildertoBuilder()StringtoString()Returns a string representation of this object.-
Methods inherited from class software.amazon.awssdk.services.rds.model.RdsResponse
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
-
dbClusterEndpointIdentifier
public final String dbClusterEndpointIdentifier()
The identifier associated with the endpoint. This parameter is stored as a lowercase string.
- Returns:
- The identifier associated with the endpoint. This parameter is stored as a lowercase string.
-
dbClusterIdentifier
public final String dbClusterIdentifier()
The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.
- Returns:
- The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.
-
dbClusterEndpointResourceIdentifier
public final String dbClusterEndpointResourceIdentifier()
A unique system-generated identifier for an endpoint. It remains the same for the whole life of the endpoint.
- Returns:
- A unique system-generated identifier for an endpoint. It remains the same for the whole life of the endpoint.
-
endpoint
public final String endpoint()
The DNS address of the endpoint.
- Returns:
- The DNS address of the endpoint.
-
status
public final String status()
The current status of the endpoint. One of:
creating,available,deleting,inactive,modifying. Theinactivestate applies to an endpoint that can't be used for a certain kind of cluster, such as awriterendpoint for a read-only secondary cluster in a global database.- Returns:
- The current status of the endpoint. One of:
creating,available,deleting,inactive,modifying. Theinactivestate applies to an endpoint that can't be used for a certain kind of cluster, such as awriterendpoint for a read-only secondary cluster in a global database.
-
endpointType
public final String endpointType()
The type of the endpoint. One of:
READER,WRITER,CUSTOM.- Returns:
- The type of the endpoint. One of:
READER,WRITER,CUSTOM.
-
customEndpointType
public final String customEndpointType()
The type associated with a custom endpoint. One of:
READER,WRITER,ANY.- Returns:
- The type associated with a custom endpoint. One of:
READER,WRITER,ANY.
-
hasStaticMembers
public final boolean hasStaticMembers()
For responses, this returns true if the service returned a value for the StaticMembers 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.
-
staticMembers
public final List<String> staticMembers()
List of DB instance identifiers that are part of the custom endpoint 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
hasStaticMembers()method.- Returns:
- List of DB instance identifiers that are part of the custom endpoint group.
-
hasExcludedMembers
public final boolean hasExcludedMembers()
For responses, this returns true if the service returned a value for the ExcludedMembers 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.
-
excludedMembers
public final List<String> excludedMembers()
List of DB instance identifiers that aren't part of the custom endpoint group. All other eligible instances are reachable through the custom endpoint. Only relevant if the list of static members is empty.
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
hasExcludedMembers()method.- Returns:
- List of DB instance identifiers that aren't part of the custom endpoint group. All other eligible instances are reachable through the custom endpoint. Only relevant if the list of static members is empty.
-
dbClusterEndpointArn
public final String dbClusterEndpointArn()
The Amazon Resource Name (ARN) for the endpoint.
- Returns:
- The Amazon Resource Name (ARN) for the endpoint.
-
toBuilder
public ModifyDbClusterEndpointResponse.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<ModifyDbClusterEndpointResponse.Builder,ModifyDbClusterEndpointResponse>- Specified by:
toBuilderin classAwsResponse
-
builder
public static ModifyDbClusterEndpointResponse.Builder builder()
-
serializableBuilderClass
public static Class<? extends ModifyDbClusterEndpointResponse.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
-
-