Class DBClusterEndpoint
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<DBClusterEndpoint.Builder,
DBClusterEndpoint>
This data type represents the information you need to connect to an Amazon Neptune 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 Neptune DB instance endpoints, see Endpoint
.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic DBClusterEndpoint.Builder
builder()
final String
The type associated with a custom endpoint.final String
The Amazon Resource Name (ARN) for the endpoint.final String
The identifier associated with the endpoint.final String
A unique system-generated identifier for an endpoint.final String
The DB cluster identifier of the DB cluster associated with the endpoint.final String
endpoint()
The DNS address of the endpoint.final String
The type of the endpoint.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.List of DB instance identifiers that aren't part of the custom endpoint group.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the ExcludedMembers property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the StaticMembers property.static Class
<? extends DBClusterEndpoint.Builder> List of DB instance identifiers that are part of the custom endpoint group.final String
status()
The current status of the endpoint.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
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
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
The DNS address of the endpoint.
- Returns:
- The DNS address of the endpoint.
-
status
The current status of the endpoint. One of:
creating
,available
,deleting
,inactive
,modifying
. Theinactive
state applies to an endpoint that cannot be used for a certain kind of cluster, such as awriter
endpoint for a read-only secondary cluster in a global database.- Returns:
- The current status of the endpoint. One of:
creating
,available
,deleting
,inactive
,modifying
. Theinactive
state applies to an endpoint that cannot be used for a certain kind of cluster, such as awriter
endpoint for a read-only secondary cluster in a global database.
-
endpointType
The type of the endpoint. One of:
READER
,WRITER
,CUSTOM
.- Returns:
- The type of the endpoint. One of:
READER
,WRITER
,CUSTOM
.
-
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
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
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
The Amazon Resource Name (ARN) for the endpoint.
- Returns:
- The Amazon Resource Name (ARN) for the endpoint.
-
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 interfaceToCopyableBuilder<DBClusterEndpoint.Builder,
DBClusterEndpoint> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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
-
sdkFields
-