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>

  • Method Details

    • 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:

    • 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:

    • 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:

    • 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:

    • 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()
      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<CreateDeploymentJobResponse.Builder,CreateDeploymentJobResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • 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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      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 final 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.