Class EngagementSummary

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

An object that contains an Engagement's subset of fields.

See Also:

  • Method Details

    • arn

      public final String arn()

      The Amazon Resource Name (ARN) of the created Engagement.

      Returns:
      The Amazon Resource Name (ARN) of the created Engagement.

    • id

      public final String id()

      The unique identifier for the Engagement.

      Returns:
      The unique identifier for the Engagement.

    • title

      public final String title()

      The title of the Engagement.

      Returns:
      The title of the Engagement.

    • createdAt

      public final Instant createdAt()

      The date and time when the Engagement was created.

      Returns:
      The date and time when the Engagement was created.

    • createdBy

      public final String createdBy()

      The AWS Account ID of the Engagement creator.

      Returns:
      The AWS Account ID of the Engagement creator.

    • memberCount

      public final Integer memberCount()

      The number of members in the Engagement.

      Returns:
      The number of members in the Engagement.

    • modifiedAt

      public final Instant modifiedAt()

      The timestamp indicating when the engagement was last modified, in ISO 8601 format (UTC). Example: "2023-05-01T20:37:46Z".

      Returns:
      The timestamp indicating when the engagement was last modified, in ISO 8601 format (UTC). Example: "2023-05-01T20:37:46Z".

    • modifiedBy

      public final String modifiedBy()

      The AWS account ID of the user who last modified the engagement. This field helps track who made the most recent changes to the engagement.

      Returns:
      The AWS account ID of the user who last modified the engagement. This field helps track who made the most recent changes to the engagement.

    • contextTypes

      public final List<EngagementContextType> contextTypes()

      An array of context types associated with the engagement, such as "CustomerProject" or "Lead". This provides a quick overview of the types of contexts included in the engagement.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasContextTypes() method.

      Returns:
      An array of context types associated with the engagement, such as "CustomerProject" or "Lead". This provides a quick overview of the types of contexts included in the engagement.

    • hasContextTypes

      public final boolean hasContextTypes()
      For responses, this returns true if the service returned a value for the ContextTypes property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • contextTypesAsStrings

      public final List<String> contextTypesAsStrings()

      An array of context types associated with the engagement, such as "CustomerProject" or "Lead". This provides a quick overview of the types of contexts included in the engagement.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasContextTypes() method.

      Returns:
      An array of context types associated with the engagement, such as "CustomerProject" or "Lead". This provides a quick overview of the types of contexts included in the engagement.

    • toBuilder

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

    • builder

      public static EngagementSummary.Builder builder()

    • serializableBuilderClass

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

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