software.amazon.awssdk.services.rds.model.DescribeDbSnapshotTenantDatabasesRequest 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 DescribeDbSnapshotTenantDatabasesRequest extends RdsRequest implements
ToCopyableBuilder {
private static final SdkField DB_INSTANCE_IDENTIFIER_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("DBInstanceIdentifier").getter(getter(DescribeDbSnapshotTenantDatabasesRequest::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(DescribeDbSnapshotTenantDatabasesRequest::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(DescribeDbSnapshotTenantDatabasesRequest::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(DescribeDbSnapshotTenantDatabasesRequest::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(DescribeDbSnapshotTenantDatabasesRequest::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(DescribeDbSnapshotTenantDatabasesRequest::marker)).setter(setter(Builder::marker))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Marker").build()).build();
private static final SdkField DBI_RESOURCE_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("DbiResourceId").getter(getter(DescribeDbSnapshotTenantDatabasesRequest::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,
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 String dbiResourceId;
private DescribeDbSnapshotTenantDatabasesRequest(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.dbiResourceId = builder.dbiResourceId;
}
/**
*
* The ID of the DB instance used to create the DB snapshots. This parameter isn't case-sensitive.
*
*
* Constraints:
*
*
* -
*
* If supplied, must match the identifier of an existing DBInstance
.
*
*
*
*
* @return The ID of the DB instance used to create the DB snapshots. This parameter isn't case-sensitive.
*
* Constraints:
*
*
* -
*
* If supplied, must match the identifier of an existing DBInstance
.
*
*
*/
public final String dbInstanceIdentifier() {
return dbInstanceIdentifier;
}
/**
*
* The ID of a DB snapshot that contains the tenant databases to describe. This value is stored as a lowercase
* string.
*
*
* Constraints:
*
*
* -
*
* If you specify this parameter, the value must match the ID of an existing DB snapshot.
*
*
* -
*
* If you specify an automatic snapshot, you must also specify SnapshotType
.
*
*
*
*
* @return The ID of a DB snapshot that contains the tenant databases to describe. This value is stored as a
* lowercase string.
*
* Constraints:
*
*
* -
*
* If you specify this parameter, the value must match the ID of an existing DB snapshot.
*
*
* -
*
* If you specify an automatic snapshot, you must also specify SnapshotType
.
*
*
*/
public final String dbSnapshotIdentifier() {
return dbSnapshotIdentifier;
}
/**
*
* The type of DB snapshots to be returned. You can specify one of the following values:
*
*
* -
*
* automated
– All DB snapshots that have been automatically taken by Amazon RDS for my Amazon Web
* Services account.
*
*
* -
*
* manual
– All DB snapshots that have been taken by my Amazon Web Services account.
*
*
* -
*
* shared
– All manual DB snapshots that have been shared to my Amazon Web Services account.
*
*
* -
*
* public
– All DB snapshots that have been marked as public.
*
*
* -
*
* awsbackup
– All DB snapshots managed by the Amazon Web Services Backup service.
*
*
*
*
* @return The type of DB snapshots to be returned. You can specify one of the following values:
*
* -
*
* automated
– All DB snapshots that have been automatically taken by Amazon RDS for my Amazon
* Web Services account.
*
*
* -
*
* manual
– All DB snapshots that have been taken by my Amazon Web Services account.
*
*
* -
*
* shared
– All manual DB snapshots that have been shared to my Amazon Web Services account.
*
*
* -
*
* public
– All DB snapshots that have been marked as public.
*
*
* -
*
* awsbackup
– All DB snapshots managed by the Amazon Web Services Backup service.
*
*
*/
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 tenant databases to describe.
*
*
* Supported filters:
*
*
* -
*
* tenant-db-name
- Tenant database names. The results list only includes information about the tenant
* databases that match these tenant DB names.
*
*
* -
*
* tenant-database-resource-id
- Tenant database resource identifiers. The results list only includes
* information about the tenant databases contained within the DB snapshots.
*
*
* -
*
* dbi-resource-id
- DB instance resource identifiers. The results list only includes information about
* snapshots containing tenant databases contained within the DB instances identified by these resource identifiers.
*
*
* -
*
* db-instance-id
- Accepts DB instance identifiers and DB instance Amazon Resource Names (ARNs).
*
*
* -
*
* db-snapshot-id
- Accepts DB snapshot identifiers.
*
*
* -
*
* snapshot-type
- Accepts types of DB snapshots.
*
*
*
*
* 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 tenant databases to describe.
*
* Supported filters:
*
*
* -
*
* tenant-db-name
- Tenant database names. The results list only includes information about the
* tenant databases that match these tenant DB names.
*
*
* -
*
* tenant-database-resource-id
- Tenant database resource identifiers. The results list only
* includes information about the tenant databases contained within the DB snapshots.
*
*
* -
*
* dbi-resource-id
- DB instance resource identifiers. The results list only includes
* information about snapshots containing tenant databases contained within the DB instances identified by
* these resource identifiers.
*
*
* -
*
* db-instance-id
- Accepts DB instance identifiers and DB instance Amazon Resource Names
* (ARNs).
*
*
* -
*
* db-snapshot-id
- Accepts DB snapshot identifiers.
*
*
* -
*
* snapshot-type
- Accepts types of DB snapshots.
*
*
*/
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.
*
*
* @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.
*/
public final Integer maxRecords() {
return maxRecords;
}
/**
*
* An optional pagination token provided by a previous DescribeDBSnapshotTenantDatabases
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 DescribeDBSnapshotTenantDatabases
* 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;
}
/**
*
* A specific DB resource identifier to describe.
*
*
* @return A specific DB resource identifier 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 extends Builder> 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(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 DescribeDbSnapshotTenantDatabasesRequest)) {
return false;
}
DescribeDbSnapshotTenantDatabasesRequest other = (DescribeDbSnapshotTenantDatabasesRequest) 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(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("DescribeDbSnapshotTenantDatabasesRequest").add("DBInstanceIdentifier", dbInstanceIdentifier())
.add("DBSnapshotIdentifier", dbSnapshotIdentifier()).add("SnapshotType", snapshotType())
.add("Filters", hasFilters() ? filters() : null).add("MaxRecords", maxRecords()).add("Marker", marker())
.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 "DbiResourceId":
return Optional.ofNullable(clazz.cast(dbiResourceId()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function