com.amazonaws.services.glacier.model.ListJobsRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-glacier 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.glacier.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* Provides options for retrieving a job list for an Amazon S3 Glacier vault.
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class ListJobsRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The AccountId value is the AWS account ID of the account that owns the vault. You can either specify
* an AWS account ID or optionally a single '-' (hyphen), in which case Amazon S3 Glacier uses the AWS
* account ID associated with the credentials used to sign the request. If you use an account ID, do not include any
* hyphens ('-') in the ID.
*
*/
private String accountId;
/**
*
* The name of the vault.
*
*/
private String vaultName;
/**
*
* The maximum number of jobs to be returned. The default limit is 50. The number of jobs returned might be fewer
* than the specified limit, but the number of returned jobs never exceeds the limit.
*
*/
private String limit;
/**
*
* An opaque string used for pagination. This value specifies the job at which the listing of jobs should begin. Get
* the marker value from a previous List Jobs response. You only need to include the marker if you are continuing
* the pagination of results started in a previous List Jobs request.
*
*/
private String marker;
/**
*
* The type of job status to return. You can specify the following values: InProgress,
* Succeeded, or Failed.
*
*/
private String statuscode;
/**
*
* The state of the jobs to return. You can specify true or false.
*
*/
private String completed;
/**
* Default constructor for ListJobsRequest object. Callers should use the setter or fluent setter (with...) methods
* to initialize the object after creating it.
*/
public ListJobsRequest() {
}
/**
* Constructs a new ListJobsRequest object. Callers should use the setter or fluent setter (with...) methods to
* initialize any additional object members.
*
* @param vaultName
* The name of the vault.
*/
public ListJobsRequest(String vaultName) {
setVaultName(vaultName);
}
/**
* Constructs a new ListJobsRequest object. Callers should use the setter or fluent setter (with...) methods to
* initialize any additional object members.
*
* @param accountId
* The AccountId value is the AWS account ID of the account that owns the vault. You can either
* specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon S3
* Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an
* account ID, do not include any hyphens ('-') in the ID.
* @param vaultName
* The name of the vault.
*/
public ListJobsRequest(String accountId, String vaultName) {
setAccountId(accountId);
setVaultName(vaultName);
}
/**
*
* The AccountId value is the AWS account ID of the account that owns the vault. You can either specify
* an AWS account ID or optionally a single '-' (hyphen), in which case Amazon S3 Glacier uses the AWS
* account ID associated with the credentials used to sign the request. If you use an account ID, do not include any
* hyphens ('-') in the ID.
*
*
* @param accountId
* The AccountId value is the AWS account ID of the account that owns the vault. You can either
* specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon S3
* Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an
* account ID, do not include any hyphens ('-') in the ID.
*/
public void setAccountId(String accountId) {
this.accountId = accountId;
}
/**
*
* The AccountId value is the AWS account ID of the account that owns the vault. You can either specify
* an AWS account ID or optionally a single '-' (hyphen), in which case Amazon S3 Glacier uses the AWS
* account ID associated with the credentials used to sign the request. If you use an account ID, do not include any
* hyphens ('-') in the ID.
*
*
* @return The AccountId value is the AWS account ID of the account that owns the vault. You can either
* specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon S3
* Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an
* account ID, do not include any hyphens ('-') in the ID.
*/
public String getAccountId() {
return this.accountId;
}
/**
*
* The AccountId value is the AWS account ID of the account that owns the vault. You can either specify
* an AWS account ID or optionally a single '-' (hyphen), in which case Amazon S3 Glacier uses the AWS
* account ID associated with the credentials used to sign the request. If you use an account ID, do not include any
* hyphens ('-') in the ID.
*
*
* @param accountId
* The AccountId value is the AWS account ID of the account that owns the vault. You can either
* specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon S3
* Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an
* account ID, do not include any hyphens ('-') in the ID.
* @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 name of the vault.
*
*
* @param vaultName
* The name of the vault.
*/
public void setVaultName(String vaultName) {
this.vaultName = vaultName;
}
/**
*
* The name of the vault.
*
*
* @return The name of the vault.
*/
public String getVaultName() {
return this.vaultName;
}
/**
*
* The name of the vault.
*
*
* @param vaultName
* The name of the vault.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListJobsRequest withVaultName(String vaultName) {
setVaultName(vaultName);
return this;
}
/**
*
* The maximum number of jobs to be returned. The default limit is 50. The number of jobs returned might be fewer
* than the specified limit, but the number of returned jobs never exceeds the limit.
*
*
* @param limit
* The maximum number of jobs to be returned. The default limit is 50. The number of jobs returned might be
* fewer than the specified limit, but the number of returned jobs never exceeds the limit.
*/
public void setLimit(String limit) {
this.limit = limit;
}
/**
*
* The maximum number of jobs to be returned. The default limit is 50. The number of jobs returned might be fewer
* than the specified limit, but the number of returned jobs never exceeds the limit.
*
*
* @return The maximum number of jobs to be returned. The default limit is 50. The number of jobs returned might be
* fewer than the specified limit, but the number of returned jobs never exceeds the limit.
*/
public String getLimit() {
return this.limit;
}
/**
*
* The maximum number of jobs to be returned. The default limit is 50. The number of jobs returned might be fewer
* than the specified limit, but the number of returned jobs never exceeds the limit.
*
*
* @param limit
* The maximum number of jobs to be returned. The default limit is 50. The number of jobs returned might be
* fewer than the specified limit, but the number of returned jobs never exceeds the limit.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListJobsRequest withLimit(String limit) {
setLimit(limit);
return this;
}
/**
*
* An opaque string used for pagination. This value specifies the job at which the listing of jobs should begin. Get
* the marker value from a previous List Jobs response. You only need to include the marker if you are continuing
* the pagination of results started in a previous List Jobs request.
*
*
* @param marker
* An opaque string used for pagination. This value specifies the job at which the listing of jobs should
* begin. Get the marker value from a previous List Jobs response. You only need to include the marker if you
* are continuing the pagination of results started in a previous List Jobs request.
*/
public void setMarker(String marker) {
this.marker = marker;
}
/**
*
* An opaque string used for pagination. This value specifies the job at which the listing of jobs should begin. Get
* the marker value from a previous List Jobs response. You only need to include the marker if you are continuing
* the pagination of results started in a previous List Jobs request.
*
*
* @return An opaque string used for pagination. This value specifies the job at which the listing of jobs should
* begin. Get the marker value from a previous List Jobs response. You only need to include the marker if
* you are continuing the pagination of results started in a previous List Jobs request.
*/
public String getMarker() {
return this.marker;
}
/**
*
* An opaque string used for pagination. This value specifies the job at which the listing of jobs should begin. Get
* the marker value from a previous List Jobs response. You only need to include the marker if you are continuing
* the pagination of results started in a previous List Jobs request.
*
*
* @param marker
* An opaque string used for pagination. This value specifies the job at which the listing of jobs should
* begin. Get the marker value from a previous List Jobs response. You only need to include the marker if you
* are continuing the pagination of results started in a previous List Jobs request.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListJobsRequest withMarker(String marker) {
setMarker(marker);
return this;
}
/**
*
* The type of job status to return. You can specify the following values: InProgress,
* Succeeded, or Failed.
*
*
* @param statuscode
* The type of job status to return. You can specify the following values: InProgress,
* Succeeded, or Failed.
*/
public void setStatuscode(String statuscode) {
this.statuscode = statuscode;
}
/**
*
* The type of job status to return. You can specify the following values: InProgress,
* Succeeded, or Failed.
*
*
* @return The type of job status to return. You can specify the following values: InProgress,
* Succeeded, or Failed.
*/
public String getStatuscode() {
return this.statuscode;
}
/**
*
* The type of job status to return. You can specify the following values: InProgress,
* Succeeded, or Failed.
*
*
* @param statuscode
* The type of job status to return. You can specify the following values: InProgress,
* Succeeded, or Failed.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListJobsRequest withStatuscode(String statuscode) {
setStatuscode(statuscode);
return this;
}
/**
*
* The state of the jobs to return. You can specify true or false.
*
*
* @param completed
* The state of the jobs to return. You can specify true or false.
*/
public void setCompleted(String completed) {
this.completed = completed;
}
/**
*
* The state of the jobs to return. You can specify true or false.
*
*
* @return The state of the jobs to return. You can specify true or false.
*/
public String getCompleted() {
return this.completed;
}
/**
*
* The state of the jobs to return. You can specify true or false.
*
*
* @param completed
* The state of the jobs to return. You can specify true or false.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListJobsRequest withCompleted(String completed) {
setCompleted(completed);
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 (getVaultName() != null)
sb.append("VaultName: ").append(getVaultName()).append(",");
if (getLimit() != null)
sb.append("Limit: ").append(getLimit()).append(",");
if (getMarker() != null)
sb.append("Marker: ").append(getMarker()).append(",");
if (getStatuscode() != null)
sb.append("Statuscode: ").append(getStatuscode()).append(",");
if (getCompleted() != null)
sb.append("Completed: ").append(getCompleted());
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.getVaultName() == null ^ this.getVaultName() == null)
return false;
if (other.getVaultName() != null && other.getVaultName().equals(this.getVaultName()) == 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.getMarker() == null ^ this.getMarker() == null)
return false;
if (other.getMarker() != null && other.getMarker().equals(this.getMarker()) == false)
return false;
if (other.getStatuscode() == null ^ this.getStatuscode() == null)
return false;
if (other.getStatuscode() != null && other.getStatuscode().equals(this.getStatuscode()) == false)
return false;
if (other.getCompleted() == null ^ this.getCompleted() == null)
return false;
if (other.getCompleted() != null && other.getCompleted().equals(this.getCompleted()) == 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 + ((getVaultName() == null) ? 0 : getVaultName().hashCode());
hashCode = prime * hashCode + ((getLimit() == null) ? 0 : getLimit().hashCode());
hashCode = prime * hashCode + ((getMarker() == null) ? 0 : getMarker().hashCode());
hashCode = prime * hashCode + ((getStatuscode() == null) ? 0 : getStatuscode().hashCode());
hashCode = prime * hashCode + ((getCompleted() == null) ? 0 : getCompleted().hashCode());
return hashCode;
}
@Override
public ListJobsRequest clone() {
return (ListJobsRequest) super.clone();
}
}