Class ListOpportunityFromEngagementTaskSummary

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

Provides a summary of a task related to creating an opportunity from an engagement. This structure contains key information about the task's status, associated identifiers, and any failure details for opportunity creation processes.

See Also:

  • Method Details

    • taskId

      public final String taskId()

      The unique identifier of the task for creating an opportunity from an engagement.

      Returns:
      The unique identifier of the task for creating an opportunity from an engagement.

    • taskArn

      public final String taskArn()

      The Amazon Resource Name (ARN) that uniquely identifies the task within AWS. This ARN can be used for referencing the task in other AWS services or APIs.

      Returns:
      The Amazon Resource Name (ARN) that uniquely identifies the task within AWS. This ARN can be used for referencing the task in other AWS services or APIs.

    • startTime

      public final Instant startTime()

      The timestamp indicating when the task was initiated, in RFC 3339 format.

      Returns:
      The timestamp indicating when the task was initiated, in RFC 3339 format.

    • taskStatus

      public final TaskStatus taskStatus()

      The current status of the task. Valid values are COMPLETE, INPROGRESS, or FAILED.

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

      Returns:
      The current status of the task. Valid values are COMPLETE, INPROGRESS, or FAILED.
      See Also:

    • taskStatusAsString

      public final String taskStatusAsString()

      The current status of the task. Valid values are COMPLETE, INPROGRESS, or FAILED.

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

      Returns:
      The current status of the task. Valid values are COMPLETE, INPROGRESS, or FAILED.
      See Also:

    • message

      public final String message()

      A detailed message providing additional information about the task, especially useful in case of failures. This field may contain error details or other relevant information about the task's execution.

      Returns:
      A detailed message providing additional information about the task, especially useful in case of failures. This field may contain error details or other relevant information about the task's execution.

    • reasonCode

      public final ReasonCode reasonCode()

      A code indicating the specific reason for a task failure. This field is populated when the task status is FAILED and provides a categorized reason for the failure.

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

      Returns:
      A code indicating the specific reason for a task failure. This field is populated when the task status is FAILED and provides a categorized reason for the failure.
      See Also:

    • reasonCodeAsString

      public final String reasonCodeAsString()

      A code indicating the specific reason for a task failure. This field is populated when the task status is FAILED and provides a categorized reason for the failure.

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

      Returns:
      A code indicating the specific reason for a task failure. This field is populated when the task status is FAILED and provides a categorized reason for the failure.
      See Also:

    • opportunityId

      public final String opportunityId()

      The unique identifier of the opportunity created as a result of the task. This field is populated when the task is completed successfully.

      Returns:
      The unique identifier of the opportunity created as a result of the task. This field is populated when the task is completed successfully.

    • resourceSnapshotJobId

      public final String resourceSnapshotJobId()

      The identifier of the resource snapshot job associated with this task, if a snapshot was created as part of the opportunity creation process.

      Returns:
      The identifier of the resource snapshot job associated with this task, if a snapshot was created as part of the opportunity creation process.

    • engagementId

      public final String engagementId()

      The unique identifier of the engagement from which the opportunity is being created. This field helps track the source of the opportunity creation task.

      Returns:
      The unique identifier of the engagement from which the opportunity is being created. This field helps track the source of the opportunity creation task.

    • contextId

      public final String contextId()

      The unique identifier of the engagement context associated with the opportunity creation task. This links the task to specific contextual information within the engagement.

      Returns:
      The unique identifier of the engagement context associated with the opportunity creation task. This links the task to specific contextual information within the engagement.

    • toBuilder

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

    • builder

      public static ListOpportunityFromEngagementTaskSummary.Builder builder()

    • serializableBuilderClass

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