software.amazon.awssdk.services.transfer.model.CreateConnectorRequest 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 CreateConnectorRequest extends TransferRequest implements
ToCopyableBuilder {
private static final SdkField URL_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Url")
.getter(getter(CreateConnectorRequest::url)).setter(setter(Builder::url))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Url").build()).build();
private static final SdkField AS2_CONFIG_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("As2Config")
.getter(getter(CreateConnectorRequest::as2Config)).setter(setter(Builder::as2Config))
.constructor(As2ConnectorConfig::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("As2Config").build()).build();
private static final SdkField ACCESS_ROLE_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("AccessRole").getter(getter(CreateConnectorRequest::accessRole)).setter(setter(Builder::accessRole))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("AccessRole").build()).build();
private static final SdkField LOGGING_ROLE_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("LoggingRole").getter(getter(CreateConnectorRequest::loggingRole)).setter(setter(Builder::loggingRole))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("LoggingRole").build()).build();
private static final SdkField> TAGS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Tags")
.getter(getter(CreateConnectorRequest::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(URL_FIELD, AS2_CONFIG_FIELD,
ACCESS_ROLE_FIELD, LOGGING_ROLE_FIELD, TAGS_FIELD));
private final String url;
private final As2ConnectorConfig as2Config;
private final String accessRole;
private final String loggingRole;
private final List tags;
private CreateConnectorRequest(BuilderImpl builder) {
super(builder);
this.url = builder.url;
this.as2Config = builder.as2Config;
this.accessRole = builder.accessRole;
this.loggingRole = builder.loggingRole;
this.tags = builder.tags;
}
/**
*
* The URL of the partner's AS2 endpoint.
*
*
* @return The URL of the partner's AS2 endpoint.
*/
public final String url() {
return url;
}
/**
*
* A structure that contains the parameters for a connector object.
*
*
* @return A structure that contains the parameters for a connector object.
*/
public final As2ConnectorConfig as2Config() {
return as2Config;
}
/**
*
* 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.
*
*
* @return 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.
*/
public final String accessRole() {
return accessRole;
}
/**
*
* The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a connector to turn
* on CloudWatch logging for Amazon S3 events. When set, you can view connector activity in your CloudWatch logs.
*
*
* @return The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a connector
* to turn on CloudWatch logging for Amazon S3 events. When set, you can view connector activity in your
* CloudWatch logs.
*/
public final String loggingRole() {
return loggingRole;
}
/**
* 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 connectors. Tags are metadata attached to connectors for
* any purpose.
*
*
* 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 connectors. Tags are metadata attached to
* connectors for any purpose.
*/
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(url());
hashCode = 31 * hashCode + Objects.hashCode(as2Config());
hashCode = 31 * hashCode + Objects.hashCode(accessRole());
hashCode = 31 * hashCode + Objects.hashCode(loggingRole());
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 CreateConnectorRequest)) {
return false;
}
CreateConnectorRequest other = (CreateConnectorRequest) obj;
return Objects.equals(url(), other.url()) && Objects.equals(as2Config(), other.as2Config())
&& Objects.equals(accessRole(), other.accessRole()) && Objects.equals(loggingRole(), other.loggingRole())
&& 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("CreateConnectorRequest").add("Url", url()).add("As2Config", as2Config())
.add("AccessRole", accessRole()).add("LoggingRole", loggingRole()).add("Tags", hasTags() ? tags() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Url":
return Optional.ofNullable(clazz.cast(url()));
case "As2Config":
return Optional.ofNullable(clazz.cast(as2Config()));
case "AccessRole":
return Optional.ofNullable(clazz.cast(accessRole()));
case "LoggingRole":
return Optional.ofNullable(clazz.cast(loggingRole()));
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((CreateConnectorRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends TransferRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* The URL of the partner's AS2 endpoint.
*
*
* @param url
* The URL of the partner's AS2 endpoint.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder url(String url);
/**
*
* A structure that contains the parameters for a connector object.
*
*
* @param as2Config
* A structure that contains the parameters for a connector object.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder as2Config(As2ConnectorConfig as2Config);
/**
*
* A structure that contains the parameters for a connector object.
*
* This is a convenience method that creates an instance of the {@link As2ConnectorConfig.Builder} avoiding the
* need to create one manually via {@link As2ConnectorConfig#builder()}.
*
*
* When the {@link Consumer} completes, {@link As2ConnectorConfig.Builder#build()} is called immediately and its
* result is passed to {@link #as2Config(As2ConnectorConfig)}.
*
* @param as2Config
* a consumer that will call methods on {@link As2ConnectorConfig.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #as2Config(As2ConnectorConfig)
*/
default Builder as2Config(Consumer as2Config) {
return as2Config(As2ConnectorConfig.builder().applyMutation(as2Config).build());
}
/**
*
* 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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder accessRole(String accessRole);
/**
*
* The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a connector to
* turn on CloudWatch logging for Amazon S3 events. When set, you can view connector activity in your CloudWatch
* logs.
*
*
* @param loggingRole
* The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a
* connector to turn on CloudWatch logging for Amazon S3 events. When set, you can view connector
* activity in your CloudWatch logs.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder loggingRole(String loggingRole);
/**
*
* Key-value pairs that can be used to group and search for connectors. Tags are metadata attached to connectors
* for any purpose.
*
*
* @param tags
* Key-value pairs that can be used to group and search for connectors. Tags are metadata attached to
* connectors for any purpose.
* @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 connectors. Tags are metadata attached to connectors
* for any purpose.
*
*
* @param tags
* Key-value pairs that can be used to group and search for connectors. Tags are metadata attached to
* connectors for any purpose.
* @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 connectors. Tags are metadata attached to connectors
* for any purpose.
*
* 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 url;
private As2ConnectorConfig as2Config;
private String accessRole;
private String loggingRole;
private List tags = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(CreateConnectorRequest model) {
super(model);
url(model.url);
as2Config(model.as2Config);
accessRole(model.accessRole);
loggingRole(model.loggingRole);
tags(model.tags);
}
public final String getUrl() {
return url;
}
public final void setUrl(String url) {
this.url = url;
}
@Override
public final Builder url(String url) {
this.url = url;
return this;
}
public final As2ConnectorConfig.Builder getAs2Config() {
return as2Config != null ? as2Config.toBuilder() : null;
}
public final void setAs2Config(As2ConnectorConfig.BuilderImpl as2Config) {
this.as2Config = as2Config != null ? as2Config.build() : null;
}
@Override
public final Builder as2Config(As2ConnectorConfig as2Config) {
this.as2Config = as2Config;
return this;
}
public final String getAccessRole() {
return accessRole;
}
public final void setAccessRole(String accessRole) {
this.accessRole = accessRole;
}
@Override
public final Builder accessRole(String accessRole) {
this.accessRole = accessRole;
return this;
}
public final String getLoggingRole() {
return loggingRole;
}
public final void setLoggingRole(String loggingRole) {
this.loggingRole = loggingRole;
}
@Override
public final Builder loggingRole(String loggingRole) {
this.loggingRole = loggingRole;
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 CreateConnectorRequest build() {
return new CreateConnectorRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}