GetDeploymentResponse (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.core.SdkResponse
- - software.amazon.awssdk.awscore.AwsResponse
  - - software.amazon.awssdk.services.greengrassv2.model.GreengrassV2Response
    - - software.amazon.awssdk.services.greengrassv2.model.GetDeploymentResponse

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<GetDeploymentResponse.Builder,GetDeploymentResponse>

@Generated(value="software.amazon.awssdk:codegen")
public final class GetDeploymentResponse
extends GreengrassV2Response
implements ToCopyableBuilder<GetDeploymentResponse.Builder,GetDeploymentResponse>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface GetDeploymentResponse.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`GetDeploymentResponse.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static GetDeploymentResponse.Builder`	`builder()`
`Map<String,ComponentDeploymentSpecification>`	`components()` The components to deploy.
`Instant`	`creationTimestamp()` The time at which the deployment was created, expressed in ISO 8601 format.
`String`	`deploymentId()` The ID of the deployment.
`String`	`deploymentName()` The name of the deployment.
`DeploymentPolicies`	`deploymentPolicies()` The deployment policies for the deployment.
`DeploymentStatus`	`deploymentStatus()` The status of the deployment.
`String`	`deploymentStatusAsString()` The status of the deployment.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasComponents()` For responses, this returns true if the service returned a value for the Components property.
`int`	`hashCode()`
`boolean`	`hasTags()` For responses, this returns true if the service returned a value for the Tags property.
`String`	`iotJobArn()` The ARN of the IoT job that applies the deployment to target devices.
`DeploymentIoTJobConfiguration`	`iotJobConfiguration()` The job configuration for the deployment configuration.
`String`	`iotJobId()` The ID of the IoT job that applies the deployment to target devices.
`Boolean`	`isLatestForTarget()` Whether or not the deployment is the latest revision for its target.
`String`	`parentTargetArn()` The parent deployment's target ARN within a subdeployment.
`String`	`revisionId()` The revision number of the deployment.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends GetDeploymentResponse.Builder>`	`serializableBuilderClass()`
`Map<String,String>`	`tags()` A list of key-value pairs that contain metadata for the resource.
`String`	`targetArn()` The ARN of the target IoT thing or thing group.
`GetDeploymentResponse.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.greengrassv2.model.GreengrassV2Response
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
  - targetArn
```
public final String targetArn()
```
    The ARN of the target IoT thing or thing group.
    
    Returns:
    
    The ARN of the target IoT thing or thing group.
  - revisionId
```
public final String revisionId()
```
    The revision number of the deployment.
    
    Returns:
    
    The revision number of the deployment.
  - deploymentId
```
public final String deploymentId()
```
    The ID of the deployment.
    
    Returns:
    
    The ID of the deployment.
  - deploymentName
```
public final String deploymentName()
```
    The name of the deployment.
    
    Returns:
    
    The name of the deployment.
  - deploymentStatus
```
public final DeploymentStatus deploymentStatus()
```
    The status of the deployment.
    
    If the service returns an enum value that is not available in the current SDK version, deploymentStatus will return DeploymentStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from deploymentStatusAsString().
    
    Returns:
    
    The status of the deployment.
    
    See Also:
    
    DeploymentStatus
  - deploymentStatusAsString
```
public final String deploymentStatusAsString()
```
    The status of the deployment.
    
    If the service returns an enum value that is not available in the current SDK version, deploymentStatus will return DeploymentStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from deploymentStatusAsString().
    
    Returns:
    
    The status of the deployment.
    
    See Also:
    
    DeploymentStatus
  - iotJobId
```
public final String iotJobId()
```
    The ID of the IoT job that applies the deployment to target devices.
    
    Returns:
    
    The ID of the IoT job that applies the deployment to target devices.
  - iotJobArn
```
public final String iotJobArn()
```
    The ARN of the IoT job that applies the deployment to target devices.
    
    Returns:
    
    The ARN of the IoT job that applies the deployment to target devices.
  - hasComponents
```
public final boolean hasComponents()
```
    For responses, this returns true if the service returned a value for the Components 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.
  - components
```
public final Map<String,ComponentDeploymentSpecification> 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.
    
    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 hasComponents() method.
    
    Returns:
    
    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.
  - deploymentPolicies
```
public final DeploymentPolicies deploymentPolicies()
```
    The deployment policies for the deployment. These policies define how the deployment updates components and handles failure.
    
    Returns:
    
    The deployment policies for the deployment. These policies define how the deployment updates components and handles failure.
  - iotJobConfiguration
```
public final DeploymentIoTJobConfiguration iotJobConfiguration()
```
    The job configuration for the deployment configuration. The job configuration specifies the rollout, timeout, and stop configurations for the deployment configuration.
    
    Returns:
    
    The job configuration for the deployment configuration. The job configuration specifies the rollout, timeout, and stop configurations for the deployment configuration.
  - creationTimestamp
```
public final Instant creationTimestamp()
```
    The time at which the deployment was created, expressed in ISO 8601 format.
    
    Returns:
    
    The time at which the deployment was created, expressed in ISO 8601 format.
  - isLatestForTarget
```
public final Boolean isLatestForTarget()
```
    Whether or not the deployment is the latest revision for its target.
    
    Returns:
    
    Whether or not the deployment is the latest revision for its target.
  - parentTargetArn
```
public final String parentTargetArn()
```
    The parent deployment's target ARN within a subdeployment.
    
    Returns:
    
    The parent deployment's target ARN within a subdeployment.
  - 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()
```
    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.
    
    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:
    
    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.
  - toBuilder
```
public GetDeploymentResponse.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<GetDeploymentResponse.Builder,GetDeploymentResponse>
    
    Overrides:
    
    toBuilder in class AwsResponse
  - builder
```
public static GetDeploymentResponse.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends GetDeploymentResponse.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

Class GetDeploymentResponse

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.services.greengrassv2.model.GreengrassV2Response

Methods inherited from class software.amazon.awssdk.core.SdkResponse

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

targetArn

revisionId

deploymentId

deploymentName

deploymentStatus

deploymentStatusAsString

iotJobId

iotJobArn

hasComponents

components

deploymentPolicies

iotJobConfiguration

creationTimestamp

isLatestForTarget

parentTargetArn

hasTags

tags

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields