software.amazon.awssdk.services.rds.model.DescribeDbClusterEndpointsRequest Maven / Gradle / Ivy
Show all versions of rds 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.rds.model;
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.Consumer;
import java.util.function.Function;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.awscore.AwsRequestOverrideConfiguration;
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;
/**
*/
@Generated("software.amazon.awssdk:codegen")
public final class DescribeDbClusterEndpointsRequest extends RdsRequest implements
ToCopyableBuilder {
private static final SdkField DB_CLUSTER_IDENTIFIER_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("DBClusterIdentifier").getter(getter(DescribeDbClusterEndpointsRequest::dbClusterIdentifier))
.setter(setter(Builder::dbClusterIdentifier))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DBClusterIdentifier").build())
.build();
private static final SdkField DB_CLUSTER_ENDPOINT_IDENTIFIER_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("DBClusterEndpointIdentifier")
.getter(getter(DescribeDbClusterEndpointsRequest::dbClusterEndpointIdentifier))
.setter(setter(Builder::dbClusterEndpointIdentifier))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DBClusterEndpointIdentifier")
.build()).build();
private static final SdkField> FILTERS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Filters")
.getter(getter(DescribeDbClusterEndpointsRequest::filters))
.setter(setter(Builder::filters))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Filters").build(),
ListTrait
.builder()
.memberLocationName("Filter")
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(Filter::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("Filter").build()).build()).build()).build();
private static final SdkField MAX_RECORDS_FIELD = SdkField. builder(MarshallingType.INTEGER)
.memberName("MaxRecords").getter(getter(DescribeDbClusterEndpointsRequest::maxRecords))
.setter(setter(Builder::maxRecords))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("MaxRecords").build()).build();
private static final SdkField MARKER_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Marker")
.getter(getter(DescribeDbClusterEndpointsRequest::marker)).setter(setter(Builder::marker))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Marker").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(DB_CLUSTER_IDENTIFIER_FIELD,
DB_CLUSTER_ENDPOINT_IDENTIFIER_FIELD, FILTERS_FIELD, MAX_RECORDS_FIELD, MARKER_FIELD));
private final String dbClusterIdentifier;
private final String dbClusterEndpointIdentifier;
private final List filters;
private final Integer maxRecords;
private final String marker;
private DescribeDbClusterEndpointsRequest(BuilderImpl builder) {
super(builder);
this.dbClusterIdentifier = builder.dbClusterIdentifier;
this.dbClusterEndpointIdentifier = builder.dbClusterEndpointIdentifier;
this.filters = builder.filters;
this.maxRecords = builder.maxRecords;
this.marker = builder.marker;
}
/**
*
* 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;
}
/**
*
* The identifier of the endpoint to describe. This parameter is stored as a lowercase string.
*
*
* @return The identifier of the endpoint to describe. This parameter is stored as a lowercase string.
*/
public final String dbClusterEndpointIdentifier() {
return dbClusterEndpointIdentifier;
}
/**
* For responses, this returns true if the service returned a value for the Filters 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 hasFilters() {
return filters != null && !(filters instanceof SdkAutoConstructList);
}
/**
*
* A set of name-value pairs that define which endpoints to include in the output. The filters are specified as
* name-value pairs, in the format
* Name=endpoint_type,Values=endpoint_type1,endpoint_type2,.... Name
* can be one of: db-cluster-endpoint-type, db-cluster-endpoint-custom-type,
* db-cluster-endpoint-id, db-cluster-endpoint-status. Values for the
* db-cluster-endpoint-type filter can be one or more of: reader, writer,
* custom. Values for the db-cluster-endpoint-custom-type filter can be one
* or more of: reader, any. Values for the
* db-cluster-endpoint-status filter can be one or more of: available,
* creating, deleting, inactive, modifying.
*
*
* 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 #hasFilters} method.
*
*
* @return A set of name-value pairs that define which endpoints to include in the output. The filters are specified
* as name-value pairs, in the format
* Name=endpoint_type,Values=endpoint_type1,endpoint_type2,....
* Name can be one of: db-cluster-endpoint-type,
* db-cluster-endpoint-custom-type, db-cluster-endpoint-id,
* db-cluster-endpoint-status. Values for the
* db-cluster-endpoint-type filter can be one or more of: reader,
* writer, custom. Values for the
* db-cluster-endpoint-custom-type filter can be one or more of: reader,
* any. Values for the db-cluster-endpoint-status filter can be one
* or more of: available, creating, deleting, inactive,
* modifying.
*/
public final List filters() {
return filters;
}
/**
*
* The maximum number of records to include in the response. If more records exist than the specified
* MaxRecords value, a pagination token called a marker is included in the response so you can retrieve
* the remaining results.
*
*
* Default: 100
*
*
* Constraints: Minimum 20, maximum 100.
*
*
* @return The maximum number of records to include in the response. If more records exist than the specified
* MaxRecords value, a pagination token called a marker is included in the response so you can
* retrieve the remaining results.
*
* Default: 100
*
*
* Constraints: Minimum 20, maximum 100.
*/
public final Integer maxRecords() {
return maxRecords;
}
/**
*
* An optional pagination token provided by a previous DescribeDBClusterEndpoints request. If this
* parameter is specified, the response includes only records beyond the marker, up to the value specified by
* MaxRecords.
*
*
* @return An optional pagination token provided by a previous DescribeDBClusterEndpoints request. If
* this parameter is specified, the response includes only records beyond the marker, up to the value
* specified by MaxRecords.
*/
public final String marker() {
return marker;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(dbClusterIdentifier());
hashCode = 31 * hashCode + Objects.hashCode(dbClusterEndpointIdentifier());
hashCode = 31 * hashCode + Objects.hashCode(hasFilters() ? filters() : null);
hashCode = 31 * hashCode + Objects.hashCode(maxRecords());
hashCode = 31 * hashCode + Objects.hashCode(marker());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof DescribeDbClusterEndpointsRequest)) {
return false;
}
DescribeDbClusterEndpointsRequest other = (DescribeDbClusterEndpointsRequest) obj;
return Objects.equals(dbClusterIdentifier(), other.dbClusterIdentifier())
&& Objects.equals(dbClusterEndpointIdentifier(), other.dbClusterEndpointIdentifier())
&& hasFilters() == other.hasFilters() && Objects.equals(filters(), other.filters())
&& Objects.equals(maxRecords(), other.maxRecords()) && Objects.equals(marker(), other.marker());
}
/**
* 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("DescribeDbClusterEndpointsRequest").add("DBClusterIdentifier", dbClusterIdentifier())
.add("DBClusterEndpointIdentifier", dbClusterEndpointIdentifier())
.add("Filters", hasFilters() ? filters() : null).add("MaxRecords", maxRecords()).add("Marker", marker()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "DBClusterIdentifier":
return Optional.ofNullable(clazz.cast(dbClusterIdentifier()));
case "DBClusterEndpointIdentifier":
return Optional.ofNullable(clazz.cast(dbClusterEndpointIdentifier()));
case "Filters":
return Optional.ofNullable(clazz.cast(filters()));
case "MaxRecords":
return Optional.ofNullable(clazz.cast(maxRecords()));
case "Marker":
return Optional.ofNullable(clazz.cast(marker()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((DescribeDbClusterEndpointsRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends RdsRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a
* lowercase string.
*
*
* @param dbClusterIdentifier
* The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as
* a lowercase string.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder dbClusterIdentifier(String dbClusterIdentifier);
/**
*
* The identifier of the endpoint to describe. This parameter is stored as a lowercase string.
*
*
* @param dbClusterEndpointIdentifier
* The identifier of the endpoint to describe. This parameter is stored as a lowercase string.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder dbClusterEndpointIdentifier(String dbClusterEndpointIdentifier);
/**
*
* A set of name-value pairs that define which endpoints to include in the output. The filters are specified as
* name-value pairs, in the format
* Name=endpoint_type,Values=endpoint_type1,endpoint_type2,....
* Name can be one of: db-cluster-endpoint-type,
* db-cluster-endpoint-custom-type, db-cluster-endpoint-id,
* db-cluster-endpoint-status. Values for the db-cluster-endpoint-type
* filter can be one or more of: reader, writer, custom.
* Values for the db-cluster-endpoint-custom-type filter can be one or more of:
* reader, any. Values for the db-cluster-endpoint-status
* filter can be one or more of: available, creating, deleting,
* inactive, modifying.
*
*
* @param filters
* A set of name-value pairs that define which endpoints to include in the output. The filters are
* specified as name-value pairs, in the format
* Name=endpoint_type,Values=endpoint_type1,endpoint_type2,....
* Name can be one of: db-cluster-endpoint-type,
* db-cluster-endpoint-custom-type, db-cluster-endpoint-id,
* db-cluster-endpoint-status. Values for the
* db-cluster-endpoint-type filter can be one or more of: reader,
* writer, custom. Values for the
* db-cluster-endpoint-custom-type filter can be one or more of: reader,
* any. Values for the db-cluster-endpoint-status filter can be
* one or more of: available, creating, deleting,
* inactive, modifying.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder filters(Collection filters);
/**
*
* A set of name-value pairs that define which endpoints to include in the output. The filters are specified as
* name-value pairs, in the format
* Name=endpoint_type,Values=endpoint_type1,endpoint_type2,....
* Name can be one of: db-cluster-endpoint-type,
* db-cluster-endpoint-custom-type, db-cluster-endpoint-id,
* db-cluster-endpoint-status. Values for the db-cluster-endpoint-type
* filter can be one or more of: reader, writer, custom.
* Values for the db-cluster-endpoint-custom-type filter can be one or more of:
* reader, any. Values for the db-cluster-endpoint-status
* filter can be one or more of: available, creating, deleting,
* inactive, modifying.
*
*
* @param filters
* A set of name-value pairs that define which endpoints to include in the output. The filters are
* specified as name-value pairs, in the format
* Name=endpoint_type,Values=endpoint_type1,endpoint_type2,....
* Name can be one of: db-cluster-endpoint-type,
* db-cluster-endpoint-custom-type, db-cluster-endpoint-id,
* db-cluster-endpoint-status. Values for the
* db-cluster-endpoint-type filter can be one or more of: reader,
* writer, custom. Values for the
* db-cluster-endpoint-custom-type filter can be one or more of: reader,
* any. Values for the db-cluster-endpoint-status filter can be
* one or more of: available, creating, deleting,
* inactive, modifying.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder filters(Filter... filters);
/**
*
* A set of name-value pairs that define which endpoints to include in the output. The filters are specified as
* name-value pairs, in the format
* Name=endpoint_type,Values=endpoint_type1,endpoint_type2,....
* Name can be one of: db-cluster-endpoint-type,
* db-cluster-endpoint-custom-type, db-cluster-endpoint-id,
* db-cluster-endpoint-status. Values for the db-cluster-endpoint-type
* filter can be one or more of: reader, writer, custom.
* Values for the db-cluster-endpoint-custom-type filter can be one or more of:
* reader, any. Values for the db-cluster-endpoint-status
* filter can be one or more of: available, creating, deleting,
* inactive, modifying.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.rds.model.Filter.Builder} avoiding the need to create one manually via
* {@link software.amazon.awssdk.services.rds.model.Filter#builder()}.
*
*
* When the {@link Consumer} completes, {@link software.amazon.awssdk.services.rds.model.Filter.Builder#build()}
* is called immediately and its result is passed to {@link #filters(List)}.
*
* @param filters
* a consumer that will call methods on {@link software.amazon.awssdk.services.rds.model.Filter.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #filters(java.util.Collection)
*/
Builder filters(Consumer... filters);
/**
*
* The maximum number of records to include in the response. If more records exist than the specified
* MaxRecords value, a pagination token called a marker is included in the response so you can
* retrieve the remaining results.
*
*
* Default: 100
*
*
* Constraints: Minimum 20, maximum 100.
*
*
* @param maxRecords
* The maximum number of records to include in the response. If more records exist than the specified
* MaxRecords value, a pagination token called a marker is included in the response so you
* can retrieve the remaining results.
*
* Default: 100
*
*
* Constraints: Minimum 20, maximum 100.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder maxRecords(Integer maxRecords);
/**
*
* An optional pagination token provided by a previous DescribeDBClusterEndpoints request. If this
* parameter is specified, the response includes only records beyond the marker, up to the value specified by
* MaxRecords.
*
*
* @param marker
* An optional pagination token provided by a previous DescribeDBClusterEndpoints request.
* If this parameter is specified, the response includes only records beyond the marker, up to the value
* specified by MaxRecords.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder marker(String marker);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends RdsRequest.BuilderImpl implements Builder {
private String dbClusterIdentifier;
private String dbClusterEndpointIdentifier;
private List filters = DefaultSdkAutoConstructList.getInstance();
private Integer maxRecords;
private String marker;
private BuilderImpl() {
}
private BuilderImpl(DescribeDbClusterEndpointsRequest model) {
super(model);
dbClusterIdentifier(model.dbClusterIdentifier);
dbClusterEndpointIdentifier(model.dbClusterEndpointIdentifier);
filters(model.filters);
maxRecords(model.maxRecords);
marker(model.marker);
}
public final String getDbClusterIdentifier() {
return dbClusterIdentifier;
}
public final void setDbClusterIdentifier(String dbClusterIdentifier) {
this.dbClusterIdentifier = dbClusterIdentifier;
}
@Override
public final Builder dbClusterIdentifier(String dbClusterIdentifier) {
this.dbClusterIdentifier = dbClusterIdentifier;
return this;
}
public final String getDbClusterEndpointIdentifier() {
return dbClusterEndpointIdentifier;
}
public final void setDbClusterEndpointIdentifier(String dbClusterEndpointIdentifier) {
this.dbClusterEndpointIdentifier = dbClusterEndpointIdentifier;
}
@Override
public final Builder dbClusterEndpointIdentifier(String dbClusterEndpointIdentifier) {
this.dbClusterEndpointIdentifier = dbClusterEndpointIdentifier;
return this;
}
public final List getFilters() {
List result = FilterListCopier.copyToBuilder(this.filters);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setFilters(Collection filters) {
this.filters = FilterListCopier.copyFromBuilder(filters);
}
@Override
public final Builder filters(Collection filters) {
this.filters = FilterListCopier.copy(filters);
return this;
}
@Override
@SafeVarargs
public final Builder filters(Filter... filters) {
filters(Arrays.asList(filters));
return this;
}
@Override
@SafeVarargs
public final Builder filters(Consumer... filters) {
filters(Stream.of(filters).map(c -> Filter.builder().applyMutation(c).build()).collect(Collectors.toList()));
return this;
}
public final Integer getMaxRecords() {
return maxRecords;
}
public final void setMaxRecords(Integer maxRecords) {
this.maxRecords = maxRecords;
}
@Override
public final Builder maxRecords(Integer maxRecords) {
this.maxRecords = maxRecords;
return this;
}
public final String getMarker() {
return marker;
}
public final void setMarker(String marker) {
this.marker = marker;
}
@Override
public final Builder marker(String marker) {
this.marker = marker;
return this;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public DescribeDbClusterEndpointsRequest build() {
return new DescribeDbClusterEndpointsRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}