software.amazon.awssdk.services.transfer.model.UpdateConnectorRequest Maven / Gradle / Ivy
Show all versions of transfer Show documentation
/*
* 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.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 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.LocationTrait;
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 UpdateConnectorRequest extends TransferRequest implements
ToCopyableBuilder {
private static final SdkField CONNECTOR_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ConnectorId").getter(getter(UpdateConnectorRequest::connectorId)).setter(setter(Builder::connectorId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ConnectorId").build()).build();
private static final SdkField URL_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Url")
.getter(getter(UpdateConnectorRequest::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(UpdateConnectorRequest::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(UpdateConnectorRequest::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(UpdateConnectorRequest::loggingRole)).setter(setter(Builder::loggingRole))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("LoggingRole").build()).build();
private static final SdkField SFTP_CONFIG_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("SftpConfig")
.getter(getter(UpdateConnectorRequest::sftpConfig)).setter(setter(Builder::sftpConfig))
.constructor(SftpConnectorConfig::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("SftpConfig").build()).build();
private static final SdkField SECURITY_POLICY_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("SecurityPolicyName").getter(getter(UpdateConnectorRequest::securityPolicyName))
.setter(setter(Builder::securityPolicyName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("SecurityPolicyName").build())
.build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(CONNECTOR_ID_FIELD, URL_FIELD,
AS2_CONFIG_FIELD, ACCESS_ROLE_FIELD, LOGGING_ROLE_FIELD, SFTP_CONFIG_FIELD, SECURITY_POLICY_NAME_FIELD));
private final String connectorId;
private final String url;
private final As2ConnectorConfig as2Config;
private final String accessRole;
private final String loggingRole;
private final SftpConnectorConfig sftpConfig;
private final String securityPolicyName;
private UpdateConnectorRequest(BuilderImpl builder) {
super(builder);
this.connectorId = builder.connectorId;
this.url = builder.url;
this.as2Config = builder.as2Config;
this.accessRole = builder.accessRole;
this.loggingRole = builder.loggingRole;
this.sftpConfig = builder.sftpConfig;
this.securityPolicyName = builder.securityPolicyName;
}
/**
*
* The unique identifier for the connector.
*
*
* @return The unique identifier for the connector.
*/
public final String connectorId() {
return connectorId;
}
/**
*
* The URL of the partner's AS2 or SFTP endpoint.
*
*
* @return The URL of the partner's AS2 or SFTP endpoint.
*/
public final String url() {
return url;
}
/**
*
* A structure that contains the parameters for an AS2 connector object.
*
*
* @return A structure that contains the parameters for an AS2 connector object.
*/
public final As2ConnectorConfig as2Config() {
return as2Config;
}
/**
*
* Connectors are used to send files using either the AS2 or SFTP protocol. For the access role, provide the Amazon
* Resource Name (ARN) of the Identity and Access Management role to use.
*
*
* For AS2 connectors
*
*
* 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.
*
*
* For SFTP connectors
*
*
* Make sure that the access role provides read and write access to the parent directory of the file location that's
* used in the StartFileTransfer request. Additionally, make sure that the role provides
* secretsmanager:GetSecretValue permission to Secrets Manager.
*
*
* @return Connectors are used to send files using either the AS2 or SFTP protocol. For the access role, provide the
* Amazon Resource Name (ARN) of the Identity and Access Management role to use.
*
* For AS2 connectors
*
*
* 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.
*
*
* For SFTP connectors
*
*
* Make sure that the access role provides read and write access to the parent directory of the file
* location that's used in the StartFileTransfer request. Additionally, make sure that the role
* provides secretsmanager:GetSecretValue permission to Secrets Manager.
*/
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;
}
/**
*
* A structure that contains the parameters for an SFTP connector object.
*
*
* @return A structure that contains the parameters for an SFTP connector object.
*/
public final SftpConnectorConfig sftpConfig() {
return sftpConfig;
}
/**
*
* Specifies the name of the security policy for the connector.
*
*
* @return Specifies the name of the security policy for the connector.
*/
public final String securityPolicyName() {
return securityPolicyName;
}
@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(connectorId());
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(sftpConfig());
hashCode = 31 * hashCode + Objects.hashCode(securityPolicyName());
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 UpdateConnectorRequest)) {
return false;
}
UpdateConnectorRequest other = (UpdateConnectorRequest) obj;
return Objects.equals(connectorId(), other.connectorId()) && Objects.equals(url(), other.url())
&& Objects.equals(as2Config(), other.as2Config()) && Objects.equals(accessRole(), other.accessRole())
&& Objects.equals(loggingRole(), other.loggingRole()) && Objects.equals(sftpConfig(), other.sftpConfig())
&& Objects.equals(securityPolicyName(), other.securityPolicyName());
}
/**
* 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("UpdateConnectorRequest").add("ConnectorId", connectorId()).add("Url", url())
.add("As2Config", as2Config()).add("AccessRole", accessRole()).add("LoggingRole", loggingRole())
.add("SftpConfig", sftpConfig()).add("SecurityPolicyName", securityPolicyName()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "ConnectorId":
return Optional.ofNullable(clazz.cast(connectorId()));
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 "SftpConfig":
return Optional.ofNullable(clazz.cast(sftpConfig()));
case "SecurityPolicyName":
return Optional.ofNullable(clazz.cast(securityPolicyName()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((UpdateConnectorRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends TransferRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* The unique identifier for the connector.
*
*
* @param connectorId
* The unique identifier for the connector.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder connectorId(String connectorId);
/**
*
* The URL of the partner's AS2 or SFTP endpoint.
*
*
* @param url
* The URL of the partner's AS2 or SFTP 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 an AS2 connector object.
*
*
* @param as2Config
* A structure that contains the parameters for an AS2 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 an AS2 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());
}
/**
*
* Connectors are used to send files using either the AS2 or SFTP protocol. For the access role, provide the
* Amazon Resource Name (ARN) of the Identity and Access Management role to use.
*
*
* For AS2 connectors
*
*
* 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.
*
*
* For SFTP connectors
*
*
* Make sure that the access role provides read and write access to the parent directory of the file location
* that's used in the StartFileTransfer request. Additionally, make sure that the role provides
* secretsmanager:GetSecretValue permission to Secrets Manager.
*
*
* @param accessRole
* Connectors are used to send files using either the AS2 or SFTP protocol. For the access role, provide
* the Amazon Resource Name (ARN) of the Identity and Access Management role to use.
*
* For AS2 connectors
*
*
* 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.
*
*
* For SFTP connectors
*
*
* Make sure that the access role provides read and write access to the parent directory of the file
* location that's used in the StartFileTransfer request. Additionally, make sure that the
* role provides secretsmanager:GetSecretValue permission to Secrets Manager.
* @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);
/**
*
* A structure that contains the parameters for an SFTP connector object.
*
*
* @param sftpConfig
* A structure that contains the parameters for an SFTP connector object.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder sftpConfig(SftpConnectorConfig sftpConfig);
/**
*
* A structure that contains the parameters for an SFTP connector object.
*
* This is a convenience method that creates an instance of the {@link SftpConnectorConfig.Builder} avoiding the
* need to create one manually via {@link SftpConnectorConfig#builder()}.
*
*
* When the {@link Consumer} completes, {@link SftpConnectorConfig.Builder#build()} is called immediately and
* its result is passed to {@link #sftpConfig(SftpConnectorConfig)}.
*
* @param sftpConfig
* a consumer that will call methods on {@link SftpConnectorConfig.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #sftpConfig(SftpConnectorConfig)
*/
default Builder sftpConfig(Consumer sftpConfig) {
return sftpConfig(SftpConnectorConfig.builder().applyMutation(sftpConfig).build());
}
/**
*
* Specifies the name of the security policy for the connector.
*
*
* @param securityPolicyName
* Specifies the name of the security policy for the connector.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder securityPolicyName(String securityPolicyName);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends TransferRequest.BuilderImpl implements Builder {
private String connectorId;
private String url;
private As2ConnectorConfig as2Config;
private String accessRole;
private String loggingRole;
private SftpConnectorConfig sftpConfig;
private String securityPolicyName;
private BuilderImpl() {
}
private BuilderImpl(UpdateConnectorRequest model) {
super(model);
connectorId(model.connectorId);
url(model.url);
as2Config(model.as2Config);
accessRole(model.accessRole);
loggingRole(model.loggingRole);
sftpConfig(model.sftpConfig);
securityPolicyName(model.securityPolicyName);
}
public final String getConnectorId() {
return connectorId;
}
public final void setConnectorId(String connectorId) {
this.connectorId = connectorId;
}
@Override
public final Builder connectorId(String connectorId) {
this.connectorId = connectorId;
return this;
}
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 SftpConnectorConfig.Builder getSftpConfig() {
return sftpConfig != null ? sftpConfig.toBuilder() : null;
}
public final void setSftpConfig(SftpConnectorConfig.BuilderImpl sftpConfig) {
this.sftpConfig = sftpConfig != null ? sftpConfig.build() : null;
}
@Override
public final Builder sftpConfig(SftpConnectorConfig sftpConfig) {
this.sftpConfig = sftpConfig;
return this;
}
public final String getSecurityPolicyName() {
return securityPolicyName;
}
public final void setSecurityPolicyName(String securityPolicyName) {
this.securityPolicyName = securityPolicyName;
}
@Override
public final Builder securityPolicyName(String securityPolicyName) {
this.securityPolicyName = securityPolicyName;
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 UpdateConnectorRequest build() {
return new UpdateConnectorRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}