software.amazon.awssdk.services.robomaker.model

Class CreateWorldExportJobResponse

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateWorldExportJobResponse.Builder,CreateWorldExportJobResponse>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateWorldExportJobResponse.Builder

Method Summary

Modifier and Type	Method and Description
String	arn() The Amazon Resource Name (ARN) of the world export job.
static CreateWorldExportJobResponse.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 export job was created.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
WorldExportJobErrorCode	failureCode() The failure code of the world export job if it failed:
String	failureCodeAsString() The failure code of the world export job if it failed:
<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).
String	iamRole() The IAM role that the world export process uses to access the Amazon S3 bucket and put the export.
OutputLocation	outputLocation() Returns the value of the OutputLocation property for this object.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateWorldExportJobResponse.Builder>	serializableBuilderClass()
WorldExportJobStatus	status() The status of the world export job.
String	statusAsString() The status of the world export job.
Map<String,String>	tags() A map that contains tag keys and tag values that are attached to the world export job.
CreateWorldExportJobResponse.Builder	toBuilder()
String	toString() Returns a string representation of this object.

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 export job.

Returns:

The Amazon Resource Name (ARN) of the world export job.

status

public WorldExportJobStatus status()

The status of the world export job.

Pending

The world export job request is pending.

Running

The world export job is running.

Completed

The world export job completed.

Failed

The world export job failed. See failureCode for more information.

Canceled

The world export job was cancelled.

Canceling

The world export job is being cancelled.

If the service returns an enum value that is not available in the current SDK version, status will return WorldExportJobStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

The status of the world export job.

Pending

The world export job request is pending.

Running

The world export job is running.

Completed

The world export job completed.

Failed

The world export job failed. See failureCode for more information.

Canceled

The world export job was cancelled.

Canceling

The world export job is being cancelled.

See Also:

WorldExportJobStatus

statusAsString

public String statusAsString()

The status of the world export job.

Pending

The world export job request is pending.

Running

The world export job is running.

Completed

The world export job completed.

Failed

The world export job failed. See failureCode for more information.

Canceled

The world export job was cancelled.

Canceling

The world export job is being cancelled.

If the service returns an enum value that is not available in the current SDK version, status will return WorldExportJobStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

The status of the world export job.

Pending

The world export job request is pending.

Running

The world export job is running.

Completed

The world export job completed.

Failed

The world export job failed. See failureCode for more information.

Canceled

The world export job was cancelled.

Canceling

The world export job is being cancelled.

See Also:

WorldExportJobStatus

createdAt

public Instant createdAt()

The time, in milliseconds since the epoch, when the world export job was created.

Returns:

The time, in milliseconds since the epoch, when the world export job was created.

failureCode

public WorldExportJobErrorCode failureCode()

The failure code of the world export 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 WorldExportJobErrorCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from failureCodeAsString().

Returns:

The failure code of the world export 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:

WorldExportJobErrorCode

failureCodeAsString

public String failureCodeAsString()

The failure code of the world export 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 WorldExportJobErrorCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from failureCodeAsString().

Returns:

The failure code of the world export 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:

WorldExportJobErrorCode

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.

outputLocation

public OutputLocation outputLocation()

Returns the value of the OutputLocation property for this object.

Returns:

The value of the OutputLocation property for this object.

iamRole

public String iamRole()

The IAM role that the world export process uses to access the Amazon S3 bucket and put the export.

Returns:

The IAM role that the world export process uses to access the Amazon S3 bucket and put the export.

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 export 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 export job.

toBuilder

public CreateWorldExportJobResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateWorldExportJobResponse.Builder,CreateWorldExportJobResponse>

Overrides:

toBuilder in class AwsResponse

builder

public static CreateWorldExportJobResponse.Builder builder()

serializableBuilderClass

public static Class<? extends CreateWorldExportJobResponse.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