Package software.amazon.awssdk.services.robomaker.model

Class DescribeWorldExportJobResponse

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeWorldExportJobResponse.Builder,DescribeWorldExportJobResponse>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribeWorldExportJobResponse.Builder

Method Summary

Modifier and Type	Method	Description
String	arn()	The Amazon Resource Name (ARN) of the world export job.
static DescribeWorldExportJobResponse.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:
String	failureReason()	The reason why the world export job failed.
<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.
boolean	hasWorlds()	For responses, this returns true if the service returned a value for the Worlds property.
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 DescribeWorldExportJobResponse.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.
DescribeWorldExportJobResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
List<String>	worlds()	A list of Amazon Resource Names (arns) that correspond to worlds to be exported.

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 final 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 final 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 and failureReason 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 and failureReason for more information.

Canceled

The world export job was cancelled.

Canceling

The world export job is being cancelled.

See Also:

WorldExportJobStatus

statusAsString

public final 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 and failureReason 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 and failureReason for more information.

Canceled

The world export job was cancelled.

Canceling

The world export job is being cancelled.

See Also:

WorldExportJobStatus

createdAt

public final 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 final 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 final 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

failureReason

public final String failureReason()

The reason why the world export job failed.

Returns:

The reason why the world export job failed.

clientRequestToken

public final 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.

hasWorlds

public final boolean hasWorlds()

For responses, this returns true if the service returned a value for the Worlds 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.

worlds

public final List<String> worlds()

A list of Amazon Resource Names (arns) that correspond to worlds to be exported.

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 hasWorlds() method.

Returns:

A list of Amazon Resource Names (arns) that correspond to worlds to be exported.

outputLocation

public final OutputLocation outputLocation()

Returns the value of the OutputLocation property for this object.

Returns:

The value of the OutputLocation property for this object.

iamRole

public final 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 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 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.

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 map that contains tag keys and tag values that are attached to the world export job.

toBuilder

public DescribeWorldExportJobResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeWorldExportJobResponse.Builder,DescribeWorldExportJobResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static DescribeWorldExportJobResponse.Builder builder()

serializableBuilderClass

public static Class<? extends DescribeWorldExportJobResponse.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

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 SdkResponse

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo