software.amazon.awssdk.services.neptune.model.DescribeDbInstancesRequest 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.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 DescribeDbInstancesRequest extends NeptuneRequest implements
ToCopyableBuilder {
private static final SdkField DB_INSTANCE_IDENTIFIER_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("DBInstanceIdentifier").getter(getter(DescribeDbInstancesRequest::dbInstanceIdentifier))
.setter(setter(Builder::dbInstanceIdentifier))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DBInstanceIdentifier").build())
.build();
private static final SdkField> FILTERS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Filters")
.getter(getter(DescribeDbInstancesRequest::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(DescribeDbInstancesRequest::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(DescribeDbInstancesRequest::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_INSTANCE_IDENTIFIER_FIELD,
FILTERS_FIELD, MAX_RECORDS_FIELD, MARKER_FIELD));
private final String dbInstanceIdentifier;
private final List filters;
private final Integer maxRecords;
private final String marker;
private DescribeDbInstancesRequest(BuilderImpl builder) {
super(builder);
this.dbInstanceIdentifier = builder.dbInstanceIdentifier;
this.filters = builder.filters;
this.maxRecords = builder.maxRecords;
this.marker = builder.marker;
}
/**
*
* The user-supplied instance identifier. If this parameter is specified, information from only the specific DB
* instance is returned. This parameter isn't case-sensitive.
*
*
* Constraints:
*
*
* -
*
* If supplied, must match the identifier of an existing DBInstance.
*
*
*
*
* @return The user-supplied instance identifier. If this parameter is specified, information from only the specific
* DB instance is returned. This parameter isn't case-sensitive.
*
* Constraints:
*
*
* -
*
* If supplied, must match the identifier of an existing DBInstance.
*
*
*/
public final String dbInstanceIdentifier() {
return dbInstanceIdentifier;
}
/**
* Returns true if the Filters property was specified by the sender (it may be empty), or false if the sender did
* not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
*/
public final boolean hasFilters() {
return filters != null && !(filters instanceof SdkAutoConstructList);
}
/**
*
* A filter that specifies one or more DB instances to describe.
*
*
* Supported filters:
*
*
* -
*
* db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The
* results list will only include information about the DB instances associated with the DB clusters identified by
* these ARNs.
*
*
* -
*
* engine - Accepts an engine name (such as neptune), and restricts the results list to DB
* instances created by that engine.
*
*
*
*
* For example, to invoke this API from the AWS CLI and filter so that only Neptune DB instances are returned, you
* could use the following command:
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* You can use {@link #hasFilters()} to see if a value was sent in this field.
*
*
* @return A filter that specifies one or more DB instances to describe.
*
* Supported filters:
*
*
* -
*
* db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs).
* The results list will only include information about the DB instances associated with the DB clusters
* identified by these ARNs.
*
*
* -
*
* engine - Accepts an engine name (such as neptune), and restricts the results
* list to DB instances created by that engine.
*
*
*
*
* For example, to invoke this API from the AWS CLI and filter so that only Neptune DB instances are
* returned, you could use the following command:
*/
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 that the
* remaining results can be retrieved.
*
*
* 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 that the
* remaining results can be retrieved.
*
* Default: 100
*
*
* Constraints: Minimum 20, maximum 100.
*/
public final Integer maxRecords() {
return maxRecords;
}
/**
*
* An optional pagination token provided by a previous DescribeDBInstances 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 DescribeDBInstances 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(dbInstanceIdentifier());
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 DescribeDbInstancesRequest)) {
return false;
}
DescribeDbInstancesRequest other = (DescribeDbInstancesRequest) obj;
return Objects.equals(dbInstanceIdentifier(), other.dbInstanceIdentifier()) && 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("DescribeDbInstancesRequest").add("DBInstanceIdentifier", dbInstanceIdentifier())
.add("Filters", hasFilters() ? filters() : null).add("MaxRecords", maxRecords()).add("Marker", marker()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "DBInstanceIdentifier":
return Optional.ofNullable(clazz.cast(dbInstanceIdentifier()));
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((DescribeDbInstancesRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends NeptuneRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* The user-supplied instance identifier. If this parameter is specified, information from only the specific DB
* instance is returned. This parameter isn't case-sensitive.
*
*
* Constraints:
*
*
* -
*
* If supplied, must match the identifier of an existing DBInstance.
*
*
*
*
* @param dbInstanceIdentifier
* The user-supplied instance identifier. If this parameter is specified, information from only the
* specific DB instance is returned. This parameter isn't case-sensitive.
*
* Constraints:
*
*
* -
*
* If supplied, must match the identifier of an existing DBInstance.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder dbInstanceIdentifier(String dbInstanceIdentifier);
/**
*
* A filter that specifies one or more DB instances to describe.
*
*
* Supported filters:
*
*
* -
*
* db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The
* results list will only include information about the DB instances associated with the DB clusters identified
* by these ARNs.
*
*
* -
*
* engine - Accepts an engine name (such as neptune), and restricts the results list
* to DB instances created by that engine.
*
*
*
*
* For example, to invoke this API from the AWS CLI and filter so that only Neptune DB instances are returned,
* you could use the following command:
*
*
* @param filters
* A filter that specifies one or more DB instances to describe.
*
* Supported filters:
*
*
* -
*
* db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names
* (ARNs). The results list will only include information about the DB instances associated with the DB
* clusters identified by these ARNs.
*
*
* -
*
* engine - Accepts an engine name (such as neptune), and restricts the results
* list to DB instances created by that engine.
*
*
*
*
* For example, to invoke this API from the AWS CLI and filter so that only Neptune DB instances are
* returned, you could use the following command:
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder filters(Collection filters);
/**
*
* A filter that specifies one or more DB instances to describe.
*
*
* Supported filters:
*
*
* -
*
* db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The
* results list will only include information about the DB instances associated with the DB clusters identified
* by these ARNs.
*
*
* -
*
* engine - Accepts an engine name (such as neptune), and restricts the results list
* to DB instances created by that engine.
*
*
*
*
* For example, to invoke this API from the AWS CLI and filter so that only Neptune DB instances are returned,
* you could use the following command:
*
*
* @param filters
* A filter that specifies one or more DB instances to describe.
*
* Supported filters:
*
*
* -
*
* db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names
* (ARNs). The results list will only include information about the DB instances associated with the DB
* clusters identified by these ARNs.
*
*
* -
*
* engine - Accepts an engine name (such as neptune), and restricts the results
* list to DB instances created by that engine.
*
*
*
*
* For example, to invoke this API from the AWS CLI and filter so that only Neptune DB instances are
* returned, you could use the following command:
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder filters(Filter... filters);
/**
*
* A filter that specifies one or more DB instances to describe.
*
*
* Supported filters:
*
*
* -
*
* db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The
* results list will only include information about the DB instances associated with the DB clusters identified
* by these ARNs.
*
*
* -
*
* engine - Accepts an engine name (such as neptune), and restricts the results list
* to DB instances created by that engine.
*
*
*
*
* For example, to invoke this API from the AWS CLI and filter so that only Neptune DB instances are returned,
* you could use the following command:
*
* This is a convenience that creates an instance of the {@link List.Builder} avoiding the need to
* create one manually via {@link List#builder()}.
*
* When the {@link Consumer} completes, {@link List.Builder#build()} is called immediately and its
* result is passed to {@link #filters(List)}.
*
* @param filters
* a consumer that will call methods on {@link List.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #filters(List)
*/
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 that the
* remaining results can be retrieved.
*
*
* 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 that
* the remaining results can be retrieved.
*
* 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 DescribeDBInstances 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 DescribeDBInstances 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 NeptuneRequest.BuilderImpl implements Builder {
private String dbInstanceIdentifier;
private List filters = DefaultSdkAutoConstructList.getInstance();
private Integer maxRecords;
private String marker;
private BuilderImpl() {
}
private BuilderImpl(DescribeDbInstancesRequest model) {
super(model);
dbInstanceIdentifier(model.dbInstanceIdentifier);
filters(model.filters);
maxRecords(model.maxRecords);
marker(model.marker);
}
public final String getDbInstanceIdentifier() {
return dbInstanceIdentifier;
}
@Override
public final Builder dbInstanceIdentifier(String dbInstanceIdentifier) {
this.dbInstanceIdentifier = dbInstanceIdentifier;
return this;
}
public final void setDbInstanceIdentifier(String dbInstanceIdentifier) {
this.dbInstanceIdentifier = dbInstanceIdentifier;
}
public final Collection getFilters() {
if (filters instanceof SdkAutoConstructList) {
return null;
}
return filters != null ? filters.stream().map(Filter::toBuilder).collect(Collectors.toList()) : null;
}
@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 void setFilters(Collection filters) {
this.filters = FilterListCopier.copyFromBuilder(filters);
}
public final Integer getMaxRecords() {
return maxRecords;
}
@Override
public final Builder maxRecords(Integer maxRecords) {
this.maxRecords = maxRecords;
return this;
}
public final void setMaxRecords(Integer maxRecords) {
this.maxRecords = maxRecords;
}
public final String getMarker() {
return marker;
}
@Override
public final Builder marker(String marker) {
this.marker = marker;
return this;
}
public final void setMarker(String marker) {
this.marker = marker;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public DescribeDbInstancesRequest build() {
return new DescribeDbInstancesRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}