* A unique identifier for the agreement. This identifier is returned when you create an agreement. *
*/ private String agreementId; /** ** A system-assigned unique identifier for a server instance. This is the specific server that the agreement uses. *
*/ private String serverId; /** ** To replace the existing description, provide a short description for the agreement. *
*/ private String description; /** ** You can update the status for the agreement, either activating an inactive agreement or the reverse. *
*/ private String status; /** ** A unique identifier for the AS2 local profile. *
** To change the local profile identifier, provide a new value here. *
*/ private String localProfileId; /** ** A unique identifier for the partner profile. To change the partner profile identifier, provide a new value here. *
*/ private String partnerProfileId; /** *
* To change the landing directory (folder) for files that are transferred, provide the bucket folder that you want
* to use; for example, /DOC-EXAMPLE-BUCKET/home/mydirectory .
*
* With AS2, you can send files by calling StartFileTransfer and specifying the file paths in the
* request parameter, SendFilePaths. We use the file’s parent directory (for example, for
* --send-file-paths /bucket/dir/file.txt, parent directory is /bucket/dir/) to
* temporarily store a processed AS2 message file, store the MDN when we receive them from the partner, and write a
* final JSON file containing relevant metadata of the transmission. So, the AccessRole needs to
* provide read and write access to the parent directory of the file location used in the
* StartFileTransfer request. Additionally, you need to provide read and write access to the parent
* directory of the files that you intend to send with StartFileTransfer.
*
* If you are using Basic authentication for your AS2 connector, the access role requires the
* secretsmanager:GetSecretValue permission for the secret. If the secret is encrypted using a
* customer-managed key instead of the Amazon Web Services managed key in Secrets Manager, then the role also needs
* the kms:Decrypt permission for that key.
*
* A unique identifier for the agreement. This identifier is returned when you create an agreement. *
* * @param agreementId * A unique identifier for the agreement. This identifier is returned when you create an agreement. */ public void setAgreementId(String agreementId) { this.agreementId = agreementId; } /** ** A unique identifier for the agreement. This identifier is returned when you create an agreement. *
* * @return A unique identifier for the agreement. This identifier is returned when you create an agreement. */ public String getAgreementId() { return this.agreementId; } /** ** A unique identifier for the agreement. This identifier is returned when you create an agreement. *
* * @param agreementId * A unique identifier for the agreement. This identifier is returned when you create an agreement. * @return Returns a reference to this object so that method calls can be chained together. */ public UpdateAgreementRequest withAgreementId(String agreementId) { setAgreementId(agreementId); return this; } /** ** A system-assigned unique identifier for a server instance. This is the specific server that the agreement uses. *
* * @param serverId * A system-assigned unique identifier for a server instance. This is the specific server that the agreement * uses. */ public void setServerId(String serverId) { this.serverId = serverId; } /** ** A system-assigned unique identifier for a server instance. This is the specific server that the agreement uses. *
* * @return A system-assigned unique identifier for a server instance. This is the specific server that the agreement * uses. */ public String getServerId() { return this.serverId; } /** ** A system-assigned unique identifier for a server instance. This is the specific server that the agreement uses. *
* * @param serverId * A system-assigned unique identifier for a server instance. This is the specific server that the agreement * uses. * @return Returns a reference to this object so that method calls can be chained together. */ public UpdateAgreementRequest withServerId(String serverId) { setServerId(serverId); return this; } /** ** To replace the existing description, provide a short description for the agreement. *
* * @param description * To replace the existing description, provide a short description for the agreement. */ public void setDescription(String description) { this.description = description; } /** ** To replace the existing description, provide a short description for the agreement. *
* * @return To replace the existing description, provide a short description for the agreement. */ public String getDescription() { return this.description; } /** ** To replace the existing description, provide a short description for the agreement. *
* * @param description * To replace the existing description, provide a short description for the agreement. * @return Returns a reference to this object so that method calls can be chained together. */ public UpdateAgreementRequest withDescription(String description) { setDescription(description); return this; } /** ** You can update the status for the agreement, either activating an inactive agreement or the reverse. *
* * @param status * You can update the status for the agreement, either activating an inactive agreement or the reverse. * @see AgreementStatusType */ public void setStatus(String status) { this.status = status; } /** ** You can update the status for the agreement, either activating an inactive agreement or the reverse. *
* * @return You can update the status for the agreement, either activating an inactive agreement or the reverse. * @see AgreementStatusType */ public String getStatus() { return this.status; } /** ** You can update the status for the agreement, either activating an inactive agreement or the reverse. *
* * @param status * You can update the status for the agreement, either activating an inactive agreement or the reverse. * @return Returns a reference to this object so that method calls can be chained together. * @see AgreementStatusType */ public UpdateAgreementRequest withStatus(String status) { setStatus(status); return this; } /** ** You can update the status for the agreement, either activating an inactive agreement or the reverse. *
* * @param status * You can update the status for the agreement, either activating an inactive agreement or the reverse. * @return Returns a reference to this object so that method calls can be chained together. * @see AgreementStatusType */ public UpdateAgreementRequest withStatus(AgreementStatusType status) { this.status = status.toString(); return this; } /** ** A unique identifier for the AS2 local profile. *
** To change the local profile identifier, provide a new value here. *
* * @param localProfileId * A unique identifier for the AS2 local profile. ** To change the local profile identifier, provide a new value here. */ public void setLocalProfileId(String localProfileId) { this.localProfileId = localProfileId; } /** *
* A unique identifier for the AS2 local profile. *
** To change the local profile identifier, provide a new value here. *
* * @return A unique identifier for the AS2 local profile. ** To change the local profile identifier, provide a new value here. */ public String getLocalProfileId() { return this.localProfileId; } /** *
* A unique identifier for the AS2 local profile. *
** To change the local profile identifier, provide a new value here. *
* * @param localProfileId * A unique identifier for the AS2 local profile. ** To change the local profile identifier, provide a new value here. * @return Returns a reference to this object so that method calls can be chained together. */ public UpdateAgreementRequest withLocalProfileId(String localProfileId) { setLocalProfileId(localProfileId); return this; } /** *
* A unique identifier for the partner profile. To change the partner profile identifier, provide a new value here. *
* * @param partnerProfileId * A unique identifier for the partner profile. To change the partner profile identifier, provide a new value * here. */ public void setPartnerProfileId(String partnerProfileId) { this.partnerProfileId = partnerProfileId; } /** ** A unique identifier for the partner profile. To change the partner profile identifier, provide a new value here. *
* * @return A unique identifier for the partner profile. To change the partner profile identifier, provide a new * value here. */ public String getPartnerProfileId() { return this.partnerProfileId; } /** ** A unique identifier for the partner profile. To change the partner profile identifier, provide a new value here. *
* * @param partnerProfileId * A unique identifier for the partner profile. To change the partner profile identifier, provide a new value * here. * @return Returns a reference to this object so that method calls can be chained together. */ public UpdateAgreementRequest withPartnerProfileId(String partnerProfileId) { setPartnerProfileId(partnerProfileId); return this; } /** *
* To change the landing directory (folder) for files that are transferred, provide the bucket folder that you want
* to use; for example, /DOC-EXAMPLE-BUCKET/home/mydirectory .
*
/DOC-EXAMPLE-BUCKET/home/mydirectory .
*/
public void setBaseDirectory(String baseDirectory) {
this.baseDirectory = baseDirectory;
}
/**
*
* To change the landing directory (folder) for files that are transferred, provide the bucket folder that you want
* to use; for example, /DOC-EXAMPLE-BUCKET/home/mydirectory .
*
/DOC-EXAMPLE-BUCKET/home/mydirectory .
*/
public String getBaseDirectory() {
return this.baseDirectory;
}
/**
*
* To change the landing directory (folder) for files that are transferred, provide the bucket folder that you want
* to use; for example, /DOC-EXAMPLE-BUCKET/home/mydirectory .
*
/DOC-EXAMPLE-BUCKET/home/mydirectory .
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateAgreementRequest withBaseDirectory(String baseDirectory) {
setBaseDirectory(baseDirectory);
return this;
}
/**
*
* With AS2, you can send files by calling StartFileTransfer and specifying the file paths in the
* request parameter, SendFilePaths. We use the file’s parent directory (for example, for
* --send-file-paths /bucket/dir/file.txt, parent directory is /bucket/dir/) to
* temporarily store a processed AS2 message file, store the MDN when we receive them from the partner, and write a
* final JSON file containing relevant metadata of the transmission. So, the AccessRole needs to
* provide read and write access to the parent directory of the file location used in the
* StartFileTransfer request. Additionally, you need to provide read and write access to the parent
* directory of the files that you intend to send with StartFileTransfer.
*
* If you are using Basic authentication for your AS2 connector, the access role requires the
* secretsmanager:GetSecretValue permission for the secret. If the secret is encrypted using a
* customer-managed key instead of the Amazon Web Services managed key in Secrets Manager, then the role also needs
* the kms:Decrypt permission for that key.
*
StartFileTransfer and specifying the file paths in
* the request parameter, SendFilePaths. We use the file’s parent directory (for example, for
* --send-file-paths /bucket/dir/file.txt, parent directory is /bucket/dir/) to
* temporarily store a processed AS2 message file, store the MDN when we receive them from the partner, and
* write a final JSON file containing relevant metadata of the transmission. So, the AccessRole
* needs to provide read and write access to the parent directory of the file location used in the
* StartFileTransfer request. Additionally, you need to provide read and write access to the
* parent directory of the files that you intend to send with StartFileTransfer.
*
* If you are using Basic authentication for your AS2 connector, the access role requires the
* secretsmanager:GetSecretValue permission for the secret. If the secret is encrypted using a
* customer-managed key instead of the Amazon Web Services managed key in Secrets Manager, then the role also
* needs the kms:Decrypt permission for that key.
*/
public void setAccessRole(String accessRole) {
this.accessRole = accessRole;
}
/**
*
* With AS2, you can send files by calling StartFileTransfer and specifying the file paths in the
* request parameter, SendFilePaths. We use the file’s parent directory (for example, for
* --send-file-paths /bucket/dir/file.txt, parent directory is /bucket/dir/) to
* temporarily store a processed AS2 message file, store the MDN when we receive them from the partner, and write a
* final JSON file containing relevant metadata of the transmission. So, the AccessRole needs to
* provide read and write access to the parent directory of the file location used in the
* StartFileTransfer request. Additionally, you need to provide read and write access to the parent
* directory of the files that you intend to send with StartFileTransfer.
*
* If you are using Basic authentication for your AS2 connector, the access role requires the
* secretsmanager:GetSecretValue permission for the secret. If the secret is encrypted using a
* customer-managed key instead of the Amazon Web Services managed key in Secrets Manager, then the role also needs
* the kms:Decrypt permission for that key.
*
StartFileTransfer and specifying the file paths in
* the request parameter, SendFilePaths. We use the file’s parent directory (for example, for
* --send-file-paths /bucket/dir/file.txt, parent directory is /bucket/dir/) to
* temporarily store a processed AS2 message file, store the MDN when we receive them from the partner, and
* write a final JSON file containing relevant metadata of the transmission. So, the AccessRole
* needs to provide read and write access to the parent directory of the file location used in the
* StartFileTransfer request. Additionally, you need to provide read and write access to the
* parent directory of the files that you intend to send with StartFileTransfer.
*
* If you are using Basic authentication for your AS2 connector, the access role requires the
* secretsmanager:GetSecretValue permission for the secret. If the secret is encrypted using a
* customer-managed key instead of the Amazon Web Services managed key in Secrets Manager, then the role
* also needs the kms:Decrypt permission for that key.
*/
public String getAccessRole() {
return this.accessRole;
}
/**
*
* With AS2, you can send files by calling StartFileTransfer and specifying the file paths in the
* request parameter, SendFilePaths. We use the file’s parent directory (for example, for
* --send-file-paths /bucket/dir/file.txt, parent directory is /bucket/dir/) to
* temporarily store a processed AS2 message file, store the MDN when we receive them from the partner, and write a
* final JSON file containing relevant metadata of the transmission. So, the AccessRole needs to
* provide read and write access to the parent directory of the file location used in the
* StartFileTransfer request. Additionally, you need to provide read and write access to the parent
* directory of the files that you intend to send with StartFileTransfer.
*
* If you are using Basic authentication for your AS2 connector, the access role requires the
* secretsmanager:GetSecretValue permission for the secret. If the secret is encrypted using a
* customer-managed key instead of the Amazon Web Services managed key in Secrets Manager, then the role also needs
* the kms:Decrypt permission for that key.
*
StartFileTransfer and specifying the file paths in
* the request parameter, SendFilePaths. We use the file’s parent directory (for example, for
* --send-file-paths /bucket/dir/file.txt, parent directory is /bucket/dir/) to
* temporarily store a processed AS2 message file, store the MDN when we receive them from the partner, and
* write a final JSON file containing relevant metadata of the transmission. So, the AccessRole
* needs to provide read and write access to the parent directory of the file location used in the
* StartFileTransfer request. Additionally, you need to provide read and write access to the
* parent directory of the files that you intend to send with StartFileTransfer.
*
* If you are using Basic authentication for your AS2 connector, the access role requires the
* secretsmanager:GetSecretValue permission for the secret. If the secret is encrypted using a
* customer-managed key instead of the Amazon Web Services managed key in Secrets Manager, then the role also
* needs the kms:Decrypt permission for that key.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateAgreementRequest withAccessRole(String accessRole) {
setAccessRole(accessRole);
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 (getAgreementId() != null)
sb.append("AgreementId: ").append(getAgreementId()).append(",");
if (getServerId() != null)
sb.append("ServerId: ").append(getServerId()).append(",");
if (getDescription() != null)
sb.append("Description: ").append(getDescription()).append(",");
if (getStatus() != null)
sb.append("Status: ").append(getStatus()).append(",");
if (getLocalProfileId() != null)
sb.append("LocalProfileId: ").append(getLocalProfileId()).append(",");
if (getPartnerProfileId() != null)
sb.append("PartnerProfileId: ").append(getPartnerProfileId()).append(",");
if (getBaseDirectory() != null)
sb.append("BaseDirectory: ").append(getBaseDirectory()).append(",");
if (getAccessRole() != null)
sb.append("AccessRole: ").append(getAccessRole());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof UpdateAgreementRequest == false)
return false;
UpdateAgreementRequest other = (UpdateAgreementRequest) obj;
if (other.getAgreementId() == null ^ this.getAgreementId() == null)
return false;
if (other.getAgreementId() != null && other.getAgreementId().equals(this.getAgreementId()) == false)
return false;
if (other.getServerId() == null ^ this.getServerId() == null)
return false;
if (other.getServerId() != null && other.getServerId().equals(this.getServerId()) == false)
return false;
if (other.getDescription() == null ^ this.getDescription() == null)
return false;
if (other.getDescription() != null && other.getDescription().equals(this.getDescription()) == false)
return false;
if (other.getStatus() == null ^ this.getStatus() == null)
return false;
if (other.getStatus() != null && other.getStatus().equals(this.getStatus()) == false)
return false;
if (other.getLocalProfileId() == null ^ this.getLocalProfileId() == null)
return false;
if (other.getLocalProfileId() != null && other.getLocalProfileId().equals(this.getLocalProfileId()) == false)
return false;
if (other.getPartnerProfileId() == null ^ this.getPartnerProfileId() == null)
return false;
if (other.getPartnerProfileId() != null && other.getPartnerProfileId().equals(this.getPartnerProfileId()) == false)
return false;
if (other.getBaseDirectory() == null ^ this.getBaseDirectory() == null)
return false;
if (other.getBaseDirectory() != null && other.getBaseDirectory().equals(this.getBaseDirectory()) == false)
return false;
if (other.getAccessRole() == null ^ this.getAccessRole() == null)
return false;
if (other.getAccessRole() != null && other.getAccessRole().equals(this.getAccessRole()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getAgreementId() == null) ? 0 : getAgreementId().hashCode());
hashCode = prime * hashCode + ((getServerId() == null) ? 0 : getServerId().hashCode());
hashCode = prime * hashCode + ((getDescription() == null) ? 0 : getDescription().hashCode());
hashCode = prime * hashCode + ((getStatus() == null) ? 0 : getStatus().hashCode());
hashCode = prime * hashCode + ((getLocalProfileId() == null) ? 0 : getLocalProfileId().hashCode());
hashCode = prime * hashCode + ((getPartnerProfileId() == null) ? 0 : getPartnerProfileId().hashCode());
hashCode = prime * hashCode + ((getBaseDirectory() == null) ? 0 : getBaseDirectory().hashCode());
hashCode = prime * hashCode + ((getAccessRole() == null) ? 0 : getAccessRole().hashCode());
return hashCode;
}
@Override
public UpdateAgreementRequest clone() {
return (UpdateAgreementRequest) super.clone();
}
}