com.amazonaws.services.ssmcontacts.model.AcceptPageRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-ssmcontacts Show documentation
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.ssmcontacts.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class AcceptPageRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The Amazon Resource Name (ARN) of the engagement to a contact channel.
*
*/
private String pageId;
/**
*
* The ARN of the contact channel.
*
*/
private String contactChannelId;
/**
*
* The type indicates if the page was DELIVERED or READ.
*
*/
private String acceptType;
/**
*
* Information provided by the user when the user acknowledges the page.
*
*/
private String note;
/**
*
* A 6-digit code used to acknowledge the page.
*
*/
private String acceptCode;
/**
*
* 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.
*
*/
private String acceptCodeValidation;
/**
*
* The Amazon Resource Name (ARN) of the engagement to a contact channel.
*
*
* @param pageId
* The Amazon Resource Name (ARN) of the engagement to a contact channel.
*/
public void setPageId(String pageId) {
this.pageId = pageId;
}
/**
*
* The Amazon Resource Name (ARN) of the engagement to a contact channel.
*
*
* @return The Amazon Resource Name (ARN) of the engagement to a contact channel.
*/
public String getPageId() {
return this.pageId;
}
/**
*
* The Amazon Resource Name (ARN) of the engagement to a contact channel.
*
*
* @param pageId
* The Amazon Resource Name (ARN) of the engagement to a contact channel.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public AcceptPageRequest withPageId(String pageId) {
setPageId(pageId);
return this;
}
/**
*
* The ARN of the contact channel.
*
*
* @param contactChannelId
* The ARN of the contact channel.
*/
public void setContactChannelId(String contactChannelId) {
this.contactChannelId = contactChannelId;
}
/**
*
* The ARN of the contact channel.
*
*
* @return The ARN of the contact channel.
*/
public String getContactChannelId() {
return this.contactChannelId;
}
/**
*
* The ARN of the contact channel.
*
*
* @param contactChannelId
* The ARN of the contact channel.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public AcceptPageRequest withContactChannelId(String contactChannelId) {
setContactChannelId(contactChannelId);
return this;
}
/**
*
* The type indicates if the page was DELIVERED or READ.
*
*
* @param acceptType
* The type indicates if the page was DELIVERED or READ.
* @see AcceptType
*/
public void setAcceptType(String acceptType) {
this.acceptType = acceptType;
}
/**
*
* The type indicates if the page was DELIVERED or READ.
*
*
* @return The type indicates if the page was DELIVERED or READ.
* @see AcceptType
*/
public String getAcceptType() {
return this.acceptType;
}
/**
*
* The type indicates if the page was DELIVERED or READ.
*
*
* @param acceptType
* The type indicates if the page was DELIVERED or READ.
* @return Returns a reference to this object so that method calls can be chained together.
* @see AcceptType
*/
public AcceptPageRequest withAcceptType(String acceptType) {
setAcceptType(acceptType);
return this;
}
/**
*
* The type indicates if the page was DELIVERED or READ.
*
*
* @param acceptType
* The type indicates if the page was DELIVERED or READ.
* @return Returns a reference to this object so that method calls can be chained together.
* @see AcceptType
*/
public AcceptPageRequest withAcceptType(AcceptType acceptType) {
this.acceptType = acceptType.toString();
return this;
}
/**
*
* Information provided by the user when the user acknowledges the page.
*
*
* @param note
* Information provided by the user when the user acknowledges the page.
*/
public void setNote(String note) {
this.note = note;
}
/**
*
* Information provided by the user when the user acknowledges the page.
*
*
* @return Information provided by the user when the user acknowledges the page.
*/
public String getNote() {
return this.note;
}
/**
*
* Information provided by the user when the user acknowledges the page.
*
*
* @param note
* Information provided by the user when the user acknowledges the page.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public AcceptPageRequest withNote(String note) {
setNote(note);
return this;
}
/**
*
* A 6-digit code used to acknowledge the page.
*
*
* @param acceptCode
* A 6-digit code used to acknowledge the page.
*/
public void setAcceptCode(String acceptCode) {
this.acceptCode = acceptCode;
}
/**
*
* A 6-digit code used to acknowledge the page.
*
*
* @return A 6-digit code used to acknowledge the page.
*/
public String getAcceptCode() {
return this.acceptCode;
}
/**
*
* A 6-digit code used to acknowledge the page.
*
*
* @param acceptCode
* A 6-digit code used to acknowledge the page.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public AcceptPageRequest withAcceptCode(String acceptCode) {
setAcceptCode(acceptCode);
return this;
}
/**
*
* 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.
*
*
* @param 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.
* @see AcceptCodeValidation
*/
public void setAcceptCodeValidation(String acceptCodeValidation) {
this.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.
*
*
* @return 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 AcceptCodeValidation
*/
public String getAcceptCodeValidation() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
* @see AcceptCodeValidation
*/
public AcceptPageRequest withAcceptCodeValidation(String acceptCodeValidation) {
setAcceptCodeValidation(acceptCodeValidation);
return this;
}
/**
*
* 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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
* @see AcceptCodeValidation
*/
public AcceptPageRequest withAcceptCodeValidation(AcceptCodeValidation acceptCodeValidation) {
this.acceptCodeValidation = acceptCodeValidation.toString();
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getPageId() != null)
sb.append("PageId: ").append(getPageId()).append(",");
if (getContactChannelId() != null)
sb.append("ContactChannelId: ").append(getContactChannelId()).append(",");
if (getAcceptType() != null)
sb.append("AcceptType: ").append(getAcceptType()).append(",");
if (getNote() != null)
sb.append("Note: ").append(getNote()).append(",");
if (getAcceptCode() != null)
sb.append("AcceptCode: ").append(getAcceptCode()).append(",");
if (getAcceptCodeValidation() != null)
sb.append("AcceptCodeValidation: ").append(getAcceptCodeValidation());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof AcceptPageRequest == false)
return false;
AcceptPageRequest other = (AcceptPageRequest) obj;
if (other.getPageId() == null ^ this.getPageId() == null)
return false;
if (other.getPageId() != null && other.getPageId().equals(this.getPageId()) == false)
return false;
if (other.getContactChannelId() == null ^ this.getContactChannelId() == null)
return false;
if (other.getContactChannelId() != null && other.getContactChannelId().equals(this.getContactChannelId()) == false)
return false;
if (other.getAcceptType() == null ^ this.getAcceptType() == null)
return false;
if (other.getAcceptType() != null && other.getAcceptType().equals(this.getAcceptType()) == false)
return false;
if (other.getNote() == null ^ this.getNote() == null)
return false;
if (other.getNote() != null && other.getNote().equals(this.getNote()) == false)
return false;
if (other.getAcceptCode() == null ^ this.getAcceptCode() == null)
return false;
if (other.getAcceptCode() != null && other.getAcceptCode().equals(this.getAcceptCode()) == false)
return false;
if (other.getAcceptCodeValidation() == null ^ this.getAcceptCodeValidation() == null)
return false;
if (other.getAcceptCodeValidation() != null && other.getAcceptCodeValidation().equals(this.getAcceptCodeValidation()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getPageId() == null) ? 0 : getPageId().hashCode());
hashCode = prime * hashCode + ((getContactChannelId() == null) ? 0 : getContactChannelId().hashCode());
hashCode = prime * hashCode + ((getAcceptType() == null) ? 0 : getAcceptType().hashCode());
hashCode = prime * hashCode + ((getNote() == null) ? 0 : getNote().hashCode());
hashCode = prime * hashCode + ((getAcceptCode() == null) ? 0 : getAcceptCode().hashCode());
hashCode = prime * hashCode + ((getAcceptCodeValidation() == null) ? 0 : getAcceptCodeValidation().hashCode());
return hashCode;
}
@Override
public AcceptPageRequest clone() {
return (AcceptPageRequest) super.clone();
}
}