com.amazonaws.services.ssmcontacts.model.CreateContactChannelRequest 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 CreateContactChannelRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The Amazon Resource Name (ARN) of the contact you are adding the contact channel to.
*
*/
private String contactId;
/**
*
* The name of the contact channel.
*
*/
private String name;
/**
*
* Incident Manager supports three types of contact channels:
*
*
* -
*
* SMS
*
*
* -
*
* VOICE
*
*
* -
*
* EMAIL
*
*
*
*/
private String type;
/**
*
* The details that Incident Manager uses when trying to engage the contact channel. The format is dependent on the
* type of the contact channel. The following are the expected formats:
*
*
* -
*
* SMS - '+' followed by the country code and phone number
*
*
* -
*
* VOICE - '+' followed by the country code and phone number
*
*
* -
*
* EMAIL - any standard email format
*
*
*
*/
private ContactChannelAddress deliveryAddress;
/**
*
* If you want to activate the channel at a later time, you can choose to defer activation. Incident Manager can't
* engage your contact channel until it has been activated.
*
*/
private Boolean deferActivation;
/**
*
* A token ensuring that the operation is called only once with the specified details.
*
*/
private String idempotencyToken;
/**
*
* The Amazon Resource Name (ARN) of the contact you are adding the contact channel to.
*
*
* @param contactId
* The Amazon Resource Name (ARN) of the contact you are adding the contact channel to.
*/
public void setContactId(String contactId) {
this.contactId = contactId;
}
/**
*
* The Amazon Resource Name (ARN) of the contact you are adding the contact channel to.
*
*
* @return The Amazon Resource Name (ARN) of the contact you are adding the contact channel to.
*/
public String getContactId() {
return this.contactId;
}
/**
*
* The Amazon Resource Name (ARN) of the contact you are adding the contact channel to.
*
*
* @param contactId
* The Amazon Resource Name (ARN) of the contact you are adding the contact channel to.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateContactChannelRequest withContactId(String contactId) {
setContactId(contactId);
return this;
}
/**
*
* The name of the contact channel.
*
*
* @param name
* The name of the contact channel.
*/
public void setName(String name) {
this.name = name;
}
/**
*
* The name of the contact channel.
*
*
* @return The name of the contact channel.
*/
public String getName() {
return this.name;
}
/**
*
* The name of the contact channel.
*
*
* @param name
* The name of the contact channel.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateContactChannelRequest withName(String name) {
setName(name);
return this;
}
/**
*
* Incident Manager supports three types of contact channels:
*
*
* -
*
* SMS
*
*
* -
*
* VOICE
*
*
* -
*
* EMAIL
*
*
*
*
* @param type
* Incident Manager supports three types of contact channels:
*
* -
*
* SMS
*
*
* -
*
* VOICE
*
*
* -
*
* EMAIL
*
*
* @see ChannelType
*/
public void setType(String type) {
this.type = type;
}
/**
*
* Incident Manager supports three types of contact channels:
*
*
* -
*
* SMS
*
*
* -
*
* VOICE
*
*
* -
*
* EMAIL
*
*
*
*
* @return Incident Manager supports three types of contact channels:
*
* -
*
* SMS
*
*
* -
*
* VOICE
*
*
* -
*
* EMAIL
*
*
* @see ChannelType
*/
public String getType() {
return this.type;
}
/**
*
* Incident Manager supports three types of contact channels:
*
*
* -
*
* SMS
*
*
* -
*
* VOICE
*
*
* -
*
* EMAIL
*
*
*
*
* @param type
* Incident Manager supports three types of contact channels:
*
* -
*
* SMS
*
*
* -
*
* VOICE
*
*
* -
*
* EMAIL
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see ChannelType
*/
public CreateContactChannelRequest withType(String type) {
setType(type);
return this;
}
/**
*
* Incident Manager supports three types of contact channels:
*
*
* -
*
* SMS
*
*
* -
*
* VOICE
*
*
* -
*
* EMAIL
*
*
*
*
* @param type
* Incident Manager supports three types of contact channels:
*
* -
*
* SMS
*
*
* -
*
* VOICE
*
*
* -
*
* EMAIL
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see ChannelType
*/
public CreateContactChannelRequest withType(ChannelType type) {
this.type = type.toString();
return this;
}
/**
*
* The details that Incident Manager uses when trying to engage the contact channel. The format is dependent on the
* type of the contact channel. The following are the expected formats:
*
*
* -
*
* SMS - '+' followed by the country code and phone number
*
*
* -
*
* VOICE - '+' followed by the country code and phone number
*
*
* -
*
* EMAIL - any standard email format
*
*
*
*
* @param deliveryAddress
* The details that Incident Manager uses when trying to engage the contact channel. The format is dependent
* on the type of the contact channel. The following are the expected formats:
*
* -
*
* SMS - '+' followed by the country code and phone number
*
*
* -
*
* VOICE - '+' followed by the country code and phone number
*
*
* -
*
* EMAIL - any standard email format
*
*
*/
public void setDeliveryAddress(ContactChannelAddress deliveryAddress) {
this.deliveryAddress = deliveryAddress;
}
/**
*
* The details that Incident Manager uses when trying to engage the contact channel. The format is dependent on the
* type of the contact channel. The following are the expected formats:
*
*
* -
*
* SMS - '+' followed by the country code and phone number
*
*
* -
*
* VOICE - '+' followed by the country code and phone number
*
*
* -
*
* EMAIL - any standard email format
*
*
*
*
* @return The details that Incident Manager uses when trying to engage the contact channel. The format is dependent
* on the type of the contact channel. The following are the expected formats:
*
* -
*
* SMS - '+' followed by the country code and phone number
*
*
* -
*
* VOICE - '+' followed by the country code and phone number
*
*
* -
*
* EMAIL - any standard email format
*
*
*/
public ContactChannelAddress getDeliveryAddress() {
return this.deliveryAddress;
}
/**
*
* The details that Incident Manager uses when trying to engage the contact channel. The format is dependent on the
* type of the contact channel. The following are the expected formats:
*
*
* -
*
* SMS - '+' followed by the country code and phone number
*
*
* -
*
* VOICE - '+' followed by the country code and phone number
*
*
* -
*
* EMAIL - any standard email format
*
*
*
*
* @param deliveryAddress
* The details that Incident Manager uses when trying to engage the contact channel. The format is dependent
* on the type of the contact channel. The following are the expected formats:
*
* -
*
* SMS - '+' followed by the country code and phone number
*
*
* -
*
* VOICE - '+' followed by the country code and phone number
*
*
* -
*
* EMAIL - any standard email format
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateContactChannelRequest withDeliveryAddress(ContactChannelAddress deliveryAddress) {
setDeliveryAddress(deliveryAddress);
return this;
}
/**
*
* If you want to activate the channel at a later time, you can choose to defer activation. Incident Manager can't
* engage your contact channel until it has been activated.
*
*
* @param deferActivation
* If you want to activate the channel at a later time, you can choose to defer activation. Incident Manager
* can't engage your contact channel until it has been activated.
*/
public void setDeferActivation(Boolean deferActivation) {
this.deferActivation = deferActivation;
}
/**
*
* If you want to activate the channel at a later time, you can choose to defer activation. Incident Manager can't
* engage your contact channel until it has been activated.
*
*
* @return If you want to activate the channel at a later time, you can choose to defer activation. Incident Manager
* can't engage your contact channel until it has been activated.
*/
public Boolean getDeferActivation() {
return this.deferActivation;
}
/**
*
* If you want to activate the channel at a later time, you can choose to defer activation. Incident Manager can't
* engage your contact channel until it has been activated.
*
*
* @param deferActivation
* If you want to activate the channel at a later time, you can choose to defer activation. Incident Manager
* can't engage your contact channel until it has been activated.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateContactChannelRequest withDeferActivation(Boolean deferActivation) {
setDeferActivation(deferActivation);
return this;
}
/**
*
* If you want to activate the channel at a later time, you can choose to defer activation. Incident Manager can't
* engage your contact channel until it has been activated.
*
*
* @return If you want to activate the channel at a later time, you can choose to defer activation. Incident Manager
* can't engage your contact channel until it has been activated.
*/
public Boolean isDeferActivation() {
return this.deferActivation;
}
/**
*
* A token ensuring that the operation is called only once with the specified details.
*
*
* @param idempotencyToken
* A token ensuring that the operation is called only once with the specified details.
*/
public void setIdempotencyToken(String idempotencyToken) {
this.idempotencyToken = idempotencyToken;
}
/**
*
* A token ensuring that the operation is called only once with the specified details.
*
*
* @return A token ensuring that the operation is called only once with the specified details.
*/
public String getIdempotencyToken() {
return this.idempotencyToken;
}
/**
*
* A token ensuring that the operation is called only once with the specified details.
*
*
* @param idempotencyToken
* A token ensuring that the operation is called only once with the specified details.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateContactChannelRequest withIdempotencyToken(String idempotencyToken) {
setIdempotencyToken(idempotencyToken);
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 (getContactId() != null)
sb.append("ContactId: ").append(getContactId()).append(",");
if (getName() != null)
sb.append("Name: ").append(getName()).append(",");
if (getType() != null)
sb.append("Type: ").append(getType()).append(",");
if (getDeliveryAddress() != null)
sb.append("DeliveryAddress: ").append(getDeliveryAddress()).append(",");
if (getDeferActivation() != null)
sb.append("DeferActivation: ").append(getDeferActivation()).append(",");
if (getIdempotencyToken() != null)
sb.append("IdempotencyToken: ").append(getIdempotencyToken());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof CreateContactChannelRequest == false)
return false;
CreateContactChannelRequest other = (CreateContactChannelRequest) obj;
if (other.getContactId() == null ^ this.getContactId() == null)
return false;
if (other.getContactId() != null && other.getContactId().equals(this.getContactId()) == false)
return false;
if (other.getName() == null ^ this.getName() == null)
return false;
if (other.getName() != null && other.getName().equals(this.getName()) == false)
return false;
if (other.getType() == null ^ this.getType() == null)
return false;
if (other.getType() != null && other.getType().equals(this.getType()) == false)
return false;
if (other.getDeliveryAddress() == null ^ this.getDeliveryAddress() == null)
return false;
if (other.getDeliveryAddress() != null && other.getDeliveryAddress().equals(this.getDeliveryAddress()) == false)
return false;
if (other.getDeferActivation() == null ^ this.getDeferActivation() == null)
return false;
if (other.getDeferActivation() != null && other.getDeferActivation().equals(this.getDeferActivation()) == false)
return false;
if (other.getIdempotencyToken() == null ^ this.getIdempotencyToken() == null)
return false;
if (other.getIdempotencyToken() != null && other.getIdempotencyToken().equals(this.getIdempotencyToken()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getContactId() == null) ? 0 : getContactId().hashCode());
hashCode = prime * hashCode + ((getName() == null) ? 0 : getName().hashCode());
hashCode = prime * hashCode + ((getType() == null) ? 0 : getType().hashCode());
hashCode = prime * hashCode + ((getDeliveryAddress() == null) ? 0 : getDeliveryAddress().hashCode());
hashCode = prime * hashCode + ((getDeferActivation() == null) ? 0 : getDeferActivation().hashCode());
hashCode = prime * hashCode + ((getIdempotencyToken() == null) ? 0 : getIdempotencyToken().hashCode());
return hashCode;
}
@Override
public CreateContactChannelRequest clone() {
return (CreateContactChannelRequest) super.clone();
}
}