com.amazonaws.services.transfer.model.CreateProfileRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-transfer 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.transfer.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 CreateProfileRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The As2Id is the AS2-name, as defined in the RFC 4130. For inbound transfers, this is the
* AS2-From header for the AS2 messages sent from the partner. For outbound connectors, this is the
* AS2-To header for the AS2 messages sent to the partner using the StartFileTransfer API
* operation. This ID cannot include spaces.
*
*/
private String as2Id;
/**
*
* Determines the type of profile to create:
*
*
* -
*
* Specify LOCAL to create a local profile. A local profile represents the AS2-enabled Transfer Family
* server organization or party.
*
*
* -
*
* Specify PARTNER to create a partner profile. A partner profile represents a remote organization,
* external to Transfer Family.
*
*
*
*/
private String profileType;
/**
*
* An array of identifiers for the imported certificates. You use this identifier for working with profiles and
* partner profiles.
*
*/
private java.util.List certificateIds;
/**
*
* Key-value pairs that can be used to group and search for AS2 profiles.
*
*/
private java.util.List tags;
/**
*
* The As2Id is the AS2-name, as defined in the RFC 4130. For inbound transfers, this is the
* AS2-From header for the AS2 messages sent from the partner. For outbound connectors, this is the
* AS2-To header for the AS2 messages sent to the partner using the StartFileTransfer API
* operation. This ID cannot include spaces.
*
*
* @param as2Id
* The As2Id is the AS2-name, as defined in the RFC 4130. For inbound transfers, this is the
* AS2-From header for the AS2 messages sent from the partner. For outbound connectors, this is
* the AS2-To header for the AS2 messages sent to the partner using the
* StartFileTransfer API operation. This ID cannot include spaces.
*/
public void setAs2Id(String as2Id) {
this.as2Id = as2Id;
}
/**
*
* The As2Id is the AS2-name, as defined in the RFC 4130. For inbound transfers, this is the
* AS2-From header for the AS2 messages sent from the partner. For outbound connectors, this is the
* AS2-To header for the AS2 messages sent to the partner using the StartFileTransfer API
* operation. This ID cannot include spaces.
*
*
* @return The As2Id is the AS2-name, as defined in the RFC 4130. For inbound transfers, this is the
* AS2-From header for the AS2 messages sent from the partner. For outbound connectors, this is
* the AS2-To header for the AS2 messages sent to the partner using the
* StartFileTransfer API operation. This ID cannot include spaces.
*/
public String getAs2Id() {
return this.as2Id;
}
/**
*
* The As2Id is the AS2-name, as defined in the RFC 4130. For inbound transfers, this is the
* AS2-From header for the AS2 messages sent from the partner. For outbound connectors, this is the
* AS2-To header for the AS2 messages sent to the partner using the StartFileTransfer API
* operation. This ID cannot include spaces.
*
*
* @param as2Id
* The As2Id is the AS2-name, as defined in the RFC 4130. For inbound transfers, this is the
* AS2-From header for the AS2 messages sent from the partner. For outbound connectors, this is
* the AS2-To header for the AS2 messages sent to the partner using the
* StartFileTransfer API operation. This ID cannot include spaces.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateProfileRequest withAs2Id(String as2Id) {
setAs2Id(as2Id);
return this;
}
/**
*
* Determines the type of profile to create:
*
*
* -
*
* Specify LOCAL to create a local profile. A local profile represents the AS2-enabled Transfer Family
* server organization or party.
*
*
* -
*
* Specify PARTNER to create a partner profile. A partner profile represents a remote organization,
* external to Transfer Family.
*
*
*
*
* @param profileType
* Determines the type of profile to create:
*
* -
*
* Specify LOCAL to create a local profile. A local profile represents the AS2-enabled Transfer
* Family server organization or party.
*
*
* -
*
* Specify PARTNER to create a partner profile. A partner profile represents a remote
* organization, external to Transfer Family.
*
*
* @see ProfileType
*/
public void setProfileType(String profileType) {
this.profileType = profileType;
}
/**
*
* Determines the type of profile to create:
*
*
* -
*
* Specify LOCAL to create a local profile. A local profile represents the AS2-enabled Transfer Family
* server organization or party.
*
*
* -
*
* Specify PARTNER to create a partner profile. A partner profile represents a remote organization,
* external to Transfer Family.
*
*
*
*
* @return Determines the type of profile to create:
*
* -
*
* Specify LOCAL to create a local profile. A local profile represents the AS2-enabled Transfer
* Family server organization or party.
*
*
* -
*
* Specify PARTNER to create a partner profile. A partner profile represents a remote
* organization, external to Transfer Family.
*
*
* @see ProfileType
*/
public String getProfileType() {
return this.profileType;
}
/**
*
* Determines the type of profile to create:
*
*
* -
*
* Specify LOCAL to create a local profile. A local profile represents the AS2-enabled Transfer Family
* server organization or party.
*
*
* -
*
* Specify PARTNER to create a partner profile. A partner profile represents a remote organization,
* external to Transfer Family.
*
*
*
*
* @param profileType
* Determines the type of profile to create:
*
* -
*
* Specify LOCAL to create a local profile. A local profile represents the AS2-enabled Transfer
* Family server organization or party.
*
*
* -
*
* Specify PARTNER to create a partner profile. A partner profile represents a remote
* organization, external to Transfer Family.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see ProfileType
*/
public CreateProfileRequest withProfileType(String profileType) {
setProfileType(profileType);
return this;
}
/**
*
* Determines the type of profile to create:
*
*
* -
*
* Specify LOCAL to create a local profile. A local profile represents the AS2-enabled Transfer Family
* server organization or party.
*
*
* -
*
* Specify PARTNER to create a partner profile. A partner profile represents a remote organization,
* external to Transfer Family.
*
*
*
*
* @param profileType
* Determines the type of profile to create:
*
* -
*
* Specify LOCAL to create a local profile. A local profile represents the AS2-enabled Transfer
* Family server organization or party.
*
*
* -
*
* Specify PARTNER to create a partner profile. A partner profile represents a remote
* organization, external to Transfer Family.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see ProfileType
*/
public CreateProfileRequest withProfileType(ProfileType profileType) {
this.profileType = profileType.toString();
return this;
}
/**
*
* An array of identifiers for the imported certificates. You use this identifier for working with profiles and
* partner profiles.
*
*
* @return An array of identifiers for the imported certificates. You use this identifier for working with profiles
* and partner profiles.
*/
public java.util.List getCertificateIds() {
return certificateIds;
}
/**
*
* An array of identifiers for the imported certificates. You use this identifier for working with profiles and
* partner profiles.
*
*
* @param certificateIds
* An array of identifiers for the imported certificates. You use this identifier for working with profiles
* and partner profiles.
*/
public void setCertificateIds(java.util.Collection certificateIds) {
if (certificateIds == null) {
this.certificateIds = null;
return;
}
this.certificateIds = new java.util.ArrayList(certificateIds);
}
/**
*
* An array of identifiers for the imported certificates. You use this identifier for working with profiles and
* partner profiles.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setCertificateIds(java.util.Collection)} or {@link #withCertificateIds(java.util.Collection)} if you want
* to override the existing values.
*
*
* @param certificateIds
* An array of identifiers for the imported certificates. You use this identifier for working with profiles
* and partner profiles.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateProfileRequest withCertificateIds(String... certificateIds) {
if (this.certificateIds == null) {
setCertificateIds(new java.util.ArrayList(certificateIds.length));
}
for (String ele : certificateIds) {
this.certificateIds.add(ele);
}
return this;
}
/**
*
* An array of identifiers for the imported certificates. You use this identifier for working with profiles and
* partner profiles.
*
*
* @param certificateIds
* An array of identifiers for the imported certificates. You use this identifier for working with profiles
* and partner profiles.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateProfileRequest withCertificateIds(java.util.Collection certificateIds) {
setCertificateIds(certificateIds);
return this;
}
/**
*
* Key-value pairs that can be used to group and search for AS2 profiles.
*
*
* @return Key-value pairs that can be used to group and search for AS2 profiles.
*/
public java.util.List getTags() {
return tags;
}
/**
*
* Key-value pairs that can be used to group and search for AS2 profiles.
*
*
* @param tags
* Key-value pairs that can be used to group and search for AS2 profiles.
*/
public void setTags(java.util.Collection tags) {
if (tags == null) {
this.tags = null;
return;
}
this.tags = new java.util.ArrayList(tags);
}
/**
*
* Key-value pairs that can be used to group and search for AS2 profiles.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setTags(java.util.Collection)} or {@link #withTags(java.util.Collection)} if you want to override the
* existing values.
*
*
* @param tags
* Key-value pairs that can be used to group and search for AS2 profiles.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateProfileRequest withTags(Tag... tags) {
if (this.tags == null) {
setTags(new java.util.ArrayList(tags.length));
}
for (Tag ele : tags) {
this.tags.add(ele);
}
return this;
}
/**
*
* Key-value pairs that can be used to group and search for AS2 profiles.
*
*
* @param tags
* Key-value pairs that can be used to group and search for AS2 profiles.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateProfileRequest withTags(java.util.Collection tags) {
setTags(tags);
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 (getAs2Id() != null)
sb.append("As2Id: ").append(getAs2Id()).append(",");
if (getProfileType() != null)
sb.append("ProfileType: ").append(getProfileType()).append(",");
if (getCertificateIds() != null)
sb.append("CertificateIds: ").append(getCertificateIds()).append(",");
if (getTags() != null)
sb.append("Tags: ").append(getTags());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof CreateProfileRequest == false)
return false;
CreateProfileRequest other = (CreateProfileRequest) obj;
if (other.getAs2Id() == null ^ this.getAs2Id() == null)
return false;
if (other.getAs2Id() != null && other.getAs2Id().equals(this.getAs2Id()) == false)
return false;
if (other.getProfileType() == null ^ this.getProfileType() == null)
return false;
if (other.getProfileType() != null && other.getProfileType().equals(this.getProfileType()) == false)
return false;
if (other.getCertificateIds() == null ^ this.getCertificateIds() == null)
return false;
if (other.getCertificateIds() != null && other.getCertificateIds().equals(this.getCertificateIds()) == false)
return false;
if (other.getTags() == null ^ this.getTags() == null)
return false;
if (other.getTags() != null && other.getTags().equals(this.getTags()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getAs2Id() == null) ? 0 : getAs2Id().hashCode());
hashCode = prime * hashCode + ((getProfileType() == null) ? 0 : getProfileType().hashCode());
hashCode = prime * hashCode + ((getCertificateIds() == null) ? 0 : getCertificateIds().hashCode());
hashCode = prime * hashCode + ((getTags() == null) ? 0 : getTags().hashCode());
return hashCode;
}
@Override
public CreateProfileRequest clone() {
return (CreateProfileRequest) super.clone();
}
}