Class StartEngagementByAcceptingInvitationTaskResponse
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<StartEngagementByAcceptingInvitationTaskResponse.Builder,
StartEngagementByAcceptingInvitationTaskResponse>
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic interface
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final String
Returns the identifier of the engagement invitation that was accepted and used to create the opportunity.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkResponse
.final int
hashCode()
final String
message()
If the task fails, this field contains a detailed message describing the failure and possible recovery steps.final String
Returns the original opportunity identifier passed in the request.final ReasonCode
Indicates the reason for task failure using an enumerated code.final String
Indicates the reason for task failure using an enumerated code.final String
The identifier of the Resource Snapshot Job created as part of this task.static Class
<? extends StartEngagementByAcceptingInvitationTaskResponse.Builder> final Instant
The timestamp indicating when the task was initiated.final String
taskArn()
The Amazon Resource Name (ARN) of the task, used for tracking and managing the task within AWS.final String
taskId()
The unique identifier of the task, used to track the task’s progress.final TaskStatus
Indicates the current status of the task.final String
Indicates the current status of the task.Take this object and create a builder that contains all of the current property values of this object.final 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 interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
engagementInvitationId
Returns the identifier of the engagement invitation that was accepted and used to create the opportunity.
- Returns:
- Returns the identifier of the engagement invitation that was accepted and used to create the opportunity.
-
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
Returns the original opportunity identifier passed in the request. This is the unique identifier for the opportunity.
- Returns:
- Returns the original opportunity identifier passed in the request. This is the unique identifier for the opportunity.
-
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 returnReasonCode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromreasonCodeAsString()
.- Returns:
- Indicates the reason for task failure using an enumerated code.
- See Also:
-
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 returnReasonCode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromreasonCodeAsString()
.- Returns:
- Indicates the reason for task failure using an enumerated code.
- See Also:
-
resourceSnapshotJobId
The identifier of the Resource Snapshot Job created as part of this task.
- Returns:
- The identifier of the Resource Snapshot Job created as part of this task.
-
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
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
The unique identifier of the task, used to track the task’s progress.
- Returns:
- The unique identifier of the task, used to track the task’s progress.
-
taskStatus
Indicates the current status of the task.
If the service returns an enum value that is not available in the current SDK version,
taskStatus
will returnTaskStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtaskStatusAsString()
.- Returns:
- Indicates the current status of the task.
- See Also:
-
taskStatusAsString
Indicates the current status of the task.
If the service returns an enum value that is not available in the current SDK version,
taskStatus
will returnTaskStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtaskStatusAsString()
.- Returns:
- Indicates the current status of the task.
- See Also:
-
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 interfaceToCopyableBuilder<StartEngagementByAcceptingInvitationTaskResponse.Builder,
StartEngagementByAcceptingInvitationTaskResponse> - Specified by:
toBuilder
in classAwsResponse
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
public static Class<? extends StartEngagementByAcceptingInvitationTaskResponse.Builder> serializableBuilderClass() -
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsResponse
-
equals
- Overrides:
equals
in classAwsResponse
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
-
getValueForField
Description copied from class:SdkResponse
Used to retrieve the value of a field from any class that extendsSdkResponse
. 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, theSdkResponse.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkResponse
- 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
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToField
in interfaceSdkPojo
- Returns:
- The mapping between the field name and its corresponding field.
-