Class 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>
  • Method Details

    • 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:
    • 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:
    • 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()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<GetDeploymentResponse.Builder,GetDeploymentResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T
    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.
    • 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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value
    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.