com.amazonaws.services.storagegateway.model.UpdateChapCredentialsRequest Maven / Gradle / Ivy
/*
* Copyright 2010-2014 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.storagegateway.model;
import java.io.Serializable;
import com.amazonaws.AmazonWebServiceRequest;
/**
* Container for the parameters to the {@link com.amazonaws.services.storagegateway.AWSStorageGateway#updateChapCredentials(UpdateChapCredentialsRequest) UpdateChapCredentials operation}.
*
* This operation updates the Challenge-Handshake Authentication Protocol
* (CHAP) credentials for a specified iSCSI target. By default, a gateway
* does not have CHAP enabled; however, for added security, you might use
* it.
*
*
* IMPORTANT: When you update CHAP credentials, all existing
* connections on the target are closed and initiators must reconnect
* with the new credentials.
*
*
* @see com.amazonaws.services.storagegateway.AWSStorageGateway#updateChapCredentials(UpdateChapCredentialsRequest)
*/
public class UpdateChapCredentialsRequest extends AmazonWebServiceRequest implements Serializable {
/**
* The Amazon Resource Name (ARN) of the iSCSI volume target. Use the
* DescribeStorediSCSIVolumes operation to return to retrieve the
* TargetARN for specified VolumeARN.
*
* Constraints:
* Length: 50 - 800
*/
private String targetARN;
/**
* The secret key that the initiator (e.g. Windows client) must provide
* to participate in mutual CHAP with the target.
*
* Constraints:
* Length: 12 - 16
*/
private String secretToAuthenticateInitiator;
/**
* The iSCSI initiator that connects to the target.
*
* Constraints:
* Length: 1 - 255
* Pattern: [0-9a-z:.-]+
*/
private String initiatorName;
/**
* The secret key that the target must provide to participate in mutual
* CHAP with the initiator (e.g. Windows client).
*
* Constraints:
* Length: 12 - 16
*/
private String secretToAuthenticateTarget;
/**
* The Amazon Resource Name (ARN) of the iSCSI volume target. Use the
* DescribeStorediSCSIVolumes operation to return to retrieve the
* TargetARN for specified VolumeARN.
*
* Constraints:
* Length: 50 - 800
*
* @return The Amazon Resource Name (ARN) of the iSCSI volume target. Use the
* DescribeStorediSCSIVolumes operation to return to retrieve the
* TargetARN for specified VolumeARN.
*/
public String getTargetARN() {
return targetARN;
}
/**
* The Amazon Resource Name (ARN) of the iSCSI volume target. Use the
* DescribeStorediSCSIVolumes operation to return to retrieve the
* TargetARN for specified VolumeARN.
*
* Constraints:
* Length: 50 - 800
*
* @param targetARN The Amazon Resource Name (ARN) of the iSCSI volume target. Use the
* DescribeStorediSCSIVolumes operation to return to retrieve the
* TargetARN for specified VolumeARN.
*/
public void setTargetARN(String targetARN) {
this.targetARN = targetARN;
}
/**
* The Amazon Resource Name (ARN) of the iSCSI volume target. Use the
* DescribeStorediSCSIVolumes operation to return to retrieve the
* TargetARN for specified VolumeARN.
*
* Returns a reference to this object so that method calls can be chained together.
*
* Constraints:
* Length: 50 - 800
*
* @param targetARN The Amazon Resource Name (ARN) of the iSCSI volume target. Use the
* DescribeStorediSCSIVolumes operation to return to retrieve the
* TargetARN for specified VolumeARN.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public UpdateChapCredentialsRequest withTargetARN(String targetARN) {
this.targetARN = targetARN;
return this;
}
/**
* The secret key that the initiator (e.g. Windows client) must provide
* to participate in mutual CHAP with the target.
*
* Constraints:
* Length: 12 - 16
*
* @return The secret key that the initiator (e.g. Windows client) must provide
* to participate in mutual CHAP with the target.
*/
public String getSecretToAuthenticateInitiator() {
return secretToAuthenticateInitiator;
}
/**
* The secret key that the initiator (e.g. Windows client) must provide
* to participate in mutual CHAP with the target.
*
* Constraints:
* Length: 12 - 16
*
* @param secretToAuthenticateInitiator The secret key that the initiator (e.g. Windows client) must provide
* to participate in mutual CHAP with the target.
*/
public void setSecretToAuthenticateInitiator(String secretToAuthenticateInitiator) {
this.secretToAuthenticateInitiator = secretToAuthenticateInitiator;
}
/**
* The secret key that the initiator (e.g. Windows client) must provide
* to participate in mutual CHAP with the target.
*
* Returns a reference to this object so that method calls can be chained together.
*
* Constraints:
* Length: 12 - 16
*
* @param secretToAuthenticateInitiator The secret key that the initiator (e.g. Windows client) must provide
* to participate in mutual CHAP with the target.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public UpdateChapCredentialsRequest withSecretToAuthenticateInitiator(String secretToAuthenticateInitiator) {
this.secretToAuthenticateInitiator = secretToAuthenticateInitiator;
return this;
}
/**
* The iSCSI initiator that connects to the target.
*
* Constraints:
* Length: 1 - 255
* Pattern: [0-9a-z:.-]+
*
* @return The iSCSI initiator that connects to the target.
*/
public String getInitiatorName() {
return initiatorName;
}
/**
* The iSCSI initiator that connects to the target.
*
* Constraints:
* Length: 1 - 255
* Pattern: [0-9a-z:.-]+
*
* @param initiatorName The iSCSI initiator that connects to the target.
*/
public void setInitiatorName(String initiatorName) {
this.initiatorName = initiatorName;
}
/**
* The iSCSI initiator that connects to the target.
*
* Returns a reference to this object so that method calls can be chained together.
*
* Constraints:
* Length: 1 - 255
* Pattern: [0-9a-z:.-]+
*
* @param initiatorName The iSCSI initiator that connects to the target.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public UpdateChapCredentialsRequest withInitiatorName(String initiatorName) {
this.initiatorName = initiatorName;
return this;
}
/**
* The secret key that the target must provide to participate in mutual
* CHAP with the initiator (e.g. Windows client).
*
* Constraints:
* Length: 12 - 16
*
* @return The secret key that the target must provide to participate in mutual
* CHAP with the initiator (e.g. Windows client).
*/
public String getSecretToAuthenticateTarget() {
return secretToAuthenticateTarget;
}
/**
* The secret key that the target must provide to participate in mutual
* CHAP with the initiator (e.g. Windows client).
*
* Constraints:
* Length: 12 - 16
*
* @param secretToAuthenticateTarget The secret key that the target must provide to participate in mutual
* CHAP with the initiator (e.g. Windows client).
*/
public void setSecretToAuthenticateTarget(String secretToAuthenticateTarget) {
this.secretToAuthenticateTarget = secretToAuthenticateTarget;
}
/**
* The secret key that the target must provide to participate in mutual
* CHAP with the initiator (e.g. Windows client).
*
* Returns a reference to this object so that method calls can be chained together.
*
* Constraints:
* Length: 12 - 16
*
* @param secretToAuthenticateTarget The secret key that the target must provide to participate in mutual
* CHAP with the initiator (e.g. Windows client).
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public UpdateChapCredentialsRequest withSecretToAuthenticateTarget(String secretToAuthenticateTarget) {
this.secretToAuthenticateTarget = secretToAuthenticateTarget;
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 (getTargetARN() != null) sb.append("TargetARN: " + getTargetARN() + ",");
if (getSecretToAuthenticateInitiator() != null) sb.append("SecretToAuthenticateInitiator: " + getSecretToAuthenticateInitiator() + ",");
if (getInitiatorName() != null) sb.append("InitiatorName: " + getInitiatorName() + ",");
if (getSecretToAuthenticateTarget() != null) sb.append("SecretToAuthenticateTarget: " + getSecretToAuthenticateTarget() );
sb.append("}");
return sb.toString();
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getTargetARN() == null) ? 0 : getTargetARN().hashCode());
hashCode = prime * hashCode + ((getSecretToAuthenticateInitiator() == null) ? 0 : getSecretToAuthenticateInitiator().hashCode());
hashCode = prime * hashCode + ((getInitiatorName() == null) ? 0 : getInitiatorName().hashCode());
hashCode = prime * hashCode + ((getSecretToAuthenticateTarget() == null) ? 0 : getSecretToAuthenticateTarget().hashCode());
return hashCode;
}
@Override
public boolean equals(Object obj) {
if (this == obj) return true;
if (obj == null) return false;
if (obj instanceof UpdateChapCredentialsRequest == false) return false;
UpdateChapCredentialsRequest other = (UpdateChapCredentialsRequest)obj;
if (other.getTargetARN() == null ^ this.getTargetARN() == null) return false;
if (other.getTargetARN() != null && other.getTargetARN().equals(this.getTargetARN()) == false) return false;
if (other.getSecretToAuthenticateInitiator() == null ^ this.getSecretToAuthenticateInitiator() == null) return false;
if (other.getSecretToAuthenticateInitiator() != null && other.getSecretToAuthenticateInitiator().equals(this.getSecretToAuthenticateInitiator()) == false) return false;
if (other.getInitiatorName() == null ^ this.getInitiatorName() == null) return false;
if (other.getInitiatorName() != null && other.getInitiatorName().equals(this.getInitiatorName()) == false) return false;
if (other.getSecretToAuthenticateTarget() == null ^ this.getSecretToAuthenticateTarget() == null) return false;
if (other.getSecretToAuthenticateTarget() != null && other.getSecretToAuthenticateTarget().equals(this.getSecretToAuthenticateTarget()) == false) return false;
return true;
}
}