software.amazon.awssdk.services.ssmcontacts.model

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(value="software.amazon.awssdk:codegen")
public final class AcceptPageRequest
extends SsmContactsRequest
implements ToCopyableBuilder<AcceptPageRequest.Builder,AcceptPageRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AcceptPageRequest.Builder

Method Summary

Modifier and Type	Method and Description
String	acceptCode() The accept code is a 6-digit code used to acknowledge the page.
AcceptCodeValidation	acceptCodeValidation() An optional field that Incident Manager uses to ENFORCE AcceptCode validation when acknowledging an page.
String	acceptCodeValidationAsString() An optional field that Incident Manager uses to ENFORCE AcceptCode validation when acknowledging an page.
AcceptType	acceptType() The type indicates if the page was DELIVERED or READ.
String	acceptTypeAsString() The type indicates if the page was DELIVERED or READ.
static AcceptPageRequest.Builder	builder()
String	contactChannelId() The ARN of the contact channel.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	note() Information provided by the user when the user acknowledges the page.
String	pageId() The Amazon Resource Name (ARN) of the engagement to a contact channel.
List<SdkField<?>>	sdkFields()
static Class<? extends AcceptPageRequest.Builder>	serializableBuilderClass()
AcceptPageRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

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:

AcceptType

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:

AcceptType

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

The accept code is a 6-digit code used to acknowledge the page.

Returns:

The accept code is 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:

AcceptCodeValidation

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:

AcceptCodeValidation

toBuilder

public AcceptPageRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AcceptPageRequest.Builder,AcceptPageRequest>

Specified by:

toBuilder in class SsmContactsRequest

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo