Package software.amazon.awssdk.services.greengrassv2.model

Interface EffectiveDeployment.Builder

    • Method Detail

      • deploymentId

        EffectiveDeployment.Builder deploymentId​(String deploymentId)

        The ID of the deployment.

        Parameters:
        deploymentId - The ID of the deployment.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • deploymentName

        EffectiveDeployment.Builder deploymentName​(String deploymentName)

        The name of the deployment.

        Parameters:
        deploymentName - The name of the deployment.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • iotJobId

        EffectiveDeployment.Builder iotJobId​(String iotJobId)

        The ID of the IoT job that applies the deployment to target devices.

        Parameters:
        iotJobId - The ID of the IoT job that applies the deployment to target devices.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • iotJobArn

        EffectiveDeployment.Builder iotJobArn​(String iotJobArn)

        The ARN of the IoT job that applies the deployment to target devices.

        Parameters:
        iotJobArn - The ARN of the IoT job that applies the deployment to target devices.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • description

        EffectiveDeployment.Builder description​(String description)

        The description of the deployment job.

        Parameters:
        description - The description of the deployment job.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • targetArn

        EffectiveDeployment.Builder targetArn​(String targetArn)

        The ARN of the target IoT thing or thing group.

        Parameters:
        targetArn - The ARN of the target IoT thing or thing group.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • coreDeviceExecutionStatus

        EffectiveDeployment.Builder coreDeviceExecutionStatus​(String coreDeviceExecutionStatus)

        The status of the deployment job on the Greengrass core device.

        • IN_PROGRESS – The deployment job is running.

        • QUEUED – The deployment job is in the job queue and waiting to run.

        • FAILED – The deployment failed. For more information, see the statusDetails field.

        • COMPLETED – The deployment to an IoT thing was completed successfully.

        • TIMED_OUT – The deployment didn't complete in the allotted time.

        • CANCELED – The deployment was canceled by the user.

        • REJECTED – The deployment was rejected. For more information, see the statusDetails field.

        • SUCCEEDED – The deployment to an IoT thing group was completed successfully.

        Parameters:
        coreDeviceExecutionStatus - The status of the deployment job on the Greengrass core device.

        • IN_PROGRESS – The deployment job is running.

        • QUEUED – The deployment job is in the job queue and waiting to run.

        • FAILED – The deployment failed. For more information, see the statusDetails field.

        • COMPLETED – The deployment to an IoT thing was completed successfully.

        • TIMED_OUT – The deployment didn't complete in the allotted time.

        • CANCELED – The deployment was canceled by the user.

        • REJECTED – The deployment was rejected. For more information, see the statusDetails field.

        • SUCCEEDED – The deployment to an IoT thing group was completed successfully.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        EffectiveDeploymentExecutionStatus, EffectiveDeploymentExecutionStatus

      • coreDeviceExecutionStatus

        EffectiveDeployment.Builder coreDeviceExecutionStatus​(EffectiveDeploymentExecutionStatus coreDeviceExecutionStatus)

        The status of the deployment job on the Greengrass core device.

        • IN_PROGRESS – The deployment job is running.

        • QUEUED – The deployment job is in the job queue and waiting to run.

        • FAILED – The deployment failed. For more information, see the statusDetails field.

        • COMPLETED – The deployment to an IoT thing was completed successfully.

        • TIMED_OUT – The deployment didn't complete in the allotted time.

        • CANCELED – The deployment was canceled by the user.

        • REJECTED – The deployment was rejected. For more information, see the statusDetails field.

        • SUCCEEDED – The deployment to an IoT thing group was completed successfully.

        Parameters:
        coreDeviceExecutionStatus - The status of the deployment job on the Greengrass core device.

        • IN_PROGRESS – The deployment job is running.

        • QUEUED – The deployment job is in the job queue and waiting to run.

        • FAILED – The deployment failed. For more information, see the statusDetails field.

        • COMPLETED – The deployment to an IoT thing was completed successfully.

        • TIMED_OUT – The deployment didn't complete in the allotted time.

        • CANCELED – The deployment was canceled by the user.

        • REJECTED – The deployment was rejected. For more information, see the statusDetails field.

        • SUCCEEDED – The deployment to an IoT thing group was completed successfully.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        EffectiveDeploymentExecutionStatus, EffectiveDeploymentExecutionStatus

      • reason

        EffectiveDeployment.Builder reason​(String reason)

        The reason code for the update, if the job was updated.

        Parameters:
        reason - The reason code for the update, if the job was updated.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • creationTimestamp

        EffectiveDeployment.Builder creationTimestamp​(Instant creationTimestamp)

        The time at which the deployment was created, expressed in ISO 8601 format.

        Parameters:
        creationTimestamp - The time at which the deployment was created, expressed in ISO 8601 format.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • modifiedTimestamp

        EffectiveDeployment.Builder modifiedTimestamp​(Instant modifiedTimestamp)

        The time at which the deployment job was last modified, expressed in ISO 8601 format.

        Parameters:
        modifiedTimestamp - The time at which the deployment job was last modified, expressed in ISO 8601 format.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • statusDetails

        EffectiveDeployment.Builder statusDetails​(EffectiveDeploymentStatusDetails statusDetails)

        The status details that explain why a deployment has an error. This response will be null if the deployment is in a success state.

        Parameters:
        statusDetails - The status details that explain why a deployment has an error. This response will be null if the deployment is in a success state.
        Returns:
        Returns a reference to this object so that method calls can be chained together.