Class EngagementContextPayload

java.lang.Object
software.amazon.awssdk.services.partnercentralselling.model.EngagementContextPayload
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<EngagementContextPayload.Builder,EngagementContextPayload>
@Generated("software.amazon.awssdk:codegen") public final class EngagementContextPayload extends Object implements SdkPojo, Serializable, ToCopyableBuilder<EngagementContextPayload.Builder,EngagementContextPayload>

Represents the payload of an Engagement context. The structure of this payload varies based on the context type specified in the EngagementContextDetails.

See Also:

  • Method Details

    • customerProject

      public final CustomerProjectsContext customerProject()

      Contains detailed information about a customer project when the context type is "CustomerProject". This field is present only when the Type in EngagementContextDetails is set to "CustomerProject".

      Returns:
      Contains detailed information about a customer project when the context type is "CustomerProject". This field is present only when the Type in EngagementContextDetails is set to "CustomerProject".

    • lead

      public final LeadContext lead()

      Contains detailed information about a lead when the context type is "Lead". This field is present only when the Type in EngagementContextDetails is set to "Lead".

      Returns:
      Contains detailed information about a lead when the context type is "Lead". This field is present only when the Type in EngagementContextDetails is set to "Lead".

    • prospectingResult

      public final ProspectingResult prospectingResult()

      Contains prospecting result data with enriched insights. The system generates these insights when a partner runs an autonomous prospecting job on leads. This field appears only when the context type is "ProspectingResult".

      Returns:
      Contains prospecting result data with enriched insights. The system generates these insights when a partner runs an autonomous prospecting job on leads. This field appears only when the context type is "ProspectingResult".

    • toBuilder

      public EngagementContextPayload.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<EngagementContextPayload.Builder,EngagementContextPayload>
      Returns:
      a builder for type T

    • builder

      public static EngagementContextPayload.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

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

    • fromCustomerProject

      public static EngagementContextPayload fromCustomerProject(CustomerProjectsContext customerProject)
      Create an instance of this class with customerProject() initialized to the given value.

      Contains detailed information about a customer project when the context type is "CustomerProject". This field is present only when the Type in EngagementContextDetails is set to "CustomerProject".

      Parameters:
      customerProject - Contains detailed information about a customer project when the context type is "CustomerProject". This field is present only when the Type in EngagementContextDetails is set to "CustomerProject".

    • fromCustomerProject

      public static EngagementContextPayload fromCustomerProject(Consumer<CustomerProjectsContext.Builder> customerProject)
      Create an instance of this class with customerProject() initialized to the given value.

      Contains detailed information about a customer project when the context type is "CustomerProject". This field is present only when the Type in EngagementContextDetails is set to "CustomerProject".

      Parameters:
      customerProject - Contains detailed information about a customer project when the context type is "CustomerProject". This field is present only when the Type in EngagementContextDetails is set to "CustomerProject".

    • fromLead

      public static EngagementContextPayload fromLead(LeadContext lead)
      Create an instance of this class with lead() initialized to the given value.

      Contains detailed information about a lead when the context type is "Lead". This field is present only when the Type in EngagementContextDetails is set to "Lead".

      Parameters:
      lead - Contains detailed information about a lead when the context type is "Lead". This field is present only when the Type in EngagementContextDetails is set to "Lead".

    • fromLead

      public static EngagementContextPayload fromLead(Consumer<LeadContext.Builder> lead)
      Create an instance of this class with lead() initialized to the given value.

      Contains detailed information about a lead when the context type is "Lead". This field is present only when the Type in EngagementContextDetails is set to "Lead".

      Parameters:
      lead - Contains detailed information about a lead when the context type is "Lead". This field is present only when the Type in EngagementContextDetails is set to "Lead".

    • fromProspectingResult

      public static EngagementContextPayload fromProspectingResult(ProspectingResult prospectingResult)
      Create an instance of this class with prospectingResult() initialized to the given value.

      Contains prospecting result data with enriched insights. The system generates these insights when a partner runs an autonomous prospecting job on leads. This field appears only when the context type is "ProspectingResult".

      Parameters:
      prospectingResult - Contains prospecting result data with enriched insights. The system generates these insights when a partner runs an autonomous prospecting job on leads. This field appears only when the context type is "ProspectingResult".

    • fromProspectingResult

      public static EngagementContextPayload fromProspectingResult(Consumer<ProspectingResult.Builder> prospectingResult)
      Create an instance of this class with prospectingResult() initialized to the given value.

      Contains prospecting result data with enriched insights. The system generates these insights when a partner runs an autonomous prospecting job on leads. This field appears only when the context type is "ProspectingResult".

      Parameters:
      prospectingResult - Contains prospecting result data with enriched insights. The system generates these insights when a partner runs an autonomous prospecting job on leads. This field appears only when the context type is "ProspectingResult".

    • type

      public EngagementContextPayload.Type type()
      Retrieve an enum value representing which member of this object is populated. When this class is returned in a service response, this will be EngagementContextPayload.Type.UNKNOWN_TO_SDK_VERSION if the service returned a member that is only known to a newer SDK version. When this class is created directly in your code, this will be EngagementContextPayload.Type.UNKNOWN_TO_SDK_VERSION if zero members are set, and null if more than one member is set.

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