StartSimulationRequest (AWS Java SDK :: Services :: Sim Space Weaver 2.20.147 API)

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.simspaceweaver.model.SimSpaceWeaverRequest
    - - software.amazon.awssdk.services.simspaceweaver.model.StartSimulationRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<StartSimulationRequest.Builder,StartSimulationRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class StartSimulationRequest
extends SimSpaceWeaverRequest
implements ToCopyableBuilder<StartSimulationRequest.Builder,StartSimulationRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface StartSimulationRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`StartSimulationRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static StartSimulationRequest.Builder`	`builder()`
`String`	`clientToken()` A value that you provide to ensure that repeated calls to this API operation using the same parameters complete only once.
`String`	`description()` The description of the simulation.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasTags()` For responses, this returns true if the service returned a value for the Tags property.
`String`	`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).
`String`	`name()` The name of the simulation.
`String`	`roleArn()` The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that the simulation assumes to perform actions.
`S3Location`	`schemaS3Location()` The location of the simulation schema in Amazon Simple Storage Service (Amazon S3).
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends StartSimulationRequest.Builder>`	`serializableBuilderClass()`
`S3Location`	`snapshotS3Location()` The location of the snapshot .zip file in Amazon Simple Storage Service (Amazon S3).
`Map<String,String>`	`tags()` A list of tags for the simulation.
`StartSimulationRequest.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - clientToken
```
public final String 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.
    
    Returns:
    
    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.
  - description
```
public final String description()
```
    The description of the simulation.
    
    Returns:
    
    The description of the simulation.
  - maximumDuration
```
public final String 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.
    
    Returns:
    
    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.
  - name
```
public final String name()
```
    The name of the simulation.
    
    Returns:
    
    The name of the simulation.
  - roleArn
```
public final String 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.
    
    Returns:
    
    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.
  - schemaS3Location
```
public final S3Location 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.
    
    Returns:
    
    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.
  - snapshotS3Location
```
public final S3Location 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.
    
    Returns:
    
    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.
  - hasTags
```
public final boolean hasTags()
```
    For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - tags
```
public final Map<String,String> 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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.
    
    Returns:
    
    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.
  - toBuilder
```
public StartSimulationRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<StartSimulationRequest.Builder,StartSimulationRequest>
    
    Specified by:
    
    toBuilder in class SimSpaceWeaverRequest
  - builder
```
public static StartSimulationRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends StartSimulationRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String toString()
```
    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.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class StartSimulationRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

clientToken

description

maximumDuration

name

roleArn

schemaS3Location

snapshotS3Location

hasTags

tags

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields