Class WorldExportJobSummary
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<WorldExportJobSummary.Builder,
WorldExportJobSummary>
Information about a world export job.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
arn()
The Amazon Resource Name (ARN) of the world export job.builder()
final Instant
The time, in milliseconds since the epoch, when the world export job was created.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the Worlds property.final OutputLocation
Returns the value of the OutputLocation property for this object.static Class
<? extends WorldExportJobSummary.Builder> final WorldExportJobStatus
status()
The status of the world export job.final String
The status of the world export job.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.worlds()
A list of worlds.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
arn
The Amazon Resource Name (ARN) of the world export job.
- Returns:
- The Amazon Resource Name (ARN) of the world export job.
-
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 returnWorldExportJobStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- 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:
-
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 returnWorldExportJobStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- 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:
-
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.
-
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 theisEmpty()
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
A list of worlds.
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 worlds.
-
outputLocation
Returns the value of the OutputLocation property for this object.- Returns:
- The value of the OutputLocation property for this object.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<WorldExportJobSummary.Builder,
WorldExportJobSummary> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-