software.amazon.awssdk.services.rds.model.DescribeDbSnapshotsRequest 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 DescribeDbSnapshotsRequest extends RdsRequest implements
ToCopyableBuilder {
private static final SdkField DB_INSTANCE_IDENTIFIER_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("DBInstanceIdentifier").getter(getter(DescribeDbSnapshotsRequest::dbInstanceIdentifier))
.setter(setter(Builder::dbInstanceIdentifier))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DBInstanceIdentifier").build())
.build();
private static final SdkField DB_SNAPSHOT_IDENTIFIER_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("DBSnapshotIdentifier").getter(getter(DescribeDbSnapshotsRequest::dbSnapshotIdentifier))
.setter(setter(Builder::dbSnapshotIdentifier))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DBSnapshotIdentifier").build())
.build();
private static final SdkField SNAPSHOT_TYPE_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("SnapshotType").getter(getter(DescribeDbSnapshotsRequest::snapshotType))
.setter(setter(Builder::snapshotType))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("SnapshotType").build()).build();
private static final SdkField> FILTERS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Filters")
.getter(getter(DescribeDbSnapshotsRequest::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(DescribeDbSnapshotsRequest::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(DescribeDbSnapshotsRequest::marker)).setter(setter(Builder::marker))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Marker").build()).build();
private static final SdkField INCLUDE_SHARED_FIELD = SdkField. builder(MarshallingType.BOOLEAN)
.memberName("IncludeShared").getter(getter(DescribeDbSnapshotsRequest::includeShared))
.setter(setter(Builder::includeShared))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("IncludeShared").build()).build();
private static final SdkField INCLUDE_PUBLIC_FIELD = SdkField. builder(MarshallingType.BOOLEAN)
.memberName("IncludePublic").getter(getter(DescribeDbSnapshotsRequest::includePublic))
.setter(setter(Builder::includePublic))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("IncludePublic").build()).build();
private static final SdkField DBI_RESOURCE_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("DbiResourceId").getter(getter(DescribeDbSnapshotsRequest::dbiResourceId))
.setter(setter(Builder::dbiResourceId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DbiResourceId").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(DB_INSTANCE_IDENTIFIER_FIELD,
DB_SNAPSHOT_IDENTIFIER_FIELD, SNAPSHOT_TYPE_FIELD, FILTERS_FIELD, MAX_RECORDS_FIELD, MARKER_FIELD,
INCLUDE_SHARED_FIELD, INCLUDE_PUBLIC_FIELD, DBI_RESOURCE_ID_FIELD));
private final String dbInstanceIdentifier;
private final String dbSnapshotIdentifier;
private final String snapshotType;
private final List filters;
private final Integer maxRecords;
private final String marker;
private final Boolean includeShared;
private final Boolean includePublic;
private final String dbiResourceId;
private DescribeDbSnapshotsRequest(BuilderImpl builder) {
super(builder);
this.dbInstanceIdentifier = builder.dbInstanceIdentifier;
this.dbSnapshotIdentifier = builder.dbSnapshotIdentifier;
this.snapshotType = builder.snapshotType;
this.filters = builder.filters;
this.maxRecords = builder.maxRecords;
this.marker = builder.marker;
this.includeShared = builder.includeShared;
this.includePublic = builder.includePublic;
this.dbiResourceId = builder.dbiResourceId;
}
/**
*
* The ID of the DB instance to retrieve the list of DB snapshots for. This parameter isn't case-sensitive.
*
*
* Constraints:
*
*
* -
*
* If supplied, must match the identifier of an existing DBInstance.
*
*
*
*
* @return The ID of the DB instance to retrieve the list of DB snapshots for. This parameter isn't
* case-sensitive.
*
* Constraints:
*
*
* -
*
* If supplied, must match the identifier of an existing DBInstance.
*
*
*/
public final String dbInstanceIdentifier() {
return dbInstanceIdentifier;
}
/**
*
* A specific DB snapshot identifier to describe. This value is stored as a lowercase string.
*
*
* Constraints:
*
*
* -
*
* If supplied, must match the identifier of an existing DBSnapshot.
*
*
* -
*
* If this identifier is for an automated snapshot, the SnapshotType parameter must also be specified.
*
*
*
*
* @return A specific DB snapshot identifier to describe. This value is stored as a lowercase string.
*
* Constraints:
*
*
* -
*
* If supplied, must match the identifier of an existing DBSnapshot.
*
*
* -
*
* If this identifier is for an automated snapshot, the SnapshotType parameter must also be
* specified.
*
*
*/
public final String dbSnapshotIdentifier() {
return dbSnapshotIdentifier;
}
/**
*
* The type of snapshots to be returned. You can specify one of the following values:
*
*
* -
*
* automated - Return all DB snapshots that have been automatically taken by Amazon RDS for my Amazon
* Web Services account.
*
*
* -
*
* manual - Return all DB snapshots that have been taken by my Amazon Web Services account.
*
*
* -
*
* shared - Return all manual DB snapshots that have been shared to my Amazon Web Services account.
*
*
* -
*
* public - Return all DB snapshots that have been marked as public.
*
*
* -
*
* awsbackup - Return the DB snapshots managed by the Amazon Web Services Backup service.
*
*
* For information about Amazon Web Services Backup, see the Amazon Web Services Backup
* Developer Guide.
*
*
* The awsbackup type does not apply to Aurora.
*
*
*
*
* If you don't specify a SnapshotType value, then both automated and manual snapshots are returned.
* Shared and public DB snapshots are not included in the returned results by default. You can include shared
* snapshots with these results by enabling the IncludeShared parameter. You can include public
* snapshots with these results by enabling the IncludePublic parameter.
*
*
* The IncludeShared and IncludePublic parameters don't apply for
* SnapshotType values of manual or automated. The IncludePublic
* parameter doesn't apply when SnapshotType is set to shared. The
* IncludeShared parameter doesn't apply when SnapshotType is set to public.
*
*
* @return The type of snapshots to be returned. You can specify one of the following values:
*
* -
*
* automated - Return all DB snapshots that have been automatically taken by Amazon RDS for my
* Amazon Web Services account.
*
*
* -
*
* manual - Return all DB snapshots that have been taken by my Amazon Web Services account.
*
*
* -
*
* shared - Return all manual DB snapshots that have been shared to my Amazon Web Services
* account.
*
*
* -
*
* public - Return all DB snapshots that have been marked as public.
*
*
* -
*
* awsbackup - Return the DB snapshots managed by the Amazon Web Services Backup service.
*
*
* For information about Amazon Web Services Backup, see the Amazon Web Services
* Backup Developer Guide.
*
*
* The awsbackup type does not apply to Aurora.
*
*
*
*
* If you don't specify a SnapshotType value, then both automated and manual snapshots are
* returned. Shared and public DB snapshots are not included in the returned results by default. You can
* include shared snapshots with these results by enabling the IncludeShared parameter. You can
* include public snapshots with these results by enabling the IncludePublic parameter.
*
*
* The IncludeShared and IncludePublic parameters don't apply for
* SnapshotType values of manual or automated. The
* IncludePublic parameter doesn't apply when SnapshotType is set to
* shared. The IncludeShared parameter doesn't apply when
* SnapshotType is set to public.
*/
public final String snapshotType() {
return snapshotType;
}
/**
* 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 filter that specifies one or more DB snapshots to describe.
*
*
* Supported filters:
*
*
* -
*
* db-instance-id - Accepts DB instance identifiers and DB instance Amazon Resource Names (ARNs).
*
*
* -
*
* db-snapshot-id - Accepts DB snapshot identifiers.
*
*
* -
*
* dbi-resource-id - Accepts identifiers of source DB instances.
*
*
* -
*
* snapshot-type - Accepts types of DB snapshots.
*
*
* -
*
* engine - Accepts names of database engines.
*
*
*
*
* 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 filter that specifies one or more DB snapshots to describe.
*
* Supported filters:
*
*
* -
*
* db-instance-id - Accepts DB instance identifiers and DB instance Amazon Resource Names
* (ARNs).
*
*
* -
*
* db-snapshot-id - Accepts DB snapshot identifiers.
*
*
* -
*
* dbi-resource-id - Accepts identifiers of source DB instances.
*
*
* -
*
* snapshot-type - Accepts types of DB snapshots.
*
*
* -
*
* engine - Accepts names of database engines.
*
*
*/
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 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 that 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 DescribeDBSnapshots 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 DescribeDBSnapshots 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;
}
/**
*
* Specifies whether to include shared manual DB cluster snapshots from other Amazon Web Services accounts that this
* Amazon Web Services account has been given permission to copy or restore. By default, these snapshots are not
* included.
*
*
* You can give an Amazon Web Services account permission to restore a manual DB snapshot from another Amazon Web
* Services account by using the ModifyDBSnapshotAttribute API action.
*
*
* This setting doesn't apply to RDS Custom.
*
*
* @return Specifies whether to include shared manual DB cluster snapshots from other Amazon Web Services accounts
* that this Amazon Web Services account has been given permission to copy or restore. By default, these
* snapshots are not included.
*
* You can give an Amazon Web Services account permission to restore a manual DB snapshot from another
* Amazon Web Services account by using the ModifyDBSnapshotAttribute API action.
*
*
* This setting doesn't apply to RDS Custom.
*/
public final Boolean includeShared() {
return includeShared;
}
/**
*
* Specifies whether to include manual DB cluster snapshots that are public and can be copied or restored by any
* Amazon Web Services account. By default, the public snapshots are not included.
*
*
* You can share a manual DB snapshot as public by using the ModifyDBSnapshotAttribute API.
*
*
* This setting doesn't apply to RDS Custom.
*
*
* @return Specifies whether to include manual DB cluster snapshots that are public and can be copied or restored by
* any Amazon Web Services account. By default, the public snapshots are not included.
*
* You can share a manual DB snapshot as public by using the ModifyDBSnapshotAttribute API.
*
*
* This setting doesn't apply to RDS Custom.
*/
public final Boolean includePublic() {
return includePublic;
}
/**
*
* A specific DB resource ID to describe.
*
*
* @return A specific DB resource ID to describe.
*/
public final String dbiResourceId() {
return dbiResourceId;
}
@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(dbSnapshotIdentifier());
hashCode = 31 * hashCode + Objects.hashCode(snapshotType());
hashCode = 31 * hashCode + Objects.hashCode(hasFilters() ? filters() : null);
hashCode = 31 * hashCode + Objects.hashCode(maxRecords());
hashCode = 31 * hashCode + Objects.hashCode(marker());
hashCode = 31 * hashCode + Objects.hashCode(includeShared());
hashCode = 31 * hashCode + Objects.hashCode(includePublic());
hashCode = 31 * hashCode + Objects.hashCode(dbiResourceId());
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 DescribeDbSnapshotsRequest)) {
return false;
}
DescribeDbSnapshotsRequest other = (DescribeDbSnapshotsRequest) obj;
return Objects.equals(dbInstanceIdentifier(), other.dbInstanceIdentifier())
&& Objects.equals(dbSnapshotIdentifier(), other.dbSnapshotIdentifier())
&& Objects.equals(snapshotType(), other.snapshotType()) && hasFilters() == other.hasFilters()
&& Objects.equals(filters(), other.filters()) && Objects.equals(maxRecords(), other.maxRecords())
&& Objects.equals(marker(), other.marker()) && Objects.equals(includeShared(), other.includeShared())
&& Objects.equals(includePublic(), other.includePublic())
&& Objects.equals(dbiResourceId(), other.dbiResourceId());
}
/**
* 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("DescribeDbSnapshotsRequest").add("DBInstanceIdentifier", dbInstanceIdentifier())
.add("DBSnapshotIdentifier", dbSnapshotIdentifier()).add("SnapshotType", snapshotType())
.add("Filters", hasFilters() ? filters() : null).add("MaxRecords", maxRecords()).add("Marker", marker())
.add("IncludeShared", includeShared()).add("IncludePublic", includePublic())
.add("DbiResourceId", dbiResourceId()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "DBInstanceIdentifier":
return Optional.ofNullable(clazz.cast(dbInstanceIdentifier()));
case "DBSnapshotIdentifier":
return Optional.ofNullable(clazz.cast(dbSnapshotIdentifier()));
case "SnapshotType":
return Optional.ofNullable(clazz.cast(snapshotType()));
case "Filters":
return Optional.ofNullable(clazz.cast(filters()));
case "MaxRecords":
return Optional.ofNullable(clazz.cast(maxRecords()));
case "Marker":
return Optional.ofNullable(clazz.cast(marker()));
case "IncludeShared":
return Optional.ofNullable(clazz.cast(includeShared()));
case "IncludePublic":
return Optional.ofNullable(clazz.cast(includePublic()));
case "DbiResourceId":
return Optional.ofNullable(clazz.cast(dbiResourceId()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((DescribeDbSnapshotsRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends RdsRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* The ID of the DB instance to retrieve the list of DB snapshots for. This parameter isn't case-sensitive.
*
*
* Constraints:
*
*
* -
*
* If supplied, must match the identifier of an existing DBInstance.
*
*
*
*
* @param dbInstanceIdentifier
* The ID of the DB instance to retrieve the list of DB snapshots for. 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 specific DB snapshot identifier to describe. This value is stored as a lowercase string.
*
*
* Constraints:
*
*
* -
*
* If supplied, must match the identifier of an existing DBSnapshot.
*
*
* -
*
* If this identifier is for an automated snapshot, the SnapshotType parameter must also be
* specified.
*
*
*
*
* @param dbSnapshotIdentifier
* A specific DB snapshot identifier to describe. This value is stored as a lowercase string.
*
* Constraints:
*
*
* -
*
* If supplied, must match the identifier of an existing DBSnapshot.
*
*
* -
*
* If this identifier is for an automated snapshot, the SnapshotType parameter must also be
* specified.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder dbSnapshotIdentifier(String dbSnapshotIdentifier);
/**
*
* The type of snapshots to be returned. You can specify one of the following values:
*
*
* -
*
* automated - Return all DB snapshots that have been automatically taken by Amazon RDS for my
* Amazon Web Services account.
*
*
* -
*
* manual - Return all DB snapshots that have been taken by my Amazon Web Services account.
*
*
* -
*
* shared - Return all manual DB snapshots that have been shared to my Amazon Web Services account.
*
*
* -
*
* public - Return all DB snapshots that have been marked as public.
*
*
* -
*
* awsbackup - Return the DB snapshots managed by the Amazon Web Services Backup service.
*
*
* For information about Amazon Web Services Backup, see the Amazon Web Services
* Backup Developer Guide.
*
*
* The awsbackup type does not apply to Aurora.
*
*
*
*
* If you don't specify a SnapshotType value, then both automated and manual snapshots are
* returned. Shared and public DB snapshots are not included in the returned results by default. You can include
* shared snapshots with these results by enabling the IncludeShared parameter. You can include
* public snapshots with these results by enabling the IncludePublic parameter.
*
*
* The IncludeShared and IncludePublic parameters don't apply for
* SnapshotType values of manual or automated. The
* IncludePublic parameter doesn't apply when SnapshotType is set to
* shared. The IncludeShared parameter doesn't apply when SnapshotType is
* set to public.
*
*
* @param snapshotType
* The type of snapshots to be returned. You can specify one of the following values:
*
* -
*
* automated - Return all DB snapshots that have been automatically taken by Amazon RDS for
* my Amazon Web Services account.
*
*
* -
*
* manual - Return all DB snapshots that have been taken by my Amazon Web Services account.
*
*
* -
*
* shared - Return all manual DB snapshots that have been shared to my Amazon Web Services
* account.
*
*
* -
*
* public - Return all DB snapshots that have been marked as public.
*
*
* -
*
* awsbackup - Return the DB snapshots managed by the Amazon Web Services Backup service.
*
*
* For information about Amazon Web Services Backup, see the Amazon Web
* Services Backup Developer Guide.
*
*
* The awsbackup type does not apply to Aurora.
*
*
*
*
* If you don't specify a SnapshotType value, then both automated and manual snapshots are
* returned. Shared and public DB snapshots are not included in the returned results by default. You can
* include shared snapshots with these results by enabling the IncludeShared parameter. You
* can include public snapshots with these results by enabling the IncludePublic parameter.
*
*
* The IncludeShared and IncludePublic parameters don't apply for
* SnapshotType values of manual or automated. The
* IncludePublic parameter doesn't apply when SnapshotType is set to
* shared. The IncludeShared parameter doesn't apply when
* SnapshotType is set to public.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder snapshotType(String snapshotType);
/**
*
* A filter that specifies one or more DB snapshots to describe.
*
*
* Supported filters:
*
*
* -
*
* db-instance-id - Accepts DB instance identifiers and DB instance Amazon Resource Names (ARNs).
*
*
* -
*
* db-snapshot-id - Accepts DB snapshot identifiers.
*
*
* -
*
* dbi-resource-id - Accepts identifiers of source DB instances.
*
*
* -
*
* snapshot-type - Accepts types of DB snapshots.
*
*
* -
*
* engine - Accepts names of database engines.
*
*
*
*
* @param filters
* A filter that specifies one or more DB snapshots to describe.
*
* Supported filters:
*
*
* -
*
* db-instance-id - Accepts DB instance identifiers and DB instance Amazon Resource Names
* (ARNs).
*
*
* -
*
* db-snapshot-id - Accepts DB snapshot identifiers.
*
*
* -
*
* dbi-resource-id - Accepts identifiers of source DB instances.
*
*
* -
*
* snapshot-type - Accepts types of DB snapshots.
*
*
* -
*
* engine - Accepts names of database engines.
*
*
* @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 snapshots to describe.
*
*
* Supported filters:
*
*
* -
*
* db-instance-id - Accepts DB instance identifiers and DB instance Amazon Resource Names (ARNs).
*
*
* -
*
* db-snapshot-id - Accepts DB snapshot identifiers.
*
*
* -
*
* dbi-resource-id - Accepts identifiers of source DB instances.
*
*
* -
*
* snapshot-type - Accepts types of DB snapshots.
*
*
* -
*
* engine - Accepts names of database engines.
*
*
*
*
* @param filters
* A filter that specifies one or more DB snapshots to describe.
*
* Supported filters:
*
*
* -
*
* db-instance-id - Accepts DB instance identifiers and DB instance Amazon Resource Names
* (ARNs).
*
*
* -
*
* db-snapshot-id - Accepts DB snapshot identifiers.
*
*
* -
*
* dbi-resource-id - Accepts identifiers of source DB instances.
*
*
* -
*
* snapshot-type - Accepts types of DB snapshots.
*
*
* -
*
* engine - Accepts names of database engines.
*
*
* @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 snapshots to describe.
*
*
* Supported filters:
*
*
* -
*
* db-instance-id - Accepts DB instance identifiers and DB instance Amazon Resource Names (ARNs).
*
*
* -
*
* db-snapshot-id - Accepts DB snapshot identifiers.
*
*
* -
*
* dbi-resource-id - Accepts identifiers of source DB instances.
*
*
* -
*
* snapshot-type - Accepts types of DB snapshots.
*
*
* -
*
* engine - Accepts names of database engines.
*
*
*
* 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 that 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 that
* 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 DescribeDBSnapshots 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 DescribeDBSnapshots 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);
/**
*
* Specifies whether to include shared manual DB cluster snapshots from other Amazon Web Services accounts that
* this Amazon Web Services account has been given permission to copy or restore. By default, these snapshots
* are not included.
*
*
* You can give an Amazon Web Services account permission to restore a manual DB snapshot from another Amazon
* Web Services account by using the ModifyDBSnapshotAttribute API action.
*
*
* This setting doesn't apply to RDS Custom.
*
*
* @param includeShared
* Specifies whether to include shared manual DB cluster snapshots from other Amazon Web Services
* accounts that this Amazon Web Services account has been given permission to copy or restore. By
* default, these snapshots are not included.
*
* You can give an Amazon Web Services account permission to restore a manual DB snapshot from another
* Amazon Web Services account by using the ModifyDBSnapshotAttribute API action.
*
*
* This setting doesn't apply to RDS Custom.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder includeShared(Boolean includeShared);
/**
*
* Specifies whether to include manual DB cluster snapshots that are public and can be copied or restored by any
* Amazon Web Services account. By default, the public snapshots are not included.
*
*
* You can share a manual DB snapshot as public by using the ModifyDBSnapshotAttribute API.
*
*
* This setting doesn't apply to RDS Custom.
*
*
* @param includePublic
* Specifies whether to include manual DB cluster snapshots that are public and can be copied or restored
* by any Amazon Web Services account. By default, the public snapshots are not included.
*
* You can share a manual DB snapshot as public by using the ModifyDBSnapshotAttribute API.
*
*
* This setting doesn't apply to RDS Custom.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder includePublic(Boolean includePublic);
/**
*
* A specific DB resource ID to describe.
*
*
* @param dbiResourceId
* A specific DB resource ID to describe.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder dbiResourceId(String dbiResourceId);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends RdsRequest.BuilderImpl implements Builder {
private String dbInstanceIdentifier;
private String dbSnapshotIdentifier;
private String snapshotType;
private List filters = DefaultSdkAutoConstructList.getInstance();
private Integer maxRecords;
private String marker;
private Boolean includeShared;
private Boolean includePublic;
private String dbiResourceId;
private BuilderImpl() {
}
private BuilderImpl(DescribeDbSnapshotsRequest model) {
super(model);
dbInstanceIdentifier(model.dbInstanceIdentifier);
dbSnapshotIdentifier(model.dbSnapshotIdentifier);
snapshotType(model.snapshotType);
filters(model.filters);
maxRecords(model.maxRecords);
marker(model.marker);
includeShared(model.includeShared);
includePublic(model.includePublic);
dbiResourceId(model.dbiResourceId);
}
public final String getDbInstanceIdentifier() {
return dbInstanceIdentifier;
}
public final void setDbInstanceIdentifier(String dbInstanceIdentifier) {
this.dbInstanceIdentifier = dbInstanceIdentifier;
}
@Override
public final Builder dbInstanceIdentifier(String dbInstanceIdentifier) {
this.dbInstanceIdentifier = dbInstanceIdentifier;
return this;
}
public final String getDbSnapshotIdentifier() {
return dbSnapshotIdentifier;
}
public final void setDbSnapshotIdentifier(String dbSnapshotIdentifier) {
this.dbSnapshotIdentifier = dbSnapshotIdentifier;
}
@Override
public final Builder dbSnapshotIdentifier(String dbSnapshotIdentifier) {
this.dbSnapshotIdentifier = dbSnapshotIdentifier;
return this;
}
public final String getSnapshotType() {
return snapshotType;
}
public final void setSnapshotType(String snapshotType) {
this.snapshotType = snapshotType;
}
@Override
public final Builder snapshotType(String snapshotType) {
this.snapshotType = snapshotType;
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;
}
public final Boolean getIncludeShared() {
return includeShared;
}
public final void setIncludeShared(Boolean includeShared) {
this.includeShared = includeShared;
}
@Override
public final Builder includeShared(Boolean includeShared) {
this.includeShared = includeShared;
return this;
}
public final Boolean getIncludePublic() {
return includePublic;
}
public final void setIncludePublic(Boolean includePublic) {
this.includePublic = includePublic;
}
@Override
public final Builder includePublic(Boolean includePublic) {
this.includePublic = includePublic;
return this;
}
public final String getDbiResourceId() {
return dbiResourceId;
}
public final void setDbiResourceId(String dbiResourceId) {
this.dbiResourceId = dbiResourceId;
}
@Override
public final Builder dbiResourceId(String dbiResourceId) {
this.dbiResourceId = dbiResourceId;
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 DescribeDbSnapshotsRequest build() {
return new DescribeDbSnapshotsRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}