Class StartProspectingFromEngagementTaskResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.partnercentralselling.model.PartnerCentralSellingResponse
software.amazon.awssdk.services.partnercentralselling.model.StartProspectingFromEngagementTaskResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<StartProspectingFromEngagementTaskResponse.Builder,StartProspectingFromEngagementTaskResponse>
@Generated("software.amazon.awssdk:codegen") public final class StartProspectingFromEngagementTaskResponse extends PartnerCentralSellingResponse implements ToCopyableBuilder<StartProspectingFromEngagementTaskResponse.Builder,StartProspectingFromEngagementTaskResponse>

Represents the response structure returned when a prospecting task is successfully submitted. Contains the task identifier, ARN, and initial status. Uses TaskId with GetProspectingFromEngagementTask to poll for completion.

  • Method Details

    • hasIdentifiers

      public final boolean hasIdentifiers()
      For responses, this returns true if the service returned a value for the Identifiers 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.

    • identifiers

      public final List<String> identifiers()

      The list of engagement identifiers that were accepted into the task queue for processing. This list matches the identifiers provided in the request.

      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 hasIdentifiers() method.

      Returns:
      The list of engagement identifiers that were accepted into the task queue for processing. This list matches the identifiers provided in the request.

    • taskName

      public final String taskName()

      The task name from the request.

      Returns:
      The task name from the request.

    • message

      public final String message()

      A message providing additional context about the task's current state. When the task fails, this field contains a detailed description of the failure and suggested recovery steps. This field is only populated for tasks in a failed state.

      Returns:
      A message providing additional context about the task's current state. When the task fails, this field contains a detailed description of the failure and suggested recovery steps. This field is only populated for tasks in a failed state.

    • reasonCode

      public final String reasonCode()

      An enumerated code identifying the reason for task failure. This field is only populated when the task has failed. Use the corresponding Message field for a human-readable description of the failure.

      Returns:
      An enumerated code identifying the reason for task failure. This field is only populated when the task has failed. Use the corresponding Message field for a human-readable description of the failure.

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

    • taskId

      public final String taskId()

      The unique identifier assigned to this task. Use this identifier with GetProspectingFromEngagementTask to retrieve task details and check status.

      Returns:
      The unique identifier assigned to this task. Use this identifier with GetProspectingFromEngagementTask to retrieve task details and check status.

    • taskArn

      public final String taskArn()

      The Amazon Resource Name (ARN) of the task. The ARN uniquely identifies the task across AWS and can be used for resource-level IAM policies.

      Returns:
      The Amazon Resource Name (ARN) of the task. The ARN uniquely identifies the task across AWS and can be used for resource-level IAM policies.

    • taskStatus

      public final ProspectingTaskStatus taskStatus()

      The current status of the task. Possible values: PENDING (waiting to run), IN_PROGRESS (actively processing), COMPLETED (successfully processed), and FAILED (unrecoverable error).

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

      Returns:
      The current status of the task. Possible values: PENDING (waiting to run), IN_PROGRESS (actively processing), COMPLETED (successfully processed), and FAILED (unrecoverable error).
      See Also:

    • taskStatusAsString

      public final String taskStatusAsString()

      The current status of the task. Possible values: PENDING (waiting to run), IN_PROGRESS (actively processing), COMPLETED (successfully processed), and FAILED (unrecoverable error).

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

      Returns:
      The current status of the task. Possible values: PENDING (waiting to run), IN_PROGRESS (actively processing), COMPLETED (successfully processed), and FAILED (unrecoverable error).
      See Also:

    • toBuilder

      public StartProspectingFromEngagementTaskResponse.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<StartProspectingFromEngagementTaskResponse.Builder,StartProspectingFromEngagementTaskResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static StartProspectingFromEngagementTaskResponse.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

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