/* * Copyright 2010-2023 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.connect.model; import java.io.Serializable; import com.amazonaws.AmazonWebServiceRequest; /** *

* Initiates silent monitoring of a contact. The Contact Control Panel (CCP) of * the user specified by userId will be set to silent monitoring mode on * the contact. *

*/ public class MonitorContactRequest extends AmazonWebServiceRequest implements Serializable { /** *

* The identifier of the Amazon Connect instance. You can find the * instanceId in the ARN of the instance. *

*

* Constraints:
* Length: 1 - 100
*/ private String instanceId; /** *

* The identifier of the contact. *

*

* Constraints:
* Length: 1 - 256
*/ private String contactId; /** *

* The identifier of the user account. *

*

* Constraints:
* Length: 1 - 256
*/ private String userId; /** *

* Specify which monitoring actions the user is allowed to take. For * example, whether the user is allowed to escalate from silent monitoring * to barge. *

*/ private java.util.List allowedMonitorCapabilities; /** *

* A unique, case-sensitive identifier that you provide to ensure the * idempotency of the request. If not provided, the Amazon Web Services SDK * populates this field. For more information about idempotency, see Making retries safe with idempotent APIs. *

*

* Constraints:
* Length: - 500
*/ private String clientToken; /** *

* The identifier of the Amazon Connect instance. You can find the * instanceId in the ARN of the instance. *

*

* Constraints:
* Length: 1 - 100
* * @return

* The identifier of the Amazon Connect instance. You can find the * instanceId in the ARN of the instance. *

*/ public String getInstanceId() { return instanceId; } /** *

* The identifier of the Amazon Connect instance. You can find the * instanceId in the ARN of the instance. *

*

* Constraints:
* Length: 1 - 100
* * @param instanceId

* The identifier of the Amazon Connect instance. You can find * the instanceId in the ARN of the instance. *

*/ public void setInstanceId(String instanceId) { this.instanceId = instanceId; } /** *

* The identifier of the Amazon Connect instance. You can find the * instanceId in the ARN of the instance. *

*

* Returns a reference to this object so that method calls can be chained * together. *

* Constraints:
* Length: 1 - 100
* * @param instanceId

* The identifier of the Amazon Connect instance. You can find * the instanceId in the ARN of the instance. *

* @return A reference to this updated object so that method calls can be * chained together. */ public MonitorContactRequest withInstanceId(String instanceId) { this.instanceId = instanceId; return this; } /** *

* The identifier of the contact. *

*

* Constraints:
* Length: 1 - 256
* * @return

* The identifier of the contact. *

*/ public String getContactId() { return contactId; } /** *

* The identifier of the contact. *

*

* Constraints:
* Length: 1 - 256
* * @param contactId

* The identifier of the contact. *

*/ public void setContactId(String contactId) { this.contactId = contactId; } /** *

* The identifier of the contact. *

*

* Returns a reference to this object so that method calls can be chained * together. *

* Constraints:
* Length: 1 - 256
* * @param contactId

* The identifier of the contact. *

* @return A reference to this updated object so that method calls can be * chained together. */ public MonitorContactRequest withContactId(String contactId) { this.contactId = contactId; return this; } /** *

* The identifier of the user account. *

*

* Constraints:
* Length: 1 - 256
* * @return

* The identifier of the user account. *

*/ public String getUserId() { return userId; } /** *

* The identifier of the user account. *

*

* Constraints:
* Length: 1 - 256
* * @param userId

* The identifier of the user account. *

*/ public void setUserId(String userId) { this.userId = userId; } /** *

* The identifier of the user account. *

*

* Returns a reference to this object so that method calls can be chained * together. *

* Constraints:
* Length: 1 - 256
* * @param userId

* The identifier of the user account. *

* @return A reference to this updated object so that method calls can be * chained together. */ public MonitorContactRequest withUserId(String userId) { this.userId = userId; return this; } /** *

* Specify which monitoring actions the user is allowed to take. For * example, whether the user is allowed to escalate from silent monitoring * to barge. *

* * @return

* Specify which monitoring actions the user is allowed to take. For * example, whether the user is allowed to escalate from silent * monitoring to barge. *

*/ public java.util.List getAllowedMonitorCapabilities() { return allowedMonitorCapabilities; } /** *

* Specify which monitoring actions the user is allowed to take. For * example, whether the user is allowed to escalate from silent monitoring * to barge. *

* * @param allowedMonitorCapabilities

* Specify which monitoring actions the user is allowed to take. * For example, whether the user is allowed to escalate from * silent monitoring to barge. *

*/ public void setAllowedMonitorCapabilities( java.util.Collection allowedMonitorCapabilities) { if (allowedMonitorCapabilities == null) { this.allowedMonitorCapabilities = null; return; } this.allowedMonitorCapabilities = new java.util.ArrayList( allowedMonitorCapabilities); } /** *

* Specify which monitoring actions the user is allowed to take. For * example, whether the user is allowed to escalate from silent monitoring * to barge. *

*

* Returns a reference to this object so that method calls can be chained * together. * * @param allowedMonitorCapabilities

* Specify which monitoring actions the user is allowed to take. * For example, whether the user is allowed to escalate from * silent monitoring to barge. *

* @return A reference to this updated object so that method calls can be * chained together. */ public MonitorContactRequest withAllowedMonitorCapabilities( String... allowedMonitorCapabilities) { if (getAllowedMonitorCapabilities() == null) { this.allowedMonitorCapabilities = new java.util.ArrayList( allowedMonitorCapabilities.length); } for (String value : allowedMonitorCapabilities) { this.allowedMonitorCapabilities.add(value); } return this; } /** *

* Specify which monitoring actions the user is allowed to take. For * example, whether the user is allowed to escalate from silent monitoring * to barge. *

*

* Returns a reference to this object so that method calls can be chained * together. * * @param allowedMonitorCapabilities

* Specify which monitoring actions the user is allowed to take. * For example, whether the user is allowed to escalate from * silent monitoring to barge. *

* @return A reference to this updated object so that method calls can be * chained together. */ public MonitorContactRequest withAllowedMonitorCapabilities( java.util.Collection allowedMonitorCapabilities) { setAllowedMonitorCapabilities(allowedMonitorCapabilities); return this; } /** *

* A unique, case-sensitive identifier that you provide to ensure the * idempotency of the request. If not provided, the Amazon Web Services SDK * populates this field. For more information about idempotency, see Making retries safe with idempotent APIs. *

*

* Constraints:
* Length: - 500
* * @return

* A unique, case-sensitive identifier that you provide to ensure * the idempotency of the request. If not provided, the Amazon Web * Services SDK populates this field. For more information about * idempotency, see Making retries safe with idempotent APIs. *

*/ public String getClientToken() { return clientToken; } /** *

* A unique, case-sensitive identifier that you provide to ensure the * idempotency of the request. If not provided, the Amazon Web Services SDK * populates this field. For more information about idempotency, see Making retries safe with idempotent APIs. *

*

* Constraints:
* Length: - 500
* * @param clientToken

* A unique, case-sensitive identifier that you provide to ensure * the idempotency of the request. If not provided, the Amazon * Web Services SDK populates this field. For more information * about idempotency, see Making retries safe with idempotent APIs. *

*/ public void setClientToken(String clientToken) { this.clientToken = clientToken; } /** *

* A unique, case-sensitive identifier that you provide to ensure the * idempotency of the request. If not provided, the Amazon Web Services SDK * populates this field. For more information about idempotency, see Making retries safe with idempotent APIs. *

*

* Returns a reference to this object so that method calls can be chained * together. *

* Constraints:
* Length: - 500
* * @param clientToken

* A unique, case-sensitive identifier that you provide to ensure * the idempotency of the request. If not provided, the Amazon * Web Services SDK populates this field. For more information * about idempotency, see Making retries safe with idempotent APIs. *

* @return A reference to this updated object so that method calls can be * chained together. */ public MonitorContactRequest withClientToken(String clientToken) { this.clientToken = clientToken; return this; } /** * Returns a string representation of this object; useful for testing and * debugging. * * @return A string representation of this object. * @see java.lang.Object#toString() */ @Override public String toString() { StringBuilder sb = new StringBuilder(); sb.append("{"); if (getInstanceId() != null) sb.append("InstanceId: " + getInstanceId() + ","); if (getContactId() != null) sb.append("ContactId: " + getContactId() + ","); if (getUserId() != null) sb.append("UserId: " + getUserId() + ","); if (getAllowedMonitorCapabilities() != null) sb.append("AllowedMonitorCapabilities: " + getAllowedMonitorCapabilities() + ","); if (getClientToken() != null) sb.append("ClientToken: " + getClientToken()); sb.append("}"); return sb.toString(); } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getInstanceId() == null) ? 0 : getInstanceId().hashCode()); hashCode = prime * hashCode + ((getContactId() == null) ? 0 : getContactId().hashCode()); hashCode = prime * hashCode + ((getUserId() == null) ? 0 : getUserId().hashCode()); hashCode = prime * hashCode + ((getAllowedMonitorCapabilities() == null) ? 0 : getAllowedMonitorCapabilities() .hashCode()); hashCode = prime * hashCode + ((getClientToken() == null) ? 0 : getClientToken().hashCode()); return hashCode; } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof MonitorContactRequest == false) return false; MonitorContactRequest other = (MonitorContactRequest) obj; if (other.getInstanceId() == null ^ this.getInstanceId() == null) return false; if (other.getInstanceId() != null && other.getInstanceId().equals(this.getInstanceId()) == false) return false; if (other.getContactId() == null ^ this.getContactId() == null) return false; if (other.getContactId() != null && other.getContactId().equals(this.getContactId()) == false) return false; if (other.getUserId() == null ^ this.getUserId() == null) return false; if (other.getUserId() != null && other.getUserId().equals(this.getUserId()) == false) return false; if (other.getAllowedMonitorCapabilities() == null ^ this.getAllowedMonitorCapabilities() == null) return false; if (other.getAllowedMonitorCapabilities() != null && other.getAllowedMonitorCapabilities().equals( this.getAllowedMonitorCapabilities()) == false) return false; if (other.getClientToken() == null ^ this.getClientToken() == null) return false; if (other.getClientToken() != null && other.getClientToken().equals(this.getClientToken()) == false) return false; return true; } }