Class UpdateEngagementContextRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.partnercentralselling.model.PartnerCentralSellingRequest
software.amazon.awssdk.services.partnercentralselling.model.UpdateEngagementContextRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<UpdateEngagementContextRequest.Builder,UpdateEngagementContextRequest>
@Generated("software.amazon.awssdk:codegen") public final class UpdateEngagementContextRequest extends PartnerCentralSellingRequest implements ToCopyableBuilder<UpdateEngagementContextRequest.Builder,UpdateEngagementContextRequest>

  • Method Details

    • catalog

      public final String catalog()

      Specifies the catalog associated with the engagement context update request. This field takes a string value from a predefined list: AWS or Sandbox. The catalog determines which environment the engagement context is updated in.

      Returns:
      Specifies the catalog associated with the engagement context update request. This field takes a string value from a predefined list: AWS or Sandbox. The catalog determines which environment the engagement context is updated in.

    • engagementIdentifier

      public final String engagementIdentifier()

      The unique identifier of the Engagement containing the context to be updated. This parameter ensures the context update is applied to the correct engagement.

      Returns:
      The unique identifier of the Engagement containing the context to be updated. This parameter ensures the context update is applied to the correct engagement.

    • contextIdentifier

      public final String contextIdentifier()

      The unique identifier of the specific engagement context to be updated. This ensures that the correct context within the engagement is modified.

      Returns:
      The unique identifier of the specific engagement context to be updated. This ensures that the correct context within the engagement is modified.

    • engagementLastModifiedAt

      public final Instant engagementLastModifiedAt()

      The timestamp when the engagement was last modified, used for optimistic concurrency control. This helps prevent conflicts when multiple users attempt to update the same engagement simultaneously.

      Returns:
      The timestamp when the engagement was last modified, used for optimistic concurrency control. This helps prevent conflicts when multiple users attempt to update the same engagement simultaneously.

    • type

      public final EngagementContextType type()

      Specifies the type of context being updated within the engagement. This field determines the structure and content of the context payload being modified.

      If the service returns an enum value that is not available in the current SDK version, type will return EngagementContextType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

      Returns:
      Specifies the type of context being updated within the engagement. This field determines the structure and content of the context payload being modified.
      See Also:

    • typeAsString

      public final String typeAsString()

      Specifies the type of context being updated within the engagement. This field determines the structure and content of the context payload being modified.

      If the service returns an enum value that is not available in the current SDK version, type will return EngagementContextType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

      Returns:
      Specifies the type of context being updated within the engagement. This field determines the structure and content of the context payload being modified.
      See Also:

    • payload

      public final UpdateEngagementContextPayload payload()

      Contains the updated contextual information for the engagement. The structure of this payload varies based on the context type specified in the Type field.

      Returns:
      Contains the updated contextual information for the engagement. The structure of this payload varies based on the context type specified in the Type field.

    • toBuilder

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

    • builder

      public static UpdateEngagementContextRequest.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. 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 SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      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.