software.amazon.jdbc.plugin.customendpoint

Class CustomEndpointInfo

java.lang.Object

software.amazon.jdbc.plugin.customendpoint.CustomEndpointInfo

public class CustomEndpointInfo
extends java.lang.Object

Represents custom endpoint information for a given custom endpoint.

Constructor Summary

Constructors

Constructor and Description
CustomEndpointInfo(java.lang.String endpointIdentifier, java.lang.String clusterIdentifier, java.lang.String url, CustomEndpointRoleType roleType, java.util.Set<java.lang.String> members, MemberListType memberListType) Constructs a new CustomEndpointInfo instance with the specified details.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
static CustomEndpointInfo	fromDBClusterEndpoint(software.amazon.awssdk.services.rds.model.DBClusterEndpoint responseEndpointInfo) Constructs a CustomEndpointInfo object from a DBClusterEndpoint instance as returned by the RDS API.
java.lang.String	getClusterIdentifier() Gets the cluster identifier for the cluster that the custom endpoint belongs to.
CustomEndpointRoleType	getCustomEndpointType() Gets the role type of the custom endpoint.
java.lang.String	getEndpointIdentifier() Gets the endpoint identifier for the custom endpoint.
java.util.Set<java.lang.String>	getExcludedMembers() Gets the excluded members of the custom endpoint.
MemberListType	getMemberListType() Gets the member list type of the custom endpoint.
java.util.Set<java.lang.String>	getStaticMembers() Gets the static members of the custom endpoint.
java.lang.String	getUrl() Gets the URL for the custom endpoint.
int	hashCode()
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CustomEndpointInfo

public CustomEndpointInfo(java.lang.String endpointIdentifier,
                          java.lang.String clusterIdentifier,
                          java.lang.String url,
                          CustomEndpointRoleType roleType,
                          java.util.Set<java.lang.String> members,
                          MemberListType memberListType)

Constructs a new CustomEndpointInfo instance with the specified details.

Parameters:

endpointIdentifier - The endpoint identifier for the custom endpoint. For example, if the custom endpoint URL is "my-custom-endpoint.cluster-custom-XYZ.us-east-1.rds.amazonaws.com", the endpoint identifier is "my-custom-endpoint".

clusterIdentifier - The cluster identifier for the cluster that the custom endpoint belongs to.

url - The URL for the custom endpoint.

roleType - The role type of the custom endpoint.

members - The instance IDs for the hosts in the custom endpoint.

memberListType - The list type for members.

Method Detail

fromDBClusterEndpoint

public static CustomEndpointInfo fromDBClusterEndpoint(software.amazon.awssdk.services.rds.model.DBClusterEndpoint responseEndpointInfo)

Constructs a CustomEndpointInfo object from a DBClusterEndpoint instance as returned by the RDS API.

Parameters:

responseEndpointInfo - The endpoint info returned by the RDS API.

Returns:

a CustomEndPointInfo object representing the information in the given DBClusterEndpoint.

getEndpointIdentifier

public java.lang.String getEndpointIdentifier()

Gets the endpoint identifier for the custom endpoint. For example, if the custom endpoint URL is "my-custom-endpoint.cluster-custom-XYZ.us-east-1.rds.amazonaws.com", the endpoint identifier is "my-custom-endpoint".

Returns:

the endpoint identifier for the custom endpoint.

getClusterIdentifier

public java.lang.String getClusterIdentifier()

Gets the cluster identifier for the cluster that the custom endpoint belongs to.

Returns:

the cluster identifier for the cluster that the custom endpoint belongs to.

getUrl

public java.lang.String getUrl()

Gets the URL for the custom endpoint.

Returns:

the URL for the custom endpoint.

getCustomEndpointType

public CustomEndpointRoleType getCustomEndpointType()

Gets the role type of the custom endpoint.

Returns:

the role type of the custom endpoint.

getMemberListType

public MemberListType getMemberListType()

Gets the member list type of the custom endpoint.

Returns:

the member list type of the custom endpoint.

getStaticMembers

public java.util.Set<java.lang.String> getStaticMembers()

Gets the static members of the custom endpoint. If the custom endpoint member list type is an exclusion list, returns null.

Returns:

the static members of the custom endpoint, or null if the custom endpoint member list type is an exclusion list.

getExcludedMembers

public java.util.Set<java.lang.String> getExcludedMembers()

Gets the excluded members of the custom endpoint. If the custom endpoint member list type is a static list, returns null.

Returns:

the excluded members of the custom endpoint, or null if the custom endpoint member list type is a static list.

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object