software.amazon.awssdk.services.transfer.model

Class DescribedProfile

java.lang.Object

software.amazon.awssdk.services.transfer.model.DescribedProfile

All Implemented Interfaces:

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

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

The details for a local or partner AS2 profile.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribedProfile.Builder

Method Summary

Modifier and Type	Method and Description
String	arn() The unique Amazon Resource Name (ARN) for the profile.
String	as2Id() The As2Id is the AS2-name, as defined in the RFC 4130.
static DescribedProfile.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.
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.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribedProfile.Builder>	serializableBuilderClass()
List<Tag>	tags() Key-value pairs that can be used to group and search for profiles.
DescribedProfile.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 unique Amazon Resource Name (ARN) for the profile.

Returns:

The unique Amazon Resource Name (ARN) for the 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.

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

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.

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

toBuilder

public DescribedProfile.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribedProfile.Builder,DescribedProfile>

builder

public static DescribedProfile.Builder builder()

serializableBuilderClass

public static Class<? extends DescribedProfile.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