Package software.amazon.awssdk.services.rds.model

Class DescribeDbSnapshotTenantDatabasesRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.rds.model.RdsRequest
software.amazon.awssdk.services.rds.model.DescribeDbSnapshotTenantDatabasesRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<DescribeDbSnapshotTenantDatabasesRequest.Builder,DescribeDbSnapshotTenantDatabasesRequest>
@Generated("software.amazon.awssdk:codegen") public final class DescribeDbSnapshotTenantDatabasesRequest extends RdsRequest implements ToCopyableBuilder<DescribeDbSnapshotTenantDatabasesRequest.Builder,DescribeDbSnapshotTenantDatabasesRequest>

  • Method Details

    • dbInstanceIdentifier

      public final String dbInstanceIdentifier()

      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.

      Returns:
      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.

    • dbSnapshotIdentifier

      public final String dbSnapshotIdentifier()

      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.

      Returns:
      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.

    • snapshotType

      public final String snapshotType()

      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.

      Returns:
      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.

    • hasFilters

      public final boolean hasFilters()
      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 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.

    • filters

      public final List<Filter> filters()

      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 hasFilters() method.

      Returns:
      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.

    • maxRecords

      public final Integer 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.

      Returns:
      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.

    • marker

      public final String marker()

      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.

      Returns:
      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.

    • dbiResourceId

      public final String dbiResourceId()

      A specific DB resource identifier to describe.

      Returns:
      A specific DB resource identifier to describe.

    • toBuilder

      public DescribeDbSnapshotTenantDatabasesRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<DescribeDbSnapshotTenantDatabasesRequest.Builder,DescribeDbSnapshotTenantDatabasesRequest>
      Specified by:
      toBuilder in class RdsRequest
      Returns:
      a builder for type T

    • builder

      public static DescribeDbSnapshotTenantDatabasesRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends DescribeDbSnapshotTenantDatabasesRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      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.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.