Class RecordDetail

    • Method Detail

      • recordId

        public final String recordId()

        The identifier of the record.

        Returns:
        The identifier of the record.
      • provisionedProductName

        public final String provisionedProductName()

        The user-friendly name of the provisioned product.

        Returns:
        The user-friendly name of the provisioned product.
      • status

        public final RecordStatus status()

        The status of the provisioned product.

        • CREATED - The request was created but the operation has not started.

        • IN_PROGRESS - The requested operation is in progress.

        • IN_PROGRESS_IN_ERROR - The provisioned product is under change but the requested operation failed and some remediation is occurring. For example, a rollback.

        • SUCCEEDED - The requested operation has successfully completed.

        • FAILED - The requested operation has unsuccessfully completed. Investigate using the error messages returned.

        If the service returns an enum value that is not available in the current SDK version, status will return RecordStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

        Returns:
        The status of the provisioned product.

        • CREATED - The request was created but the operation has not started.

        • IN_PROGRESS - The requested operation is in progress.

        • IN_PROGRESS_IN_ERROR - The provisioned product is under change but the requested operation failed and some remediation is occurring. For example, a rollback.

        • SUCCEEDED - The requested operation has successfully completed.

        • FAILED - The requested operation has unsuccessfully completed. Investigate using the error messages returned.

        See Also:
        RecordStatus
      • statusAsString

        public final String statusAsString()

        The status of the provisioned product.

        • CREATED - The request was created but the operation has not started.

        • IN_PROGRESS - The requested operation is in progress.

        • IN_PROGRESS_IN_ERROR - The provisioned product is under change but the requested operation failed and some remediation is occurring. For example, a rollback.

        • SUCCEEDED - The requested operation has successfully completed.

        • FAILED - The requested operation has unsuccessfully completed. Investigate using the error messages returned.

        If the service returns an enum value that is not available in the current SDK version, status will return RecordStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

        Returns:
        The status of the provisioned product.

        • CREATED - The request was created but the operation has not started.

        • IN_PROGRESS - The requested operation is in progress.

        • IN_PROGRESS_IN_ERROR - The provisioned product is under change but the requested operation failed and some remediation is occurring. For example, a rollback.

        • SUCCEEDED - The requested operation has successfully completed.

        • FAILED - The requested operation has unsuccessfully completed. Investigate using the error messages returned.

        See Also:
        RecordStatus
      • createdTime

        public final Instant createdTime()

        The UTC time stamp of the creation time.

        Returns:
        The UTC time stamp of the creation time.
      • updatedTime

        public final Instant updatedTime()

        The time when the record was last updated.

        Returns:
        The time when the record was last updated.
      • provisionedProductType

        public final String provisionedProductType()

        The type of provisioned product. The supported values are CFN_STACK, CFN_STACKSET, TERRAFORM_OPEN_SOURCE, TERRAFORM_CLOUD, and EXTERNAL.

        Returns:
        The type of provisioned product. The supported values are CFN_STACK, CFN_STACKSET, TERRAFORM_OPEN_SOURCE, TERRAFORM_CLOUD, and EXTERNAL.
      • recordType

        public final String recordType()

        The record type.

        • PROVISION_PRODUCT

        • UPDATE_PROVISIONED_PRODUCT

        • TERMINATE_PROVISIONED_PRODUCT

        Returns:
        The record type.

        • PROVISION_PRODUCT

        • UPDATE_PROVISIONED_PRODUCT

        • TERMINATE_PROVISIONED_PRODUCT

      • provisionedProductId

        public final String provisionedProductId()

        The identifier of the provisioned product.

        Returns:
        The identifier of the provisioned product.
      • productId

        public final String productId()

        The product identifier.

        Returns:
        The product identifier.
      • provisioningArtifactId

        public final String provisioningArtifactId()

        The identifier of the provisioning artifact.

        Returns:
        The identifier of the provisioning artifact.
      • pathId

        public final String pathId()

        The path identifier.

        Returns:
        The path identifier.
      • hasRecordErrors

        public final boolean hasRecordErrors()
        For responses, this returns true if the service returned a value for the RecordErrors 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.
      • recordErrors

        public final List<RecordError> recordErrors()

        The errors that occurred.

        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 hasRecordErrors() method.

        Returns:
        The errors that occurred.
      • hasRecordTags

        public final boolean hasRecordTags()
        For responses, this returns true if the service returned a value for the RecordTags 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.
      • recordTags

        public final List<RecordTag> recordTags()

        One or more tags.

        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 hasRecordTags() method.

        Returns:
        One or more tags.
      • launchRoleArn

        public final String launchRoleArn()

        The ARN of the launch role associated with the provisioned product.

        Returns:
        The ARN of the launch role associated with the provisioned product.
      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object
      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object
      • 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)