Class GetEngagementResponse

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.GetEngagementResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetEngagementResponse.Builder,GetEngagementResponse>
@Generated("software.amazon.awssdk:codegen") public final class GetEngagementResponse extends PartnerCentralSellingResponse implements ToCopyableBuilder<GetEngagementResponse.Builder,GetEngagementResponse>

  • Method Details

    • arn

      public final String arn()

      The Amazon Resource Name (ARN) of the engagement retrieved.

      Returns:
      The Amazon Resource Name (ARN) of the engagement retrieved.

    • hasContexts

      public final boolean hasContexts()
      For responses, this returns true if the service returned a value for the Contexts 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.

    • contexts

      public final List<EngagementContextDetails> contexts()

      A list of context objects associated with the engagement. Each context provides additional information related to the Engagement, such as customer projects or documents.

      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 hasContexts() method.

      Returns:
      A list of context objects associated with the engagement. Each context provides additional information related to the Engagement, such as customer projects or documents.

    • createdAt

      public final Instant createdAt()

      The date and time when the Engagement was created, presented in ISO 8601 format (UTC). For example: "2023-05-01T20:37:46Z". This timestamp helps track the lifecycle of the Engagement.

      Returns:
      The date and time when the Engagement was created, presented in ISO 8601 format (UTC). For example: "2023-05-01T20:37:46Z". This timestamp helps track the lifecycle of the Engagement.

    • createdBy

      public final String createdBy()

      The AWS account ID of the user who originally created the engagement. This field helps in tracking the origin of the engagement.

      Returns:
      The AWS account ID of the user who originally created the engagement. This field helps in tracking the origin of the engagement.

    • description

      public final String description()

      A more detailed description of the engagement. This provides additional context or information about the engagement's purpose or scope.

      Returns:
      A more detailed description of the engagement. This provides additional context or information about the engagement's purpose or scope.

    • id

      public final String id()

      The unique resource identifier of the engagement retrieved.

      Returns:
      The unique resource identifier of the engagement retrieved.

    • memberCount

      public final Integer memberCount()

      Specifies the current count of members participating in the Engagement. This count includes all active members regardless of their roles or permissions within the Engagement.

      Returns:
      Specifies the current count of members participating in the Engagement. This count includes all active members regardless of their roles or permissions within the Engagement.

    • title

      public final String title()

      The title of the engagement. It provides a brief, descriptive name for the engagement that is meaningful and easily recognizable.

      Returns:
      The title of the engagement. It provides a brief, descriptive name for the engagement that is meaningful and easily recognizable.

    • toBuilder

      public GetEngagementResponse.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<GetEngagementResponse.Builder,GetEngagementResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static GetEngagementResponse.Builder builder()

    • serializableBuilderClass

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