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

Class ListedAgreement

java.lang.Object

software.amazon.awssdk.services.transfer.model.ListedAgreement

All Implemented Interfaces:

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

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

Describes the properties of an agreement.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ListedAgreement.Builder

Method Summary

Modifier and Type	Method	Description
String	agreementId()	A unique identifier for the agreement.
String	arn()	The Amazon Resource Name (ARN) of the specified agreement.
static ListedAgreement.Builder	builder()
String	description()	The current description for the agreement.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	localProfileId()	A unique identifier for the AS2 local profile.
String	partnerProfileId()	A unique identifier for the partner profile.
List<SdkField<?>>	sdkFields()
static Class<? extends ListedAgreement.Builder>	serializableBuilderClass()
String	serverId()	The unique identifier for the agreement.
AgreementStatusType	status()	The agreement can be either ACTIVE or INACTIVE.
String	statusAsString()	The agreement can be either ACTIVE or INACTIVE.
ListedAgreement.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 agreement.

Returns:

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

agreementId

public final String agreementId()

A unique identifier for the agreement. This identifier is returned when you create an agreement.

Returns:

A unique identifier for the agreement. This identifier is returned when you create an agreement.

description

public final String description()

The current description for the agreement. You can change it by calling the UpdateAgreement operation and providing a new description.

Returns:

The current description for the agreement. You can change it by calling the UpdateAgreement operation and providing a new description.

status

public final AgreementStatusType status()

The agreement can be either ACTIVE or INACTIVE.

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

Returns:

The agreement can be either ACTIVE or INACTIVE.

See Also:

AgreementStatusType

statusAsString

public final String statusAsString()

The agreement can be either ACTIVE or INACTIVE.

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

Returns:

The agreement can be either ACTIVE or INACTIVE.

See Also:

AgreementStatusType

serverId

public final String serverId()

The unique identifier for the agreement.

Returns:

The unique identifier for the agreement.

localProfileId

public final String localProfileId()

A unique identifier for the AS2 local profile.

Returns:

A unique identifier for the AS2 local profile.

partnerProfileId

public final String partnerProfileId()

A unique identifier for the partner profile.

Returns:

A unique identifier for the partner profile.

toBuilder

public ListedAgreement.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListedAgreement.Builder,ListedAgreement>

builder

public static ListedAgreement.Builder builder()

serializableBuilderClass

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