com.amazonaws.services.transfer.model

Class ListedAgreement

java.lang.Object

com.amazonaws.services.transfer.model.ListedAgreement

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ListedAgreement
extends Object
implements Serializable, Cloneable, StructuredPojo

Describes the properties of an agreement.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
ListedAgreement()

Method Summary

Modifier and Type	Method and Description
ListedAgreement	clone()
boolean	equals(Object obj)
String	getAgreementId() A unique identifier for the agreement.
String	getArn() The Amazon Resource Name (ARN) of the specified agreement.
String	getDescription() The current description for the agreement.
String	getLocalProfileId() A unique identifier for the AS2 local profile.
String	getPartnerProfileId() A unique identifier for the partner profile.
String	getServerId() The unique identifier for the agreement.
String	getStatus() The agreement can be either ACTIVE or INACTIVE.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller)
void	setAgreementId(String agreementId) A unique identifier for the agreement.
void	setArn(String arn) The Amazon Resource Name (ARN) of the specified agreement.
void	setDescription(String description) The current description for the agreement.
void	setLocalProfileId(String localProfileId) A unique identifier for the AS2 local profile.
void	setPartnerProfileId(String partnerProfileId) A unique identifier for the partner profile.
void	setServerId(String serverId) The unique identifier for the agreement.
void	setStatus(String status) The agreement can be either ACTIVE or INACTIVE.
String	toString() Returns a string representation of this object.
ListedAgreement	withAgreementId(String agreementId) A unique identifier for the agreement.
ListedAgreement	withArn(String arn) The Amazon Resource Name (ARN) of the specified agreement.
ListedAgreement	withDescription(String description) The current description for the agreement.
ListedAgreement	withLocalProfileId(String localProfileId) A unique identifier for the AS2 local profile.
ListedAgreement	withPartnerProfileId(String partnerProfileId) A unique identifier for the partner profile.
ListedAgreement	withServerId(String serverId) The unique identifier for the agreement.
ListedAgreement	withStatus(AgreementStatusType status) The agreement can be either ACTIVE or INACTIVE.
ListedAgreement	withStatus(String status) The agreement can be either ACTIVE or INACTIVE.

Methods inherited from class java.lang.Object

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

Constructor Detail

ListedAgreement

public ListedAgreement()

Method Detail

setArn

public void setArn(String arn)

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

Parameters:

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

getArn

public String getArn()

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

Returns:

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

withArn

public ListedAgreement withArn(String arn)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setAgreementId

public void setAgreementId(String agreementId)

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

Parameters:

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

getAgreementId

public String getAgreementId()

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.

withAgreementId

public ListedAgreement withAgreementId(String agreementId)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setDescription

public void setDescription(String description)

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

Parameters:

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

getDescription

public String getDescription()

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.

withDescription

public ListedAgreement withDescription(String description)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setStatus

public void setStatus(String status)

The agreement can be either ACTIVE or INACTIVE.

Parameters:

status - The agreement can be either ACTIVE or INACTIVE.

See Also:

AgreementStatusType

getStatus

public String getStatus()

The agreement can be either ACTIVE or INACTIVE.

Returns:

The agreement can be either ACTIVE or INACTIVE.

See Also:

AgreementStatusType

withStatus

public ListedAgreement withStatus(String status)

The agreement can be either ACTIVE or INACTIVE.

Parameters:

status - The agreement can be either ACTIVE or INACTIVE.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

AgreementStatusType

withStatus

public ListedAgreement withStatus(AgreementStatusType status)

The agreement can be either ACTIVE or INACTIVE.

Parameters:

status - The agreement can be either ACTIVE or INACTIVE.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

AgreementStatusType

setServerId

public void setServerId(String serverId)

The unique identifier for the agreement.

Parameters:

serverId - The unique identifier for the agreement.

getServerId

public String getServerId()

The unique identifier for the agreement.

Returns:

The unique identifier for the agreement.

withServerId

public ListedAgreement withServerId(String serverId)

The unique identifier for the agreement.

Parameters:

serverId - The unique identifier for the agreement.

Returns:

Returns a reference to this object so that method calls can be chained together.

setLocalProfileId

public void setLocalProfileId(String localProfileId)

A unique identifier for the AS2 local profile.

Parameters:

localProfileId - A unique identifier for the AS2 local profile.

getLocalProfileId

public String getLocalProfileId()

A unique identifier for the AS2 local profile.

Returns:

A unique identifier for the AS2 local profile.

withLocalProfileId

public ListedAgreement withLocalProfileId(String localProfileId)

A unique identifier for the AS2 local profile.

Parameters:

localProfileId - A unique identifier for the AS2 local profile.

Returns:

Returns a reference to this object so that method calls can be chained together.

setPartnerProfileId

public void setPartnerProfileId(String partnerProfileId)

A unique identifier for the partner profile.

Parameters:

partnerProfileId - A unique identifier for the partner profile.

getPartnerProfileId

public String getPartnerProfileId()

A unique identifier for the partner profile.

Returns:

A unique identifier for the partner profile.

withPartnerProfileId

public ListedAgreement withPartnerProfileId(String partnerProfileId)

A unique identifier for the partner profile.

Parameters:

partnerProfileId - A unique identifier for the partner profile.

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public ListedAgreement clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Specified by:

marshall in interface StructuredPojo