com.amazonaws.services.dynamodbv2.model.ListBackupsRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-dynamodb Show documentation
/*
* Copyright 2019-2024 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.dynamodbv2.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 ListBackupsRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* Lists the backups from the table specified in TableName. You can also provide the Amazon Resource
* Name (ARN) of the table in this parameter.
*
*/
private String tableName;
/**
*
* Maximum number of backups to return at once.
*
*/
private Integer limit;
/**
*
* Only backups created after this time are listed. TimeRangeLowerBound is inclusive.
*
*/
private java.util.Date timeRangeLowerBound;
/**
*
* Only backups created before this time are listed. TimeRangeUpperBound is exclusive.
*
*/
private java.util.Date timeRangeUpperBound;
/**
*
* LastEvaluatedBackupArn is the Amazon Resource Name (ARN) of the backup last evaluated when the
* current page of results was returned, inclusive of the current page of results. This value may be specified as
* the ExclusiveStartBackupArn of a new ListBackups operation in order to fetch the next
* page of results.
*
*/
private String exclusiveStartBackupArn;
/**
*
* The backups from the table specified by BackupType are listed.
*
*
* Where BackupType can be:
*
*
* -
*
* USER - On-demand backup created by you. (The default setting if no other backup types are
* specified.)
*
*
* -
*
* SYSTEM - On-demand backup automatically created by DynamoDB.
*
*
* -
*
* ALL - All types of on-demand backups (USER and SYSTEM).
*
*
*
*/
private String backupType;
/**
*
* Lists the backups from the table specified in TableName. You can also provide the Amazon Resource
* Name (ARN) of the table in this parameter.
*
*
* @param tableName
* Lists the backups from the table specified in TableName. You can also provide the Amazon
* Resource Name (ARN) of the table in this parameter.
*/
public void setTableName(String tableName) {
this.tableName = tableName;
}
/**
*
* Lists the backups from the table specified in TableName. You can also provide the Amazon Resource
* Name (ARN) of the table in this parameter.
*
*
* @return Lists the backups from the table specified in TableName. You can also provide the Amazon
* Resource Name (ARN) of the table in this parameter.
*/
public String getTableName() {
return this.tableName;
}
/**
*
* Lists the backups from the table specified in TableName. You can also provide the Amazon Resource
* Name (ARN) of the table in this parameter.
*
*
* @param tableName
* Lists the backups from the table specified in TableName. You can also provide the Amazon
* Resource Name (ARN) of the table in this parameter.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListBackupsRequest withTableName(String tableName) {
setTableName(tableName);
return this;
}
/**
*
* Maximum number of backups to return at once.
*
*
* @param limit
* Maximum number of backups to return at once.
*/
public void setLimit(Integer limit) {
this.limit = limit;
}
/**
*
* Maximum number of backups to return at once.
*
*
* @return Maximum number of backups to return at once.
*/
public Integer getLimit() {
return this.limit;
}
/**
*
* Maximum number of backups to return at once.
*
*
* @param limit
* Maximum number of backups to return at once.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListBackupsRequest withLimit(Integer limit) {
setLimit(limit);
return this;
}
/**
*
* Only backups created after this time are listed. TimeRangeLowerBound is inclusive.
*
*
* @param timeRangeLowerBound
* Only backups created after this time are listed. TimeRangeLowerBound is inclusive.
*/
public void setTimeRangeLowerBound(java.util.Date timeRangeLowerBound) {
this.timeRangeLowerBound = timeRangeLowerBound;
}
/**
*
* Only backups created after this time are listed. TimeRangeLowerBound is inclusive.
*
*
* @return Only backups created after this time are listed. TimeRangeLowerBound is inclusive.
*/
public java.util.Date getTimeRangeLowerBound() {
return this.timeRangeLowerBound;
}
/**
*
* Only backups created after this time are listed. TimeRangeLowerBound is inclusive.
*
*
* @param timeRangeLowerBound
* Only backups created after this time are listed. TimeRangeLowerBound is inclusive.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListBackupsRequest withTimeRangeLowerBound(java.util.Date timeRangeLowerBound) {
setTimeRangeLowerBound(timeRangeLowerBound);
return this;
}
/**
*
* Only backups created before this time are listed. TimeRangeUpperBound is exclusive.
*
*
* @param timeRangeUpperBound
* Only backups created before this time are listed. TimeRangeUpperBound is exclusive.
*/
public void setTimeRangeUpperBound(java.util.Date timeRangeUpperBound) {
this.timeRangeUpperBound = timeRangeUpperBound;
}
/**
*
* Only backups created before this time are listed. TimeRangeUpperBound is exclusive.
*
*
* @return Only backups created before this time are listed. TimeRangeUpperBound is exclusive.
*/
public java.util.Date getTimeRangeUpperBound() {
return this.timeRangeUpperBound;
}
/**
*
* Only backups created before this time are listed. TimeRangeUpperBound is exclusive.
*
*
* @param timeRangeUpperBound
* Only backups created before this time are listed. TimeRangeUpperBound is exclusive.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListBackupsRequest withTimeRangeUpperBound(java.util.Date timeRangeUpperBound) {
setTimeRangeUpperBound(timeRangeUpperBound);
return this;
}
/**
*
* LastEvaluatedBackupArn is the Amazon Resource Name (ARN) of the backup last evaluated when the
* current page of results was returned, inclusive of the current page of results. This value may be specified as
* the ExclusiveStartBackupArn of a new ListBackups operation in order to fetch the next
* page of results.
*
*
* @param exclusiveStartBackupArn
* LastEvaluatedBackupArn is the Amazon Resource Name (ARN) of the backup last evaluated when
* the current page of results was returned, inclusive of the current page of results. This value may be
* specified as the ExclusiveStartBackupArn of a new ListBackups operation in order
* to fetch the next page of results.
*/
public void setExclusiveStartBackupArn(String exclusiveStartBackupArn) {
this.exclusiveStartBackupArn = exclusiveStartBackupArn;
}
/**
*
* LastEvaluatedBackupArn is the Amazon Resource Name (ARN) of the backup last evaluated when the
* current page of results was returned, inclusive of the current page of results. This value may be specified as
* the ExclusiveStartBackupArn of a new ListBackups operation in order to fetch the next
* page of results.
*
*
* @return LastEvaluatedBackupArn is the Amazon Resource Name (ARN) of the backup last evaluated when
* the current page of results was returned, inclusive of the current page of results. This value may be
* specified as the ExclusiveStartBackupArn of a new ListBackups operation in
* order to fetch the next page of results.
*/
public String getExclusiveStartBackupArn() {
return this.exclusiveStartBackupArn;
}
/**
*
* LastEvaluatedBackupArn is the Amazon Resource Name (ARN) of the backup last evaluated when the
* current page of results was returned, inclusive of the current page of results. This value may be specified as
* the ExclusiveStartBackupArn of a new ListBackups operation in order to fetch the next
* page of results.
*
*
* @param exclusiveStartBackupArn
* LastEvaluatedBackupArn is the Amazon Resource Name (ARN) of the backup last evaluated when
* the current page of results was returned, inclusive of the current page of results. This value may be
* specified as the ExclusiveStartBackupArn of a new ListBackups operation in order
* to fetch the next page of results.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListBackupsRequest withExclusiveStartBackupArn(String exclusiveStartBackupArn) {
setExclusiveStartBackupArn(exclusiveStartBackupArn);
return this;
}
/**
*
* The backups from the table specified by BackupType are listed.
*
*
* Where BackupType can be:
*
*
* -
*
* USER - On-demand backup created by you. (The default setting if no other backup types are
* specified.)
*
*
* -
*
* SYSTEM - On-demand backup automatically created by DynamoDB.
*
*
* -
*
* ALL - All types of on-demand backups (USER and SYSTEM).
*
*
*
*
* @param backupType
* The backups from the table specified by BackupType are listed.
*
* Where BackupType can be:
*
*
* -
*
* USER - On-demand backup created by you. (The default setting if no other backup types are
* specified.)
*
*
* -
*
* SYSTEM - On-demand backup automatically created by DynamoDB.
*
*
* -
*
* ALL - All types of on-demand backups (USER and SYSTEM).
*
*
* @see BackupTypeFilter
*/
public void setBackupType(String backupType) {
this.backupType = backupType;
}
/**
*
* The backups from the table specified by BackupType are listed.
*
*
* Where BackupType can be:
*
*
* -
*
* USER - On-demand backup created by you. (The default setting if no other backup types are
* specified.)
*
*
* -
*
* SYSTEM - On-demand backup automatically created by DynamoDB.
*
*
* -
*
* ALL - All types of on-demand backups (USER and SYSTEM).
*
*
*
*
* @return The backups from the table specified by BackupType are listed.
*
* Where BackupType can be:
*
*
* -
*
* USER - On-demand backup created by you. (The default setting if no other backup types are
* specified.)
*
*
* -
*
* SYSTEM - On-demand backup automatically created by DynamoDB.
*
*
* -
*
* ALL - All types of on-demand backups (USER and SYSTEM).
*
*
* @see BackupTypeFilter
*/
public String getBackupType() {
return this.backupType;
}
/**
*
* The backups from the table specified by BackupType are listed.
*
*
* Where BackupType can be:
*
*
* -
*
* USER - On-demand backup created by you. (The default setting if no other backup types are
* specified.)
*
*
* -
*
* SYSTEM - On-demand backup automatically created by DynamoDB.
*
*
* -
*
* ALL - All types of on-demand backups (USER and SYSTEM).
*
*
*
*
* @param backupType
* The backups from the table specified by BackupType are listed.
*
* Where BackupType can be:
*
*
* -
*
* USER - On-demand backup created by you. (The default setting if no other backup types are
* specified.)
*
*
* -
*
* SYSTEM - On-demand backup automatically created by DynamoDB.
*
*
* -
*
* ALL - All types of on-demand backups (USER and SYSTEM).
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see BackupTypeFilter
*/
public ListBackupsRequest withBackupType(String backupType) {
setBackupType(backupType);
return this;
}
/**
*
* The backups from the table specified by BackupType are listed.
*
*
* Where BackupType can be:
*
*
* -
*
* USER - On-demand backup created by you. (The default setting if no other backup types are
* specified.)
*
*
* -
*
* SYSTEM - On-demand backup automatically created by DynamoDB.
*
*
* -
*
* ALL - All types of on-demand backups (USER and SYSTEM).
*
*
*
*
* @param backupType
* The backups from the table specified by BackupType are listed.
*
* Where BackupType can be:
*
*
* -
*
* USER - On-demand backup created by you. (The default setting if no other backup types are
* specified.)
*
*
* -
*
* SYSTEM - On-demand backup automatically created by DynamoDB.
*
*
* -
*
* ALL - All types of on-demand backups (USER and SYSTEM).
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see BackupTypeFilter
*/
public ListBackupsRequest withBackupType(BackupTypeFilter backupType) {
this.backupType = backupType.toString();
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 (getTableName() != null)
sb.append("TableName: ").append(getTableName()).append(",");
if (getLimit() != null)
sb.append("Limit: ").append(getLimit()).append(",");
if (getTimeRangeLowerBound() != null)
sb.append("TimeRangeLowerBound: ").append(getTimeRangeLowerBound()).append(",");
if (getTimeRangeUpperBound() != null)
sb.append("TimeRangeUpperBound: ").append(getTimeRangeUpperBound()).append(",");
if (getExclusiveStartBackupArn() != null)
sb.append("ExclusiveStartBackupArn: ").append(getExclusiveStartBackupArn()).append(",");
if (getBackupType() != null)
sb.append("BackupType: ").append(getBackupType());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof ListBackupsRequest == false)
return false;
ListBackupsRequest other = (ListBackupsRequest) obj;
if (other.getTableName() == null ^ this.getTableName() == null)
return false;
if (other.getTableName() != null && other.getTableName().equals(this.getTableName()) == false)
return false;
if (other.getLimit() == null ^ this.getLimit() == null)
return false;
if (other.getLimit() != null && other.getLimit().equals(this.getLimit()) == false)
return false;
if (other.getTimeRangeLowerBound() == null ^ this.getTimeRangeLowerBound() == null)
return false;
if (other.getTimeRangeLowerBound() != null && other.getTimeRangeLowerBound().equals(this.getTimeRangeLowerBound()) == false)
return false;
if (other.getTimeRangeUpperBound() == null ^ this.getTimeRangeUpperBound() == null)
return false;
if (other.getTimeRangeUpperBound() != null && other.getTimeRangeUpperBound().equals(this.getTimeRangeUpperBound()) == false)
return false;
if (other.getExclusiveStartBackupArn() == null ^ this.getExclusiveStartBackupArn() == null)
return false;
if (other.getExclusiveStartBackupArn() != null && other.getExclusiveStartBackupArn().equals(this.getExclusiveStartBackupArn()) == false)
return false;
if (other.getBackupType() == null ^ this.getBackupType() == null)
return false;
if (other.getBackupType() != null && other.getBackupType().equals(this.getBackupType()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getTableName() == null) ? 0 : getTableName().hashCode());
hashCode = prime * hashCode + ((getLimit() == null) ? 0 : getLimit().hashCode());
hashCode = prime * hashCode + ((getTimeRangeLowerBound() == null) ? 0 : getTimeRangeLowerBound().hashCode());
hashCode = prime * hashCode + ((getTimeRangeUpperBound() == null) ? 0 : getTimeRangeUpperBound().hashCode());
hashCode = prime * hashCode + ((getExclusiveStartBackupArn() == null) ? 0 : getExclusiveStartBackupArn().hashCode());
hashCode = prime * hashCode + ((getBackupType() == null) ? 0 : getBackupType().hashCode());
return hashCode;
}
@Override
public ListBackupsRequest clone() {
return (ListBackupsRequest) super.clone();
}
}