software.amazon.awssdk.services.neptune.model.DBClusterEndpoint Maven / Gradle / Ivy
Show all versions of neptune Show documentation
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package software.amazon.awssdk.services.neptune.model;
import java.io.Serializable;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Function;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.ListTrait;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructList;
import software.amazon.awssdk.core.util.SdkAutoConstructList;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* 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
.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class DBClusterEndpoint implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField DB_CLUSTER_ENDPOINT_IDENTIFIER_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("DBClusterEndpointIdentifier")
.getter(getter(DBClusterEndpoint::dbClusterEndpointIdentifier))
.setter(setter(Builder::dbClusterEndpointIdentifier))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DBClusterEndpointIdentifier")
.build()).build();
private static final SdkField DB_CLUSTER_IDENTIFIER_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("DBClusterIdentifier").getter(getter(DBClusterEndpoint::dbClusterIdentifier))
.setter(setter(Builder::dbClusterIdentifier))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DBClusterIdentifier").build())
.build();
private static final SdkField DB_CLUSTER_ENDPOINT_RESOURCE_IDENTIFIER_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("DBClusterEndpointResourceIdentifier")
.getter(getter(DBClusterEndpoint::dbClusterEndpointResourceIdentifier))
.setter(setter(Builder::dbClusterEndpointResourceIdentifier))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("DBClusterEndpointResourceIdentifier").build()).build();
private static final SdkField ENDPOINT_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("Endpoint").getter(getter(DBClusterEndpoint::endpoint)).setter(setter(Builder::endpoint))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Endpoint").build()).build();
private static final SdkField STATUS_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Status")
.getter(getter(DBClusterEndpoint::status)).setter(setter(Builder::status))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Status").build()).build();
private static final SdkField ENDPOINT_TYPE_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("EndpointType").getter(getter(DBClusterEndpoint::endpointType)).setter(setter(Builder::endpointType))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("EndpointType").build()).build();
private static final SdkField CUSTOM_ENDPOINT_TYPE_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("CustomEndpointType").getter(getter(DBClusterEndpoint::customEndpointType))
.setter(setter(Builder::customEndpointType))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("CustomEndpointType").build())
.build();
private static final SdkField> STATIC_MEMBERS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("StaticMembers")
.getter(getter(DBClusterEndpoint::staticMembers))
.setter(setter(Builder::staticMembers))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("StaticMembers").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField> EXCLUDED_MEMBERS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("ExcludedMembers")
.getter(getter(DBClusterEndpoint::excludedMembers))
.setter(setter(Builder::excludedMembers))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ExcludedMembers").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField DB_CLUSTER_ENDPOINT_ARN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("DBClusterEndpointArn").getter(getter(DBClusterEndpoint::dbClusterEndpointArn))
.setter(setter(Builder::dbClusterEndpointArn))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DBClusterEndpointArn").build())
.build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(
DB_CLUSTER_ENDPOINT_IDENTIFIER_FIELD, DB_CLUSTER_IDENTIFIER_FIELD, DB_CLUSTER_ENDPOINT_RESOURCE_IDENTIFIER_FIELD,
ENDPOINT_FIELD, STATUS_FIELD, ENDPOINT_TYPE_FIELD, CUSTOM_ENDPOINT_TYPE_FIELD, STATIC_MEMBERS_FIELD,
EXCLUDED_MEMBERS_FIELD, DB_CLUSTER_ENDPOINT_ARN_FIELD));
private static final long serialVersionUID = 1L;
private final String dbClusterEndpointIdentifier;
private final String dbClusterIdentifier;
private final String dbClusterEndpointResourceIdentifier;
private final String endpoint;
private final String status;
private final String endpointType;
private final String customEndpointType;
private final List staticMembers;
private final List excludedMembers;
private final String dbClusterEndpointArn;
private DBClusterEndpoint(BuilderImpl builder) {
this.dbClusterEndpointIdentifier = builder.dbClusterEndpointIdentifier;
this.dbClusterIdentifier = builder.dbClusterIdentifier;
this.dbClusterEndpointResourceIdentifier = builder.dbClusterEndpointResourceIdentifier;
this.endpoint = builder.endpoint;
this.status = builder.status;
this.endpointType = builder.endpointType;
this.customEndpointType = builder.customEndpointType;
this.staticMembers = builder.staticMembers;
this.excludedMembers = builder.excludedMembers;
this.dbClusterEndpointArn = builder.dbClusterEndpointArn;
}
/**
*
* The identifier associated with the endpoint. This parameter is stored as a lowercase string.
*
*
* @return The identifier associated with the endpoint. This parameter is stored as a lowercase string.
*/
public final String dbClusterEndpointIdentifier() {
return dbClusterEndpointIdentifier;
}
/**
*
* The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase
* string.
*
*
* @return The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a
* lowercase string.
*/
public final String dbClusterIdentifier() {
return dbClusterIdentifier;
}
/**
*
* A unique system-generated identifier for an endpoint. It remains the same for the whole life of the endpoint.
*
*
* @return A unique system-generated identifier for an endpoint. It remains the same for the whole life of the
* endpoint.
*/
public final String dbClusterEndpointResourceIdentifier() {
return dbClusterEndpointResourceIdentifier;
}
/**
*
* The DNS address of the endpoint.
*
*
* @return The DNS address of the endpoint.
*/
public final String endpoint() {
return endpoint;
}
/**
*
* The current status of the endpoint. One of: creating
, available
, deleting
,
* inactive
, modifying
. The inactive
state applies to an endpoint that cannot
* be used for a certain kind of cluster, such as a writer
endpoint for a read-only secondary cluster
* in a global database.
*
*
* @return The current status of the endpoint. One of: creating
, available
,
* deleting
, inactive
, modifying
. The inactive
state
* applies to an endpoint that cannot be used for a certain kind of cluster, such as a writer
* endpoint for a read-only secondary cluster in a global database.
*/
public final String status() {
return status;
}
/**
*
* The type of the endpoint. One of: READER
, WRITER
, CUSTOM
.
*
*
* @return The type of the endpoint. One of: READER
, WRITER
, CUSTOM
.
*/
public final String endpointType() {
return endpointType;
}
/**
*
* The type associated with a custom endpoint. One of: READER
, WRITER
, ANY
.
*
*
* @return The type associated with a custom endpoint. One of: READER
, WRITER
,
* ANY
.
*/
public final String customEndpointType() {
return customEndpointType;
}
/**
* 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 the {@code 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.
*/
public final boolean hasStaticMembers() {
return staticMembers != null && !(staticMembers instanceof SdkAutoConstructList);
}
/**
*
* 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 {@link #hasStaticMembers} method.
*
*
* @return List of DB instance identifiers that are part of the custom endpoint group.
*/
public final List staticMembers() {
return staticMembers;
}
/**
* 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 the {@code 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.
*/
public final boolean hasExcludedMembers() {
return excludedMembers != null && !(excludedMembers instanceof SdkAutoConstructList);
}
/**
*
* 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 {@link #hasExcludedMembers} method.
*
*
* @return 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.
*/
public final List excludedMembers() {
return excludedMembers;
}
/**
*
* The Amazon Resource Name (ARN) for the endpoint.
*
*
* @return The Amazon Resource Name (ARN) for the endpoint.
*/
public final String dbClusterEndpointArn() {
return dbClusterEndpointArn;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class extends Builder> serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + Objects.hashCode(dbClusterEndpointIdentifier());
hashCode = 31 * hashCode + Objects.hashCode(dbClusterIdentifier());
hashCode = 31 * hashCode + Objects.hashCode(dbClusterEndpointResourceIdentifier());
hashCode = 31 * hashCode + Objects.hashCode(endpoint());
hashCode = 31 * hashCode + Objects.hashCode(status());
hashCode = 31 * hashCode + Objects.hashCode(endpointType());
hashCode = 31 * hashCode + Objects.hashCode(customEndpointType());
hashCode = 31 * hashCode + Objects.hashCode(hasStaticMembers() ? staticMembers() : null);
hashCode = 31 * hashCode + Objects.hashCode(hasExcludedMembers() ? excludedMembers() : null);
hashCode = 31 * hashCode + Objects.hashCode(dbClusterEndpointArn());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof DBClusterEndpoint)) {
return false;
}
DBClusterEndpoint other = (DBClusterEndpoint) obj;
return Objects.equals(dbClusterEndpointIdentifier(), other.dbClusterEndpointIdentifier())
&& Objects.equals(dbClusterIdentifier(), other.dbClusterIdentifier())
&& Objects.equals(dbClusterEndpointResourceIdentifier(), other.dbClusterEndpointResourceIdentifier())
&& Objects.equals(endpoint(), other.endpoint()) && Objects.equals(status(), other.status())
&& Objects.equals(endpointType(), other.endpointType())
&& Objects.equals(customEndpointType(), other.customEndpointType())
&& hasStaticMembers() == other.hasStaticMembers() && Objects.equals(staticMembers(), other.staticMembers())
&& hasExcludedMembers() == other.hasExcludedMembers()
&& Objects.equals(excludedMembers(), other.excludedMembers())
&& Objects.equals(dbClusterEndpointArn(), other.dbClusterEndpointArn());
}
/**
* 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.
*/
@Override
public final String toString() {
return ToString.builder("DBClusterEndpoint").add("DBClusterEndpointIdentifier", dbClusterEndpointIdentifier())
.add("DBClusterIdentifier", dbClusterIdentifier())
.add("DBClusterEndpointResourceIdentifier", dbClusterEndpointResourceIdentifier()).add("Endpoint", endpoint())
.add("Status", status()).add("EndpointType", endpointType()).add("CustomEndpointType", customEndpointType())
.add("StaticMembers", hasStaticMembers() ? staticMembers() : null)
.add("ExcludedMembers", hasExcludedMembers() ? excludedMembers() : null)
.add("DBClusterEndpointArn", dbClusterEndpointArn()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "DBClusterEndpointIdentifier":
return Optional.ofNullable(clazz.cast(dbClusterEndpointIdentifier()));
case "DBClusterIdentifier":
return Optional.ofNullable(clazz.cast(dbClusterIdentifier()));
case "DBClusterEndpointResourceIdentifier":
return Optional.ofNullable(clazz.cast(dbClusterEndpointResourceIdentifier()));
case "Endpoint":
return Optional.ofNullable(clazz.cast(endpoint()));
case "Status":
return Optional.ofNullable(clazz.cast(status()));
case "EndpointType":
return Optional.ofNullable(clazz.cast(endpointType()));
case "CustomEndpointType":
return Optional.ofNullable(clazz.cast(customEndpointType()));
case "StaticMembers":
return Optional.ofNullable(clazz.cast(staticMembers()));
case "ExcludedMembers":
return Optional.ofNullable(clazz.cast(excludedMembers()));
case "DBClusterEndpointArn":
return Optional.ofNullable(clazz.cast(dbClusterEndpointArn()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function