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

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<StartEngagementFromOpportunityTaskResponse.Builder,StartEngagementFromOpportunityTaskResponse>

@Generated("software.amazon.awssdk:codegen")
public final class StartEngagementFromOpportunityTaskResponse
extends PartnerCentralSellingResponse
implements ToCopyableBuilder<StartEngagementFromOpportunityTaskResponse.Builder,StartEngagementFromOpportunityTaskResponse>

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface StartEngagementFromOpportunityTaskResponse.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static StartEngagementFromOpportunityTaskResponse.Builder`	`builder()`
`String`	`engagementId()`	The identifier of the newly created Engagement.
`String`	`engagementInvitationId()`	The identifier of the new Engagement invitation.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`String`	`message()`	If the task fails, this field contains a detailed message describing the failure and possible recovery steps.
`String`	`opportunityId()`	Returns the original opportunity identifier passed in the request, which is the unique identifier for the opportunity created in the partner’s system.
`ReasonCode`	`reasonCode()`	Indicates the reason for task failure using an enumerated code.
`String`	`reasonCodeAsString()`	Indicates the reason for task failure using an enumerated code.
`String`	`resourceSnapshotJobId()`	The identifier of the resource snapshot job created to add the opportunity resource snapshot to the Engagement.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends StartEngagementFromOpportunityTaskResponse.Builder>`	`serializableBuilderClass()`
`Instant`	`startTime()`	The timestamp indicating when the task was initiated.
`String`	`taskArn()`	The Amazon Resource Name (ARN) of the task, used for tracking and managing the task within AWS.
`String`	`taskId()`	The unique identifier of the task, used to track the task’s progress.
`TaskStatus`	`taskStatus()`	Indicates the current status of the task.
`String`	`taskStatusAsString()`	Indicates the current status of the task.
`StartEngagementFromOpportunityTaskResponse.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.partnercentralselling.model.PartnerCentralSellingResponse
responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse

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 identifier of the newly created Engagement. Only populated if TaskStatus is COMPLETE.
    
    Returns:
    
    The identifier of the newly created Engagement. Only populated if TaskStatus is COMPLETE.
  - engagementInvitationId
```
public final String engagementInvitationId()
```
    The identifier of the new Engagement invitation. Only populated if TaskStatus is COMPLETE.
    
    Returns:
    
    The identifier of the new Engagement invitation. Only populated if TaskStatus is COMPLETE.
  - message
```
public final String message()
```
    If the task fails, this field contains a detailed message describing the failure and possible recovery steps.
    
    Returns:
    
    If the task fails, this field contains a detailed message describing the failure and possible recovery steps.
  - opportunityId
```
public final String opportunityId()
```
    Returns the original opportunity identifier passed in the request, which is the unique identifier for the opportunity created in the partner’s system.
    
    Returns:
    
    Returns the original opportunity identifier passed in the request, which is the unique identifier for the opportunity created in the partner’s system.
  - reasonCode
```
public final ReasonCode reasonCode()
```
    Indicates the reason for task failure using an enumerated code.
    
    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:
    
    Indicates the reason for task failure using an enumerated code.
    
    See Also:
    
    ReasonCode
  - reasonCodeAsString
```
public final String reasonCodeAsString()
```
    Indicates the reason for task failure using an enumerated code.
    
    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:
    
    Indicates the reason for task failure using an enumerated code.
    
    See Also:
    
    ReasonCode
  - resourceSnapshotJobId
```
public final String resourceSnapshotJobId()
```
    The identifier of the resource snapshot job created to add the opportunity resource snapshot to the Engagement. Only populated if TaskStatus is COMPLETE
    
    Returns:
    
    The identifier of the resource snapshot job created to add the opportunity resource snapshot to the Engagement. Only populated if TaskStatus is COMPLETE
  - startTime
```
public final Instant startTime()
```
    The timestamp indicating when the task was initiated. The format follows RFC 3339 section 5.6.
    
    Returns:
    
    The timestamp indicating when the task was initiated. The format follows RFC 3339 section 5.6.
  - taskArn
```
public final String taskArn()
```
    The Amazon Resource Name (ARN) of the task, used for tracking and managing the task within AWS.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the task, used for tracking and managing the task within AWS.
  - taskId
```
public final String taskId()
```
    The unique identifier of the task, used to track the task’s progress. This value follows a specific pattern: ^oit-[0-9a-z]{13}$.
    
    Returns:
    
    The unique identifier of the task, used to track the task’s progress. This value follows a specific pattern: ^oit-[0-9a-z]{13}$.
  - taskStatus
```
public final TaskStatus taskStatus()
```
    Indicates the current status of the task. Valid values include IN_PROGRESS, COMPLETE, and 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:
    
    Indicates the current status of the task. Valid values include IN_PROGRESS, COMPLETE, and FAILED.
    
    See Also:
    
    TaskStatus
  - taskStatusAsString
```
public final String taskStatusAsString()
```
    Indicates the current status of the task. Valid values include IN_PROGRESS, COMPLETE, and 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:
    
    Indicates the current status of the task. Valid values include IN_PROGRESS, COMPLETE, and FAILED.
    
    See Also:
    
    TaskStatus
  - toBuilder
```
public StartEngagementFromOpportunityTaskResponse.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<StartEngagementFromOpportunityTaskResponse.Builder,StartEngagementFromOpportunityTaskResponse>
    
    Specified by:
    
    toBuilder in class AwsResponse
  - builder
```
public static StartEngagementFromOpportunityTaskResponse.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends StartEngagementFromOpportunityTaskResponse.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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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)
```
    Overrides:
    
    getValueForField in class SdkResponse
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class StartEngagementFromOpportunityTaskResponse

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.services.partnercentralselling.model.PartnerCentralSellingResponse

Methods inherited from class software.amazon.awssdk.core.SdkResponse

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

engagementId

engagementInvitationId

message

opportunityId

reasonCode

reasonCodeAsString

resourceSnapshotJobId

startTime

taskArn

taskId

taskStatus

taskStatusAsString

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField