software.amazon.awssdk.services.sagemakergeospatial.model

Class StartEarthObservationJobResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.sagemakergeospatial.model.SageMakerGeospatialResponse

software.amazon.awssdk.services.sagemakergeospatial.model.StartEarthObservationJobResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<StartEarthObservationJobResponse.Builder,StartEarthObservationJobResponse>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	StartEarthObservationJobResponse.Builder

Method Summary

Modifier and Type	Method and Description
String	arn() The Amazon Resource Name (ARN) of the Earth Observation job.
static StartEarthObservationJobResponse.Builder	builder()
Instant	creationTime() The creation time.
Integer	durationInSeconds() The duration of the session, in seconds.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	executionRoleArn() The Amazon Resource Name (ARN) of the IAM role that you specified for the job.
<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.
InputConfigOutput	inputConfig() Input configuration information for the Earth Observation job.
JobConfigInput	jobConfig() An object containing information about the job configuration.
String	kmsKeyId() The Key Management Service key ID for server-side encryption.
String	name() The name of the Earth Observation job.
List<SdkField<?>>	sdkFields()
static Class<? extends StartEarthObservationJobResponse.Builder>	serializableBuilderClass()
EarthObservationJobStatus	status() The status of the Earth Observation job.
String	statusAsString() The status of the Earth Observation job.
Map<String,String>	tags() Each tag consists of a key and a value.
StartEarthObservationJobResponse.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.sagemakergeospatial.model.SageMakerGeospatialResponse

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 Earth Observation job.

Returns:

The Amazon Resource Name (ARN) of the Earth Observation job.

creationTime

public final Instant creationTime()

The creation time.

Returns:

The creation time.

durationInSeconds

public final Integer durationInSeconds()

The duration of the session, in seconds.

Returns:

The duration of the session, in seconds.

executionRoleArn

public final String executionRoleArn()

The Amazon Resource Name (ARN) of the IAM role that you specified for the job.

Returns:

The Amazon Resource Name (ARN) of the IAM role that you specified for the job.

inputConfig

public final InputConfigOutput inputConfig()

Input configuration information for the Earth Observation job.

Returns:

Input configuration information for the Earth Observation job.

jobConfig

public final JobConfigInput jobConfig()

An object containing information about the job configuration.

Returns:

An object containing information about the job configuration.

kmsKeyId

public final String kmsKeyId()

The Key Management Service key ID for server-side encryption.

Returns:

The Key Management Service key ID for server-side encryption.

name

public final String name()

The name of the Earth Observation job.

Returns:

The name of the Earth Observation job.

status

public final EarthObservationJobStatus status()

The status of the Earth Observation job.

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

Returns:

The status of the Earth Observation job.

See Also:

EarthObservationJobStatus

statusAsString

public final String statusAsString()

The status of the Earth Observation job.

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

Returns:

The status of the Earth Observation job.

See Also:

EarthObservationJobStatus

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()

Each tag consists of a key and a value.

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:

Each tag consists of a key and a value.

toBuilder

public StartEarthObservationJobResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<StartEarthObservationJobResponse.Builder,StartEarthObservationJobResponse>

Overrides:

toBuilder in class AwsResponse

builder

public static StartEarthObservationJobResponse.Builder builder()

serializableBuilderClass

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