Interface GetDeploymentResponse.Builder
- All Superinterfaces:
AwsResponse.Builder
,Buildable
,CopyableBuilder<GetDeploymentResponse.Builder,
,GetDeploymentResponse> GreengrassV2Response.Builder
,SdkBuilder<GetDeploymentResponse.Builder,
,GetDeploymentResponse> SdkPojo
,SdkResponse.Builder
- Enclosing class:
GetDeploymentResponse
-
Method Summary
Modifier and TypeMethodDescriptioncomponents
(Map<String, ComponentDeploymentSpecification> components) The components to deploy.creationTimestamp
(Instant creationTimestamp) The time at which the deployment was created, expressed in ISO 8601 format.deploymentId
(String deploymentId) The ID of the deployment.deploymentName
(String deploymentName) The name of the deployment.default GetDeploymentResponse.Builder
deploymentPolicies
(Consumer<DeploymentPolicies.Builder> deploymentPolicies) The deployment policies for the deployment.deploymentPolicies
(DeploymentPolicies deploymentPolicies) The deployment policies for the deployment.deploymentStatus
(String deploymentStatus) The status of the deployment.deploymentStatus
(DeploymentStatus deploymentStatus) The status of the deployment.The ARN of the IoT job that applies the deployment to target devices.default GetDeploymentResponse.Builder
iotJobConfiguration
(Consumer<DeploymentIoTJobConfiguration.Builder> iotJobConfiguration) The job configuration for the deployment configuration.iotJobConfiguration
(DeploymentIoTJobConfiguration iotJobConfiguration) The job configuration for the deployment configuration.The ID of the IoT job that applies the deployment to target devices.isLatestForTarget
(Boolean isLatestForTarget) Whether or not the deployment is the latest revision for its target.parentTargetArn
(String parentTargetArn) The parent deployment's target ARN within a subdeployment.revisionId
(String revisionId) The revision number of the deployment.A list of key-value pairs that contain metadata for the resource.The ARN of the target IoT thing or thing group.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.greengrassv2.model.GreengrassV2Response.Builder
build, responseMetadata, responseMetadata
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder
sdkHttpResponse, sdkHttpResponse
-
Method Details
-
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.
-
revisionId
The revision number of the deployment.
- Parameters:
revisionId
- The revision number of the deployment.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
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.
-
deploymentStatus
The status of the deployment.
- Parameters:
deploymentStatus
- The status of the deployment.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
deploymentStatus
The status of the deployment.
- Parameters:
deploymentStatus
- The status of the deployment.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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.
-
components
The components to deploy. This is a dictionary, where each key is the name of a component, and each key's value is the version and configuration to deploy for that component.
- Parameters:
components
- The components to deploy. This is a dictionary, where each key is the name of a component, and each key's value is the version and configuration to deploy for that component.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
deploymentPolicies
The deployment policies for the deployment. These policies define how the deployment updates components and handles failure.
- Parameters:
deploymentPolicies
- The deployment policies for the deployment. These policies define how the deployment updates components and handles failure.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
deploymentPolicies
default GetDeploymentResponse.Builder deploymentPolicies(Consumer<DeploymentPolicies.Builder> deploymentPolicies) The deployment policies for the deployment. These policies define how the deployment updates components and handles failure.
This is a convenience method that creates an instance of theDeploymentPolicies.Builder
avoiding the need to create one manually viaDeploymentPolicies.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed todeploymentPolicies(DeploymentPolicies)
.- Parameters:
deploymentPolicies
- a consumer that will call methods onDeploymentPolicies.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
iotJobConfiguration
GetDeploymentResponse.Builder iotJobConfiguration(DeploymentIoTJobConfiguration iotJobConfiguration) The job configuration for the deployment configuration. The job configuration specifies the rollout, timeout, and stop configurations for the deployment configuration.
- Parameters:
iotJobConfiguration
- The job configuration for the deployment configuration. The job configuration specifies the rollout, timeout, and stop configurations for the deployment configuration.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
iotJobConfiguration
default GetDeploymentResponse.Builder iotJobConfiguration(Consumer<DeploymentIoTJobConfiguration.Builder> iotJobConfiguration) The job configuration for the deployment configuration. The job configuration specifies the rollout, timeout, and stop configurations for the deployment configuration.
This is a convenience method that creates an instance of theDeploymentIoTJobConfiguration.Builder
avoiding the need to create one manually viaDeploymentIoTJobConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toiotJobConfiguration(DeploymentIoTJobConfiguration)
.- Parameters:
iotJobConfiguration
- a consumer that will call methods onDeploymentIoTJobConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.
-
isLatestForTarget
Whether or not the deployment is the latest revision for its target.
- Parameters:
isLatestForTarget
- Whether or not the deployment is the latest revision for its target.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
parentTargetArn
The parent deployment's target ARN within a subdeployment.
- Parameters:
parentTargetArn
- The parent deployment's target ARN within a subdeployment.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
A list of key-value pairs that contain metadata for the resource. For more information, see Tag your resources in the IoT Greengrass V2 Developer Guide.
- Parameters:
tags
- A list of key-value pairs that contain metadata for the resource. For more information, see Tag your resources in the IoT Greengrass V2 Developer Guide.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-