Class DiscoveryStatus

java.lang.Object
software.amazon.awssdk.services.apiportal.model.DiscoveryStatus
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<DiscoveryStatus.Builder,DiscoveryStatus>

@Generated("software.amazon.awssdk:codegen") public final class DiscoveryStatus extends Object implements SdkPojo, Serializable, ToCopyableBuilder<DiscoveryStatus.Builder,DiscoveryStatus>

The state of API discovery for one discovery source.

See Also:
  • Method Details

    • accountId

      public final String accountId()

      The AWS account ID the status applies to.

      Returns:
      The AWS account ID the status applies to.
    • discoverySource

      public final DiscoverySource discoverySource()
      Returns the value of the DiscoverySource property for this object.

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

      Returns:
      The value of the DiscoverySource property for this object.
      See Also:
    • discoverySourceAsString

      public final String discoverySourceAsString()
      Returns the value of the DiscoverySource property for this object.

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

      Returns:
      The value of the DiscoverySource property for this object.
      See Also:
    • status

      public final DiscoveryStatusValue status()

      The current state of discovery for this source.

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

      Returns:
      The current state of discovery for this source.
      See Also:
    • statusAsString

      public final String statusAsString()

      The current state of discovery for this source.

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

      Returns:
      The current state of discovery for this source.
      See Also:
    • failureReason

      public final DiscoveryFailureReason failureReason()

      Typed reason for failure, present only when status is FAILED

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

      Returns:
      Typed reason for failure, present only when status is FAILED
      See Also:
    • failureReasonAsString

      public final String failureReasonAsString()

      Typed reason for failure, present only when status is FAILED

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

      Returns:
      Typed reason for failure, present only when status is FAILED
      See Also:
    • toBuilder

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

      public static DiscoveryStatus.Builder builder()
    • serializableBuilderClass

      public static Class<? extends DiscoveryStatus.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.