software.amazon.awssdk.services.transfer.model

Class CreateProfileRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.transfer.model.TransferRequest

software.amazon.awssdk.services.transfer.model.CreateProfileRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateProfileRequest.Builder,CreateProfileRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateProfileRequest
extends TransferRequest
implements ToCopyableBuilder<CreateProfileRequest.Builder,CreateProfileRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateProfileRequest.Builder

Method Summary

Modifier and Type	Method and Description
String	as2Id() The As2Id is the AS2-name, as defined in the RFC 4130.
static CreateProfileRequest.Builder	builder()
List<String>	certificateIds() An array of identifiers for the imported certificates.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasCertificateIds() For responses, this returns true if the service returned a value for the CertificateIds property.
int	hashCode()
boolean	hasTags() For responses, this returns true if the service returned a value for the Tags property.
ProfileType	profileType() Determines the type of profile to create:
String	profileTypeAsString() Determines the type of profile to create:
List<SdkField<?>>	sdkFields()
static Class<? extends CreateProfileRequest.Builder>	serializableBuilderClass()
List<Tag>	tags() Key-value pairs that can be used to group and search for AS2 profiles.
CreateProfileRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

as2Id

public final String 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.

Returns:

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.

profileType

public final 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.

If the service returns an enum value that is not available in the current SDK version, profileType will return ProfileType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from profileTypeAsString().

Returns:

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 Also:

ProfileType

profileTypeAsString

public final String profileTypeAsString()

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, profileType will return ProfileType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from profileTypeAsString().

Returns:

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 Also:

ProfileType

hasCertificateIds

public final boolean hasCertificateIds()

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 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.

certificateIds

public final List<String> certificateIds()

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 hasCertificateIds() method.

Returns:

An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles.

hasTags

public final boolean hasTags()

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 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.

tags

public final List<Tag> tags()

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 hasTags() method.

Returns:

Key-value pairs that can be used to group and search for AS2 profiles.

toBuilder

public CreateProfileRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateProfileRequest.Builder,CreateProfileRequest>

Specified by:

toBuilder in class TransferRequest

builder

public static CreateProfileRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateProfileRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

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.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo