/* * Copyright 2018-2023 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; /** *
* Parameter input for DescribeDBInstanceAutomatedBackups. *
* * @see AWS API Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class DescribeDBInstanceAutomatedBackupsRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable { /** ** The resource ID of the DB instance that is the source of the automated backup. This parameter isn't * case-sensitive. *
*/ private String dbiResourceId; /** ** (Optional) The user-supplied instance identifier. If this parameter is specified, it must match the identifier of * an existing DB instance. It returns information from the specific DB instance' automated backup. This parameter * isn't case-sensitive. *
*/ private String dBInstanceIdentifier; /** ** A filter that specifies which resources to return based on status. *
** Supported filters are the following: *
*
* status
*
* active
- automated backups for current instances
*
* retained
- automated backups for deleted instances and after backup replication is stopped
*
* creating
- automated backups that are waiting for the first automated snapshot to be available
*
* db-instance-id
- Accepts DB instance identifiers and Amazon Resource Names (ARNs). The results list
* includes only information about the DB instance automated backups identified by these ARNs.
*
* dbi-resource-id
- Accepts DB resource identifiers and Amazon Resource Names (ARNs). The results list
* includes only information about the DB instance resources identified by these ARNs.
*
* Returns all resources by default. The status for each resource is specified in the response. *
*/ private com.amazonaws.internal.SdkInternalList
* 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.
*
* The pagination token provided in the previous request. If this parameter is specified the response includes only
* records beyond the marker, up to MaxRecords
.
*
* The Amazon Resource Name (ARN) of the replicated automated backups, for example,
* arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE
.
*
* This setting doesn't apply to RDS Custom. *
*/ private String dBInstanceAutomatedBackupsArn; /** ** The resource ID of the DB instance that is the source of the automated backup. This parameter isn't * case-sensitive. *
* * @param dbiResourceId * The resource ID of the DB instance that is the source of the automated backup. This parameter isn't * case-sensitive. */ public void setDbiResourceId(String dbiResourceId) { this.dbiResourceId = dbiResourceId; } /** ** The resource ID of the DB instance that is the source of the automated backup. This parameter isn't * case-sensitive. *
* * @return The resource ID of the DB instance that is the source of the automated backup. This parameter isn't * case-sensitive. */ public String getDbiResourceId() { return this.dbiResourceId; } /** ** The resource ID of the DB instance that is the source of the automated backup. This parameter isn't * case-sensitive. *
* * @param dbiResourceId * The resource ID of the DB instance that is the source of the automated backup. This parameter isn't * case-sensitive. * @return Returns a reference to this object so that method calls can be chained together. */ public DescribeDBInstanceAutomatedBackupsRequest withDbiResourceId(String dbiResourceId) { setDbiResourceId(dbiResourceId); return this; } /** ** (Optional) The user-supplied instance identifier. If this parameter is specified, it must match the identifier of * an existing DB instance. It returns information from the specific DB instance' automated backup. This parameter * isn't case-sensitive. *
* * @param dBInstanceIdentifier * (Optional) The user-supplied instance identifier. If this parameter is specified, it must match the * identifier of an existing DB instance. It returns information from the specific DB instance' automated * backup. This parameter isn't case-sensitive. */ public void setDBInstanceIdentifier(String dBInstanceIdentifier) { this.dBInstanceIdentifier = dBInstanceIdentifier; } /** ** (Optional) The user-supplied instance identifier. If this parameter is specified, it must match the identifier of * an existing DB instance. It returns information from the specific DB instance' automated backup. This parameter * isn't case-sensitive. *
* * @return (Optional) The user-supplied instance identifier. If this parameter is specified, it must match the * identifier of an existing DB instance. It returns information from the specific DB instance' automated * backup. This parameter isn't case-sensitive. */ public String getDBInstanceIdentifier() { return this.dBInstanceIdentifier; } /** ** (Optional) The user-supplied instance identifier. If this parameter is specified, it must match the identifier of * an existing DB instance. It returns information from the specific DB instance' automated backup. This parameter * isn't case-sensitive. *
* * @param dBInstanceIdentifier * (Optional) The user-supplied instance identifier. If this parameter is specified, it must match the * identifier of an existing DB instance. It returns information from the specific DB instance' automated * backup. This parameter isn't case-sensitive. * @return Returns a reference to this object so that method calls can be chained together. */ public DescribeDBInstanceAutomatedBackupsRequest withDBInstanceIdentifier(String dBInstanceIdentifier) { setDBInstanceIdentifier(dBInstanceIdentifier); return this; } /** ** A filter that specifies which resources to return based on status. *
** Supported filters are the following: *
*
* status
*
* active
- automated backups for current instances
*
* retained
- automated backups for deleted instances and after backup replication is stopped
*
* creating
- automated backups that are waiting for the first automated snapshot to be available
*
* db-instance-id
- Accepts DB instance identifiers and Amazon Resource Names (ARNs). The results list
* includes only information about the DB instance automated backups identified by these ARNs.
*
* dbi-resource-id
- Accepts DB resource identifiers and Amazon Resource Names (ARNs). The results list
* includes only information about the DB instance resources identified by these ARNs.
*
* Returns all resources by default. The status for each resource is specified in the response. *
* * @return A filter that specifies which resources to return based on status. ** Supported filters are the following: *
*
* status
*
* active
- automated backups for current instances
*
* retained
- automated backups for deleted instances and after backup replication is stopped
*
* creating
- automated backups that are waiting for the first automated snapshot to be
* available
*
* db-instance-id
- Accepts DB instance identifiers and Amazon Resource Names (ARNs). The
* results list includes only information about the DB instance automated backups identified by these ARNs.
*
* dbi-resource-id
- Accepts DB resource identifiers and Amazon Resource Names (ARNs). The
* results list includes only information about the DB instance resources identified by these ARNs.
*
* Returns all resources by default. The status for each resource is specified in the response.
*/
public java.util.List
* A filter that specifies which resources to return based on status.
*
* Supported filters are the following:
*
*
*
*
*
*
*
* Returns all resources by default. The status for each resource is specified in the response.
*
*
* status
*
*
* active
- automated backups for current instances
* retained
- automated backups for deleted instances and after backup replication is stopped
* creating
- automated backups that are waiting for the first automated snapshot to be available
* db-instance-id
- Accepts DB instance identifiers and Amazon Resource Names (ARNs). The results list
* includes only information about the DB instance automated backups identified by these ARNs.
* dbi-resource-id
- Accepts DB resource identifiers and Amazon Resource Names (ARNs). The results list
* includes only information about the DB instance resources identified by these ARNs.
*
* Supported filters are the following: *
*
* status
*
* active
- automated backups for current instances
*
* retained
- automated backups for deleted instances and after backup replication is stopped
*
* creating
- automated backups that are waiting for the first automated snapshot to be
* available
*
* db-instance-id
- Accepts DB instance identifiers and Amazon Resource Names (ARNs). The
* results list includes only information about the DB instance automated backups identified by these ARNs.
*
* dbi-resource-id
- Accepts DB resource identifiers and Amazon Resource Names (ARNs). The
* results list includes only information about the DB instance resources identified by these ARNs.
*
* Returns all resources by default. The status for each resource is specified in the response.
*/
public void setFilters(java.util.Collection
* A filter that specifies which resources to return based on status.
*
* Supported filters are the following:
*
*
*
*
*
*
*
* Returns all resources by default. The status for each resource is specified in the response.
*
* 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.
*
*
* status
*
*
* active
- automated backups for current instances
* retained
- automated backups for deleted instances and after backup replication is stopped
* creating
- automated backups that are waiting for the first automated snapshot to be available
* db-instance-id
- Accepts DB instance identifiers and Amazon Resource Names (ARNs). The results list
* includes only information about the DB instance automated backups identified by these ARNs.
* dbi-resource-id
- Accepts DB resource identifiers and Amazon Resource Names (ARNs). The results list
* includes only information about the DB instance resources identified by these ARNs.
*
* Supported filters are the following: *
*
* status
*
* active
- automated backups for current instances
*
* retained
- automated backups for deleted instances and after backup replication is stopped
*
* creating
- automated backups that are waiting for the first automated snapshot to be
* available
*
* db-instance-id
- Accepts DB instance identifiers and Amazon Resource Names (ARNs). The
* results list includes only information about the DB instance automated backups identified by these ARNs.
*
* dbi-resource-id
- Accepts DB resource identifiers and Amazon Resource Names (ARNs). The
* results list includes only information about the DB instance resources identified by these ARNs.
*
* Returns all resources by default. The status for each resource is specified in the response.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeDBInstanceAutomatedBackupsRequest withFilters(Filter... filters) {
if (this.filters == null) {
setFilters(new com.amazonaws.internal.SdkInternalList
* A filter that specifies which resources to return based on status.
*
* Supported filters are the following:
*
*
*
*
*
*
*
* Returns all resources by default. The status for each resource is specified in the response.
*
*
* status
*
*
* active
- automated backups for current instances
* retained
- automated backups for deleted instances and after backup replication is stopped
* creating
- automated backups that are waiting for the first automated snapshot to be available
* db-instance-id
- Accepts DB instance identifiers and Amazon Resource Names (ARNs). The results list
* includes only information about the DB instance automated backups identified by these ARNs.
* dbi-resource-id
- Accepts DB resource identifiers and Amazon Resource Names (ARNs). The results list
* includes only information about the DB instance resources identified by these ARNs.
*
* Supported filters are the following: *
*
* status
*
* active
- automated backups for current instances
*
* retained
- automated backups for deleted instances and after backup replication is stopped
*
* creating
- automated backups that are waiting for the first automated snapshot to be
* available
*
* db-instance-id
- Accepts DB instance identifiers and Amazon Resource Names (ARNs). The
* results list includes only information about the DB instance automated backups identified by these ARNs.
*
* dbi-resource-id
- Accepts DB resource identifiers and Amazon Resource Names (ARNs). The
* results list includes only information about the DB instance resources identified by these ARNs.
*
* Returns all resources by default. The status for each resource is specified in the response.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeDBInstanceAutomatedBackupsRequest withFilters(java.util.Collection
* The maximum number of records to include in the response. If more records exist than the specified
*
* The maximum number of records to include in the response. If more records exist than the specified
*
* The maximum number of records to include in the response. If more records exist than the specified
*
* The pagination token provided in the previous request. If this parameter is specified the response includes only
* records beyond the marker, up to
* The pagination token provided in the previous request. If this parameter is specified the response includes only
* records beyond the marker, up to
* The pagination token provided in the previous request. If this parameter is specified the response includes only
* records beyond the marker, up to
* The Amazon Resource Name (ARN) of the replicated automated backups, for example,
*
* This setting doesn't apply to RDS Custom.
* MaxRecords
value, a pagination token called a marker is included in the response so that you can
* retrieve the remaining results.
* MaxRecords
value, a pagination token called a marker is included in the response so that you
* can retrieve the remaining results.
*/
public void setMaxRecords(Integer maxRecords) {
this.maxRecords = maxRecords;
}
/**
* MaxRecords
value, a pagination token called a marker is included in the response so that you can
* retrieve the remaining results.
* MaxRecords
value, a pagination token called a marker is included in the response so that you
* can retrieve the remaining results.
*/
public Integer getMaxRecords() {
return this.maxRecords;
}
/**
* MaxRecords
value, a pagination token called a marker is included in the response so that you can
* retrieve the remaining results.
* MaxRecords
value, a pagination token called a marker is included in the response so that you
* can retrieve the remaining results.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeDBInstanceAutomatedBackupsRequest withMaxRecords(Integer maxRecords) {
setMaxRecords(maxRecords);
return this;
}
/**
* MaxRecords
.
* MaxRecords
.
*/
public void setMarker(String marker) {
this.marker = marker;
}
/**
* MaxRecords
.
* MaxRecords
.
*/
public String getMarker() {
return this.marker;
}
/**
* MaxRecords
.
* MaxRecords
.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeDBInstanceAutomatedBackupsRequest withMarker(String marker) {
setMarker(marker);
return this;
}
/**
* arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE
.
* arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE
.
* This setting doesn't apply to RDS Custom. */ public void setDBInstanceAutomatedBackupsArn(String dBInstanceAutomatedBackupsArn) { this.dBInstanceAutomatedBackupsArn = dBInstanceAutomatedBackupsArn; } /** *
* The Amazon Resource Name (ARN) of the replicated automated backups, for example,
* arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE
.
*
* This setting doesn't apply to RDS Custom. *
* * @return The Amazon Resource Name (ARN) of the replicated automated backups, for example, *arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE
.
* * This setting doesn't apply to RDS Custom. */ public String getDBInstanceAutomatedBackupsArn() { return this.dBInstanceAutomatedBackupsArn; } /** *
* The Amazon Resource Name (ARN) of the replicated automated backups, for example,
* arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE
.
*
* This setting doesn't apply to RDS Custom. *
* * @param dBInstanceAutomatedBackupsArn * The Amazon Resource Name (ARN) of the replicated automated backups, for example, *arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE
.
* * This setting doesn't apply to RDS Custom. * @return Returns a reference to this object so that method calls can be chained together. */ public DescribeDBInstanceAutomatedBackupsRequest withDBInstanceAutomatedBackupsArn(String dBInstanceAutomatedBackupsArn) { setDBInstanceAutomatedBackupsArn(dBInstanceAutomatedBackupsArn); 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 (getDbiResourceId() != null) sb.append("DbiResourceId: ").append(getDbiResourceId()).append(","); if (getDBInstanceIdentifier() != null) sb.append("DBInstanceIdentifier: ").append(getDBInstanceIdentifier()).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 (getDBInstanceAutomatedBackupsArn() != null) sb.append("DBInstanceAutomatedBackupsArn: ").append(getDBInstanceAutomatedBackupsArn()); sb.append("}"); return sb.toString(); } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof DescribeDBInstanceAutomatedBackupsRequest == false) return false; DescribeDBInstanceAutomatedBackupsRequest other = (DescribeDBInstanceAutomatedBackupsRequest) obj; if (other.getDbiResourceId() == null ^ this.getDbiResourceId() == null) return false; if (other.getDbiResourceId() != null && other.getDbiResourceId().equals(this.getDbiResourceId()) == false) return false; if (other.getDBInstanceIdentifier() == null ^ this.getDBInstanceIdentifier() == null) return false; if (other.getDBInstanceIdentifier() != null && other.getDBInstanceIdentifier().equals(this.getDBInstanceIdentifier()) == 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.getDBInstanceAutomatedBackupsArn() == null ^ this.getDBInstanceAutomatedBackupsArn() == null) return false; if (other.getDBInstanceAutomatedBackupsArn() != null && other.getDBInstanceAutomatedBackupsArn().equals(this.getDBInstanceAutomatedBackupsArn()) == false) return false; return true; } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getDbiResourceId() == null) ? 0 : getDbiResourceId().hashCode()); hashCode = prime * hashCode + ((getDBInstanceIdentifier() == null) ? 0 : getDBInstanceIdentifier().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 + ((getDBInstanceAutomatedBackupsArn() == null) ? 0 : getDBInstanceAutomatedBackupsArn().hashCode()); return hashCode; } @Override public DescribeDBInstanceAutomatedBackupsRequest clone() { return (DescribeDBInstanceAutomatedBackupsRequest) super.clone(); } }