Class Operation

java.lang.Object
software.amazon.awssdk.services.servicediscovery.model.Operation
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<Operation.Builder,Operation>
@Generated("software.amazon.awssdk:codegen") public final class Operation extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Operation.Builder,Operation>

A complex type that contains information about a specified operation.

See Also:

  • Method Details

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

    • ownerAccount

      public final String ownerAccount()

      The ID of the Amazon Web Services account that owns the namespace associated with the operation.

      Returns:
      The ID of the Amazon Web Services account that owns the namespace associated with the operation.

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

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

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

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

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

    • toBuilder

      public Operation.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<Operation.Builder,Operation>
      Returns:
      a builder for type T

    • builder

      public static Operation.Builder builder()

    • serializableBuilderClass

      public static Class<? extends Operation.Builder> serializableBuilderClass()

    • hashCode

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

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

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

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.