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

Class CreateDeploymentJobResponse

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateDeploymentJobResponse.Builder,CreateDeploymentJobResponse>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateDeploymentJobResponse.Builder

Method Summary

Modifier and Type	Method	Description
String	arn()	The Amazon Resource Name (ARN) of the deployment job.
static CreateDeploymentJobResponse.Builder	builder()
Instant	createdAt()	The time, in milliseconds since the epoch, when the fleet was created.
List<DeploymentApplicationConfig>	deploymentApplicationConfigs()	The deployment application configuration.
DeploymentConfig	deploymentConfig()	The deployment configuration.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
DeploymentJobErrorCode	failureCode()	The failure code of the simulation job if it failed:
String	failureCodeAsString()	The failure code of the simulation job if it failed:
String	failureReason()	The failure reason of the deployment job if it failed.
String	fleet()	The target fleet for the deployment job.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasDeploymentApplicationConfigs()	For responses, this returns true if the service returned a value for the DeploymentApplicationConfigs property.
int	hashCode()
boolean	hasTags()	For responses, this returns true if the service returned a value for the Tags property.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateDeploymentJobResponse.Builder>	serializableBuilderClass()
DeploymentStatus	status()	The status of the deployment job.
String	statusAsString()	The status of the deployment job.
Map<String,String>	tags()	The list of all tags added to the deployment job.
CreateDeploymentJobResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

Returns:

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

fleet

public final String fleet()

The target fleet for the deployment job.

Returns:

The target fleet for the deployment job.

status

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

hasDeploymentApplicationConfigs

public final boolean hasDeploymentApplicationConfigs()

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

deploymentApplicationConfigs

public final List<DeploymentApplicationConfig> deploymentApplicationConfigs()

The deployment application configuration.

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

Returns:

The deployment application configuration.

failureReason

public final String failureReason()

The failure reason of the deployment job if it failed.

Returns:

The failure reason of the deployment job if it failed.

failureCode

public final DeploymentJobErrorCode failureCode()

The failure code of the simulation job if it failed:

BadPermissionError

AWS Greengrass requires a service-level role permission to access other services. The role must include the AWSGreengrassResourceAccessRolePolicy managed policy.

ExtractingBundleFailure

The robot application could not be extracted from the bundle.

FailureThresholdBreached

The percentage of robots that could not be updated exceeded the percentage set for the deployment.

GreengrassDeploymentFailed

The robot application could not be deployed to the robot.

GreengrassGroupVersionDoesNotExist

The AWS Greengrass group or version associated with a robot is missing.

InternalServerError

An internal error has occurred. Retry your request, but if the problem persists, contact us with details.

MissingRobotApplicationArchitecture

The robot application does not have a source that matches the architecture of the robot.

MissingRobotDeploymentResource

One or more of the resources specified for the robot application are missing. For example, does the robot application have the correct launch package and launch file?

PostLaunchFileFailure

The post-launch script failed.

PreLaunchFileFailure

The pre-launch script failed.

ResourceNotFound

One or more deployment resources are missing. For example, do robot application source bundles still exist?

RobotDeploymentNoResponse

There is no response from the robot. It might not be powered on or connected to the internet.

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 failure code of the simulation job if it failed:

BadPermissionError

AWS Greengrass requires a service-level role permission to access other services. The role must include the AWSGreengrassResourceAccessRolePolicy managed policy.

ExtractingBundleFailure

The robot application could not be extracted from the bundle.

FailureThresholdBreached

The percentage of robots that could not be updated exceeded the percentage set for the deployment.

GreengrassDeploymentFailed

The robot application could not be deployed to the robot.

GreengrassGroupVersionDoesNotExist

The AWS Greengrass group or version associated with a robot is missing.

InternalServerError

An internal error has occurred. Retry your request, but if the problem persists, contact us with details.

MissingRobotApplicationArchitecture

The robot application does not have a source that matches the architecture of the robot.

MissingRobotDeploymentResource

One or more of the resources specified for the robot application are missing. For example, does the robot application have the correct launch package and launch file?

PostLaunchFileFailure

The post-launch script failed.

PreLaunchFileFailure

The pre-launch script failed.

ResourceNotFound

One or more deployment resources are missing. For example, do robot application source bundles still exist?

RobotDeploymentNoResponse

There is no response from the robot. It might not be powered on or connected to the internet.

See Also:

DeploymentJobErrorCode

failureCodeAsString

public final String failureCodeAsString()

The failure code of the simulation job if it failed:

BadPermissionError

AWS Greengrass requires a service-level role permission to access other services. The role must include the AWSGreengrassResourceAccessRolePolicy managed policy.

ExtractingBundleFailure

The robot application could not be extracted from the bundle.

FailureThresholdBreached

The percentage of robots that could not be updated exceeded the percentage set for the deployment.

GreengrassDeploymentFailed

The robot application could not be deployed to the robot.

GreengrassGroupVersionDoesNotExist

The AWS Greengrass group or version associated with a robot is missing.

InternalServerError

An internal error has occurred. Retry your request, but if the problem persists, contact us with details.

MissingRobotApplicationArchitecture

The robot application does not have a source that matches the architecture of the robot.

MissingRobotDeploymentResource

One or more of the resources specified for the robot application are missing. For example, does the robot application have the correct launch package and launch file?

PostLaunchFileFailure

The post-launch script failed.

PreLaunchFileFailure

The pre-launch script failed.

ResourceNotFound

One or more deployment resources are missing. For example, do robot application source bundles still exist?

RobotDeploymentNoResponse

There is no response from the robot. It might not be powered on or connected to the internet.

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 failure code of the simulation job if it failed:

BadPermissionError

AWS Greengrass requires a service-level role permission to access other services. The role must include the AWSGreengrassResourceAccessRolePolicy managed policy.

ExtractingBundleFailure

The robot application could not be extracted from the bundle.

FailureThresholdBreached

The percentage of robots that could not be updated exceeded the percentage set for the deployment.

GreengrassDeploymentFailed

The robot application could not be deployed to the robot.

GreengrassGroupVersionDoesNotExist

The AWS Greengrass group or version associated with a robot is missing.

InternalServerError

An internal error has occurred. Retry your request, but if the problem persists, contact us with details.

MissingRobotApplicationArchitecture

The robot application does not have a source that matches the architecture of the robot.

MissingRobotDeploymentResource

One or more of the resources specified for the robot application are missing. For example, does the robot application have the correct launch package and launch file?

PostLaunchFileFailure

The post-launch script failed.

PreLaunchFileFailure

The pre-launch script failed.

ResourceNotFound

One or more deployment resources are missing. For example, do robot application source bundles still exist?

RobotDeploymentNoResponse

There is no response from the robot. It might not be powered on or connected to the internet.

See Also:

DeploymentJobErrorCode

createdAt

public final Instant createdAt()

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

Returns:

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

deploymentConfig

public final DeploymentConfig deploymentConfig()

The deployment configuration.

Returns:

The deployment configuration.

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

The list of all tags added to the deployment 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:

The list of all tags added to the deployment job.

toBuilder

public CreateDeploymentJobResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateDeploymentJobResponse.Builder,CreateDeploymentJobResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static CreateDeploymentJobResponse.Builder builder()

serializableBuilderClass

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