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

Class CreateWorldExportJobRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.robomaker.model.RoboMakerRequest

software.amazon.awssdk.services.robomaker.model.CreateWorldExportJobRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateWorldExportJobRequest.Builder,CreateWorldExportJobRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateWorldExportJobRequest.Builder

Method Summary

Modifier and Type	Method	Description
static CreateWorldExportJobRequest.Builder	builder()
String	clientRequestToken()	Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
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.
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 CreateWorldExportJobRequest.Builder>	serializableBuilderClass()
Map<String,String>	tags()	A map that contains tag keys and tag values that are attached to the world export job.
CreateWorldExportJobRequest.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 export.

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

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

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

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 CreateWorldExportJobRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateWorldExportJobRequest.Builder,CreateWorldExportJobRequest>

Specified by:

toBuilder in class RoboMakerRequest

builder

public static CreateWorldExportJobRequest.Builder builder()

serializableBuilderClass

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