Class ListEngagementFromOpportunityTaskSummary
- java.lang.Object
-
- software.amazon.awssdk.services.partnercentralselling.model.ListEngagementFromOpportunityTaskSummary
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<ListEngagementFromOpportunityTaskSummary.Builder,ListEngagementFromOpportunityTaskSummary>
@Generated("software.amazon.awssdk:codegen") public final class ListEngagementFromOpportunityTaskSummary extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ListEngagementFromOpportunityTaskSummary.Builder,ListEngagementFromOpportunityTaskSummary>
Provides a summary of a task related to creating an engagement from an opportunity. This structure contains key information about the task's status, associated identifiers, and any failure details.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceListEngagementFromOpportunityTaskSummary.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static ListEngagementFromOpportunityTaskSummary.Builderbuilder()StringengagementId()The unique identifier of the engagement created as a result of the task.StringengagementInvitationId()The unique identifier of the Engagement Invitation.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()Stringmessage()A detailed message providing additional information about the task, especially useful in case of failures.StringopportunityId()The unique identifier of the original Opportunity from which the Engagement is being created.ReasonCodereasonCode()A code indicating the specific reason for a task failure.StringreasonCodeAsString()A code indicating the specific reason for a task failure.StringresourceSnapshotJobId()The identifier of the resource snapshot job associated with this task, if a snapshot was created as part of the Engagement creation process.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends ListEngagementFromOpportunityTaskSummary.Builder>serializableBuilderClass()InstantstartTime()The timestamp indicating when the task was initiated, in RFC 3339 5.6 date-time format.StringtaskArn()The Amazon Resource Name (ARN) uniquely identifying this task within AWS.StringtaskId()A unique identifier for a specific task.TaskStatustaskStatus()The current status of the task.StringtaskStatusAsString()The current status of the task.ListEngagementFromOpportunityTaskSummary.BuildertoBuilder()StringtoString()Returns a string representation of this object.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
engagementId
public final String engagementId()
The unique identifier of the engagement created as a result of the task. This field is populated when the task is completed successfully.
- Returns:
- The unique identifier of the engagement created as a result of the task. This field is populated when the task is completed successfully.
-
engagementInvitationId
public final String engagementInvitationId()
The unique identifier of the Engagement Invitation.
- Returns:
- The unique identifier of the Engagement Invitation.
-
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
-
opportunityId
public final String opportunityId()
The unique identifier of the original Opportunity from which the Engagement is being created. This field helps track the source of the Engagement creation task.
- Returns:
- The unique identifier of the original Opportunity from which the Engagement is being created. This field helps track the source of the Engagement creation task.
-
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,
reasonCodewill returnReasonCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromreasonCodeAsString().- 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:
ReasonCode
-
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,
reasonCodewill returnReasonCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromreasonCodeAsString().- 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:
ReasonCode
-
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 Engagement creation process.
- Returns:
- The identifier of the resource snapshot job associated with this task, if a snapshot was created as part of the Engagement creation process.
-
startTime
public final Instant startTime()
The timestamp indicating when the task was initiated, in RFC 3339 5.6 date-time format.
- Returns:
- The timestamp indicating when the task was initiated, in RFC 3339 5.6 date-time format.
-
taskArn
public final String taskArn()
The Amazon Resource Name (ARN) uniquely identifying this task within AWS. This ARN can be used for referencing the task in other AWS services or APIs.
- Returns:
- The Amazon Resource Name (ARN) uniquely identifying this task within AWS. This ARN can be used for referencing the task in other AWS services or APIs.
-
taskId
public final String taskId()
A unique identifier for a specific task.
- Returns:
- A unique identifier for a specific task.
-
taskStatus
public final TaskStatus taskStatus()
The current status of the task.
If the service returns an enum value that is not available in the current SDK version,
taskStatuswill returnTaskStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromtaskStatusAsString().- Returns:
- The current status of the task.
- See Also:
TaskStatus
-
taskStatusAsString
public final String taskStatusAsString()
The current status of the task.
If the service returns an enum value that is not available in the current SDK version,
taskStatuswill returnTaskStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromtaskStatusAsString().- Returns:
- The current status of the task.
- See Also:
TaskStatus
-
toBuilder
public ListEngagementFromOpportunityTaskSummary.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<ListEngagementFromOpportunityTaskSummary.Builder,ListEngagementFromOpportunityTaskSummary>
-
builder
public static ListEngagementFromOpportunityTaskSummary.Builder builder()
-
serializableBuilderClass
public static Class<? extends ListEngagementFromOpportunityTaskSummary.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-