com.amazonaws.services.transfer.model

Class DescribedAgreement

java.lang.Object

com.amazonaws.services.transfer.model.DescribedAgreement

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DescribedAgreement
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
DescribedAgreement()

Method Summary

Modifier and Type	Method and Description
DescribedAgreement	clone()
boolean	equals(Object obj)
String	getAccessRole() The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that grants access to at least the HomeDirectory of your users' Amazon S3 buckets.
String	getAgreementId() A unique identifier for the agreement.
String	getArn() The unique Amazon Resource Name (ARN) for the agreement.
String	getBaseDirectory() The landing directory (folder) for files that are transferred by using the AS2 protocol.
String	getDescription() The name or short description that's used to identify the agreement.
String	getLocalProfileId() A unique identifier for the AS2 process.
String	getPartnerProfileId() A unique identifier for the partner in the agreement.
String	getServerId() A system-assigned unique identifier for a server instance.
String	getStatus() The current status of the agreement, either ACTIVE or INACTIVE.
List<Tag>	getTags() Key-value pairs that can be used to group and search for agreements.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller)
void	setAccessRole(String accessRole) The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that grants access to at least the HomeDirectory of your users' Amazon S3 buckets.
void	setAgreementId(String agreementId) A unique identifier for the agreement.
void	setArn(String arn) The unique Amazon Resource Name (ARN) for the agreement.
void	setBaseDirectory(String baseDirectory) The landing directory (folder) for files that are transferred by using the AS2 protocol.
void	setDescription(String description) The name or short description that's used to identify the agreement.
void	setLocalProfileId(String localProfileId) A unique identifier for the AS2 process.
void	setPartnerProfileId(String partnerProfileId) A unique identifier for the partner in the agreement.
void	setServerId(String serverId) A system-assigned unique identifier for a server instance.
void	setStatus(String status) The current status of the agreement, either ACTIVE or INACTIVE.
void	setTags(Collection<Tag> tags) Key-value pairs that can be used to group and search for agreements.
String	toString() Returns a string representation of this object.
DescribedAgreement	withAccessRole(String accessRole) The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that grants access to at least the HomeDirectory of your users' Amazon S3 buckets.
DescribedAgreement	withAgreementId(String agreementId) A unique identifier for the agreement.
DescribedAgreement	withArn(String arn) The unique Amazon Resource Name (ARN) for the agreement.
DescribedAgreement	withBaseDirectory(String baseDirectory) The landing directory (folder) for files that are transferred by using the AS2 protocol.
DescribedAgreement	withDescription(String description) The name or short description that's used to identify the agreement.
DescribedAgreement	withLocalProfileId(String localProfileId) A unique identifier for the AS2 process.
DescribedAgreement	withPartnerProfileId(String partnerProfileId) A unique identifier for the partner in the agreement.
DescribedAgreement	withServerId(String serverId) A system-assigned unique identifier for a server instance.
DescribedAgreement	withStatus(AgreementStatusType status) The current status of the agreement, either ACTIVE or INACTIVE.
DescribedAgreement	withStatus(String status) The current status of the agreement, either ACTIVE or INACTIVE.
DescribedAgreement	withTags(Collection<Tag> tags) Key-value pairs that can be used to group and search for agreements.
DescribedAgreement	withTags(Tag... tags) Key-value pairs that can be used to group and search for agreements.

Methods inherited from class java.lang.Object

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

Constructor Detail

DescribedAgreement

public DescribedAgreement()

Method Detail

setArn

public void setArn(String arn)

The unique Amazon Resource Name (ARN) for the agreement.

Parameters:

arn - The unique Amazon Resource Name (ARN) for the agreement.

getArn

public String getArn()

The unique Amazon Resource Name (ARN) for the agreement.

Returns:

The unique Amazon Resource Name (ARN) for the agreement.

withArn

public DescribedAgreement withArn(String arn)

The unique Amazon Resource Name (ARN) for the agreement.

Parameters:

arn - The unique Amazon Resource Name (ARN) for the 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 DescribedAgreement 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 name or short description that's used to identify the agreement.

Parameters:

description - The name or short description that's used to identify the agreement.

getDescription

public String getDescription()

The name or short description that's used to identify the agreement.

Returns:

The name or short description that's used to identify the agreement.

withDescription

public DescribedAgreement withDescription(String description)

The name or short description that's used to identify the agreement.

Parameters:

description - The name or short description that's used to identify the agreement.

Returns:

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

setStatus

public void setStatus(String status)

The current status of the agreement, either ACTIVE or INACTIVE.

Parameters:

status - The current status of the agreement, either ACTIVE or INACTIVE.

See Also:

AgreementStatusType

getStatus

public String getStatus()

The current status of the agreement, either ACTIVE or INACTIVE.

Returns:

The current status of the agreement, either ACTIVE or INACTIVE.

See Also:

AgreementStatusType

withStatus

public DescribedAgreement withStatus(String status)

The current status of the agreement, either ACTIVE or INACTIVE.

Parameters:

status - The current status of the agreement, either ACTIVE or INACTIVE.

Returns:

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

See Also:

AgreementStatusType

withStatus

public DescribedAgreement withStatus(AgreementStatusType status)

The current status of the agreement, either ACTIVE or INACTIVE.

Parameters:

status - The current status of the agreement, 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)

A system-assigned unique identifier for a server instance. This identifier indicates the specific server that the agreement uses.

Parameters:

serverId - A system-assigned unique identifier for a server instance. This identifier indicates the specific server that the agreement uses.

getServerId

public String getServerId()

A system-assigned unique identifier for a server instance. This identifier indicates the specific server that the agreement uses.

Returns:

A system-assigned unique identifier for a server instance. This identifier indicates the specific server that the agreement uses.

withServerId

public DescribedAgreement withServerId(String serverId)

A system-assigned unique identifier for a server instance. This identifier indicates the specific server that the agreement uses.

Parameters:

serverId - A system-assigned unique identifier for a server instance. This identifier indicates the specific server that the agreement uses.

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

Parameters:

localProfileId - A unique identifier for the AS2 process.

getLocalProfileId

public String getLocalProfileId()

A unique identifier for the AS2 process.

Returns:

A unique identifier for the AS2 process.

withLocalProfileId

public DescribedAgreement withLocalProfileId(String localProfileId)

A unique identifier for the AS2 process.

Parameters:

localProfileId - A unique identifier for the AS2 process.

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 in the agreement.

Parameters:

partnerProfileId - A unique identifier for the partner in the agreement.

getPartnerProfileId

public String getPartnerProfileId()

A unique identifier for the partner in the agreement.

Returns:

A unique identifier for the partner in the agreement.

withPartnerProfileId

public DescribedAgreement withPartnerProfileId(String partnerProfileId)

A unique identifier for the partner in the agreement.

Parameters:

partnerProfileId - A unique identifier for the partner in the agreement.

Returns:

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

setBaseDirectory

public void setBaseDirectory(String baseDirectory)

The landing directory (folder) for files that are transferred by using the AS2 protocol.

Parameters:

baseDirectory - The landing directory (folder) for files that are transferred by using the AS2 protocol.

getBaseDirectory

public String getBaseDirectory()

The landing directory (folder) for files that are transferred by using the AS2 protocol.

Returns:

The landing directory (folder) for files that are transferred by using the AS2 protocol.

withBaseDirectory

public DescribedAgreement withBaseDirectory(String baseDirectory)

The landing directory (folder) for files that are transferred by using the AS2 protocol.

Parameters:

baseDirectory - The landing directory (folder) for files that are transferred by using the AS2 protocol.

Returns:

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

setAccessRole

public void setAccessRole(String accessRole)

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that grants access to at least the HomeDirectory of your users' Amazon S3 buckets.

Parameters:

accessRole - The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that grants access to at least the HomeDirectory of your users' Amazon S3 buckets.

getAccessRole

public String getAccessRole()

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that grants access to at least the HomeDirectory of your users' Amazon S3 buckets.

Returns:

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that grants access to at least the HomeDirectory of your users' Amazon S3 buckets.

withAccessRole

public DescribedAgreement withAccessRole(String accessRole)

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that grants access to at least the HomeDirectory of your users' Amazon S3 buckets.

Parameters:

accessRole - The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that grants access to at least the HomeDirectory of your users' Amazon S3 buckets.

Returns:

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

getTags

public List<Tag> getTags()

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

Returns:

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

setTags

public void setTags(Collection<Tag> tags)

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

Parameters:

tags - Key-value pairs that can be used to group and search for agreements.

withTags

public DescribedAgreement withTags(Tag... tags)

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

NOTE: This method appends the values to the existing list (if any). Use setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the existing values.

Parameters:

tags - Key-value pairs that can be used to group and search for agreements.

Returns:

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

withTags

public DescribedAgreement withTags(Collection<Tag> tags)

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

Parameters:

tags - Key-value pairs that can be used to group and search for agreements.

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

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Specified by:

marshall in interface StructuredPojo