Class EngagementProspectingResult

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

Contains the result of processing a single engagement within a prospecting task. Each engagement is processed independently, so individual engagements can succeed or fail regardless of other engagements in the same task.

See Also:

  • Method Details

    • engagementIdentifier

      public final String engagementIdentifier()

      The unique identifier of the engagement that was processed.

      Returns:
      The unique identifier of the engagement that was processed.

    • engagementContextId

      public final String engagementContextId()

      The identifier of the prospecting context created for this engagement. This field is only populated when the engagement was processed successfully (status is COMPLETED). Use this identifier to reference the prospecting context in subsequent operations.

      Returns:
      The identifier of the prospecting context created for this engagement. This field is only populated when the engagement was processed successfully (status is COMPLETED). Use this identifier to reference the prospecting context in subsequent operations.

    • status

      public final ProspectingTaskStatus status()

      The processing status of this specific engagement. Possible values are PENDING, IN_PROGRESS, COMPLETED, and FAILED.

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

      Returns:
      The processing status of this specific engagement. Possible values are PENDING, IN_PROGRESS, COMPLETED, and FAILED.
      See Also:

    • statusAsString

      public final String statusAsString()

      The processing status of this specific engagement. Possible values are PENDING, IN_PROGRESS, COMPLETED, and FAILED.

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

      Returns:
      The processing status of this specific engagement. Possible values are PENDING, IN_PROGRESS, COMPLETED, and FAILED.
      See Also:

    • reasonCode

      public final String reasonCode()

      An enumerated code indicating the reason this engagement failed to process. This field is only populated when Status is FAILED.

      Returns:
      An enumerated code indicating the reason this engagement failed to process. This field is only populated when Status is FAILED.

    • message

      public final String message()

      A human-readable description of the failure for this engagement, including suggested recovery steps. This field is only populated when Status is FAILED.

      Returns:
      A human-readable description of the failure for this engagement, including suggested recovery steps. This field is only populated when Status is FAILED.

    • toBuilder

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

    • builder

      public static EngagementProspectingResult.Builder builder()

    • serializableBuilderClass

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