Class Operation

    • Method Detail

      • id

        public final String id()

        The ID of the operation that you want to get information about.

        Returns:
        The ID of the operation that you want to get information about.
      • type

        public final OperationType type()

        The name of the operation that's associated with the specified ID.

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

        Returns:
        The name of the operation that's associated with the specified ID.
        See Also:
        OperationType
      • typeAsString

        public final String typeAsString()

        The name of the operation that's associated with the specified ID.

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

        Returns:
        The name of the operation that's associated with the specified ID.
        See Also:
        OperationType
      • status

        public final OperationStatus status()

        The status of the operation. Values include the following:

        SUBMITTED

        This is the initial state that occurs immediately after you submit a request.

        PENDING

        Cloud Map is performing the operation.

        SUCCESS

        The operation succeeded.

        FAIL

        The operation failed. For the failure reason, see ErrorMessage.

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

        Returns:
        The status of the operation. Values include the following:

        SUBMITTED

        This is the initial state that occurs immediately after you submit a request.

        PENDING

        Cloud Map is performing the operation.

        SUCCESS

        The operation succeeded.

        FAIL

        The operation failed. For the failure reason, see ErrorMessage.

        See Also:
        OperationStatus
      • statusAsString

        public final String statusAsString()

        The status of the operation. Values include the following:

        SUBMITTED

        This is the initial state that occurs immediately after you submit a request.

        PENDING

        Cloud Map is performing the operation.

        SUCCESS

        The operation succeeded.

        FAIL

        The operation failed. For the failure reason, see ErrorMessage.

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

        Returns:
        The status of the operation. Values include the following:

        SUBMITTED

        This is the initial state that occurs immediately after you submit a request.

        PENDING

        Cloud Map is performing the operation.

        SUCCESS

        The operation succeeded.

        FAIL

        The operation failed. For the failure reason, see ErrorMessage.

        See Also:
        OperationStatus
      • errorMessage

        public final String errorMessage()

        If the value of Status is FAIL, the reason that the operation failed.

        Returns:
        If the value of Status is FAIL, the reason that the operation failed.
      • errorCode

        public final String errorCode()

        The code associated with ErrorMessage. Values for ErrorCode include the following:

        • ACCESS_DENIED

        • CANNOT_CREATE_HOSTED_ZONE

        • EXPIRED_TOKEN

        • HOSTED_ZONE_NOT_FOUND

        • INTERNAL_FAILURE

        • INVALID_CHANGE_BATCH

        • THROTTLED_REQUEST

        Returns:
        The code associated with ErrorMessage. Values for ErrorCode include the following:

        • ACCESS_DENIED

        • CANNOT_CREATE_HOSTED_ZONE

        • EXPIRED_TOKEN

        • HOSTED_ZONE_NOT_FOUND

        • INTERNAL_FAILURE

        • INVALID_CHANGE_BATCH

        • THROTTLED_REQUEST

      • createDate

        public final Instant createDate()

        The date and time that the request was submitted, in Unix date/time format and Coordinated Universal Time (UTC). The value of CreateDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

        Returns:
        The date and time that the request was submitted, in Unix date/time format and Coordinated Universal Time (UTC). The value of CreateDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
      • updateDate

        public final Instant updateDate()

        The date and time that the value of Status changed to the current value, in Unix date/time format and Coordinated Universal Time (UTC). The value of UpdateDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

        Returns:
        The date and time that the value of Status changed to the current value, in Unix date/time format and Coordinated Universal Time (UTC). The value of UpdateDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
      • targets

        public final Map<OperationTargetType,​String> targets()

        The name of the target entity that's associated with the operation:

        NAMESPACE

        The namespace ID is returned in the ResourceId property.

        SERVICE

        The service ID is returned in the ResourceId property.

        INSTANCE

        The instance ID is returned in the ResourceId property.

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

        Returns:
        The name of the target entity that's associated with the operation:

        NAMESPACE

        The namespace ID is returned in the ResourceId property.

        SERVICE

        The service ID is returned in the ResourceId property.

        INSTANCE

        The instance ID is returned in the ResourceId property.

      • hasTargets

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

        public final Map<String,​String> targetsAsStrings()

        The name of the target entity that's associated with the operation:

        NAMESPACE

        The namespace ID is returned in the ResourceId property.

        SERVICE

        The service ID is returned in the ResourceId property.

        INSTANCE

        The instance ID is returned in the ResourceId property.

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

        Returns:
        The name of the target entity that's associated with the operation:

        NAMESPACE

        The namespace ID is returned in the ResourceId property.

        SERVICE

        The service ID is returned in the ResourceId property.

        INSTANCE

        The instance ID is returned in the ResourceId property.

      • 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)