Class AcceptPageRequest

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

  • Method Details

    • pageId

      public final String pageId()

      The Amazon Resource Name (ARN) of the engagement to a contact channel.

      Returns:
      The Amazon Resource Name (ARN) of the engagement to a contact channel.

    • contactChannelId

      public final String contactChannelId()

      The ARN of the contact channel.

      Returns:
      The ARN of the contact channel.

    • acceptType

      public final AcceptType acceptType()

      The type indicates if the page was DELIVERED or READ.

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

      Returns:
      The type indicates if the page was DELIVERED or READ.
      See Also:

    • acceptTypeAsString

      public final String acceptTypeAsString()

      The type indicates if the page was DELIVERED or READ.

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

      Returns:
      The type indicates if the page was DELIVERED or READ.
      See Also:

    • note

      public final String note()

      Information provided by the user when the user acknowledges the page.

      Returns:
      Information provided by the user when the user acknowledges the page.

    • acceptCode

      public final String acceptCode()

      A 6-digit code used to acknowledge the page.

      Returns:
      A 6-digit code used to acknowledge the page.

    • acceptCodeValidation

      public final AcceptCodeValidation acceptCodeValidation()

      An optional field that Incident Manager uses to ENFORCE AcceptCode validation when acknowledging an page. Acknowledgement can occur by replying to a page, or when entering the AcceptCode in the console. Enforcing AcceptCode validation causes Incident Manager to verify that the code entered by the user matches the code sent by Incident Manager with the page.

      Incident Manager can also IGNORE AcceptCode validation. Ignoring AcceptCode validation causes Incident Manager to accept any value entered for the AcceptCode.

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

      Returns:
      An optional field that Incident Manager uses to ENFORCE AcceptCode validation when acknowledging an page. Acknowledgement can occur by replying to a page, or when entering the AcceptCode in the console. Enforcing AcceptCode validation causes Incident Manager to verify that the code entered by the user matches the code sent by Incident Manager with the page.

      Incident Manager can also IGNORE AcceptCode validation. Ignoring AcceptCode validation causes Incident Manager to accept any value entered for the AcceptCode.

      See Also:

    • acceptCodeValidationAsString

      public final String acceptCodeValidationAsString()

      An optional field that Incident Manager uses to ENFORCE AcceptCode validation when acknowledging an page. Acknowledgement can occur by replying to a page, or when entering the AcceptCode in the console. Enforcing AcceptCode validation causes Incident Manager to verify that the code entered by the user matches the code sent by Incident Manager with the page.

      Incident Manager can also IGNORE AcceptCode validation. Ignoring AcceptCode validation causes Incident Manager to accept any value entered for the AcceptCode.

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

      Returns:
      An optional field that Incident Manager uses to ENFORCE AcceptCode validation when acknowledging an page. Acknowledgement can occur by replying to a page, or when entering the AcceptCode in the console. Enforcing AcceptCode validation causes Incident Manager to verify that the code entered by the user matches the code sent by Incident Manager with the page.

      Incident Manager can also IGNORE AcceptCode validation. Ignoring AcceptCode validation causes Incident Manager to accept any value entered for the AcceptCode.

      See Also:

    • toBuilder

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

    • builder

      public static AcceptPageRequest.Builder builder()

    • serializableBuilderClass

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