software.amazon.awssdk.services.robomaker.model

Class DescribeDeploymentJobResponse

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeDeploymentJobResponse.Builder,DescribeDeploymentJobResponse>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribeDeploymentJobResponse.Builder

Method Summary

Modifier and Type	Method and Description
String	arn() The Amazon Resource Name (ARN) of the deployment job.
static DescribeDeploymentJobResponse.Builder	builder()
Instant	createdAt() The time, in milliseconds since the epoch, when the deployment job was created.
List<DeploymentApplicationConfig>	deploymentApplicationConfigs() The deployment application configuration.
DeploymentConfig	deploymentConfig() The deployment configuration.
boolean	equals(Object obj)
DeploymentJobErrorCode	failureCode() The deployment job failure code.
String	failureCodeAsString() The deployment job failure code.
String	failureReason() A short description of the reason why the deployment job failed.
String	fleet() The Amazon Resource Name (ARN) of the fleet.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkResponse.
int	hashCode()
List<RobotDeployment>	robotDeploymentSummary() A list of robot deployment summaries.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeDeploymentJobResponse.Builder>	serializableBuilderClass()
DeploymentStatus	status() The status of the deployment job.
String	statusAsString() The status of the deployment job.
DescribeDeploymentJobResponse.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

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

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

Returns:

The Amazon Resource Name (ARN) of the deployment job.

fleet

public String fleet()

The Amazon Resource Name (ARN) of the fleet.

Returns:

The Amazon Resource Name (ARN) of the fleet.

status

public DeploymentStatus status()

The status of the deployment job.

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

Returns:

The status of the deployment job.

See Also:

DeploymentStatus

statusAsString

public String statusAsString()

The status of the deployment job.

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

Returns:

The status of the deployment job.

See Also:

DeploymentStatus

deploymentConfig

public DeploymentConfig deploymentConfig()

The deployment configuration.

Returns:

The deployment configuration.

deploymentApplicationConfigs

public List<DeploymentApplicationConfig> deploymentApplicationConfigs()

The deployment application configuration.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

The deployment application configuration.

failureReason

public String failureReason()

A short description of the reason why the deployment job failed.

Returns:

A short description of the reason why the deployment job failed.

failureCode

public DeploymentJobErrorCode failureCode()

The deployment job failure code.

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

Returns:

The deployment job failure code.

See Also:

DeploymentJobErrorCode

failureCodeAsString

public String failureCodeAsString()

The deployment job failure code.

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

Returns:

The deployment job failure code.

See Also:

DeploymentJobErrorCode

createdAt

public Instant createdAt()

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

Returns:

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

robotDeploymentSummary

public List<RobotDeployment> robotDeploymentSummary()

A list of robot deployment summaries.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

A list of robot deployment summaries.

toBuilder

public DescribeDeploymentJobResponse.Builder 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 interface ToCopyableBuilder<DescribeDeploymentJobResponse.Builder,DescribeDeploymentJobResponse>

Specified by:

toBuilder in class AwsResponse

Returns:

a builder for type T

builder

public static DescribeDeploymentJobResponse.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Description copied from class: SdkResponse

Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkResponse

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.