/* * 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; /** * * @see AWS API * Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class DescribeExportTasksRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable { /** *

* The identifier of the snapshot or cluster export task to be described. *

*/ private String exportTaskIdentifier; /** *

* The Amazon Resource Name (ARN) of the snapshot or cluster exported to Amazon S3. *

*/ private String sourceArn; /** *

* Filters specify one or more snapshot or cluster exports to describe. The filters are specified as name-value * pairs that define what to include in the output. Filter names and values are case-sensitive. *

* Supported filters include the following: *

*
* export-task-identifier - An identifier for the snapshot or cluster export task. *
*
*
* s3-bucket - The Amazon S3 bucket the data is exported to. *
*
*
* source-arn - The Amazon Resource Name (ARN) of the snapshot or cluster exported to Amazon S3. *
*
*
* status - The status of the export task. Must be lowercase. Valid statuses are the following: *
*
- *
  * canceled *
  *
- *
  * canceling *
  *
- *
  * complete *
  *
- *
  * failed *
  *
- *
  * in_progress *
  *
- *
  * starting *
  *
*

*/ private com.amazonaws.internal.SdkInternalList filters; /** *

* An optional pagination token provided by a previous DescribeExportTasks request. If you specify this * parameter, the response includes only records beyond the marker, up to the value specified by the * MaxRecords parameter. *

*/ private String marker; /** *

* The maximum number of records to include in the response. If more records exist than the specified value, a * pagination token called a marker is included in the response. You can use the marker in a later * DescribeExportTasks request to retrieve the remaining results. *

* Default: 100 *

* Constraints: Minimum 20, maximum 100. *

*/ private Integer maxRecords; /** *

* The type of source for the export. *

*/ private String sourceType; /** *

* The identifier of the snapshot or cluster export task to be described. *

* * @param exportTaskIdentifier * The identifier of the snapshot or cluster export task to be described. */ public void setExportTaskIdentifier(String exportTaskIdentifier) { this.exportTaskIdentifier = exportTaskIdentifier; } /** *

* The identifier of the snapshot or cluster export task to be described. *

* * @return The identifier of the snapshot or cluster export task to be described. */ public String getExportTaskIdentifier() { return this.exportTaskIdentifier; } /** *

* The identifier of the snapshot or cluster export task to be described. *

* * @param exportTaskIdentifier * The identifier of the snapshot or cluster export task to be described. * @return Returns a reference to this object so that method calls can be chained together. */ public DescribeExportTasksRequest withExportTaskIdentifier(String exportTaskIdentifier) { setExportTaskIdentifier(exportTaskIdentifier); return this; } /** *

* The Amazon Resource Name (ARN) of the snapshot or cluster exported to Amazon S3. *

* * @param sourceArn * The Amazon Resource Name (ARN) of the snapshot or cluster exported to Amazon S3. */ public void setSourceArn(String sourceArn) { this.sourceArn = sourceArn; } /** *

* The Amazon Resource Name (ARN) of the snapshot or cluster exported to Amazon S3. *

* * @return The Amazon Resource Name (ARN) of the snapshot or cluster exported to Amazon S3. */ public String getSourceArn() { return this.sourceArn; } /** *

* The Amazon Resource Name (ARN) of the snapshot or cluster exported to Amazon S3. *

* * @param sourceArn * The Amazon Resource Name (ARN) of the snapshot or cluster exported to Amazon S3. * @return Returns a reference to this object so that method calls can be chained together. */ public DescribeExportTasksRequest withSourceArn(String sourceArn) { setSourceArn(sourceArn); return this; } /** *

* Supported filters include the following: *

*
* export-task-identifier - An identifier for the snapshot or cluster export task. *
*
*
* s3-bucket - The Amazon S3 bucket the data is exported to. *
*
*
* source-arn - The Amazon Resource Name (ARN) of the snapshot or cluster exported to Amazon S3. *
*
*
* status - The status of the export task. Must be lowercase. Valid statuses are the following: *
*
- *
  * canceled *
  *
- *
  * canceling *
  *
- *
  * complete *
  *
- *
  * failed *
  *
- *
  * in_progress *
  *
- *
  * starting *
  *
*

* * @return Filters specify one or more snapshot or cluster exports to describe. The filters are specified as * name-value pairs that define what to include in the output. Filter names and values are * case-sensitive.

* Supported filters include the following: *

*
* export-task-identifier - An identifier for the snapshot or cluster export task. *
*
*
* s3-bucket - The Amazon S3 bucket the data is exported to. *
*
*
* source-arn - The Amazon Resource Name (ARN) of the snapshot or cluster exported to Amazon * S3. *
*
*
* status - The status of the export task. Must be lowercase. Valid statuses are the following: *
*
- *
  * canceled *
  *
- *
  * canceling *
  *
- *
  * complete *
  *
- *
  * failed *
  *
- *
  * in_progress *
  *
- *
  * starting *
  *
*

getFilters() { if (filters == null) { filters = new com.amazonaws.internal.SdkInternalList(); } return filters; } /** *

* Supported filters include the following: *

*
* export-task-identifier - An identifier for the snapshot or cluster export task. *
*
*
* s3-bucket - The Amazon S3 bucket the data is exported to. *
*
*
* source-arn - The Amazon Resource Name (ARN) of the snapshot or cluster exported to Amazon S3. *
*
*
* status - The status of the export task. Must be lowercase. Valid statuses are the following: *
*
- *
  * canceled *
  *
- *
  * canceling *
  *
- *
  * complete *
  *
- *
  * failed *
  *
- *
  * in_progress *
  *
- *
  * starting *
  *
*

* * @param filters * Filters specify one or more snapshot or cluster exports to describe. The filters are specified as * name-value pairs that define what to include in the output. Filter names and values are * case-sensitive.

* Supported filters include the following: *

*
* export-task-identifier - An identifier for the snapshot or cluster export task. *
*
*
* s3-bucket - The Amazon S3 bucket the data is exported to. *
*
*
* source-arn - The Amazon Resource Name (ARN) of the snapshot or cluster exported to Amazon S3. *
*
*
* status - The status of the export task. Must be lowercase. Valid statuses are the following: *
*
- *
  * canceled *
  *
- *
  * canceling *
  *
- *
  * complete *
  *
- *
  * failed *
  *
- *
  * in_progress *
  *
- *
  * starting *
  *
*

filters) { if (filters == null) { this.filters = null; return; } this.filters = new com.amazonaws.internal.SdkInternalList(filters); } /** *

* Supported filters include the following: *

*
* export-task-identifier - An identifier for the snapshot or cluster export task. *
*
*
* s3-bucket - The Amazon S3 bucket the data is exported to. *
*
*
* source-arn - The Amazon Resource Name (ARN) of the snapshot or cluster exported to Amazon S3. *
*
*
* status - The status of the export task. Must be lowercase. Valid statuses are the following: *
*
- *
  * canceled *
  *
- *
  * canceling *
  *
- *
  * complete *
  *
- *
  * failed *
  *
- *
  * in_progress *
  *
- *
  * starting *
  *
*

* 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. *

* Supported filters include the following: *

*
* export-task-identifier - An identifier for the snapshot or cluster export task. *
*
*
* s3-bucket - The Amazon S3 bucket the data is exported to. *
*
*
* source-arn - The Amazon Resource Name (ARN) of the snapshot or cluster exported to Amazon S3. *
*
*
* status - The status of the export task. Must be lowercase. Valid statuses are the following: *
*
- *
  * canceled *
  *
- *
  * canceling *
  *
- *
  * complete *
  *
- *
  * failed *
  *
- *
  * in_progress *
  *
- *
  * starting *
  *
*

(filters.length)); } for (Filter ele : filters) { this.filters.add(ele); } return this; } /** *

* Supported filters include the following: *

*
* export-task-identifier - An identifier for the snapshot or cluster export task. *
*
*
* s3-bucket - The Amazon S3 bucket the data is exported to. *
*
*
* source-arn - The Amazon Resource Name (ARN) of the snapshot or cluster exported to Amazon S3. *
*
*
* status - The status of the export task. Must be lowercase. Valid statuses are the following: *
*
- *
  * canceled *
  *
- *
  * canceling *
  *
- *
  * complete *
  *
- *
  * failed *
  *
- *
  * in_progress *
  *
- *
  * starting *
  *
*

* Supported filters include the following: *

*
* export-task-identifier - An identifier for the snapshot or cluster export task. *
*
*
* s3-bucket - The Amazon S3 bucket the data is exported to. *
*
*
* source-arn - The Amazon Resource Name (ARN) of the snapshot or cluster exported to Amazon S3. *
*
*
* status - The status of the export task. Must be lowercase. Valid statuses are the following: *
*
- *
  * canceled *
  *
- *
  * canceling *
  *
- *
  * complete *
  *
- *
  * failed *
  *
- *
  * in_progress *
  *
- *
  * starting *
  *
*

filters) { setFilters(filters); return this; } /** *

* * @param marker * An optional pagination token provided by a previous DescribeExportTasks request. If you * specify this parameter, the response includes only records beyond the marker, up to the value specified by * the MaxRecords parameter. */ public void setMarker(String marker) { this.marker = marker; } /** *

* * @return An optional pagination token provided by a previous DescribeExportTasks request. If you * specify this parameter, the response includes only records beyond the marker, up to the value specified * by the MaxRecords parameter. */ public String getMarker() { return this.marker; } /** *

* * @param marker * An optional pagination token provided by a previous DescribeExportTasks request. If you * specify this parameter, the response includes only records beyond the marker, up to the value specified by * the MaxRecords parameter. * @return Returns a reference to this object so that method calls can be chained together. */ public DescribeExportTasksRequest withMarker(String marker) { setMarker(marker); return this; } /** *

* 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 value, * a pagination token called a marker is included in the response. You can use the marker in a later * DescribeExportTasks request to retrieve the remaining results.

* Default: 100 *

* Constraints: Minimum 20, maximum 100. */ public void setMaxRecords(Integer maxRecords) { this.maxRecords = maxRecords; } /** *

* 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 value, * a pagination token called a marker is included in the response. You can use the marker in a later * DescribeExportTasks request to retrieve the remaining results.

* Default: 100 *

* Constraints: Minimum 20, maximum 100. */ public Integer getMaxRecords() { return this.maxRecords; } /** *

* Default: 100 *

* Constraints: Minimum 20, maximum 100. *

* Default: 100 *

* Constraints: Minimum 20, maximum 100. * @return Returns a reference to this object so that method calls can be chained together. */ public DescribeExportTasksRequest withMaxRecords(Integer maxRecords) { setMaxRecords(maxRecords); return this; } /** *

* The type of source for the export. *

* * @param sourceType * The type of source for the export. * @see ExportSourceType */ public void setSourceType(String sourceType) { this.sourceType = sourceType; } /** *

* The type of source for the export. *

* * @return The type of source for the export. * @see ExportSourceType */ public String getSourceType() { return this.sourceType; } /** *

* The type of source for the export. *

* * @param sourceType * The type of source for the export. * @return Returns a reference to this object so that method calls can be chained together. * @see ExportSourceType */ public DescribeExportTasksRequest withSourceType(ExportSourceType sourceType) { this.sourceType = sourceType.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 (getExportTaskIdentifier() != null) sb.append("ExportTaskIdentifier: ").append(getExportTaskIdentifier()).append(","); if (getSourceArn() != null) sb.append("SourceArn: ").append(getSourceArn()).append(","); if (getFilters() != null) sb.append("Filters: ").append(getFilters()).append(","); if (getMarker() != null) sb.append("Marker: ").append(getMarker()).append(","); if (getMaxRecords() != null) sb.append("MaxRecords: ").append(getMaxRecords()).append(","); if (getSourceType() != null) sb.append("SourceType: ").append(getSourceType()); sb.append("}"); return sb.toString(); } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof DescribeExportTasksRequest == false) return false; DescribeExportTasksRequest other = (DescribeExportTasksRequest) obj; if (other.getExportTaskIdentifier() == null ^ this.getExportTaskIdentifier() == null) return false; if (other.getExportTaskIdentifier() != null && other.getExportTaskIdentifier().equals(this.getExportTaskIdentifier()) == false) return false; if (other.getSourceArn() == null ^ this.getSourceArn() == null) return false; if (other.getSourceArn() != null && other.getSourceArn().equals(this.getSourceArn()) == 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.getMarker() == null ^ this.getMarker() == null) return false; if (other.getMarker() != null && other.getMarker().equals(this.getMarker()) == 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.getSourceType() == null ^ this.getSourceType() == null) return false; if (other.getSourceType() != null && other.getSourceType().equals(this.getSourceType()) == false) return false; return true; } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getExportTaskIdentifier() == null) ? 0 : getExportTaskIdentifier().hashCode()); hashCode = prime * hashCode + ((getSourceArn() == null) ? 0 : getSourceArn().hashCode()); hashCode = prime * hashCode + ((getFilters() == null) ? 0 : getFilters().hashCode()); hashCode = prime * hashCode + ((getMarker() == null) ? 0 : getMarker().hashCode()); hashCode = prime * hashCode + ((getMaxRecords() == null) ? 0 : getMaxRecords().hashCode()); hashCode = prime * hashCode + ((getSourceType() == null) ? 0 : getSourceType().hashCode()); return hashCode; } @Override public DescribeExportTasksRequest clone() { return (DescribeExportTasksRequest) super.clone(); } }