Class GetDeploymentResponse
- 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("software.amazon.awssdk:codegen") public final class GetDeploymentResponse extends GreengrassV2Response implements ToCopyableBuilder<GetDeploymentResponse.Builder,GetDeploymentResponse>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceGetDeploymentResponse.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static GetDeploymentResponse.Builderbuilder()Map<String,ComponentDeploymentSpecification>components()The components to deploy.InstantcreationTimestamp()The time at which the deployment was created, expressed in ISO 8601 format.StringdeploymentId()The ID of the deployment.StringdeploymentName()The name of the deployment.DeploymentPoliciesdeploymentPolicies()The deployment policies for the deployment.DeploymentStatusdeploymentStatus()The status of the deployment.StringdeploymentStatusAsString()The status of the deployment.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasComponents()For responses, this returns true if the service returned a value for the Components property.inthashCode()booleanhasTags()For responses, this returns true if the service returned a value for the Tags property.StringiotJobArn()The ARN of the IoT job that applies the deployment to target devices.DeploymentIoTJobConfigurationiotJobConfiguration()The job configuration for the deployment configuration.StringiotJobId()The ID of the IoT job that applies the deployment to target devices.BooleanisLatestForTarget()Whether or not the deployment is the latest revision for its target.StringparentTargetArn()The parent deployment's target ARN within a subdeployment.StringrevisionId()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.StringtargetArn()The ARN of the target IoT thing or thing group.GetDeploymentResponse.BuildertoBuilder()StringtoString()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,
deploymentStatuswill returnDeploymentStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromdeploymentStatusAsString().- 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,
deploymentStatuswill returnDeploymentStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromdeploymentStatusAsString().- 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 theisEmpty()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 theisEmpty()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:
toBuilderin interfaceToCopyableBuilder<GetDeploymentResponse.Builder,GetDeploymentResponse>- Specified by:
toBuilderin classAwsResponse
-
builder
public static GetDeploymentResponse.Builder builder()
-
serializableBuilderClass
public static Class<? extends GetDeploymentResponse.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsResponse
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsResponse
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForFieldin classSdkResponse
-
-