com.amazonaws.services.robomaker.model.DescribeWorldExportJobResult Maven / Gradle / Ivy
Show all versions of aws-java-sdk-robomaker 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.robomaker.model;
import java.io.Serializable;
import javax.annotation.Generated;
/**
*
* @see AWS
* API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class DescribeWorldExportJobResult extends com.amazonaws.AmazonWebServiceResult implements Serializable, Cloneable {
/**
*
* The Amazon Resource Name (ARN) of the world export job.
*
*/
private String arn;
/**
*
* The status of the world export job.
*
*
* - Pending
* -
*
* The world export job request is pending.
*
*
* - Running
* -
*
* The world export job is running.
*
*
* - Completed
* -
*
* The world export job completed.
*
*
* - Failed
* -
*
* The world export job failed. See failureCode and failureReason for more information.
*
*
* - Canceled
* -
*
* The world export job was cancelled.
*
*
* - Canceling
* -
*
* The world export job is being cancelled.
*
*
*
*/
private String status;
/**
*
* The time, in milliseconds since the epoch, when the world export job was created.
*
*/
private java.util.Date createdAt;
/**
*
* The failure code of the world export job if it failed:
*
*
* - InternalServiceError
* -
*
* Internal service error.
*
*
* - LimitExceeded
* -
*
* The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds
* the maximum number allowed.
*
*
* - ResourceNotFound
* -
*
* The specified resource could not be found.
*
*
* - RequestThrottled
* -
*
* The request was throttled.
*
*
* - InvalidInput
* -
*
* An input parameter in the request is not valid.
*
*
*
*/
private String failureCode;
/**
*
* The reason why the world export job failed.
*
*/
private String failureReason;
/**
*
* Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
*
*/
private String clientRequestToken;
/**
*
* A list of Amazon Resource Names (arns) that correspond to worlds to be exported.
*
*/
private java.util.List worlds;
private OutputLocation outputLocation;
/**
*
* The IAM role that the world export process uses to access the Amazon S3 bucket and put the export.
*
*/
private String iamRole;
/**
*
* A map that contains tag keys and tag values that are attached to the world export job.
*
*/
private java.util.Map tags;
/**
*
* The Amazon Resource Name (ARN) of the world export job.
*
*
* @param arn
* The Amazon Resource Name (ARN) of the world export job.
*/
public void setArn(String arn) {
this.arn = arn;
}
/**
*
* The Amazon Resource Name (ARN) of the world export job.
*
*
* @return The Amazon Resource Name (ARN) of the world export job.
*/
public String getArn() {
return this.arn;
}
/**
*
* The Amazon Resource Name (ARN) of the world export job.
*
*
* @param arn
* The Amazon Resource Name (ARN) of the world export job.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeWorldExportJobResult withArn(String arn) {
setArn(arn);
return this;
}
/**
*
* The status of the world export job.
*
*
* - Pending
* -
*
* The world export job request is pending.
*
*
* - Running
* -
*
* The world export job is running.
*
*
* - Completed
* -
*
* The world export job completed.
*
*
* - Failed
* -
*
* The world export job failed. See failureCode and failureReason for more information.
*
*
* - Canceled
* -
*
* The world export job was cancelled.
*
*
* - Canceling
* -
*
* The world export job is being cancelled.
*
*
*
*
* @param status
* The status of the world export job.
*
* - Pending
* -
*
* The world export job request is pending.
*
*
* - Running
* -
*
* The world export job is running.
*
*
* - Completed
* -
*
* The world export job completed.
*
*
* - Failed
* -
*
* The world export job failed. See failureCode and failureReason for more
* information.
*
*
* - Canceled
* -
*
* The world export job was cancelled.
*
*
* - Canceling
* -
*
* The world export job is being cancelled.
*
*
* @see WorldExportJobStatus
*/
public void setStatus(String status) {
this.status = status;
}
/**
*
* The status of the world export job.
*
*
* - Pending
* -
*
* The world export job request is pending.
*
*
* - Running
* -
*
* The world export job is running.
*
*
* - Completed
* -
*
* The world export job completed.
*
*
* - Failed
* -
*
* The world export job failed. See failureCode and failureReason for more information.
*
*
* - Canceled
* -
*
* The world export job was cancelled.
*
*
* - Canceling
* -
*
* The world export job is being cancelled.
*
*
*
*
* @return The status of the world export job.
*
* - Pending
* -
*
* The world export job request is pending.
*
*
* - Running
* -
*
* The world export job is running.
*
*
* - Completed
* -
*
* The world export job completed.
*
*
* - Failed
* -
*
* The world export job failed. See failureCode and failureReason for more
* information.
*
*
* - Canceled
* -
*
* The world export job was cancelled.
*
*
* - Canceling
* -
*
* The world export job is being cancelled.
*
*
* @see WorldExportJobStatus
*/
public String getStatus() {
return this.status;
}
/**
*
* The status of the world export job.
*
*
* - Pending
* -
*
* The world export job request is pending.
*
*
* - Running
* -
*
* The world export job is running.
*
*
* - Completed
* -
*
* The world export job completed.
*
*
* - Failed
* -
*
* The world export job failed. See failureCode and failureReason for more information.
*
*
* - Canceled
* -
*
* The world export job was cancelled.
*
*
* - Canceling
* -
*
* The world export job is being cancelled.
*
*
*
*
* @param status
* The status of the world export job.
*
* - Pending
* -
*
* The world export job request is pending.
*
*
* - Running
* -
*
* The world export job is running.
*
*
* - Completed
* -
*
* The world export job completed.
*
*
* - Failed
* -
*
* The world export job failed. See failureCode and failureReason for more
* information.
*
*
* - Canceled
* -
*
* The world export job was cancelled.
*
*
* - Canceling
* -
*
* The world export job is being cancelled.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see WorldExportJobStatus
*/
public DescribeWorldExportJobResult withStatus(String status) {
setStatus(status);
return this;
}
/**
*
* The status of the world export job.
*
*
* - Pending
* -
*
* The world export job request is pending.
*
*
* - Running
* -
*
* The world export job is running.
*
*
* - Completed
* -
*
* The world export job completed.
*
*
* - Failed
* -
*
* The world export job failed. See failureCode and failureReason for more information.
*
*
* - Canceled
* -
*
* The world export job was cancelled.
*
*
* - Canceling
* -
*
* The world export job is being cancelled.
*
*
*
*
* @param status
* The status of the world export job.
*
* - Pending
* -
*
* The world export job request is pending.
*
*
* - Running
* -
*
* The world export job is running.
*
*
* - Completed
* -
*
* The world export job completed.
*
*
* - Failed
* -
*
* The world export job failed. See failureCode and failureReason for more
* information.
*
*
* - Canceled
* -
*
* The world export job was cancelled.
*
*
* - Canceling
* -
*
* The world export job is being cancelled.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see WorldExportJobStatus
*/
public DescribeWorldExportJobResult withStatus(WorldExportJobStatus status) {
this.status = status.toString();
return this;
}
/**
*
* The time, in milliseconds since the epoch, when the world export job was created.
*
*
* @param createdAt
* The time, in milliseconds since the epoch, when the world export job was created.
*/
public void setCreatedAt(java.util.Date createdAt) {
this.createdAt = createdAt;
}
/**
*
* The time, in milliseconds since the epoch, when the world export job was created.
*
*
* @return The time, in milliseconds since the epoch, when the world export job was created.
*/
public java.util.Date getCreatedAt() {
return this.createdAt;
}
/**
*
* The time, in milliseconds since the epoch, when the world export job was created.
*
*
* @param createdAt
* The time, in milliseconds since the epoch, when the world export job was created.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeWorldExportJobResult withCreatedAt(java.util.Date createdAt) {
setCreatedAt(createdAt);
return this;
}
/**
*
* The failure code of the world export job if it failed:
*
*
* - InternalServiceError
* -
*
* Internal service error.
*
*
* - LimitExceeded
* -
*
* The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds
* the maximum number allowed.
*
*
* - ResourceNotFound
* -
*
* The specified resource could not be found.
*
*
* - RequestThrottled
* -
*
* The request was throttled.
*
*
* - InvalidInput
* -
*
* An input parameter in the request is not valid.
*
*
*
*
* @param failureCode
* The failure code of the world export job if it failed:
*
* - InternalServiceError
* -
*
* Internal service error.
*
*
* - LimitExceeded
* -
*
* The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests
* exceeds the maximum number allowed.
*
*
* - ResourceNotFound
* -
*
* The specified resource could not be found.
*
*
* - RequestThrottled
* -
*
* The request was throttled.
*
*
* - InvalidInput
* -
*
* An input parameter in the request is not valid.
*
*
* @see WorldExportJobErrorCode
*/
public void setFailureCode(String failureCode) {
this.failureCode = failureCode;
}
/**
*
* The failure code of the world export job if it failed:
*
*
* - InternalServiceError
* -
*
* Internal service error.
*
*
* - LimitExceeded
* -
*
* The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds
* the maximum number allowed.
*
*
* - ResourceNotFound
* -
*
* The specified resource could not be found.
*
*
* - RequestThrottled
* -
*
* The request was throttled.
*
*
* - InvalidInput
* -
*
* An input parameter in the request is not valid.
*
*
*
*
* @return The failure code of the world export job if it failed:
*
* - InternalServiceError
* -
*
* Internal service error.
*
*
* - LimitExceeded
* -
*
* The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests
* exceeds the maximum number allowed.
*
*
* - ResourceNotFound
* -
*
* The specified resource could not be found.
*
*
* - RequestThrottled
* -
*
* The request was throttled.
*
*
* - InvalidInput
* -
*
* An input parameter in the request is not valid.
*
*
* @see WorldExportJobErrorCode
*/
public String getFailureCode() {
return this.failureCode;
}
/**
*
* The failure code of the world export job if it failed:
*
*
* - InternalServiceError
* -
*
* Internal service error.
*
*
* - LimitExceeded
* -
*
* The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds
* the maximum number allowed.
*
*
* - ResourceNotFound
* -
*
* The specified resource could not be found.
*
*
* - RequestThrottled
* -
*
* The request was throttled.
*
*
* - InvalidInput
* -
*
* An input parameter in the request is not valid.
*
*
*
*
* @param failureCode
* The failure code of the world export job if it failed:
*
* - InternalServiceError
* -
*
* Internal service error.
*
*
* - LimitExceeded
* -
*
* The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests
* exceeds the maximum number allowed.
*
*
* - ResourceNotFound
* -
*
* The specified resource could not be found.
*
*
* - RequestThrottled
* -
*
* The request was throttled.
*
*
* - InvalidInput
* -
*
* An input parameter in the request is not valid.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see WorldExportJobErrorCode
*/
public DescribeWorldExportJobResult withFailureCode(String failureCode) {
setFailureCode(failureCode);
return this;
}
/**
*
* The failure code of the world export job if it failed:
*
*
* - InternalServiceError
* -
*
* Internal service error.
*
*
* - LimitExceeded
* -
*
* The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds
* the maximum number allowed.
*
*
* - ResourceNotFound
* -
*
* The specified resource could not be found.
*
*
* - RequestThrottled
* -
*
* The request was throttled.
*
*
* - InvalidInput
* -
*
* An input parameter in the request is not valid.
*
*
*
*
* @param failureCode
* The failure code of the world export job if it failed:
*
* - InternalServiceError
* -
*
* Internal service error.
*
*
* - LimitExceeded
* -
*
* The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests
* exceeds the maximum number allowed.
*
*
* - ResourceNotFound
* -
*
* The specified resource could not be found.
*
*
* - RequestThrottled
* -
*
* The request was throttled.
*
*
* - InvalidInput
* -
*
* An input parameter in the request is not valid.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see WorldExportJobErrorCode
*/
public DescribeWorldExportJobResult withFailureCode(WorldExportJobErrorCode failureCode) {
this.failureCode = failureCode.toString();
return this;
}
/**
*
* The reason why the world export job failed.
*
*
* @param failureReason
* The reason why the world export job failed.
*/
public void setFailureReason(String failureReason) {
this.failureReason = failureReason;
}
/**
*
* The reason why the world export job failed.
*
*
* @return The reason why the world export job failed.
*/
public String getFailureReason() {
return this.failureReason;
}
/**
*
* The reason why the world export job failed.
*
*
* @param failureReason
* The reason why the world export job failed.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeWorldExportJobResult withFailureReason(String failureReason) {
setFailureReason(failureReason);
return this;
}
/**
*
* Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
*
*
* @param clientRequestToken
* Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
*/
public void setClientRequestToken(String clientRequestToken) {
this.clientRequestToken = clientRequestToken;
}
/**
*
* Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
*
*
* @return Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
*/
public String getClientRequestToken() {
return this.clientRequestToken;
}
/**
*
* Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
*
*
* @param clientRequestToken
* Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeWorldExportJobResult withClientRequestToken(String clientRequestToken) {
setClientRequestToken(clientRequestToken);
return this;
}
/**
*
* A list of Amazon Resource Names (arns) that correspond to worlds to be exported.
*
*
* @return A list of Amazon Resource Names (arns) that correspond to worlds to be exported.
*/
public java.util.List getWorlds() {
return worlds;
}
/**
*
* A list of Amazon Resource Names (arns) that correspond to worlds to be exported.
*
*
* @param worlds
* A list of Amazon Resource Names (arns) that correspond to worlds to be exported.
*/
public void setWorlds(java.util.Collection worlds) {
if (worlds == null) {
this.worlds = null;
return;
}
this.worlds = new java.util.ArrayList(worlds);
}
/**
*
* A list of Amazon Resource Names (arns) that correspond to worlds to be exported.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setWorlds(java.util.Collection)} or {@link #withWorlds(java.util.Collection)} if you want to override the
* existing values.
*
*
* @param worlds
* A list of Amazon Resource Names (arns) that correspond to worlds to be exported.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeWorldExportJobResult withWorlds(String... worlds) {
if (this.worlds == null) {
setWorlds(new java.util.ArrayList(worlds.length));
}
for (String ele : worlds) {
this.worlds.add(ele);
}
return this;
}
/**
*
* A list of Amazon Resource Names (arns) that correspond to worlds to be exported.
*
*
* @param worlds
* A list of Amazon Resource Names (arns) that correspond to worlds to be exported.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeWorldExportJobResult withWorlds(java.util.Collection worlds) {
setWorlds(worlds);
return this;
}
/**
* @param outputLocation
*/
public void setOutputLocation(OutputLocation outputLocation) {
this.outputLocation = outputLocation;
}
/**
* @return
*/
public OutputLocation getOutputLocation() {
return this.outputLocation;
}
/**
* @param outputLocation
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeWorldExportJobResult withOutputLocation(OutputLocation outputLocation) {
setOutputLocation(outputLocation);
return this;
}
/**
*
* The IAM role that the world export process uses to access the Amazon S3 bucket and put the export.
*
*
* @param iamRole
* The IAM role that the world export process uses to access the Amazon S3 bucket and put the export.
*/
public void setIamRole(String iamRole) {
this.iamRole = iamRole;
}
/**
*
* The IAM role that the world export process uses to access the Amazon S3 bucket and put the export.
*
*
* @return The IAM role that the world export process uses to access the Amazon S3 bucket and put the export.
*/
public String getIamRole() {
return this.iamRole;
}
/**
*
* The IAM role that the world export process uses to access the Amazon S3 bucket and put the export.
*
*
* @param iamRole
* The IAM role that the world export process uses to access the Amazon S3 bucket and put the export.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeWorldExportJobResult withIamRole(String iamRole) {
setIamRole(iamRole);
return this;
}
/**
*
* A map that contains tag keys and tag values that are attached to the world export job.
*
*
* @return A map that contains tag keys and tag values that are attached to the world export job.
*/
public java.util.Map getTags() {
return tags;
}
/**
*
* A map that contains tag keys and tag values that are attached to the world export job.
*
*
* @param tags
* A map that contains tag keys and tag values that are attached to the world export job.
*/
public void setTags(java.util.Map tags) {
this.tags = tags;
}
/**
*
* A map that contains tag keys and tag values that are attached to the world export job.
*
*
* @param tags
* A map that contains tag keys and tag values that are attached to the world export job.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeWorldExportJobResult withTags(java.util.Map tags) {
setTags(tags);
return this;
}
/**
* Add a single Tags entry
*
* @see DescribeWorldExportJobResult#withTags
* @returns a reference to this object so that method calls can be chained together.
*/
public DescribeWorldExportJobResult addTagsEntry(String key, String value) {
if (null == this.tags) {
this.tags = new java.util.HashMap();
}
if (this.tags.containsKey(key))
throw new IllegalArgumentException("Duplicated keys (" + key.toString() + ") are provided.");
this.tags.put(key, value);
return this;
}
/**
* Removes all the entries added into Tags.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeWorldExportJobResult clearTagsEntries() {
this.tags = null;
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 (getArn() != null)
sb.append("Arn: ").append(getArn()).append(",");
if (getStatus() != null)
sb.append("Status: ").append(getStatus()).append(",");
if (getCreatedAt() != null)
sb.append("CreatedAt: ").append(getCreatedAt()).append(",");
if (getFailureCode() != null)
sb.append("FailureCode: ").append(getFailureCode()).append(",");
if (getFailureReason() != null)
sb.append("FailureReason: ").append(getFailureReason()).append(",");
if (getClientRequestToken() != null)
sb.append("ClientRequestToken: ").append(getClientRequestToken()).append(",");
if (getWorlds() != null)
sb.append("Worlds: ").append(getWorlds()).append(",");
if (getOutputLocation() != null)
sb.append("OutputLocation: ").append(getOutputLocation()).append(",");
if (getIamRole() != null)
sb.append("IamRole: ").append(getIamRole()).append(",");
if (getTags() != null)
sb.append("Tags: ").append(getTags());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof DescribeWorldExportJobResult == false)
return false;
DescribeWorldExportJobResult other = (DescribeWorldExportJobResult) obj;
if (other.getArn() == null ^ this.getArn() == null)
return false;
if (other.getArn() != null && other.getArn().equals(this.getArn()) == false)
return false;
if (other.getStatus() == null ^ this.getStatus() == null)
return false;
if (other.getStatus() != null && other.getStatus().equals(this.getStatus()) == false)
return false;
if (other.getCreatedAt() == null ^ this.getCreatedAt() == null)
return false;
if (other.getCreatedAt() != null && other.getCreatedAt().equals(this.getCreatedAt()) == false)
return false;
if (other.getFailureCode() == null ^ this.getFailureCode() == null)
return false;
if (other.getFailureCode() != null && other.getFailureCode().equals(this.getFailureCode()) == false)
return false;
if (other.getFailureReason() == null ^ this.getFailureReason() == null)
return false;
if (other.getFailureReason() != null && other.getFailureReason().equals(this.getFailureReason()) == false)
return false;
if (other.getClientRequestToken() == null ^ this.getClientRequestToken() == null)
return false;
if (other.getClientRequestToken() != null && other.getClientRequestToken().equals(this.getClientRequestToken()) == false)
return false;
if (other.getWorlds() == null ^ this.getWorlds() == null)
return false;
if (other.getWorlds() != null && other.getWorlds().equals(this.getWorlds()) == false)
return false;
if (other.getOutputLocation() == null ^ this.getOutputLocation() == null)
return false;
if (other.getOutputLocation() != null && other.getOutputLocation().equals(this.getOutputLocation()) == false)
return false;
if (other.getIamRole() == null ^ this.getIamRole() == null)
return false;
if (other.getIamRole() != null && other.getIamRole().equals(this.getIamRole()) == false)
return false;
if (other.getTags() == null ^ this.getTags() == null)
return false;
if (other.getTags() != null && other.getTags().equals(this.getTags()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getArn() == null) ? 0 : getArn().hashCode());
hashCode = prime * hashCode + ((getStatus() == null) ? 0 : getStatus().hashCode());
hashCode = prime * hashCode + ((getCreatedAt() == null) ? 0 : getCreatedAt().hashCode());
hashCode = prime * hashCode + ((getFailureCode() == null) ? 0 : getFailureCode().hashCode());
hashCode = prime * hashCode + ((getFailureReason() == null) ? 0 : getFailureReason().hashCode());
hashCode = prime * hashCode + ((getClientRequestToken() == null) ? 0 : getClientRequestToken().hashCode());
hashCode = prime * hashCode + ((getWorlds() == null) ? 0 : getWorlds().hashCode());
hashCode = prime * hashCode + ((getOutputLocation() == null) ? 0 : getOutputLocation().hashCode());
hashCode = prime * hashCode + ((getIamRole() == null) ? 0 : getIamRole().hashCode());
hashCode = prime * hashCode + ((getTags() == null) ? 0 : getTags().hashCode());
return hashCode;
}
@Override
public DescribeWorldExportJobResult clone() {
try {
return (DescribeWorldExportJobResult) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
}