com.amazonaws.services.rds.model.DescribeDBSnapshotsRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-rds Show documentation
/*
* Copyright 2017-2022 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 com.amazonaws.services.rds.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class DescribeDBSnapshotsRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* 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.
*
*
*
*/
private 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.
*
*
*
*/
private 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.
*
*/
private 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.
*
*
*
*/
private com.amazonaws.internal.SdkInternalList 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.
*
*/
private 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.
*
*/
private String marker;
/**
*
* A value that indicates 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.
*
*/
private Boolean includeShared;
/**
*
* A value that indicates 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.
*
*/
private Boolean includePublic;
/**
*
* A specific DB resource ID to describe.
*
*/
private String 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.
*
*
*
*
* @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.
*
*
*/
public void setDBInstanceIdentifier(String dBInstanceIdentifier) {
this.dBInstanceIdentifier = 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 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 String getDBInstanceIdentifier() {
return this.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.
*
*
*
*
* @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.
*/
public DescribeDBSnapshotsRequest withDBInstanceIdentifier(String dBInstanceIdentifier) {
setDBInstanceIdentifier(dBInstanceIdentifier);
return this;
}
/**
*
* 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.
*
*
*/
public void setDBSnapshotIdentifier(String dBSnapshotIdentifier) {
this.dBSnapshotIdentifier = 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 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 String getDBSnapshotIdentifier() {
return this.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.
*
*
*
*
* @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.
*/
public DescribeDBSnapshotsRequest withDBSnapshotIdentifier(String dBSnapshotIdentifier) {
setDBSnapshotIdentifier(dBSnapshotIdentifier);
return this;
}
/**
*
* 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.
*/
public void setSnapshotType(String snapshotType) {
this.snapshotType = 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 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 String getSnapshotType() {
return this.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.
*
*
* @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.
*/
public DescribeDBSnapshotsRequest withSnapshotType(String snapshotType) {
setSnapshotType(snapshotType);
return this;
}
/**
*
* 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 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 java.util.List getFilters() {
if (filters == null) {
filters = new com.amazonaws.internal.SdkInternalList();
}
return 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.
*
*
*/
public void setFilters(java.util.Collection filters) {
if (filters == null) {
this.filters = null;
return;
}
this.filters = new com.amazonaws.internal.SdkInternalList(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.
*
*
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setFilters(java.util.Collection)} or {@link #withFilters(java.util.Collection)} if you want to override
* the existing values.
*
*
* @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.
*/
public DescribeDBSnapshotsRequest withFilters(Filter... filters) {
if (this.filters == null) {
setFilters(new com.amazonaws.internal.SdkInternalList(filters.length));
}
for (Filter ele : filters) {
this.filters.add(ele);
}
return this;
}
/**
*
* 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.
*/
public DescribeDBSnapshotsRequest withFilters(java.util.Collection filters) {
setFilters(filters);
return this;
}
/**
*
* 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.
*/
public void setMaxRecords(Integer maxRecords) {
this.maxRecords = 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 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 Integer getMaxRecords() {
return this.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.
*
*
* @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.
*/
public DescribeDBSnapshotsRequest withMaxRecords(Integer maxRecords) {
setMaxRecords(maxRecords);
return this;
}
/**
*
* 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.
*/
public void setMarker(String marker) {
this.marker = 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 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 String getMarker() {
return this.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.
*
*
* @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.
*/
public DescribeDBSnapshotsRequest withMarker(String marker) {
setMarker(marker);
return this;
}
/**
*
* A value that indicates 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
* A value that indicates 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 void setIncludeShared(Boolean includeShared) {
this.includeShared = includeShared;
}
/**
*
* A value that indicates 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 A value that indicates 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 Boolean getIncludeShared() {
return this.includeShared;
}
/**
*
* A value that indicates 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
* A value that indicates 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.
*/
public DescribeDBSnapshotsRequest withIncludeShared(Boolean includeShared) {
setIncludeShared(includeShared);
return this;
}
/**
*
* A value that indicates 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 A value that indicates 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 Boolean isIncludeShared() {
return this.includeShared;
}
/**
*
* A value that indicates 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
* A value that indicates 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 void setIncludePublic(Boolean includePublic) {
this.includePublic = includePublic;
}
/**
*
* A value that indicates 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 A value that indicates 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 Boolean getIncludePublic() {
return this.includePublic;
}
/**
*
* A value that indicates 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
* A value that indicates 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.
*/
public DescribeDBSnapshotsRequest withIncludePublic(Boolean includePublic) {
setIncludePublic(includePublic);
return this;
}
/**
*
* A value that indicates 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 A value that indicates 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 Boolean isIncludePublic() {
return this.includePublic;
}
/**
*
* A specific DB resource ID to describe.
*
*
* @param dbiResourceId
* A specific DB resource ID to describe.
*/
public void setDbiResourceId(String dbiResourceId) {
this.dbiResourceId = dbiResourceId;
}
/**
*
* A specific DB resource ID to describe.
*
*
* @return A specific DB resource ID to describe.
*/
public String getDbiResourceId() {
return this.dbiResourceId;
}
/**
*
* 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.
*/
public DescribeDBSnapshotsRequest withDbiResourceId(String dbiResourceId) {
setDbiResourceId(dbiResourceId);
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getDBInstanceIdentifier() != null)
sb.append("DBInstanceIdentifier: ").append(getDBInstanceIdentifier()).append(",");
if (getDBSnapshotIdentifier() != null)
sb.append("DBSnapshotIdentifier: ").append(getDBSnapshotIdentifier()).append(",");
if (getSnapshotType() != null)
sb.append("SnapshotType: ").append(getSnapshotType()).append(",");
if (getFilters() != null)
sb.append("Filters: ").append(getFilters()).append(",");
if (getMaxRecords() != null)
sb.append("MaxRecords: ").append(getMaxRecords()).append(",");
if (getMarker() != null)
sb.append("Marker: ").append(getMarker()).append(",");
if (getIncludeShared() != null)
sb.append("IncludeShared: ").append(getIncludeShared()).append(",");
if (getIncludePublic() != null)
sb.append("IncludePublic: ").append(getIncludePublic()).append(",");
if (getDbiResourceId() != null)
sb.append("DbiResourceId: ").append(getDbiResourceId());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof DescribeDBSnapshotsRequest == false)
return false;
DescribeDBSnapshotsRequest other = (DescribeDBSnapshotsRequest) obj;
if (other.getDBInstanceIdentifier() == null ^ this.getDBInstanceIdentifier() == null)
return false;
if (other.getDBInstanceIdentifier() != null && other.getDBInstanceIdentifier().equals(this.getDBInstanceIdentifier()) == false)
return false;
if (other.getDBSnapshotIdentifier() == null ^ this.getDBSnapshotIdentifier() == null)
return false;
if (other.getDBSnapshotIdentifier() != null && other.getDBSnapshotIdentifier().equals(this.getDBSnapshotIdentifier()) == false)
return false;
if (other.getSnapshotType() == null ^ this.getSnapshotType() == null)
return false;
if (other.getSnapshotType() != null && other.getSnapshotType().equals(this.getSnapshotType()) == false)
return false;
if (other.getFilters() == null ^ this.getFilters() == null)
return false;
if (other.getFilters() != null && other.getFilters().equals(this.getFilters()) == false)
return false;
if (other.getMaxRecords() == null ^ this.getMaxRecords() == null)
return false;
if (other.getMaxRecords() != null && other.getMaxRecords().equals(this.getMaxRecords()) == false)
return false;
if (other.getMarker() == null ^ this.getMarker() == null)
return false;
if (other.getMarker() != null && other.getMarker().equals(this.getMarker()) == false)
return false;
if (other.getIncludeShared() == null ^ this.getIncludeShared() == null)
return false;
if (other.getIncludeShared() != null && other.getIncludeShared().equals(this.getIncludeShared()) == false)
return false;
if (other.getIncludePublic() == null ^ this.getIncludePublic() == null)
return false;
if (other.getIncludePublic() != null && other.getIncludePublic().equals(this.getIncludePublic()) == false)
return false;
if (other.getDbiResourceId() == null ^ this.getDbiResourceId() == null)
return false;
if (other.getDbiResourceId() != null && other.getDbiResourceId().equals(this.getDbiResourceId()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getDBInstanceIdentifier() == null) ? 0 : getDBInstanceIdentifier().hashCode());
hashCode = prime * hashCode + ((getDBSnapshotIdentifier() == null) ? 0 : getDBSnapshotIdentifier().hashCode());
hashCode = prime * hashCode + ((getSnapshotType() == null) ? 0 : getSnapshotType().hashCode());
hashCode = prime * hashCode + ((getFilters() == null) ? 0 : getFilters().hashCode());
hashCode = prime * hashCode + ((getMaxRecords() == null) ? 0 : getMaxRecords().hashCode());
hashCode = prime * hashCode + ((getMarker() == null) ? 0 : getMarker().hashCode());
hashCode = prime * hashCode + ((getIncludeShared() == null) ? 0 : getIncludeShared().hashCode());
hashCode = prime * hashCode + ((getIncludePublic() == null) ? 0 : getIncludePublic().hashCode());
hashCode = prime * hashCode + ((getDbiResourceId() == null) ? 0 : getDbiResourceId().hashCode());
return hashCode;
}
@Override
public DescribeDBSnapshotsRequest clone() {
return (DescribeDBSnapshotsRequest) super.clone();
}
}