com.amazonaws.services.robomaker.model.WorldFailure 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;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* Information about a failed world.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class WorldFailure implements Serializable, Cloneable, StructuredPojo {
/**
*
* 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 sample reason why the world failed. World errors are aggregated. A sample is used as the
* sampleFailureReason
.
*
*/
private String sampleFailureReason;
/**
*
* The number of failed worlds.
*
*/
private Integer failureCount;
/**
*
* 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 WorldGenerationJobErrorCode
*/
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 WorldGenerationJobErrorCode
*/
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 WorldGenerationJobErrorCode
*/
public WorldFailure 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 WorldGenerationJobErrorCode
*/
public WorldFailure withFailureCode(WorldGenerationJobErrorCode failureCode) {
this.failureCode = failureCode.toString();
return this;
}
/**
*
* The sample reason why the world failed. World errors are aggregated. A sample is used as the
* sampleFailureReason
.
*
*
* @param sampleFailureReason
* The sample reason why the world failed. World errors are aggregated. A sample is used as the
* sampleFailureReason
.
*/
public void setSampleFailureReason(String sampleFailureReason) {
this.sampleFailureReason = sampleFailureReason;
}
/**
*
* The sample reason why the world failed. World errors are aggregated. A sample is used as the
* sampleFailureReason
.
*
*
* @return The sample reason why the world failed. World errors are aggregated. A sample is used as the
* sampleFailureReason
.
*/
public String getSampleFailureReason() {
return this.sampleFailureReason;
}
/**
*
* The sample reason why the world failed. World errors are aggregated. A sample is used as the
* sampleFailureReason
.
*
*
* @param sampleFailureReason
* The sample reason why the world failed. World errors are aggregated. A sample is used as the
* sampleFailureReason
.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public WorldFailure withSampleFailureReason(String sampleFailureReason) {
setSampleFailureReason(sampleFailureReason);
return this;
}
/**
*
* The number of failed worlds.
*
*
* @param failureCount
* The number of failed worlds.
*/
public void setFailureCount(Integer failureCount) {
this.failureCount = failureCount;
}
/**
*
* The number of failed worlds.
*
*
* @return The number of failed worlds.
*/
public Integer getFailureCount() {
return this.failureCount;
}
/**
*
* The number of failed worlds.
*
*
* @param failureCount
* The number of failed worlds.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public WorldFailure withFailureCount(Integer failureCount) {
setFailureCount(failureCount);
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 (getFailureCode() != null)
sb.append("FailureCode: ").append(getFailureCode()).append(",");
if (getSampleFailureReason() != null)
sb.append("SampleFailureReason: ").append(getSampleFailureReason()).append(",");
if (getFailureCount() != null)
sb.append("FailureCount: ").append(getFailureCount());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof WorldFailure == false)
return false;
WorldFailure other = (WorldFailure) obj;
if (other.getFailureCode() == null ^ this.getFailureCode() == null)
return false;
if (other.getFailureCode() != null && other.getFailureCode().equals(this.getFailureCode()) == false)
return false;
if (other.getSampleFailureReason() == null ^ this.getSampleFailureReason() == null)
return false;
if (other.getSampleFailureReason() != null && other.getSampleFailureReason().equals(this.getSampleFailureReason()) == false)
return false;
if (other.getFailureCount() == null ^ this.getFailureCount() == null)
return false;
if (other.getFailureCount() != null && other.getFailureCount().equals(this.getFailureCount()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getFailureCode() == null) ? 0 : getFailureCode().hashCode());
hashCode = prime * hashCode + ((getSampleFailureReason() == null) ? 0 : getSampleFailureReason().hashCode());
hashCode = prime * hashCode + ((getFailureCount() == null) ? 0 : getFailureCount().hashCode());
return hashCode;
}
@Override
public WorldFailure clone() {
try {
return (WorldFailure) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
@com.amazonaws.annotation.SdkInternalApi
@Override
public void marshall(ProtocolMarshaller protocolMarshaller) {
com.amazonaws.services.robomaker.model.transform.WorldFailureMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}