com.amazonaws.services.rds.model.DescribeDBSnapshotsRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-rds Show documentation
/*
* Copyright 2011-2016 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 com.amazonaws.AmazonWebServiceRequest;
/**
*
*/
public class DescribeDBSnapshotsRequest extends AmazonWebServiceRequest
implements Serializable, Cloneable {
/**
*
* The ID of the DB instance to retrieve the list of DB snapshots for. This
* parameter cannot be used in conjunction with
* DBSnapshotIdentifier. This parameter is not case-sensitive.
*
*
* Constraints:
*
*
* -
*
* Must contain from 1 to 63 alphanumeric characters or hyphens
*
*
* -
*
* First character must be a letter
*
*
* -
*
* Cannot end with a hyphen or contain two consecutive hyphens
*
*
*
*/
private String dBInstanceIdentifier;
/**
*
* A specific DB snapshot identifier to describe. This parameter cannot be
* used in conjunction with DBInstanceIdentifier. This value is
* stored as a lowercase string.
*
*
* Constraints:
*
*
* -
*
* Must be 1 to 255 alphanumeric characters.
*
*
* -
*
* First character must be a letter.
*
*
* -
*
* Cannot end with a hyphen or contain two consecutive hyphens.
*
*
* -
*
* 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 AWS account.
*
*
* -
*
* manual - Return all DB snapshots that have been taken by my
* AWS account.
*
*
* -
*
* shared - Return all manual DB snapshots that have been
* shared to my AWS account.
*
*
* -
*
* public - Return all DB snapshots that have been marked as
* public.
*
*
*
*
* 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 setting the
* IncludeShared parameter to true. You can
* include public snapshots with these results by setting the
* IncludePublic parameter to true.
*
*
* 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;
/**
*
* This parameter is not currently supported.
*
*/
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 the remaining
* results can be retrieved.
*
*
* 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;
/**
*
* Set this value to true to include shared manual DB snapshots
* from other AWS accounts that this AWS account has been given permission
* to copy or restore, otherwise set this value to false. The
* default is false.
*
*
* You can give an AWS account permission to restore a manual DB snapshot
* from another AWS account by using the ModifyDBSnapshotAttribute
* API action.
*
*/
private Boolean includeShared;
/**
*
* Set this value to true to include manual DB snapshots that
* are public and can be copied or restored by any AWS account, otherwise
* set this value to false. The default is false.
*
*
* You can share a manual DB snapshot as public by using the
* ModifyDBSnapshotAttribute API.
*
*/
private Boolean includePublic;
/**
*
* The ID of the DB instance to retrieve the list of DB snapshots for. This
* parameter cannot be used in conjunction with
* DBSnapshotIdentifier. This parameter is not case-sensitive.
*
*
* Constraints:
*
*
* -
*
* Must contain from 1 to 63 alphanumeric characters or hyphens
*
*
* -
*
* First character must be a letter
*
*
* -
*
* Cannot end with a hyphen or contain two consecutive hyphens
*
*
*
*
* @param dBInstanceIdentifier
* The ID of the DB instance to retrieve the list of DB snapshots
* for. This parameter cannot be used in conjunction with
* DBSnapshotIdentifier. This parameter is not
* case-sensitive.
*
* Constraints:
*
*
* -
*
* Must contain from 1 to 63 alphanumeric characters or hyphens
*
*
* -
*
* First character must be a letter
*
*
* -
*
* Cannot end with a hyphen or contain two consecutive hyphens
*
*
*/
public void setDBInstanceIdentifier(String dBInstanceIdentifier) {
this.dBInstanceIdentifier = dBInstanceIdentifier;
}
/**
*
* The ID of the DB instance to retrieve the list of DB snapshots for. This
* parameter cannot be used in conjunction with
* DBSnapshotIdentifier. This parameter is not case-sensitive.
*
*
* Constraints:
*
*
* -
*
* Must contain from 1 to 63 alphanumeric characters or hyphens
*
*
* -
*
* First character must be a letter
*
*
* -
*
* Cannot end with a hyphen or contain two consecutive hyphens
*
*
*
*
* @return The ID of the DB instance to retrieve the list of DB snapshots
* for. This parameter cannot be used in conjunction with
* DBSnapshotIdentifier. This parameter is not
* case-sensitive.
*
* Constraints:
*
*
* -
*
* Must contain from 1 to 63 alphanumeric characters or hyphens
*
*
* -
*
* First character must be a letter
*
*
* -
*
* Cannot end with a hyphen or contain two consecutive hyphens
*
*
*/
public String getDBInstanceIdentifier() {
return this.dBInstanceIdentifier;
}
/**
*
* The ID of the DB instance to retrieve the list of DB snapshots for. This
* parameter cannot be used in conjunction with
* DBSnapshotIdentifier. This parameter is not case-sensitive.
*
*
* Constraints:
*
*
* -
*
* Must contain from 1 to 63 alphanumeric characters or hyphens
*
*
* -
*
* First character must be a letter
*
*
* -
*
* Cannot end with a hyphen or contain two consecutive hyphens
*
*
*
*
* @param dBInstanceIdentifier
* The ID of the DB instance to retrieve the list of DB snapshots
* for. This parameter cannot be used in conjunction with
* DBSnapshotIdentifier. This parameter is not
* case-sensitive.
*
* Constraints:
*
*
* -
*
* Must contain from 1 to 63 alphanumeric characters or hyphens
*
*
* -
*
* First character must be a letter
*
*
* -
*
* Cannot end with a hyphen or contain two consecutive hyphens
*
*
* @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 parameter cannot be
* used in conjunction with DBInstanceIdentifier. This value is
* stored as a lowercase string.
*
*
* Constraints:
*
*
* -
*
* Must be 1 to 255 alphanumeric characters.
*
*
* -
*
* First character must be a letter.
*
*
* -
*
* Cannot end with a hyphen or contain two consecutive hyphens.
*
*
* -
*
* 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 parameter
* cannot be used in conjunction with
* DBInstanceIdentifier. This value is stored as a
* lowercase string.
*
* Constraints:
*
*
* -
*
* Must be 1 to 255 alphanumeric characters.
*
*
* -
*
* First character must be a letter.
*
*
* -
*
* Cannot end with a hyphen or contain two consecutive hyphens.
*
*
* -
*
* 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 parameter cannot be
* used in conjunction with DBInstanceIdentifier. This value is
* stored as a lowercase string.
*
*
* Constraints:
*
*
* -
*
* Must be 1 to 255 alphanumeric characters.
*
*
* -
*
* First character must be a letter.
*
*
* -
*
* Cannot end with a hyphen or contain two consecutive hyphens.
*
*
* -
*
* If this identifier is for an automated snapshot, the
* SnapshotType parameter must also be specified.
*
*
*
*
* @return A specific DB snapshot identifier to describe. This parameter
* cannot be used in conjunction with
* DBInstanceIdentifier. This value is stored as a
* lowercase string.
*
* Constraints:
*
*
* -
*
* Must be 1 to 255 alphanumeric characters.
*
*
* -
*
* First character must be a letter.
*
*
* -
*
* Cannot end with a hyphen or contain two consecutive hyphens.
*
*
* -
*
* 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 parameter cannot be
* used in conjunction with DBInstanceIdentifier. This value is
* stored as a lowercase string.
*
*
* Constraints:
*
*
* -
*
* Must be 1 to 255 alphanumeric characters.
*
*
* -
*
* First character must be a letter.
*
*
* -
*
* Cannot end with a hyphen or contain two consecutive hyphens.
*
*
* -
*
* 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 parameter
* cannot be used in conjunction with
* DBInstanceIdentifier. This value is stored as a
* lowercase string.
*
* Constraints:
*
*
* -
*
* Must be 1 to 255 alphanumeric characters.
*
*
* -
*
* First character must be a letter.
*
*
* -
*
* Cannot end with a hyphen or contain two consecutive hyphens.
*
*
* -
*
* 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 AWS account.
*
*
* -
*
* manual - Return all DB snapshots that have been taken by my
* AWS account.
*
*
* -
*
* shared - Return all manual DB snapshots that have been
* shared to my AWS account.
*
*
* -
*
* public - Return all DB snapshots that have been marked as
* public.
*
*
*
*
* 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 setting the
* IncludeShared parameter to true. You can
* include public snapshots with these results by setting the
* IncludePublic parameter to true.
*
*
* 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 AWS account.
*
*
* -
*
* manual - Return all DB snapshots that have been taken
* by my AWS account.
*
*
* -
*
* shared - Return all manual DB snapshots that have
* been shared to my AWS account.
*
*
* -
*
* public - Return all DB snapshots that have been
* marked as public.
*
*
*
*
* 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 setting the
* IncludeShared parameter to true. You can
* include public snapshots with these results by setting the
* IncludePublic parameter to true.
*
*
* 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 AWS account.
*
*
* -
*
* manual - Return all DB snapshots that have been taken by my
* AWS account.
*
*
* -
*
* shared - Return all manual DB snapshots that have been
* shared to my AWS account.
*
*
* -
*
* public - Return all DB snapshots that have been marked as
* public.
*
*
*
*
* 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 setting the
* IncludeShared parameter to true. You can
* include public snapshots with these results by setting the
* IncludePublic parameter to true.
*
*
* 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 AWS account.
*
*
* -
*
* manual - Return all DB snapshots that have been
* taken by my AWS account.
*
*
* -
*
* shared - Return all manual DB snapshots that have
* been shared to my AWS account.
*
*
* -
*
* public - Return all DB snapshots that have been
* marked as public.
*
*
*
*
* 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 setting
* the IncludeShared parameter to true.
* You can include public snapshots with these results by setting
* the IncludePublic parameter to true.
*
*
* 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 AWS account.
*
*
* -
*
* manual - Return all DB snapshots that have been taken by my
* AWS account.
*
*
* -
*
* shared - Return all manual DB snapshots that have been
* shared to my AWS account.
*
*
* -
*
* public - Return all DB snapshots that have been marked as
* public.
*
*
*
*
* 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 setting the
* IncludeShared parameter to true. You can
* include public snapshots with these results by setting the
* IncludePublic parameter to true.
*
*
* 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 AWS account.
*
*
* -
*
* manual - Return all DB snapshots that have been taken
* by my AWS account.
*
*
* -
*
* shared - Return all manual DB snapshots that have
* been shared to my AWS account.
*
*
* -
*
* public - Return all DB snapshots that have been
* marked as public.
*
*
*
*
* 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 setting the
* IncludeShared parameter to true. You can
* include public snapshots with these results by setting the
* IncludePublic parameter to true.
*
*
* 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;
}
/**
*
* This parameter is not currently supported.
*
*
* @return This parameter is not currently supported.
*/
public java.util.List getFilters() {
if (filters == null) {
filters = new com.amazonaws.internal.SdkInternalList();
}
return filters;
}
/**
*
* This parameter is not currently supported.
*
*
* @param filters
* This parameter is not currently supported.
*/
public void setFilters(java.util.Collection filters) {
if (filters == null) {
this.filters = null;
return;
}
this.filters = new com.amazonaws.internal.SdkInternalList(
filters);
}
/**
*
* This parameter is not currently supported.
*
*
* 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
* This parameter is not currently supported.
* @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;
}
/**
*
* This parameter is not currently supported.
*
*
* @param filters
* This parameter is not currently supported.
* @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 the remaining
* results can be retrieved.
*
*
* Default: 100
*
*
* Constraints: Minimum 20, maximum 100.
*
*
* @param maxRecords
* The maximum number of records to include in the response. If more
* records exist than the specified MaxRecords value, a
* pagination token called a marker is included in the response so
* that the remaining results can be retrieved.
*
* Default: 100
*
*
* Constraints: Minimum 20, maximum 100.
*/
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 the remaining
* results can be retrieved.
*
*
* Default: 100
*
*
* Constraints: Minimum 20, maximum 100.
*
*
* @return The maximum number of records to include in the response. If more
* records exist than the specified MaxRecords value, a
* pagination token called a marker is included in the response so
* that the remaining results can be retrieved.
*
* Default: 100
*
*
* Constraints: Minimum 20, maximum 100.
*/
public 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 the remaining
* results can be retrieved.
*
*
* Default: 100
*
*
* Constraints: Minimum 20, maximum 100.
*
*
* @param maxRecords
* The maximum number of records to include in the response. If more
* records exist than the specified MaxRecords value, a
* pagination token called a marker is included in the response so
* that the remaining results can be retrieved.
*
* Default: 100
*
*
* Constraints: Minimum 20, maximum 100.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
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;
}
/**
*
* Set this value to true to include shared manual DB snapshots
* from other AWS accounts that this AWS account has been given permission
* to copy or restore, otherwise set this value to false. The
* default is false.
*
*
* You can give an AWS account permission to restore a manual DB snapshot
* from another AWS account by using the ModifyDBSnapshotAttribute
* API action.
*
*
* @param includeShared
* Set this value to true to include shared manual DB
* snapshots from other AWS accounts that this AWS account has been
* given permission to copy or restore, otherwise set this value to
* false. The default is false.
*
* You can give an AWS account permission to restore a manual DB
* snapshot from another AWS account by using the
* ModifyDBSnapshotAttribute API action.
*/
public void setIncludeShared(Boolean includeShared) {
this.includeShared = includeShared;
}
/**
*
* Set this value to true to include shared manual DB snapshots
* from other AWS accounts that this AWS account has been given permission
* to copy or restore, otherwise set this value to false. The
* default is false.
*
*
* You can give an AWS account permission to restore a manual DB snapshot
* from another AWS account by using the ModifyDBSnapshotAttribute
* API action.
*
*
* @return Set this value to true to include shared manual DB
* snapshots from other AWS accounts that this AWS account has been
* given permission to copy or restore, otherwise set this value to
* false. The default is false.
*
* You can give an AWS account permission to restore a manual DB
* snapshot from another AWS account by using the
* ModifyDBSnapshotAttribute API action.
*/
public Boolean getIncludeShared() {
return this.includeShared;
}
/**
*
* Set this value to true to include shared manual DB snapshots
* from other AWS accounts that this AWS account has been given permission
* to copy or restore, otherwise set this value to false. The
* default is false.
*
*
* You can give an AWS account permission to restore a manual DB snapshot
* from another AWS account by using the ModifyDBSnapshotAttribute
* API action.
*
*
* @param includeShared
* Set this value to true to include shared manual DB
* snapshots from other AWS accounts that this AWS account has been
* given permission to copy or restore, otherwise set this value to
* false. The default is false.
*
* You can give an AWS account permission to restore a manual DB
* snapshot from another AWS account by using the
* ModifyDBSnapshotAttribute API action.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public DescribeDBSnapshotsRequest withIncludeShared(Boolean includeShared) {
setIncludeShared(includeShared);
return this;
}
/**
*
* Set this value to true to include shared manual DB snapshots
* from other AWS accounts that this AWS account has been given permission
* to copy or restore, otherwise set this value to false. The
* default is false.
*
*
* You can give an AWS account permission to restore a manual DB snapshot
* from another AWS account by using the ModifyDBSnapshotAttribute
* API action.
*
*
* @return Set this value to true to include shared manual DB
* snapshots from other AWS accounts that this AWS account has been
* given permission to copy or restore, otherwise set this value to
* false. The default is false.
*
* You can give an AWS account permission to restore a manual DB
* snapshot from another AWS account by using the
* ModifyDBSnapshotAttribute API action.
*/
public Boolean isIncludeShared() {
return this.includeShared;
}
/**
*
* Set this value to true to include manual DB snapshots that
* are public and can be copied or restored by any AWS account, otherwise
* set this value to false. The default is false.
*
*
* You can share a manual DB snapshot as public by using the
* ModifyDBSnapshotAttribute API.
*
*
* @param includePublic
* Set this value to true to include manual DB snapshots
* that are public and can be copied or restored by any AWS account,
* otherwise set this value to false. The default is
* false.
*
* You can share a manual DB snapshot as public by using the
* ModifyDBSnapshotAttribute API.
*/
public void setIncludePublic(Boolean includePublic) {
this.includePublic = includePublic;
}
/**
*
* Set this value to true to include manual DB snapshots that
* are public and can be copied or restored by any AWS account, otherwise
* set this value to false. The default is false.
*
*
* You can share a manual DB snapshot as public by using the
* ModifyDBSnapshotAttribute API.
*
*
* @return Set this value to true to include manual DB
* snapshots that are public and can be copied or restored by any
* AWS account, otherwise set this value to false. The
* default is false.
*
* You can share a manual DB snapshot as public by using the
* ModifyDBSnapshotAttribute API.
*/
public Boolean getIncludePublic() {
return this.includePublic;
}
/**
*
* Set this value to true to include manual DB snapshots that
* are public and can be copied or restored by any AWS account, otherwise
* set this value to false. The default is false.
*
*
* You can share a manual DB snapshot as public by using the
* ModifyDBSnapshotAttribute API.
*
*
* @param includePublic
* Set this value to true to include manual DB snapshots
* that are public and can be copied or restored by any AWS account,
* otherwise set this value to false. The default is
* false.
*
* You can share a manual DB snapshot as public by using the
* ModifyDBSnapshotAttribute API.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public DescribeDBSnapshotsRequest withIncludePublic(Boolean includePublic) {
setIncludePublic(includePublic);
return this;
}
/**
*
* Set this value to true to include manual DB snapshots that
* are public and can be copied or restored by any AWS account, otherwise
* set this value to false. The default is false.
*
*
* You can share a manual DB snapshot as public by using the
* ModifyDBSnapshotAttribute API.
*
*
* @return Set this value to true to include manual DB
* snapshots that are public and can be copied or restored by any
* AWS account, otherwise set this value to false. The
* default is false.
*
* You can share a manual DB snapshot as public by using the
* ModifyDBSnapshotAttribute API.
*/
public Boolean isIncludePublic() {
return this.includePublic;
}
/**
* Returns a string representation of this object; useful for testing and
* debugging.
*
* @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: " + getDBInstanceIdentifier()
+ ",");
if (getDBSnapshotIdentifier() != null)
sb.append("DBSnapshotIdentifier: " + getDBSnapshotIdentifier()
+ ",");
if (getSnapshotType() != null)
sb.append("SnapshotType: " + getSnapshotType() + ",");
if (getFilters() != null)
sb.append("Filters: " + getFilters() + ",");
if (getMaxRecords() != null)
sb.append("MaxRecords: " + getMaxRecords() + ",");
if (getMarker() != null)
sb.append("Marker: " + getMarker() + ",");
if (getIncludeShared() != null)
sb.append("IncludeShared: " + getIncludeShared() + ",");
if (getIncludePublic() != null)
sb.append("IncludePublic: " + getIncludePublic());
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;
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());
return hashCode;
}
@Override
public DescribeDBSnapshotsRequest clone() {
return (DescribeDBSnapshotsRequest) super.clone();
}
}