Class StartEngagementByAcceptingInvitationTaskResponse

  • Method Details

    • engagementInvitationId

      public final String 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

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

      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:
    • 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:
    • resourceSnapshotJobId

      public final String 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

      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.

      Returns:
      The unique identifier of the task, used to track the task’s progress.
    • taskStatus

      public final TaskStatus 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 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.
      See Also:
    • taskStatusAsString

      public final String 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 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.
      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 interface ToCopyableBuilder<StartEngagementByAcceptingInvitationTaskResponse.Builder,StartEngagementByAcceptingInvitationTaskResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T
    • builder

    • serializableBuilderClass

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