com.amazonaws.services.simspaceweaver.model.DescribeSimulationResult Maven / Gradle / Ivy
Show all versions of aws-java-sdk-simspaceweaver Show documentation
/*
* Copyright 2017-2022 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.simspaceweaver.model;
import java.io.Serializable;
import javax.annotation.Generated;
/**
*
* @see AWS
* API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class DescribeSimulationResult extends com.amazonaws.AmazonWebServiceResult implements Serializable, Cloneable {
/**
*
* The Amazon Resource Name (ARN) of the simulation. For more information about ARNs, see Amazon Resource Names
* (ARNs) in the Amazon Web Services General Reference.
*
*/
private String arn;
/**
*
* The time when the simulation was created, expressed as the number of seconds and milliseconds in UTC since the
* Unix epoch (0:0:0.000, January 1, 1970).
*
*/
private java.util.Date creationTime;
/**
*
* The description of the simulation.
*
*/
private String description;
/**
*
* A universally unique identifier (UUID) for this simulation.
*
*/
private String executionId;
/**
*
* A collection of additional state information, such as domain and clock configuration.
*
*/
private LiveSimulationState liveSimulationState;
/**
*
* Settings that control how SimSpace Weaver handles your simulation log data.
*
*/
private LoggingConfiguration loggingConfiguration;
/**
*
* The maximum running time of the simulation, specified as a number of months (m or M), hours (h or H), or days (d
* or D). The simulation stops when it reaches this limit.
*
*/
private String maximumDuration;
/**
*
* The name of the simulation.
*
*/
private String name;
/**
*
* The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that the simulation assumes to
* perform actions. For more information about ARNs, see Amazon Resource Names
* (ARNs) in the Amazon Web Services General Reference. For more information about IAM roles, see IAM roles in the Identity and Access
* Management User Guide.
*
*/
private String roleArn;
/**
*
* An error message that SimSpace Weaver returns only if there is a problem with the simulation schema.
*
*/
private String schemaError;
/**
*
* The location of the simulation schema in Amazon Simple Storage Service (Amazon S3). For more information about
* Amazon S3, see the Amazon Simple
* Storage Service User Guide .
*
*/
private S3Location schemaS3Location;
/**
*
* The current lifecycle state of the simulation.
*
*/
private String status;
/**
*
* The desired lifecycle state of the simulation.
*
*/
private String targetStatus;
/**
*
* The Amazon Resource Name (ARN) of the simulation. For more information about ARNs, see Amazon Resource Names
* (ARNs) in the Amazon Web Services General Reference.
*
*
* @param arn
* The Amazon Resource Name (ARN) of the simulation. For more information about ARNs, see Amazon Resource Names
* (ARNs) in the Amazon Web Services General Reference.
*/
public void setArn(String arn) {
this.arn = arn;
}
/**
*
* The Amazon Resource Name (ARN) of the simulation. For more information about ARNs, see Amazon Resource Names
* (ARNs) in the Amazon Web Services General Reference.
*
*
* @return The Amazon Resource Name (ARN) of the simulation. For more information about ARNs, see Amazon Resource Names
* (ARNs) in the Amazon Web Services General Reference.
*/
public String getArn() {
return this.arn;
}
/**
*
* The Amazon Resource Name (ARN) of the simulation. For more information about ARNs, see Amazon Resource Names
* (ARNs) in the Amazon Web Services General Reference.
*
*
* @param arn
* The Amazon Resource Name (ARN) of the simulation. For more information about ARNs, see Amazon Resource Names
* (ARNs) in the Amazon Web Services General Reference.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeSimulationResult withArn(String arn) {
setArn(arn);
return this;
}
/**
*
* The time when the simulation was created, expressed as the number of seconds and milliseconds in UTC since the
* Unix epoch (0:0:0.000, January 1, 1970).
*
*
* @param creationTime
* The time when the simulation was created, expressed as the number of seconds and milliseconds in UTC since
* the Unix epoch (0:0:0.000, January 1, 1970).
*/
public void setCreationTime(java.util.Date creationTime) {
this.creationTime = creationTime;
}
/**
*
* The time when the simulation was created, expressed as the number of seconds and milliseconds in UTC since the
* Unix epoch (0:0:0.000, January 1, 1970).
*
*
* @return The time when the simulation was created, expressed as the number of seconds and milliseconds in UTC
* since the Unix epoch (0:0:0.000, January 1, 1970).
*/
public java.util.Date getCreationTime() {
return this.creationTime;
}
/**
*
* The time when the simulation was created, expressed as the number of seconds and milliseconds in UTC since the
* Unix epoch (0:0:0.000, January 1, 1970).
*
*
* @param creationTime
* The time when the simulation was created, expressed as the number of seconds and milliseconds in UTC since
* the Unix epoch (0:0:0.000, January 1, 1970).
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeSimulationResult withCreationTime(java.util.Date creationTime) {
setCreationTime(creationTime);
return this;
}
/**
*
* The description of the simulation.
*
*
* @param description
* The description of the simulation.
*/
public void setDescription(String description) {
this.description = description;
}
/**
*
* The description of the simulation.
*
*
* @return The description of the simulation.
*/
public String getDescription() {
return this.description;
}
/**
*
* The description of the simulation.
*
*
* @param description
* The description of the simulation.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeSimulationResult withDescription(String description) {
setDescription(description);
return this;
}
/**
*
* A universally unique identifier (UUID) for this simulation.
*
*
* @param executionId
* A universally unique identifier (UUID) for this simulation.
*/
public void setExecutionId(String executionId) {
this.executionId = executionId;
}
/**
*
* A universally unique identifier (UUID) for this simulation.
*
*
* @return A universally unique identifier (UUID) for this simulation.
*/
public String getExecutionId() {
return this.executionId;
}
/**
*
* A universally unique identifier (UUID) for this simulation.
*
*
* @param executionId
* A universally unique identifier (UUID) for this simulation.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeSimulationResult withExecutionId(String executionId) {
setExecutionId(executionId);
return this;
}
/**
*
* A collection of additional state information, such as domain and clock configuration.
*
*
* @param liveSimulationState
* A collection of additional state information, such as domain and clock configuration.
*/
public void setLiveSimulationState(LiveSimulationState liveSimulationState) {
this.liveSimulationState = liveSimulationState;
}
/**
*
* A collection of additional state information, such as domain and clock configuration.
*
*
* @return A collection of additional state information, such as domain and clock configuration.
*/
public LiveSimulationState getLiveSimulationState() {
return this.liveSimulationState;
}
/**
*
* A collection of additional state information, such as domain and clock configuration.
*
*
* @param liveSimulationState
* A collection of additional state information, such as domain and clock configuration.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeSimulationResult withLiveSimulationState(LiveSimulationState liveSimulationState) {
setLiveSimulationState(liveSimulationState);
return this;
}
/**
*
* Settings that control how SimSpace Weaver handles your simulation log data.
*
*
* @param loggingConfiguration
* Settings that control how SimSpace Weaver handles your simulation log data.
*/
public void setLoggingConfiguration(LoggingConfiguration loggingConfiguration) {
this.loggingConfiguration = loggingConfiguration;
}
/**
*
* Settings that control how SimSpace Weaver handles your simulation log data.
*
*
* @return Settings that control how SimSpace Weaver handles your simulation log data.
*/
public LoggingConfiguration getLoggingConfiguration() {
return this.loggingConfiguration;
}
/**
*
* Settings that control how SimSpace Weaver handles your simulation log data.
*
*
* @param loggingConfiguration
* Settings that control how SimSpace Weaver handles your simulation log data.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeSimulationResult withLoggingConfiguration(LoggingConfiguration loggingConfiguration) {
setLoggingConfiguration(loggingConfiguration);
return this;
}
/**
*
* The maximum running time of the simulation, specified as a number of months (m or M), hours (h or H), or days (d
* or D). The simulation stops when it reaches this limit.
*
*
* @param maximumDuration
* The maximum running time of the simulation, specified as a number of months (m or M), hours (h or H), or
* days (d or D). The simulation stops when it reaches this limit.
*/
public void setMaximumDuration(String maximumDuration) {
this.maximumDuration = maximumDuration;
}
/**
*
* The maximum running time of the simulation, specified as a number of months (m or M), hours (h or H), or days (d
* or D). The simulation stops when it reaches this limit.
*
*
* @return The maximum running time of the simulation, specified as a number of months (m or M), hours (h or H), or
* days (d or D). The simulation stops when it reaches this limit.
*/
public String getMaximumDuration() {
return this.maximumDuration;
}
/**
*
* The maximum running time of the simulation, specified as a number of months (m or M), hours (h or H), or days (d
* or D). The simulation stops when it reaches this limit.
*
*
* @param maximumDuration
* The maximum running time of the simulation, specified as a number of months (m or M), hours (h or H), or
* days (d or D). The simulation stops when it reaches this limit.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeSimulationResult withMaximumDuration(String maximumDuration) {
setMaximumDuration(maximumDuration);
return this;
}
/**
*
* The name of the simulation.
*
*
* @param name
* The name of the simulation.
*/
public void setName(String name) {
this.name = name;
}
/**
*
* The name of the simulation.
*
*
* @return The name of the simulation.
*/
public String getName() {
return this.name;
}
/**
*
* The name of the simulation.
*
*
* @param name
* The name of the simulation.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeSimulationResult withName(String name) {
setName(name);
return this;
}
/**
*
* The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that the simulation assumes to
* perform actions. For more information about ARNs, see Amazon Resource Names
* (ARNs) in the Amazon Web Services General Reference. For more information about IAM roles, see IAM roles in the Identity and Access
* Management User Guide.
*
*
* @param roleArn
* The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that the simulation
* assumes to perform actions. For more information about ARNs, see Amazon Resource Names
* (ARNs) in the Amazon Web Services General Reference. For more information about IAM roles, see
* IAM roles in the Identity
* and Access Management User Guide.
*/
public void setRoleArn(String roleArn) {
this.roleArn = roleArn;
}
/**
*
* The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that the simulation assumes to
* perform actions. For more information about ARNs, see Amazon Resource Names
* (ARNs) in the Amazon Web Services General Reference. For more information about IAM roles, see IAM roles in the Identity and Access
* Management User Guide.
*
*
* @return The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that the simulation
* assumes to perform actions. For more information about ARNs, see Amazon Resource Names
* (ARNs) in the Amazon Web Services General Reference. For more information about IAM roles, see
* IAM roles in the Identity
* and Access Management User Guide.
*/
public String getRoleArn() {
return this.roleArn;
}
/**
*
* The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that the simulation assumes to
* perform actions. For more information about ARNs, see Amazon Resource Names
* (ARNs) in the Amazon Web Services General Reference. For more information about IAM roles, see IAM roles in the Identity and Access
* Management User Guide.
*
*
* @param roleArn
* The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that the simulation
* assumes to perform actions. For more information about ARNs, see Amazon Resource Names
* (ARNs) in the Amazon Web Services General Reference. For more information about IAM roles, see
* IAM roles in the Identity
* and Access Management User Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeSimulationResult withRoleArn(String roleArn) {
setRoleArn(roleArn);
return this;
}
/**
*
* An error message that SimSpace Weaver returns only if there is a problem with the simulation schema.
*
*
* @param schemaError
* An error message that SimSpace Weaver returns only if there is a problem with the simulation schema.
*/
public void setSchemaError(String schemaError) {
this.schemaError = schemaError;
}
/**
*
* An error message that SimSpace Weaver returns only if there is a problem with the simulation schema.
*
*
* @return An error message that SimSpace Weaver returns only if there is a problem with the simulation schema.
*/
public String getSchemaError() {
return this.schemaError;
}
/**
*
* An error message that SimSpace Weaver returns only if there is a problem with the simulation schema.
*
*
* @param schemaError
* An error message that SimSpace Weaver returns only if there is a problem with the simulation schema.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeSimulationResult withSchemaError(String schemaError) {
setSchemaError(schemaError);
return this;
}
/**
*
* The location of the simulation schema in Amazon Simple Storage Service (Amazon S3). For more information about
* Amazon S3, see the Amazon Simple
* Storage Service User Guide .
*
*
* @param schemaS3Location
* The location of the simulation schema in Amazon Simple Storage Service (Amazon S3). For more information
* about Amazon S3, see the
* Amazon Simple Storage Service User Guide .
*/
public void setSchemaS3Location(S3Location schemaS3Location) {
this.schemaS3Location = schemaS3Location;
}
/**
*
* The location of the simulation schema in Amazon Simple Storage Service (Amazon S3). For more information about
* Amazon S3, see the Amazon Simple
* Storage Service User Guide .
*
*
* @return The location of the simulation schema in Amazon Simple Storage Service (Amazon S3). For more information
* about Amazon S3, see the
* Amazon Simple Storage Service User Guide .
*/
public S3Location getSchemaS3Location() {
return this.schemaS3Location;
}
/**
*
* The location of the simulation schema in Amazon Simple Storage Service (Amazon S3). For more information about
* Amazon S3, see the Amazon Simple
* Storage Service User Guide .
*
*
* @param schemaS3Location
* The location of the simulation schema in Amazon Simple Storage Service (Amazon S3). For more information
* about Amazon S3, see the
* Amazon Simple Storage Service User Guide .
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeSimulationResult withSchemaS3Location(S3Location schemaS3Location) {
setSchemaS3Location(schemaS3Location);
return this;
}
/**
*
* The current lifecycle state of the simulation.
*
*
* @param status
* The current lifecycle state of the simulation.
* @see SimulationStatus
*/
public void setStatus(String status) {
this.status = status;
}
/**
*
* The current lifecycle state of the simulation.
*
*
* @return The current lifecycle state of the simulation.
* @see SimulationStatus
*/
public String getStatus() {
return this.status;
}
/**
*
* The current lifecycle state of the simulation.
*
*
* @param status
* The current lifecycle state of the simulation.
* @return Returns a reference to this object so that method calls can be chained together.
* @see SimulationStatus
*/
public DescribeSimulationResult withStatus(String status) {
setStatus(status);
return this;
}
/**
*
* The current lifecycle state of the simulation.
*
*
* @param status
* The current lifecycle state of the simulation.
* @return Returns a reference to this object so that method calls can be chained together.
* @see SimulationStatus
*/
public DescribeSimulationResult withStatus(SimulationStatus status) {
this.status = status.toString();
return this;
}
/**
*
* The desired lifecycle state of the simulation.
*
*
* @param targetStatus
* The desired lifecycle state of the simulation.
* @see SimulationTargetStatus
*/
public void setTargetStatus(String targetStatus) {
this.targetStatus = targetStatus;
}
/**
*
* The desired lifecycle state of the simulation.
*
*
* @return The desired lifecycle state of the simulation.
* @see SimulationTargetStatus
*/
public String getTargetStatus() {
return this.targetStatus;
}
/**
*
* The desired lifecycle state of the simulation.
*
*
* @param targetStatus
* The desired lifecycle state of the simulation.
* @return Returns a reference to this object so that method calls can be chained together.
* @see SimulationTargetStatus
*/
public DescribeSimulationResult withTargetStatus(String targetStatus) {
setTargetStatus(targetStatus);
return this;
}
/**
*
* The desired lifecycle state of the simulation.
*
*
* @param targetStatus
* The desired lifecycle state of the simulation.
* @return Returns a reference to this object so that method calls can be chained together.
* @see SimulationTargetStatus
*/
public DescribeSimulationResult withTargetStatus(SimulationTargetStatus targetStatus) {
this.targetStatus = targetStatus.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 (getArn() != null)
sb.append("Arn: ").append(getArn()).append(",");
if (getCreationTime() != null)
sb.append("CreationTime: ").append(getCreationTime()).append(",");
if (getDescription() != null)
sb.append("Description: ").append(getDescription()).append(",");
if (getExecutionId() != null)
sb.append("ExecutionId: ").append(getExecutionId()).append(",");
if (getLiveSimulationState() != null)
sb.append("LiveSimulationState: ").append(getLiveSimulationState()).append(",");
if (getLoggingConfiguration() != null)
sb.append("LoggingConfiguration: ").append(getLoggingConfiguration()).append(",");
if (getMaximumDuration() != null)
sb.append("MaximumDuration: ").append(getMaximumDuration()).append(",");
if (getName() != null)
sb.append("Name: ").append(getName()).append(",");
if (getRoleArn() != null)
sb.append("RoleArn: ").append(getRoleArn()).append(",");
if (getSchemaError() != null)
sb.append("SchemaError: ").append(getSchemaError()).append(",");
if (getSchemaS3Location() != null)
sb.append("SchemaS3Location: ").append(getSchemaS3Location()).append(",");
if (getStatus() != null)
sb.append("Status: ").append(getStatus()).append(",");
if (getTargetStatus() != null)
sb.append("TargetStatus: ").append(getTargetStatus());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof DescribeSimulationResult == false)
return false;
DescribeSimulationResult other = (DescribeSimulationResult) obj;
if (other.getArn() == null ^ this.getArn() == null)
return false;
if (other.getArn() != null && other.getArn().equals(this.getArn()) == false)
return false;
if (other.getCreationTime() == null ^ this.getCreationTime() == null)
return false;
if (other.getCreationTime() != null && other.getCreationTime().equals(this.getCreationTime()) == false)
return false;
if (other.getDescription() == null ^ this.getDescription() == null)
return false;
if (other.getDescription() != null && other.getDescription().equals(this.getDescription()) == false)
return false;
if (other.getExecutionId() == null ^ this.getExecutionId() == null)
return false;
if (other.getExecutionId() != null && other.getExecutionId().equals(this.getExecutionId()) == false)
return false;
if (other.getLiveSimulationState() == null ^ this.getLiveSimulationState() == null)
return false;
if (other.getLiveSimulationState() != null && other.getLiveSimulationState().equals(this.getLiveSimulationState()) == false)
return false;
if (other.getLoggingConfiguration() == null ^ this.getLoggingConfiguration() == null)
return false;
if (other.getLoggingConfiguration() != null && other.getLoggingConfiguration().equals(this.getLoggingConfiguration()) == false)
return false;
if (other.getMaximumDuration() == null ^ this.getMaximumDuration() == null)
return false;
if (other.getMaximumDuration() != null && other.getMaximumDuration().equals(this.getMaximumDuration()) == false)
return false;
if (other.getName() == null ^ this.getName() == null)
return false;
if (other.getName() != null && other.getName().equals(this.getName()) == false)
return false;
if (other.getRoleArn() == null ^ this.getRoleArn() == null)
return false;
if (other.getRoleArn() != null && other.getRoleArn().equals(this.getRoleArn()) == false)
return false;
if (other.getSchemaError() == null ^ this.getSchemaError() == null)
return false;
if (other.getSchemaError() != null && other.getSchemaError().equals(this.getSchemaError()) == false)
return false;
if (other.getSchemaS3Location() == null ^ this.getSchemaS3Location() == null)
return false;
if (other.getSchemaS3Location() != null && other.getSchemaS3Location().equals(this.getSchemaS3Location()) == 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.getTargetStatus() == null ^ this.getTargetStatus() == null)
return false;
if (other.getTargetStatus() != null && other.getTargetStatus().equals(this.getTargetStatus()) == 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 + ((getCreationTime() == null) ? 0 : getCreationTime().hashCode());
hashCode = prime * hashCode + ((getDescription() == null) ? 0 : getDescription().hashCode());
hashCode = prime * hashCode + ((getExecutionId() == null) ? 0 : getExecutionId().hashCode());
hashCode = prime * hashCode + ((getLiveSimulationState() == null) ? 0 : getLiveSimulationState().hashCode());
hashCode = prime * hashCode + ((getLoggingConfiguration() == null) ? 0 : getLoggingConfiguration().hashCode());
hashCode = prime * hashCode + ((getMaximumDuration() == null) ? 0 : getMaximumDuration().hashCode());
hashCode = prime * hashCode + ((getName() == null) ? 0 : getName().hashCode());
hashCode = prime * hashCode + ((getRoleArn() == null) ? 0 : getRoleArn().hashCode());
hashCode = prime * hashCode + ((getSchemaError() == null) ? 0 : getSchemaError().hashCode());
hashCode = prime * hashCode + ((getSchemaS3Location() == null) ? 0 : getSchemaS3Location().hashCode());
hashCode = prime * hashCode + ((getStatus() == null) ? 0 : getStatus().hashCode());
hashCode = prime * hashCode + ((getTargetStatus() == null) ? 0 : getTargetStatus().hashCode());
return hashCode;
}
@Override
public DescribeSimulationResult clone() {
try {
return (DescribeSimulationResult) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
}