software.amazon.awssdk.services.transfer.model.CreateProfileRequest Maven / Gradle / Ivy
/*
* Copyright 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 software.amazon.awssdk.services.transfer.model;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Consumer;
import java.util.function.Function;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.awscore.AwsRequestOverrideConfiguration;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.ListTrait;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructList;
import software.amazon.awssdk.core.util.SdkAutoConstructList;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*/
@Generated("software.amazon.awssdk:codegen")
public final class CreateProfileRequest extends TransferRequest implements
ToCopyableBuilder {
private static final SdkField AS2_ID_FIELD = SdkField. builder(MarshallingType.STRING).memberName("As2Id")
.getter(getter(CreateProfileRequest::as2Id)).setter(setter(Builder::as2Id))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("As2Id").build()).build();
private static final SdkField PROFILE_TYPE_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ProfileType").getter(getter(CreateProfileRequest::profileTypeAsString))
.setter(setter(Builder::profileType))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ProfileType").build()).build();
private static final SdkField> CERTIFICATE_IDS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("CertificateIds")
.getter(getter(CreateProfileRequest::certificateIds))
.setter(setter(Builder::certificateIds))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("CertificateIds").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField> TAGS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Tags")
.getter(getter(CreateProfileRequest::tags))
.setter(setter(Builder::tags))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Tags").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(Tag::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(AS2_ID_FIELD,
PROFILE_TYPE_FIELD, CERTIFICATE_IDS_FIELD, TAGS_FIELD));
private final String as2Id;
private final String profileType;
private final List certificateIds;
private final List tags;
private CreateProfileRequest(BuilderImpl builder) {
super(builder);
this.as2Id = builder.as2Id;
this.profileType = builder.profileType;
this.certificateIds = builder.certificateIds;
this.tags = builder.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.
*
*
* @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 final String as2Id() {
return 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.
*
*
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #profileType} will
* return {@link ProfileType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #profileTypeAsString}.
*
*
* @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 final ProfileType profileType() {
return ProfileType.fromValue(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.
*
*
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #profileType} will
* return {@link ProfileType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #profileTypeAsString}.
*
*
* @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 final String profileTypeAsString() {
return profileType;
}
/**
* For responses, this returns true if the service returned a value for the CertificateIds property. This DOES NOT
* check that the value is non-empty (for which, you should check the {@code isEmpty()} method on the property).
* This is useful because the SDK will never return a null collection or map, but you may need to differentiate
* between the service returning nothing (or null) and the service returning an empty collection or map. For
* requests, this returns true if a value for the property was specified in the request builder, and false if a
* value was not specified.
*/
public final boolean hasCertificateIds() {
return certificateIds != null && !(certificateIds instanceof SdkAutoConstructList);
}
/**
*
* An array of identifiers for the imported certificates. You use this identifier for working with profiles and
* partner profiles.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* This method will never return null. If you would like to know whether the service returned this field (so that
* you can differentiate between null and empty), you can use the {@link #hasCertificateIds} method.
*
*
* @return An array of identifiers for the imported certificates. You use this identifier for working with profiles
* and partner profiles.
*/
public final List certificateIds() {
return certificateIds;
}
/**
* For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that
* the value is non-empty (for which, you should check the {@code isEmpty()} method on the property). This is useful
* because the SDK will never return a null collection or map, but you may need to differentiate between the service
* returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true
* if a value for the property was specified in the request builder, and false if a value was not specified.
*/
public final boolean hasTags() {
return tags != null && !(tags instanceof SdkAutoConstructList);
}
/**
*
* Key-value pairs that can be used to group and search for AS2 profiles.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* This method will never return null. If you would like to know whether the service returned this field (so that
* you can differentiate between null and empty), you can use the {@link #hasTags} method.
*
*
* @return Key-value pairs that can be used to group and search for AS2 profiles.
*/
public final List tags() {
return tags;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(as2Id());
hashCode = 31 * hashCode + Objects.hashCode(profileTypeAsString());
hashCode = 31 * hashCode + Objects.hashCode(hasCertificateIds() ? certificateIds() : null);
hashCode = 31 * hashCode + Objects.hashCode(hasTags() ? tags() : null);
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof CreateProfileRequest)) {
return false;
}
CreateProfileRequest other = (CreateProfileRequest) obj;
return Objects.equals(as2Id(), other.as2Id()) && Objects.equals(profileTypeAsString(), other.profileTypeAsString())
&& hasCertificateIds() == other.hasCertificateIds() && Objects.equals(certificateIds(), other.certificateIds())
&& hasTags() == other.hasTags() && Objects.equals(tags(), other.tags());
}
/**
* 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.
*/
@Override
public final String toString() {
return ToString.builder("CreateProfileRequest").add("As2Id", as2Id()).add("ProfileType", profileTypeAsString())
.add("CertificateIds", hasCertificateIds() ? certificateIds() : null).add("Tags", hasTags() ? tags() : null)
.build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "As2Id":
return Optional.ofNullable(clazz.cast(as2Id()));
case "ProfileType":
return Optional.ofNullable(clazz.cast(profileTypeAsString()));
case "CertificateIds":
return Optional.ofNullable(clazz.cast(certificateIds()));
case "Tags":
return Optional.ofNullable(clazz.cast(tags()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((CreateProfileRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends TransferRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* 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.
*/
Builder as2Id(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.
*
*
*
*
* @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
* @return Returns a reference to this object so that method calls can be chained together.
* @see ProfileType
*/
Builder profileType(String 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.
*
*
* @see ProfileType
* @return Returns a reference to this object so that method calls can be chained together.
* @see ProfileType
*/
Builder profileType(ProfileType profileType);
/**
*
* 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.
*/
Builder certificateIds(Collection 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder certificateIds(String... certificateIds);
/**
*
* 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.
*/
Builder tags(Collection 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tags(Tag... tags);
/**
*
* Key-value pairs that can be used to group and search for AS2 profiles.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.transfer.model.Tag.Builder} avoiding the need to create one manually
* via {@link software.amazon.awssdk.services.transfer.model.Tag#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.transfer.model.Tag.Builder#build()} is called immediately and its
* result is passed to {@link #tags(List)}.
*
* @param tags
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.transfer.model.Tag.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #tags(java.util.Collection)
*/
Builder tags(Consumer... tags);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends TransferRequest.BuilderImpl implements Builder {
private String as2Id;
private String profileType;
private List certificateIds = DefaultSdkAutoConstructList.getInstance();
private List tags = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(CreateProfileRequest model) {
super(model);
as2Id(model.as2Id);
profileType(model.profileType);
certificateIds(model.certificateIds);
tags(model.tags);
}
public final String getAs2Id() {
return as2Id;
}
public final void setAs2Id(String as2Id) {
this.as2Id = as2Id;
}
@Override
public final Builder as2Id(String as2Id) {
this.as2Id = as2Id;
return this;
}
public final String getProfileType() {
return profileType;
}
public final void setProfileType(String profileType) {
this.profileType = profileType;
}
@Override
public final Builder profileType(String profileType) {
this.profileType = profileType;
return this;
}
@Override
public final Builder profileType(ProfileType profileType) {
this.profileType(profileType == null ? null : profileType.toString());
return this;
}
public final Collection getCertificateIds() {
if (certificateIds instanceof SdkAutoConstructList) {
return null;
}
return certificateIds;
}
public final void setCertificateIds(Collection certificateIds) {
this.certificateIds = CertificateIdsCopier.copy(certificateIds);
}
@Override
public final Builder certificateIds(Collection certificateIds) {
this.certificateIds = CertificateIdsCopier.copy(certificateIds);
return this;
}
@Override
@SafeVarargs
public final Builder certificateIds(String... certificateIds) {
certificateIds(Arrays.asList(certificateIds));
return this;
}
public final List getTags() {
List result = TagsCopier.copyToBuilder(this.tags);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setTags(Collection tags) {
this.tags = TagsCopier.copyFromBuilder(tags);
}
@Override
public final Builder tags(Collection tags) {
this.tags = TagsCopier.copy(tags);
return this;
}
@Override
@SafeVarargs
public final Builder tags(Tag... tags) {
tags(Arrays.asList(tags));
return this;
}
@Override
@SafeVarargs
public final Builder tags(Consumer... tags) {
tags(Stream.of(tags).map(c -> Tag.builder().applyMutation(c).build()).collect(Collectors.toList()));
return this;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public CreateProfileRequest build() {
return new CreateProfileRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}