Package software.amazon.awssdk.services.transfer.model

Class ListedProfile

java.lang.Object

software.amazon.awssdk.services.transfer.model.ListedProfile

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ListedProfile.Builder,ListedProfile>

@Generated("software.amazon.awssdk:codegen")
public final class ListedProfile
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ListedProfile.Builder,ListedProfile>

Returns the properties of the profile that was specified.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ListedProfile.Builder

Method Summary

Modifier and Type	Method	Description
String	arn()	The Amazon Resource Name (ARN) of the specified profile.
String	as2Id()	The As2Id is the AS2-name, as defined in the RFC 4130.
static ListedProfile.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	profileId()	A unique identifier for the local or partner AS2 profile.
ProfileType	profileType()	Indicates whether to list only LOCAL type profiles or only PARTNER type profiles.
String	profileTypeAsString()	Indicates whether to list only LOCAL type profiles or only PARTNER type profiles.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends ListedProfile.Builder>	serializableBuilderClass()
ListedProfile.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

arn

public final String arn()

The Amazon Resource Name (ARN) of the specified profile.

Returns:

The Amazon Resource Name (ARN) of the specified profile.

profileId

public final String profileId()

A unique identifier for the local or partner AS2 profile.

Returns:

A unique identifier for the local or partner AS2 profile.

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()

Indicates whether to list only LOCAL type profiles or only PARTNER type profiles. If not supplied in the request, the command lists all types of profiles.

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:

Indicates whether to list only LOCAL type profiles or only PARTNER type profiles. If not supplied in the request, the command lists all types of profiles.

See Also:

ProfileType

profileTypeAsString

public final String profileTypeAsString()

Indicates whether to list only LOCAL type profiles or only PARTNER type profiles. If not supplied in the request, the command lists all types of profiles.

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:

Indicates whether to list only LOCAL type profiles or only PARTNER type profiles. If not supplied in the request, the command lists all types of profiles.

See Also:

ProfileType

toBuilder

public ListedProfile.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListedProfile.Builder,ListedProfile>

builder

public static ListedProfile.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

sdkFields

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

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo