Class AcceptPageRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<AcceptPageRequest.Builder,
AcceptPageRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
A 6-digit code used to acknowledge the page.final AcceptCodeValidation
An optional field that Incident Manager uses toENFORCE
AcceptCode
validation when acknowledging an page.final String
An optional field that Incident Manager uses toENFORCE
AcceptCode
validation when acknowledging an page.final AcceptType
The type indicates if the page wasDELIVERED
orREAD
.final String
The type indicates if the page wasDELIVERED
orREAD
.static AcceptPageRequest.Builder
builder()
final String
The ARN of the contact channel.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final String
note()
Information provided by the user when the user acknowledges the page.final String
pageId()
The Amazon Resource Name (ARN) of the engagement to a contact channel.static Class
<? extends AcceptPageRequest.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
The ARN of the contact channel.
- Returns:
- The ARN of the contact channel.
-
acceptType
The type indicates if the page was
DELIVERED
orREAD
.If the service returns an enum value that is not available in the current SDK version,
acceptType
will returnAcceptType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromacceptTypeAsString()
.- Returns:
- The type indicates if the page was
DELIVERED
orREAD
. - See Also:
-
acceptTypeAsString
The type indicates if the page was
DELIVERED
orREAD
.If the service returns an enum value that is not available in the current SDK version,
acceptType
will returnAcceptType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromacceptTypeAsString()
.- Returns:
- The type indicates if the page was
DELIVERED
orREAD
. - See Also:
-
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
A 6-digit code used to acknowledge the page.
- Returns:
- A 6-digit code used to acknowledge the page.
-
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. IgnoringAcceptCode
validation causes Incident Manager to accept any value entered for theAcceptCode
.If the service returns an enum value that is not available in the current SDK version,
acceptCodeValidation
will returnAcceptCodeValidation.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromacceptCodeValidationAsString()
.- 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. IgnoringAcceptCode
validation causes Incident Manager to accept any value entered for theAcceptCode
. - See Also:
-
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. IgnoringAcceptCode
validation causes Incident Manager to accept any value entered for theAcceptCode
.If the service returns an enum value that is not available in the current SDK version,
acceptCodeValidation
will returnAcceptCodeValidation.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromacceptCodeValidationAsString()
.- 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. IgnoringAcceptCode
validation causes Incident Manager to accept any value entered for theAcceptCode
. - See Also:
-
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 interfaceToCopyableBuilder<AcceptPageRequest.Builder,
AcceptPageRequest> - Specified by:
toBuilder
in classSsmContactsRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. 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, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- 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
-