com.amazonaws.services.s3control.model.ListJobsRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-s3control 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.s3control.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 ListJobsRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The Amazon Web Services account ID associated with the S3 Batch Operations job.
*
*/
private String accountId;
/**
*
* The List Jobs request returns jobs that match the statuses listed in this element.
*
*/
private java.util.List jobStatuses;
/**
*
* A pagination token to request the next page of results. Use the token that Amazon S3 returned in the
* NextToken element of the ListJobsResult from the previous List Jobs
* request.
*
*/
private String nextToken;
/**
*
* The maximum number of jobs that Amazon S3 will include in the List Jobs response. If there are more
* jobs than this number, the response will include a pagination token in the NextToken field to enable
* you to retrieve the next page of results.
*
*/
private Integer maxResults;
/**
*
* The Amazon Web Services account ID associated with the S3 Batch Operations job.
*
*
* @param accountId
* The Amazon Web Services account ID associated with the S3 Batch Operations job.
*/
public void setAccountId(String accountId) {
this.accountId = accountId;
}
/**
*
* The Amazon Web Services account ID associated with the S3 Batch Operations job.
*
*
* @return The Amazon Web Services account ID associated with the S3 Batch Operations job.
*/
public String getAccountId() {
return this.accountId;
}
/**
*
* The Amazon Web Services account ID associated with the S3 Batch Operations job.
*
*
* @param accountId
* The Amazon Web Services account ID associated with the S3 Batch Operations job.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListJobsRequest withAccountId(String accountId) {
setAccountId(accountId);
return this;
}
/**
*
* The List Jobs request returns jobs that match the statuses listed in this element.
*
*
* @return The List Jobs request returns jobs that match the statuses listed in this element.
* @see JobStatus
*/
public java.util.List getJobStatuses() {
return jobStatuses;
}
/**
*
* The List Jobs request returns jobs that match the statuses listed in this element.
*
*
* @param jobStatuses
* The List Jobs request returns jobs that match the statuses listed in this element.
* @see JobStatus
*/
public void setJobStatuses(java.util.Collection jobStatuses) {
if (jobStatuses == null) {
this.jobStatuses = null;
return;
}
this.jobStatuses = new java.util.ArrayList(jobStatuses);
}
/**
*
* The List Jobs request returns jobs that match the statuses listed in this element.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setJobStatuses(java.util.Collection)} or {@link #withJobStatuses(java.util.Collection)} if you want to
* override the existing values.
*
*
* @param jobStatuses
* The List Jobs request returns jobs that match the statuses listed in this element.
* @return Returns a reference to this object so that method calls can be chained together.
* @see JobStatus
*/
public ListJobsRequest withJobStatuses(String... jobStatuses) {
if (this.jobStatuses == null) {
setJobStatuses(new java.util.ArrayList(jobStatuses.length));
}
for (String ele : jobStatuses) {
this.jobStatuses.add(ele);
}
return this;
}
/**
*
* The List Jobs request returns jobs that match the statuses listed in this element.
*
*
* @param jobStatuses
* The List Jobs request returns jobs that match the statuses listed in this element.
* @return Returns a reference to this object so that method calls can be chained together.
* @see JobStatus
*/
public ListJobsRequest withJobStatuses(java.util.Collection jobStatuses) {
setJobStatuses(jobStatuses);
return this;
}
/**
*
* The List Jobs request returns jobs that match the statuses listed in this element.
*
*
* @param jobStatuses
* The List Jobs request returns jobs that match the statuses listed in this element.
* @return Returns a reference to this object so that method calls can be chained together.
* @see JobStatus
*/
public ListJobsRequest withJobStatuses(JobStatus... jobStatuses) {
java.util.ArrayList jobStatusesCopy = new java.util.ArrayList(jobStatuses.length);
for (JobStatus value : jobStatuses) {
jobStatusesCopy.add(value.toString());
}
if (getJobStatuses() == null) {
setJobStatuses(jobStatusesCopy);
} else {
getJobStatuses().addAll(jobStatusesCopy);
}
return this;
}
/**
*
* A pagination token to request the next page of results. Use the token that Amazon S3 returned in the
* NextToken element of the ListJobsResult from the previous List Jobs
* request.
*
*
* @param nextToken
* A pagination token to request the next page of results. Use the token that Amazon S3 returned in the
* NextToken element of the ListJobsResult from the previous List Jobs
* request.
*/
public void setNextToken(String nextToken) {
this.nextToken = nextToken;
}
/**
*
* A pagination token to request the next page of results. Use the token that Amazon S3 returned in the
* NextToken element of the ListJobsResult from the previous List Jobs
* request.
*
*
* @return A pagination token to request the next page of results. Use the token that Amazon S3 returned in the
* NextToken element of the ListJobsResult from the previous
* List Jobs request.
*/
public String getNextToken() {
return this.nextToken;
}
/**
*
* A pagination token to request the next page of results. Use the token that Amazon S3 returned in the
* NextToken element of the ListJobsResult from the previous List Jobs
* request.
*
*
* @param nextToken
* A pagination token to request the next page of results. Use the token that Amazon S3 returned in the
* NextToken element of the ListJobsResult from the previous List Jobs
* request.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListJobsRequest withNextToken(String nextToken) {
setNextToken(nextToken);
return this;
}
/**
*
* The maximum number of jobs that Amazon S3 will include in the List Jobs response. If there are more
* jobs than this number, the response will include a pagination token in the NextToken field to enable
* you to retrieve the next page of results.
*
*
* @param maxResults
* The maximum number of jobs that Amazon S3 will include in the List Jobs response. If there
* are more jobs than this number, the response will include a pagination token in the NextToken
* field to enable you to retrieve the next page of results.
*/
public void setMaxResults(Integer maxResults) {
this.maxResults = maxResults;
}
/**
*
* The maximum number of jobs that Amazon S3 will include in the List Jobs response. If there are more
* jobs than this number, the response will include a pagination token in the NextToken field to enable
* you to retrieve the next page of results.
*
*
* @return The maximum number of jobs that Amazon S3 will include in the List Jobs response. If there
* are more jobs than this number, the response will include a pagination token in the
* NextToken field to enable you to retrieve the next page of results.
*/
public Integer getMaxResults() {
return this.maxResults;
}
/**
*
* The maximum number of jobs that Amazon S3 will include in the List Jobs response. If there are more
* jobs than this number, the response will include a pagination token in the NextToken field to enable
* you to retrieve the next page of results.
*
*
* @param maxResults
* The maximum number of jobs that Amazon S3 will include in the List Jobs response. If there
* are more jobs than this number, the response will include a pagination token in the NextToken
* field to enable you to retrieve the next page of results.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListJobsRequest withMaxResults(Integer maxResults) {
setMaxResults(maxResults);
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 (getAccountId() != null)
sb.append("AccountId: ").append(getAccountId()).append(",");
if (getJobStatuses() != null)
sb.append("JobStatuses: ").append(getJobStatuses()).append(",");
if (getNextToken() != null)
sb.append("NextToken: ").append(getNextToken()).append(",");
if (getMaxResults() != null)
sb.append("MaxResults: ").append(getMaxResults());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof ListJobsRequest == false)
return false;
ListJobsRequest other = (ListJobsRequest) obj;
if (other.getAccountId() == null ^ this.getAccountId() == null)
return false;
if (other.getAccountId() != null && other.getAccountId().equals(this.getAccountId()) == false)
return false;
if (other.getJobStatuses() == null ^ this.getJobStatuses() == null)
return false;
if (other.getJobStatuses() != null && other.getJobStatuses().equals(this.getJobStatuses()) == false)
return false;
if (other.getNextToken() == null ^ this.getNextToken() == null)
return false;
if (other.getNextToken() != null && other.getNextToken().equals(this.getNextToken()) == false)
return false;
if (other.getMaxResults() == null ^ this.getMaxResults() == null)
return false;
if (other.getMaxResults() != null && other.getMaxResults().equals(this.getMaxResults()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getAccountId() == null) ? 0 : getAccountId().hashCode());
hashCode = prime * hashCode + ((getJobStatuses() == null) ? 0 : getJobStatuses().hashCode());
hashCode = prime * hashCode + ((getNextToken() == null) ? 0 : getNextToken().hashCode());
hashCode = prime * hashCode + ((getMaxResults() == null) ? 0 : getMaxResults().hashCode());
return hashCode;
}
@Override
public ListJobsRequest clone() {
return (ListJobsRequest) super.clone();
}
}