/* * Copyright 2018-2023 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; import com.amazonaws.AmazonWebServiceRequest; /** * * @see AWS API * Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class StartSimulationRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable { /** *

* A value that you provide to ensure that repeated calls to this API operation using the same parameters complete * only once. A ClientToken is also known as an idempotency token. A ClientToken * expires after 24 hours. *

*/ private String clientToken; /** *

* The description of the simulation. *

*/ private String description; /** *

* The maximum running time of the simulation, specified as a number of minutes (m or M), hours (h or H), or days (d * or D). The simulation stops when it reaches this limit. The maximum value is 14D, or its equivalent * in the other units. The default value is 14D. A value equivalent to 0 makes the * simulation immediately transition to Stopping as soon as it reaches Started. *

*/ 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; /** *

* 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 . *

* Provide a SchemaS3Location to start your simulation from a schema. *

* If you provide a SchemaS3Location then you can't provide a SnapshotS3Location. *

*/ private S3Location schemaS3Location; /** *

* The location of the snapshot .zip file in Amazon Simple Storage Service (Amazon S3). For more information about * Amazon S3, see the Amazon Simple * Storage Service User Guide . *

* Provide a SnapshotS3Location to start your simulation from a snapshot. *

* The Amazon S3 bucket must be in the same Amazon Web Services Region as the simulation. *

* If you provide a SnapshotS3Location then you can't provide a SchemaS3Location. *

*/ private S3Location snapshotS3Location; /** *

* A list of tags for the simulation. For more information about tags, see Tagging Amazon Web Services resources * in the Amazon Web Services General Reference. *

*/ private java.util.Map tags; /** *

* * @param clientToken * A value that you provide to ensure that repeated calls to this API operation using the same parameters * complete only once. A ClientToken is also known as an idempotency token. A * ClientToken expires after 24 hours. */ public void setClientToken(String clientToken) { this.clientToken = clientToken; } /** *

* * @return A value that you provide to ensure that repeated calls to this API operation using the same parameters * complete only once. A ClientToken is also known as an idempotency token. A * ClientToken expires after 24 hours. */ public String getClientToken() { return this.clientToken; } /** *

* * @param clientToken * A value that you provide to ensure that repeated calls to this API operation using the same parameters * complete only once. A ClientToken is also known as an idempotency token. A * ClientToken expires after 24 hours. * @return Returns a reference to this object so that method calls can be chained together. */ public StartSimulationRequest withClientToken(String clientToken) { setClientToken(clientToken); 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 StartSimulationRequest withDescription(String description) { setDescription(description); return this; } /** *

* * @param maximumDuration * The maximum running time of the simulation, specified as a number of minutes (m or M), hours (h or H), or * days (d or D). The simulation stops when it reaches this limit. The maximum value is 14D, or * its equivalent in the other units. The default value is 14D. A value equivalent to * 0 makes the simulation immediately transition to Stopping as soon as it reaches * Started. */ public void setMaximumDuration(String maximumDuration) { this.maximumDuration = maximumDuration; } /** *

* * @return The maximum running time of the simulation, specified as a number of minutes (m or M), hours (h or H), or * days (d or D). The simulation stops when it reaches this limit. The maximum value is 14D, or * its equivalent in the other units. The default value is 14D. A value equivalent to * 0 makes the simulation immediately transition to Stopping as soon as it reaches * Started. */ public String getMaximumDuration() { return this.maximumDuration; } /** *

* * @param maximumDuration * The maximum running time of the simulation, specified as a number of minutes (m or M), hours (h or H), or * days (d or D). The simulation stops when it reaches this limit. The maximum value is 14D, or * its equivalent in the other units. The default value is 14D. A value equivalent to * 0 makes the simulation immediately transition to Stopping as soon as it reaches * Started. * @return Returns a reference to this object so that method calls can be chained together. */ public StartSimulationRequest 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 StartSimulationRequest withName(String name) { setName(name); return this; } /** *

* * @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; } /** *

* * @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; } /** *

* * @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 StartSimulationRequest withRoleArn(String roleArn) { setRoleArn(roleArn); 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 . *

* Provide a SchemaS3Location to start your simulation from a schema. *

* If you provide a SchemaS3Location then you can't provide a SnapshotS3Location. *

* * @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 .

* Provide a SchemaS3Location to start your simulation from a schema. *

* If you provide a SchemaS3Location then you can't provide a SnapshotS3Location. */ 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 . *

* Provide a SchemaS3Location to start your simulation from a schema. *

* If you provide a SchemaS3Location then you can't provide a SnapshotS3Location. *

* * @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 .

* Provide a SchemaS3Location to start your simulation from a schema. *

* If you provide a SchemaS3Location then you can't provide a SnapshotS3Location. */ 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 . *

* Provide a SchemaS3Location to start your simulation from a schema. *

* If you provide a SchemaS3Location then you can't provide a SnapshotS3Location. *

* Provide a SchemaS3Location to start your simulation from a schema. *

* If you provide a SchemaS3Location then you can't provide a SnapshotS3Location. * @return Returns a reference to this object so that method calls can be chained together. */ public StartSimulationRequest withSchemaS3Location(S3Location schemaS3Location) { setSchemaS3Location(schemaS3Location); return this; } /** *

* The location of the snapshot .zip file in Amazon Simple Storage Service (Amazon S3). For more information about * Amazon S3, see the Amazon Simple * Storage Service User Guide . *

* Provide a SnapshotS3Location to start your simulation from a snapshot. *

* The Amazon S3 bucket must be in the same Amazon Web Services Region as the simulation. *

* If you provide a SnapshotS3Location then you can't provide a SchemaS3Location. *

* * @param snapshotS3Location * The location of the snapshot .zip file in Amazon Simple Storage Service (Amazon S3). For more information * about Amazon S3, see the * Amazon Simple Storage Service User Guide .

* Provide a SnapshotS3Location to start your simulation from a snapshot. *

* The Amazon S3 bucket must be in the same Amazon Web Services Region as the simulation. *

* If you provide a SnapshotS3Location then you can't provide a SchemaS3Location. */ public void setSnapshotS3Location(S3Location snapshotS3Location) { this.snapshotS3Location = snapshotS3Location; } /** *

* The location of the snapshot .zip file in Amazon Simple Storage Service (Amazon S3). For more information about * Amazon S3, see the Amazon Simple * Storage Service User Guide . *

* Provide a SnapshotS3Location to start your simulation from a snapshot. *

* The Amazon S3 bucket must be in the same Amazon Web Services Region as the simulation. *

* If you provide a SnapshotS3Location then you can't provide a SchemaS3Location. *

* * @return The location of the snapshot .zip file in Amazon Simple Storage Service (Amazon S3). For more information * about Amazon S3, see the * Amazon Simple Storage Service User Guide .

* Provide a SnapshotS3Location to start your simulation from a snapshot. *

* The Amazon S3 bucket must be in the same Amazon Web Services Region as the simulation. *

* If you provide a SnapshotS3Location then you can't provide a SchemaS3Location. */ public S3Location getSnapshotS3Location() { return this.snapshotS3Location; } /** *

* The location of the snapshot .zip file in Amazon Simple Storage Service (Amazon S3). For more information about * Amazon S3, see the Amazon Simple * Storage Service User Guide . *

* Provide a SnapshotS3Location to start your simulation from a snapshot. *

* The Amazon S3 bucket must be in the same Amazon Web Services Region as the simulation. *

* If you provide a SnapshotS3Location then you can't provide a SchemaS3Location. *

* Provide a SnapshotS3Location to start your simulation from a snapshot. *

* The Amazon S3 bucket must be in the same Amazon Web Services Region as the simulation. *

* If you provide a SnapshotS3Location then you can't provide a SchemaS3Location. * @return Returns a reference to this object so that method calls can be chained together. */ public StartSimulationRequest withSnapshotS3Location(S3Location snapshotS3Location) { setSnapshotS3Location(snapshotS3Location); return this; } /** *

* A list of tags for the simulation. For more information about tags, see Tagging Amazon Web Services resources * in the Amazon Web Services General Reference. *

* * @return A list of tags for the simulation. For more information about tags, see Tagging Amazon Web Services * resources in the Amazon Web Services General Reference. */ public java.util.Map getTags() { return tags; } /** *

* A list of tags for the simulation. For more information about tags, see Tagging Amazon Web Services resources * in the Amazon Web Services General Reference. *

* * @param tags * A list of tags for the simulation. For more information about tags, see Tagging Amazon Web Services * resources in the Amazon Web Services General Reference. */ public void setTags(java.util.Map tags) { this.tags = tags; } /** *

* A list of tags for the simulation. For more information about tags, see Tagging Amazon Web Services resources * in the Amazon Web Services General Reference. *

* * @param tags * A list of tags for the simulation. For more information about tags, see Tagging Amazon Web Services * resources in the Amazon Web Services General Reference. * @return Returns a reference to this object so that method calls can be chained together. */ public StartSimulationRequest withTags(java.util.Map tags) { setTags(tags); return this; } /** * Add a single Tags entry * * @see StartSimulationRequest#withTags * @returns a reference to this object so that method calls can be chained together. */ public StartSimulationRequest 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 StartSimulationRequest 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 (getClientToken() != null) sb.append("ClientToken: ").append("***Sensitive Data Redacted***").append(","); if (getDescription() != null) sb.append("Description: ").append(getDescription()).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 (getSchemaS3Location() != null) sb.append("SchemaS3Location: ").append(getSchemaS3Location()).append(","); if (getSnapshotS3Location() != null) sb.append("SnapshotS3Location: ").append(getSnapshotS3Location()).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 StartSimulationRequest == false) return false; StartSimulationRequest other = (StartSimulationRequest) obj; if (other.getClientToken() == null ^ this.getClientToken() == null) return false; if (other.getClientToken() != null && other.getClientToken().equals(this.getClientToken()) == 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.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.getSchemaS3Location() == null ^ this.getSchemaS3Location() == null) return false; if (other.getSchemaS3Location() != null && other.getSchemaS3Location().equals(this.getSchemaS3Location()) == false) return false; if (other.getSnapshotS3Location() == null ^ this.getSnapshotS3Location() == null) return false; if (other.getSnapshotS3Location() != null && other.getSnapshotS3Location().equals(this.getSnapshotS3Location()) == 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 + ((getClientToken() == null) ? 0 : getClientToken().hashCode()); hashCode = prime * hashCode + ((getDescription() == null) ? 0 : getDescription().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 + ((getSchemaS3Location() == null) ? 0 : getSchemaS3Location().hashCode()); hashCode = prime * hashCode + ((getSnapshotS3Location() == null) ? 0 : getSnapshotS3Location().hashCode()); hashCode = prime * hashCode + ((getTags() == null) ? 0 : getTags().hashCode()); return hashCode; } @Override public StartSimulationRequest clone() { return (StartSimulationRequest) super.clone(); } }