Class ProspectingTaskSummary

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

A summary of a single prospecting task, returned by ListProspectingFromEngagementTasks. Contains key metrics and status information without the full per-engagement detail available from GetProspectingFromEngagementTask.

See Also:

  • Method Details

    • taskId

      public final String taskId()

      The unique identifier of the task. Use this value with GetProspectingFromEngagementTask to retrieve full task details.

      Returns:
      The unique identifier of the task. Use this value with GetProspectingFromEngagementTask to retrieve full task details.

    • taskArn

      public final String taskArn()

      The Amazon Resource Name (ARN) of the task.

      Returns:
      The Amazon Resource Name (ARN) of the task.

    • taskName

      public final String taskName()

      The descriptive name of the task provided when it was created.

      Returns:
      The descriptive name of the task provided when it was created.

    • startTime

      public final Instant startTime()

      The timestamp indicating when the task was initiated. The format follows ISO 8601 date-time notation.

      Returns:
      The timestamp indicating when the task was initiated. The format follows ISO 8601 date-time notation.

    • endTime

      public final Instant endTime()

      The timestamp indicating when the task finished processing. This field is absent if the task is still in progress. The format follows ISO 8601 date-time notation.

      Returns:
      The timestamp indicating when the task finished processing. This field is absent if the task is still in progress. The format follows ISO 8601 date-time notation.

    • totalEngagementCount

      public final Integer totalEngagementCount()

      The total number of engagements included in the task.

      Returns:
      The total number of engagements included in the task.

    • completedEngagementCount

      public final Integer completedEngagementCount()

      The number of engagements that have been successfully converted into prospecting leads.

      Returns:
      The number of engagements that have been successfully converted into prospecting leads.

    • failedEngagementCount

      public final Integer failedEngagementCount()

      The number of engagements that failed to be converted. Retrieve the full task details using GetProspectingFromEngagementTask for per-engagement error information.

      Returns:
      The number of engagements that failed to be converted. Retrieve the full task details using GetProspectingFromEngagementTask for per-engagement error information.

    • toBuilder

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

    • builder

      public static ProspectingTaskSummary.Builder builder()

    • serializableBuilderClass

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