DescribeWorldGenerationJobResult (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceResult<ResponseMetadata>
- - com.amazonaws.services.robomaker.model.DescribeWorldGenerationJobResult

All Implemented Interfaces:: Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DescribeWorldGenerationJobResult
extends AmazonWebServiceResult<ResponseMetadata>
implements Serializable, Cloneable

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

DescribeWorldGenerationJobResult()

Constructors
Constructor and Description
`DescribeWorldGenerationJobResult()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DescribeWorldGenerationJobResult`	`addTagsEntry(String key, String value)` Add a single Tags entry
`DescribeWorldGenerationJobResult`	`addWorldTagsEntry(String key, String value)` Add a single WorldTags entry
`DescribeWorldGenerationJobResult`	`clearTagsEntries()` Removes all the entries added into Tags.
`DescribeWorldGenerationJobResult`	`clearWorldTagsEntries()` Removes all the entries added into WorldTags.
`DescribeWorldGenerationJobResult`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getArn()` The Amazon Resource Name (ARN) of the world generation job.
`String`	`getClientRequestToken()` Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
`Date`	`getCreatedAt()` The time, in milliseconds since the epoch, when the world generation job was created.
`String`	`getFailureCode()` The failure code of the world generation job if it failed:
`String`	`getFailureReason()` The reason why the world generation job failed.
`FinishedWorldsSummary`	`getFinishedWorldsSummary()` Summary information about finished worlds.
`String`	`getStatus()` The status of the world generation job:
`Map<String,String>`	`getTags()` A map that contains tag keys and tag values that are attached to the world generation job.
`String`	`getTemplate()` The Amazon Resource Name (arn) of the world template.
`WorldCount`	`getWorldCount()` Information about the world count.
`Map<String,String>`	`getWorldTags()` A map that contains tag keys and tag values that are attached to the generated worlds.
`int`	`hashCode()`
`void`	`setArn(String arn)` The Amazon Resource Name (ARN) of the world generation job.
`void`	`setClientRequestToken(String clientRequestToken)` Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
`void`	`setCreatedAt(Date createdAt)` The time, in milliseconds since the epoch, when the world generation job was created.
`void`	`setFailureCode(String failureCode)` The failure code of the world generation job if it failed:
`void`	`setFailureReason(String failureReason)` The reason why the world generation job failed.
`void`	`setFinishedWorldsSummary(FinishedWorldsSummary finishedWorldsSummary)` Summary information about finished worlds.
`void`	`setStatus(String status)` The status of the world generation job:
`void`	`setTags(Map<String,String> tags)` A map that contains tag keys and tag values that are attached to the world generation job.
`void`	`setTemplate(String template)` The Amazon Resource Name (arn) of the world template.
`void`	`setWorldCount(WorldCount worldCount)` Information about the world count.
`void`	`setWorldTags(Map<String,String> worldTags)` A map that contains tag keys and tag values that are attached to the generated worlds.
`String`	`toString()` Returns a string representation of this object.
`DescribeWorldGenerationJobResult`	`withArn(String arn)` The Amazon Resource Name (ARN) of the world generation job.
`DescribeWorldGenerationJobResult`	`withClientRequestToken(String clientRequestToken)` Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
`DescribeWorldGenerationJobResult`	`withCreatedAt(Date createdAt)` The time, in milliseconds since the epoch, when the world generation job was created.
`DescribeWorldGenerationJobResult`	`withFailureCode(String failureCode)` The failure code of the world generation job if it failed:
`DescribeWorldGenerationJobResult`	`withFailureCode(WorldGenerationJobErrorCode failureCode)` The failure code of the world generation job if it failed:
`DescribeWorldGenerationJobResult`	`withFailureReason(String failureReason)` The reason why the world generation job failed.
`DescribeWorldGenerationJobResult`	`withFinishedWorldsSummary(FinishedWorldsSummary finishedWorldsSummary)` Summary information about finished worlds.
`DescribeWorldGenerationJobResult`	`withStatus(String status)` The status of the world generation job:
`DescribeWorldGenerationJobResult`	`withStatus(WorldGenerationJobStatus status)` The status of the world generation job:
`DescribeWorldGenerationJobResult`	`withTags(Map<String,String> tags)` A map that contains tag keys and tag values that are attached to the world generation job.
`DescribeWorldGenerationJobResult`	`withTemplate(String template)` The Amazon Resource Name (arn) of the world template.
`DescribeWorldGenerationJobResult`	`withWorldCount(WorldCount worldCount)` Information about the world count.
`DescribeWorldGenerationJobResult`	`withWorldTags(Map<String,String> worldTags)` A map that contains tag keys and tag values that are attached to the generated worlds.

Methods inherited from class com.amazonaws.AmazonWebServiceResult
getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata

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

- Constructor Detail
  - DescribeWorldGenerationJobResult
```
public DescribeWorldGenerationJobResult()
```
- Method Detail
  - setArn
```
public void setArn(String arn)
```
    The Amazon Resource Name (ARN) of the world generation job.
    
    Parameters:
    
    arn - The Amazon Resource Name (ARN) of the world generation job.
  - getArn
```
public String getArn()
```
    The Amazon Resource Name (ARN) of the world generation job.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the world generation job.
  - withArn
```
public DescribeWorldGenerationJobResult withArn(String arn)
```
    The Amazon Resource Name (ARN) of the world generation job.
    
    Parameters:
    
    arn - The Amazon Resource Name (ARN) of the world generation job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStatus
```
public void setStatus(String 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.
    
    Parameters:
    
    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.
    
    See Also:
    
    WorldGenerationJobStatus
  - getStatus
```
public String getStatus()
```
    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.
    
    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
  - withStatus
```
public DescribeWorldGenerationJobResult withStatus(String 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    WorldGenerationJobStatus
  - withStatus
```
public DescribeWorldGenerationJobResult withStatus(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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    WorldGenerationJobStatus
  - setCreatedAt
```
public void setCreatedAt(Date createdAt)
```
    The time, in milliseconds since the epoch, when the world generation job was created.
    
    Parameters:
    
    createdAt - The time, in milliseconds since the epoch, when the world generation job was created.
  - getCreatedAt
```
public Date getCreatedAt()
```
    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.
  - withCreatedAt
```
public DescribeWorldGenerationJobResult withCreatedAt(Date createdAt)
```
    The time, in milliseconds since the epoch, when the world generation job was created.
    
    Parameters:
    
    createdAt - The time, in milliseconds since the epoch, when the world generation job was created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setFailureCode
```
public void setFailureCode(String 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.
    
    Parameters:
    
    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.
    
    See Also:
    
    WorldGenerationJobErrorCode
  - getFailureCode
```
public String getFailureCode()
```
    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.
    
    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
  - withFailureCode
```
public DescribeWorldGenerationJobResult withFailureCode(String 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    WorldGenerationJobErrorCode
  - withFailureCode
```
public DescribeWorldGenerationJobResult withFailureCode(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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    WorldGenerationJobErrorCode
  - setFailureReason
```
public void setFailureReason(String failureReason)
```
    The reason why the world generation job failed.
    
    Parameters:
    
    failureReason - The reason why the world generation job failed.
  - getFailureReason
```
public String getFailureReason()
```
    The reason why the world generation job failed.
    
    Returns:
    
    The reason why the world generation job failed.
  - withFailureReason
```
public DescribeWorldGenerationJobResult withFailureReason(String failureReason)
```
    The reason why the world generation job failed.
    
    Parameters:
    
    failureReason - The reason why the world generation job failed.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setClientRequestToken
```
public void setClientRequestToken(String clientRequestToken)
```
    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
    
    Parameters:
    
    clientRequestToken - Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
  - getClientRequestToken
```
public String getClientRequestToken()
```
    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.
  - withClientRequestToken
```
public DescribeWorldGenerationJobResult withClientRequestToken(String clientRequestToken)
```
    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
    
    Parameters:
    
    clientRequestToken - Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTemplate
```
public void setTemplate(String template)
```
    The Amazon Resource Name (arn) of the world template.
    
    Parameters:
    
    template - The Amazon Resource Name (arn) of the world template.
  - getTemplate
```
public String getTemplate()
```
    The Amazon Resource Name (arn) of the world template.
    
    Returns:
    
    The Amazon Resource Name (arn) of the world template.
  - withTemplate
```
public DescribeWorldGenerationJobResult withTemplate(String template)
```
    The Amazon Resource Name (arn) of the world template.
    
    Parameters:
    
    template - The Amazon Resource Name (arn) of the world template.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setWorldCount
```
public void setWorldCount(WorldCount worldCount)
```
    Information about the world count.
    
    Parameters:
    
    worldCount - Information about the world count.
  - getWorldCount
```
public WorldCount getWorldCount()
```
    Information about the world count.
    
    Returns:
    
    Information about the world count.
  - withWorldCount
```
public DescribeWorldGenerationJobResult withWorldCount(WorldCount worldCount)
```
    Information about the world count.
    
    Parameters:
    
    worldCount - Information about the world count.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setFinishedWorldsSummary
```
public void setFinishedWorldsSummary(FinishedWorldsSummary finishedWorldsSummary)
```
    Summary information about finished worlds.
    
    Parameters:
    
    finishedWorldsSummary - Summary information about finished worlds.
  - getFinishedWorldsSummary
```
public FinishedWorldsSummary getFinishedWorldsSummary()
```
    Summary information about finished worlds.
    
    Returns:
    
    Summary information about finished worlds.
  - withFinishedWorldsSummary
```
public DescribeWorldGenerationJobResult withFinishedWorldsSummary(FinishedWorldsSummary finishedWorldsSummary)
```
    Summary information about finished worlds.
    
    Parameters:
    
    finishedWorldsSummary - Summary information about finished worlds.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getTags
```
public Map<String,String> getTags()
```
    A map that contains tag keys and tag values that are attached to the world generation job.
    
    Returns:
    
    A map that contains tag keys and tag values that are attached to the world generation job.
  - setTags
```
public void setTags(Map<String,String> tags)
```
    A map that contains tag keys and tag values that are attached to the world generation job.
    
    Parameters:
    
    tags - A map that contains tag keys and tag values that are attached to the world generation job.
  - withTags
```
public DescribeWorldGenerationJobResult withTags(Map<String,String> tags)
```
    A map that contains tag keys and tag values that are attached to the world generation job.
    
    Parameters:
    
    tags - A map that contains tag keys and tag values that are attached to the world generation job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addTagsEntry
```
public DescribeWorldGenerationJobResult addTagsEntry(String key,
                                                     String value)
```
    Add a single Tags entry
    
    See Also:
    
    withTags(java.util.Map<java.lang.String, java.lang.String>)
  - clearTagsEntries
```
public DescribeWorldGenerationJobResult clearTagsEntries()
```
    Removes all the entries added into Tags.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getWorldTags
```
public Map<String,String> getWorldTags()
```
    A map that contains tag keys and tag values that are attached to the generated worlds.
    
    Returns:
    
    A map that contains tag keys and tag values that are attached to the generated worlds.
  - setWorldTags
```
public void setWorldTags(Map<String,String> worldTags)
```
    A map that contains tag keys and tag values that are attached to the generated worlds.
    
    Parameters:
    
    worldTags - A map that contains tag keys and tag values that are attached to the generated worlds.
  - withWorldTags
```
public DescribeWorldGenerationJobResult withWorldTags(Map<String,String> worldTags)
```
    A map that contains tag keys and tag values that are attached to the generated worlds.
    
    Parameters:
    
    worldTags - A map that contains tag keys and tag values that are attached to the generated worlds.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addWorldTagsEntry
```
public DescribeWorldGenerationJobResult addWorldTagsEntry(String key,
                                                          String value)
```
    Add a single WorldTags entry
    
    See Also:
    
    withWorldTags(java.util.Map<java.lang.String, java.lang.String>)
  - clearWorldTagsEntries
```
public DescribeWorldGenerationJobResult clearWorldTagsEntries()
```
    Removes all the entries added into WorldTags.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public DescribeWorldGenerationJobResult clone()
```
    Overrides:
    
    clone in class Object

AWS SDK for Java 1.x API Reference - 1.12.779

Class DescribeWorldGenerationJobResult

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceResult

Methods inherited from class java.lang.Object

Constructor Detail

DescribeWorldGenerationJobResult

Method Detail

setArn

getArn

withArn

setStatus

getStatus

withStatus

withStatus

setCreatedAt

getCreatedAt

withCreatedAt

setFailureCode

getFailureCode

withFailureCode

withFailureCode

setFailureReason

getFailureReason

withFailureReason

setClientRequestToken

getClientRequestToken

withClientRequestToken

setTemplate

getTemplate

withTemplate

setWorldCount

getWorldCount

withWorldCount

setFinishedWorldsSummary

getFinishedWorldsSummary

withFinishedWorldsSummary

getTags

setTags

withTags

addTagsEntry

clearTagsEntries

getWorldTags

setWorldTags

withWorldTags

addWorldTagsEntry

clearWorldTagsEntries

toString

equals

hashCode

clone