libZSservicesZSamazonka-robomakerZSamazonka-robomaker
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.RobOMaker.Types.ProgressDetail

Description

 
Synopsis

Documentation

data ProgressDetail Source #

Information about the progress of a deployment job.

See: newProgressDetail smart constructor.

Constructors

ProgressDetail' 

Fields

  • currentProgress :: Maybe RobotDeploymentStep

    The current progress status.

    Validating
    Validating the deployment.
    DownloadingExtracting
    Downloading and extracting the bundle on the robot.
    ExecutingPreLaunch
    Executing pre-launch script(s) if provided.
    Launching
    Launching the robot application.
    ExecutingPostLaunch
    Executing post-launch script(s) if provided.
    Finished
    Deployment is complete.
  • estimatedTimeRemainingSeconds :: Maybe Int

    Estimated amount of time in seconds remaining in the step. This currently only applies to the Downloading/Extracting step of the deployment. It is empty for other steps.

  • targetResource :: Maybe Text

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

  • percentDone :: Maybe Double

    Precentage of the step that is done. This currently only applies to the Downloading/Extracting step of the deployment. It is empty for other steps.

Instances

Instances details
Eq ProgressDetail Source # 
Instance details

Defined in Amazonka.RobOMaker.Types.ProgressDetail

Read ProgressDetail Source # 
Instance details

Defined in Amazonka.RobOMaker.Types.ProgressDetail

Show ProgressDetail Source # 
Instance details

Defined in Amazonka.RobOMaker.Types.ProgressDetail

Generic ProgressDetail Source # 
Instance details

Defined in Amazonka.RobOMaker.Types.ProgressDetail

Associated Types

type Rep ProgressDetail :: Type -> Type #

NFData ProgressDetail Source # 
Instance details

Defined in Amazonka.RobOMaker.Types.ProgressDetail

Methods

rnf :: ProgressDetail -> () #

Hashable ProgressDetail Source # 
Instance details

Defined in Amazonka.RobOMaker.Types.ProgressDetail

FromJSON ProgressDetail Source # 
Instance details

Defined in Amazonka.RobOMaker.Types.ProgressDetail

type Rep ProgressDetail Source # 
Instance details

Defined in Amazonka.RobOMaker.Types.ProgressDetail

type Rep ProgressDetail = D1 ('MetaData "ProgressDetail" "Amazonka.RobOMaker.Types.ProgressDetail" "libZSservicesZSamazonka-robomakerZSamazonka-robomaker" 'False) (C1 ('MetaCons "ProgressDetail'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "currentProgress") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RobotDeploymentStep)) :*: S1 ('MetaSel ('Just "estimatedTimeRemainingSeconds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))) :*: (S1 ('MetaSel ('Just "targetResource") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "percentDone") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)))))

newProgressDetail :: ProgressDetail Source #

Create a value of ProgressDetail with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:currentProgress:ProgressDetail', progressDetail_currentProgress - The current progress status.

Validating
Validating the deployment.
DownloadingExtracting
Downloading and extracting the bundle on the robot.
ExecutingPreLaunch
Executing pre-launch script(s) if provided.
Launching
Launching the robot application.
ExecutingPostLaunch
Executing post-launch script(s) if provided.
Finished
Deployment is complete.

$sel:estimatedTimeRemainingSeconds:ProgressDetail', progressDetail_estimatedTimeRemainingSeconds - Estimated amount of time in seconds remaining in the step. This currently only applies to the Downloading/Extracting step of the deployment. It is empty for other steps.

$sel:targetResource:ProgressDetail', progressDetail_targetResource - The Amazon Resource Name (ARN) of the deployment job.

$sel:percentDone:ProgressDetail', progressDetail_percentDone - Precentage of the step that is done. This currently only applies to the Downloading/Extracting step of the deployment. It is empty for other steps.

progressDetail_currentProgress :: Lens' ProgressDetail (Maybe RobotDeploymentStep) Source #

The current progress status.

Validating
Validating the deployment.
DownloadingExtracting
Downloading and extracting the bundle on the robot.
ExecutingPreLaunch
Executing pre-launch script(s) if provided.
Launching
Launching the robot application.
ExecutingPostLaunch
Executing post-launch script(s) if provided.
Finished
Deployment is complete.

progressDetail_estimatedTimeRemainingSeconds :: Lens' ProgressDetail (Maybe Int) Source #

Estimated amount of time in seconds remaining in the step. This currently only applies to the Downloading/Extracting step of the deployment. It is empty for other steps.

progressDetail_targetResource :: Lens' ProgressDetail (Maybe Text) Source #

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

progressDetail_percentDone :: Lens' ProgressDetail (Maybe Double) Source #

Precentage of the step that is done. This currently only applies to the Downloading/Extracting step of the deployment. It is empty for other steps.