DescribeWorldGenerationJobResponse (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.core.SdkResponse
- - software.amazon.awssdk.awscore.AwsResponse
  - - software.amazon.awssdk.services.robomaker.model.RoboMakerResponse
    - - software.amazon.awssdk.services.robomaker.model.DescribeWorldGenerationJobResponse

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

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface DescribeWorldGenerationJobResponse.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`arn()` The Amazon Resource Name (ARN) of the world generation job.
`static DescribeWorldGenerationJobResponse.Builder`	`builder()`
`String`	`clientRequestToken()` Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
`Instant`	`createdAt()` The time, in milliseconds since the epoch, when the world generation job was created.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`WorldGenerationJobErrorCode`	`failureCode()` The failure code of the world generation job if it failed:
`String`	`failureCodeAsString()` The failure code of the world generation job if it failed:
`String`	`failureReason()` The reason why the world generation job failed.
`FinishedWorldsSummary`	`finishedWorldsSummary()` Summary information about finished worlds.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasTags()` Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends DescribeWorldGenerationJobResponse.Builder>`	`serializableBuilderClass()`
`WorldGenerationJobStatus`	`status()` The status of the world generation job:
`String`	`statusAsString()` The status of the world generation job:
`Map<String,String>`	`tags()` A map that contains tag keys and tag values that are attached to the world generation job.
`String`	`template()` The Amazon Resource Name (arn) of the world template.
`DescribeWorldGenerationJobResponse.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`WorldCount`	`worldCount()` Information about the world count.

Methods inherited from class software.amazon.awssdk.services.robomaker.model.RoboMakerResponse
responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse

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
  - arn
```
public String arn()
```
    The Amazon Resource Name (ARN) of the world generation job.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the world generation job.
  - status
```
public WorldGenerationJobStatus status()
```
    The status of the world generation job:
    
    Pending
    
    The world generation job request is pending.
    
    Running
    
    The world generation job is running.
    
    Completed
    
    The world generation job completed.
    
    Failed
    
    The world generation job failed. See failureCode for more information.
    
    PartialFailed
    
    Some worlds did not generate.
    
    Canceled
    
    The world generation job was cancelled.
    
    Canceling
    
    The world generation job is being cancelled.
    
    If the service returns an enum value that is not available in the current SDK version, status will return WorldGenerationJobStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    
    Returns:
    
    The status of the world generation job:
    
    Pending
    
    The world generation job request is pending.
    
    Running
    
    The world generation job is running.
    
    Completed
    
    The world generation job completed.
    
    Failed
    
    The world generation job failed. See failureCode for more information.
    
    PartialFailed
    
    Some worlds did not generate.
    
    Canceled
    
    The world generation job was cancelled.
    
    Canceling
    
    The world generation job is being cancelled.
    
    See Also:
    
    WorldGenerationJobStatus
  - statusAsString
```
public String statusAsString()
```
    The status of the world generation job:
    
    Pending
    
    The world generation job request is pending.
    
    Running
    
    The world generation job is running.
    
    Completed
    
    The world generation job completed.
    
    Failed
    
    The world generation job failed. See failureCode for more information.
    
    PartialFailed
    
    Some worlds did not generate.
    
    Canceled
    
    The world generation job was cancelled.
    
    Canceling
    
    The world generation job is being cancelled.
    
    If the service returns an enum value that is not available in the current SDK version, status will return WorldGenerationJobStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    
    Returns:
    
    The status of the world generation job:
    
    Pending
    
    The world generation job request is pending.
    
    Running
    
    The world generation job is running.
    
    Completed
    
    The world generation job completed.
    
    Failed
    
    The world generation job failed. See failureCode for more information.
    
    PartialFailed
    
    Some worlds did not generate.
    
    Canceled
    
    The world generation job was cancelled.
    
    Canceling
    
    The world generation job is being cancelled.
    
    See Also:
    
    WorldGenerationJobStatus
  - createdAt
```
public Instant createdAt()
```
    The time, in milliseconds since the epoch, when the world generation job was created.
    
    Returns:
    
    The time, in milliseconds since the epoch, when the world generation job was created.
  - failureCode
```
public WorldGenerationJobErrorCode failureCode()
```
    The failure code of the world generation 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.
    
    If the service returns an enum value that is not available in the current SDK version, failureCode will return WorldGenerationJobErrorCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from failureCodeAsString().
    
    Returns:
    
    The failure code of the world generation 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 Also:
    
    WorldGenerationJobErrorCode
  - failureCodeAsString
```
public String failureCodeAsString()
```
    The failure code of the world generation 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.
    
    If the service returns an enum value that is not available in the current SDK version, failureCode will return WorldGenerationJobErrorCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from failureCodeAsString().
    
    Returns:
    
    The failure code of the world generation 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 Also:
    
    WorldGenerationJobErrorCode
  - failureReason
```
public String failureReason()
```
    The reason why the world generation job failed.
    
    Returns:
    
    The reason why the world generation job failed.
  - clientRequestToken
```
public String clientRequestToken()
```
    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
    
    Returns:
    
    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
  - template
```
public String template()
```
    The Amazon Resource Name (arn) of the world template.
    
    Returns:
    
    The Amazon Resource Name (arn) of the world template.
  - worldCount
```
public WorldCount worldCount()
```
    Information about the world count.
    
    Returns:
    
    Information about the world count.
  - finishedWorldsSummary
```
public FinishedWorldsSummary finishedWorldsSummary()
```
    Summary information about finished worlds.
    
    Returns:
    
    Summary information about finished worlds.
  - hasTags
```
public boolean hasTags()
```
    Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - tags
```
public Map<String,String> tags()
```
    A map that contains tag keys and tag values that are attached to the world generation job.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasTags() to see if a value was sent in this field.
    
    Returns:
    
    A map that contains tag keys and tag values that are attached to the world generation job.
  - toBuilder
```
public DescribeWorldGenerationJobResponse.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<DescribeWorldGenerationJobResponse.Builder,DescribeWorldGenerationJobResponse>
    
    Overrides:
    
    toBuilder in class AwsResponse
  - builder
```
public static DescribeWorldGenerationJobResponse.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends DescribeWorldGenerationJobResponse.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class AwsResponse
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsResponse
  - equalsBySdkFields
```
public boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkResponse
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class DescribeWorldGenerationJobResponse

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.services.robomaker.model.RoboMakerResponse

Methods inherited from class software.amazon.awssdk.core.SdkResponse

Methods inherited from class java.lang.Object

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

Method Detail

arn

status

statusAsString

createdAt

failureCode

failureCodeAsString

failureReason

clientRequestToken

template

worldCount

finishedWorldsSummary

hasTags

tags

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields