DescribedProfile (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.transfer.model.DescribedProfile

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

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

The details for a local or partner AS2 profile.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

DescribedProfile()

Constructors
Constructor and Description
`DescribedProfile()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DescribedProfile`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getArn()` The unique Amazon Resource Name (ARN) for the profile.
`String`	`getAs2Id()` The `As2Id` is the AS2-name, as defined in the RFC 4130.
`List<String>`	`getCertificateIds()` An array of identifiers for the imported certificates.
`String`	`getProfileId()` A unique identifier for the local or partner AS2 profile.
`String`	`getProfileType()` Indicates whether to list only `LOCAL` type profiles or only `PARTNER` type profiles.
`List<Tag>`	`getTags()` Key-value pairs that can be used to group and search for profiles.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setArn(String arn)` The unique Amazon Resource Name (ARN) for the profile.
`void`	`setAs2Id(String as2Id)` The `As2Id` is the AS2-name, as defined in the RFC 4130.
`void`	`setCertificateIds(Collection<String> certificateIds)` An array of identifiers for the imported certificates.
`void`	`setProfileId(String profileId)` A unique identifier for the local or partner AS2 profile.
`void`	`setProfileType(String profileType)` Indicates whether to list only `LOCAL` type profiles or only `PARTNER` type profiles.
`void`	`setTags(Collection<Tag> tags)` Key-value pairs that can be used to group and search for profiles.
`String`	`toString()` Returns a string representation of this object.
`DescribedProfile`	`withArn(String arn)` The unique Amazon Resource Name (ARN) for the profile.
`DescribedProfile`	`withAs2Id(String as2Id)` The `As2Id` is the AS2-name, as defined in the RFC 4130.
`DescribedProfile`	`withCertificateIds(Collection<String> certificateIds)` An array of identifiers for the imported certificates.
`DescribedProfile`	`withCertificateIds(String... certificateIds)` An array of identifiers for the imported certificates.
`DescribedProfile`	`withProfileId(String profileId)` A unique identifier for the local or partner AS2 profile.
`DescribedProfile`	`withProfileType(ProfileType profileType)` Indicates whether to list only `LOCAL` type profiles or only `PARTNER` type profiles.
`DescribedProfile`	`withProfileType(String profileType)` Indicates whether to list only `LOCAL` type profiles or only `PARTNER` type profiles.
`DescribedProfile`	`withTags(Collection<Tag> tags)` Key-value pairs that can be used to group and search for profiles.
`DescribedProfile`	`withTags(Tag... tags)` Key-value pairs that can be used to group and search for profiles.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - DescribedProfile
```
public DescribedProfile()
```
- Method Detail
  - setArn
```
public void setArn(String arn)
```
    The unique Amazon Resource Name (ARN) for the profile.
    
    Parameters:
    
    arn - The unique Amazon Resource Name (ARN) for the profile.
  - getArn
```
public String getArn()
```
    The unique Amazon Resource Name (ARN) for the profile.
    
    Returns:
    
    The unique Amazon Resource Name (ARN) for the profile.
  - withArn
```
public DescribedProfile withArn(String arn)
```
    The unique Amazon Resource Name (ARN) for the profile.
    
    Parameters:
    
    arn - The unique Amazon Resource Name (ARN) for the profile.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setProfileId
```
public void setProfileId(String profileId)
```
    A unique identifier for the local or partner AS2 profile.
    
    Parameters:
    
    profileId - A unique identifier for the local or partner AS2 profile.
  - getProfileId
```
public String getProfileId()
```
    A unique identifier for the local or partner AS2 profile.
    
    Returns:
    
    A unique identifier for the local or partner AS2 profile.
  - withProfileId
```
public DescribedProfile withProfileId(String profileId)
```
    A unique identifier for the local or partner AS2 profile.
    
    Parameters:
    
    profileId - A unique identifier for the local or partner AS2 profile.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setProfileType
```
public void setProfileType(String 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.
    
    Parameters:
    
    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.
    
    See Also:
    
    ProfileType
  - getProfileType
```
public String getProfileType()
```
    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.
    
    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
  - withProfileType
```
public DescribedProfile withProfileType(String 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ProfileType
  - withProfileType
```
public DescribedProfile withProfileType(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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ProfileType
  - setAs2Id
```
public void setAs2Id(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.
    
    Parameters:
    
    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.
  - getAs2Id
```
public String getAs2Id()
```
    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.
  - withAs2Id
```
public DescribedProfile withAs2Id(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - getCertificateIds
```
public List<String> getCertificateIds()
```
    An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles.
    
    Returns:
    
    An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles.
  - setCertificateIds
```
public void setCertificateIds(Collection<String> certificateIds)
```
    An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles.
    
    Parameters:
    
    certificateIds - An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles.
  - withCertificateIds
```
public DescribedProfile withCertificateIds(String... certificateIds)
```
    An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles.
    
    NOTE: This method appends the values to the existing list (if any). Use setCertificateIds(java.util.Collection) or withCertificateIds(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    certificateIds - An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withCertificateIds
```
public DescribedProfile withCertificateIds(Collection<String> certificateIds)
```
    An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles.
    
    Parameters:
    
    certificateIds - An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles.
    
    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 profiles.
    
    Returns:
    
    Key-value pairs that can be used to group and search for profiles.
  - setTags
```
public void setTags(Collection<Tag> tags)
```
    Key-value pairs that can be used to group and search for profiles.
    
    Parameters:
    
    tags - Key-value pairs that can be used to group and search for profiles.
  - withTags
```
public DescribedProfile withTags(Tag... tags)
```
    Key-value pairs that can be used to group and search for profiles.
    
    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 profiles.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withTags
```
public DescribedProfile withTags(Collection<Tag> tags)
```
    Key-value pairs that can be used to group and search for profiles.
    
    Parameters:
    
    tags - Key-value pairs that can be used to group and search for profiles.
    
    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 DescribedProfile clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.780

Class DescribedProfile

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DescribedProfile

Method Detail

setArn

getArn

withArn

setProfileId

getProfileId

withProfileId

setProfileType

getProfileType

withProfileType

withProfileType

setAs2Id

getAs2Id

withAs2Id

getCertificateIds

setCertificateIds

withCertificateIds

withCertificateIds

getTags

setTags

withTags

withTags

toString

equals

hashCode

clone

marshall