AccessPointDescription (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.elasticfilesystem.model.AccessPointDescription

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

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

Provides a description of an EFS file system access point.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

AccessPointDescription()

Constructors
Constructor and Description
`AccessPointDescription()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AccessPointDescription`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getAccessPointArn()` The unique Amazon Resource Name (ARN) associated with the access point.
`String`	`getAccessPointId()` The ID of the access point, assigned by Amazon EFS.
`String`	`getClientToken()` The opaque string specified in the request to ensure idempotent creation.
`String`	`getFileSystemId()` The ID of the EFS file system that the access point applies to.
`String`	`getLifeCycleState()` Identifies the lifecycle phase of the access point.
`String`	`getName()` The name of the access point.
`String`	`getOwnerId()` Identified the Amazon Web Services account that owns the access point resource.
`PosixUser`	`getPosixUser()` The full POSIX identity, including the user ID, group ID, and secondary group IDs on the access point that is used for all file operations by NFS clients using the access point.
`RootDirectory`	`getRootDirectory()` The directory on the Amazon EFS file system that the access point exposes as the root directory to NFS clients using the access point.
`List<Tag>`	`getTags()` The tags associated with the access point, presented as an array of Tag objects.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAccessPointArn(String accessPointArn)` The unique Amazon Resource Name (ARN) associated with the access point.
`void`	`setAccessPointId(String accessPointId)` The ID of the access point, assigned by Amazon EFS.
`void`	`setClientToken(String clientToken)` The opaque string specified in the request to ensure idempotent creation.
`void`	`setFileSystemId(String fileSystemId)` The ID of the EFS file system that the access point applies to.
`void`	`setLifeCycleState(String lifeCycleState)` Identifies the lifecycle phase of the access point.
`void`	`setName(String name)` The name of the access point.
`void`	`setOwnerId(String ownerId)` Identified the Amazon Web Services account that owns the access point resource.
`void`	`setPosixUser(PosixUser posixUser)` The full POSIX identity, including the user ID, group ID, and secondary group IDs on the access point that is used for all file operations by NFS clients using the access point.
`void`	`setRootDirectory(RootDirectory rootDirectory)` The directory on the Amazon EFS file system that the access point exposes as the root directory to NFS clients using the access point.
`void`	`setTags(Collection<Tag> tags)` The tags associated with the access point, presented as an array of Tag objects.
`String`	`toString()` Returns a string representation of this object.
`AccessPointDescription`	`withAccessPointArn(String accessPointArn)` The unique Amazon Resource Name (ARN) associated with the access point.
`AccessPointDescription`	`withAccessPointId(String accessPointId)` The ID of the access point, assigned by Amazon EFS.
`AccessPointDescription`	`withClientToken(String clientToken)` The opaque string specified in the request to ensure idempotent creation.
`AccessPointDescription`	`withFileSystemId(String fileSystemId)` The ID of the EFS file system that the access point applies to.
`AccessPointDescription`	`withLifeCycleState(LifeCycleState lifeCycleState)` Identifies the lifecycle phase of the access point.
`AccessPointDescription`	`withLifeCycleState(String lifeCycleState)` Identifies the lifecycle phase of the access point.
`AccessPointDescription`	`withName(String name)` The name of the access point.
`AccessPointDescription`	`withOwnerId(String ownerId)` Identified the Amazon Web Services account that owns the access point resource.
`AccessPointDescription`	`withPosixUser(PosixUser posixUser)` The full POSIX identity, including the user ID, group ID, and secondary group IDs on the access point that is used for all file operations by NFS clients using the access point.
`AccessPointDescription`	`withRootDirectory(RootDirectory rootDirectory)` The directory on the Amazon EFS file system that the access point exposes as the root directory to NFS clients using the access point.
`AccessPointDescription`	`withTags(Collection<Tag> tags)` The tags associated with the access point, presented as an array of Tag objects.
`AccessPointDescription`	`withTags(Tag... tags)` The tags associated with the access point, presented as an array of Tag objects.

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

- Constructor Detail
  - AccessPointDescription
```
public AccessPointDescription()
```
- Method Detail
  - setClientToken
```
public void setClientToken(String clientToken)
```
    The opaque string specified in the request to ensure idempotent creation.
    
    Parameters:
    
    clientToken - The opaque string specified in the request to ensure idempotent creation.
  - getClientToken
```
public String getClientToken()
```
    The opaque string specified in the request to ensure idempotent creation.
    
    Returns:
    
    The opaque string specified in the request to ensure idempotent creation.
  - withClientToken
```
public AccessPointDescription withClientToken(String clientToken)
```
    The opaque string specified in the request to ensure idempotent creation.
    
    Parameters:
    
    clientToken - The opaque string specified in the request to ensure idempotent creation.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setName
```
public void setName(String name)
```
    The name of the access point. This is the value of the Name tag.
    
    Parameters:
    
    name - The name of the access point. This is the value of the Name tag.
  - getName
```
public String getName()
```
    The name of the access point. This is the value of the Name tag.
    
    Returns:
    
    The name of the access point. This is the value of the Name tag.
  - withName
```
public AccessPointDescription withName(String name)
```
    The name of the access point. This is the value of the Name tag.
    
    Parameters:
    
    name - The name of the access point. This is the value of the Name tag.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getTags
```
public List<Tag> getTags()
```
    The tags associated with the access point, presented as an array of Tag objects.
    
    Returns:
    
    The tags associated with the access point, presented as an array of Tag objects.
  - setTags
```
public void setTags(Collection<Tag> tags)
```
    The tags associated with the access point, presented as an array of Tag objects.
    
    Parameters:
    
    tags - The tags associated with the access point, presented as an array of Tag objects.
  - withTags
```
public AccessPointDescription withTags(Tag... tags)
```
    The tags associated with the access point, presented as an array of Tag objects.
    
    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 - The tags associated with the access point, presented as an array of Tag objects.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withTags
```
public AccessPointDescription withTags(Collection<Tag> tags)
```
    The tags associated with the access point, presented as an array of Tag objects.
    
    Parameters:
    
    tags - The tags associated with the access point, presented as an array of Tag objects.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAccessPointId
```
public void setAccessPointId(String accessPointId)
```
    The ID of the access point, assigned by Amazon EFS.
    
    Parameters:
    
    accessPointId - The ID of the access point, assigned by Amazon EFS.
  - getAccessPointId
```
public String getAccessPointId()
```
    The ID of the access point, assigned by Amazon EFS.
    
    Returns:
    
    The ID of the access point, assigned by Amazon EFS.
  - withAccessPointId
```
public AccessPointDescription withAccessPointId(String accessPointId)
```
    The ID of the access point, assigned by Amazon EFS.
    
    Parameters:
    
    accessPointId - The ID of the access point, assigned by Amazon EFS.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAccessPointArn
```
public void setAccessPointArn(String accessPointArn)
```
    The unique Amazon Resource Name (ARN) associated with the access point.
    
    Parameters:
    
    accessPointArn - The unique Amazon Resource Name (ARN) associated with the access point.
  - getAccessPointArn
```
public String getAccessPointArn()
```
    The unique Amazon Resource Name (ARN) associated with the access point.
    
    Returns:
    
    The unique Amazon Resource Name (ARN) associated with the access point.
  - withAccessPointArn
```
public AccessPointDescription withAccessPointArn(String accessPointArn)
```
    The unique Amazon Resource Name (ARN) associated with the access point.
    
    Parameters:
    
    accessPointArn - The unique Amazon Resource Name (ARN) associated with the access point.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setFileSystemId
```
public void setFileSystemId(String fileSystemId)
```
    The ID of the EFS file system that the access point applies to.
    
    Parameters:
    
    fileSystemId - The ID of the EFS file system that the access point applies to.
  - getFileSystemId
```
public String getFileSystemId()
```
    The ID of the EFS file system that the access point applies to.
    
    Returns:
    
    The ID of the EFS file system that the access point applies to.
  - withFileSystemId
```
public AccessPointDescription withFileSystemId(String fileSystemId)
```
    The ID of the EFS file system that the access point applies to.
    
    Parameters:
    
    fileSystemId - The ID of the EFS file system that the access point applies to.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPosixUser
```
public void setPosixUser(PosixUser posixUser)
```
    The full POSIX identity, including the user ID, group ID, and secondary group IDs on the access point that is used for all file operations by NFS clients using the access point.
    
    Parameters:
    
    posixUser - The full POSIX identity, including the user ID, group ID, and secondary group IDs on the access point that is used for all file operations by NFS clients using the access point.
  - getPosixUser
```
public PosixUser getPosixUser()
```
    The full POSIX identity, including the user ID, group ID, and secondary group IDs on the access point that is used for all file operations by NFS clients using the access point.
    
    Returns:
    
    The full POSIX identity, including the user ID, group ID, and secondary group IDs on the access point that is used for all file operations by NFS clients using the access point.
  - withPosixUser
```
public AccessPointDescription withPosixUser(PosixUser posixUser)
```
    The full POSIX identity, including the user ID, group ID, and secondary group IDs on the access point that is used for all file operations by NFS clients using the access point.
    
    Parameters:
    
    posixUser - The full POSIX identity, including the user ID, group ID, and secondary group IDs on the access point that is used for all file operations by NFS clients using the access point.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRootDirectory
```
public void setRootDirectory(RootDirectory rootDirectory)
```
    The directory on the Amazon EFS file system that the access point exposes as the root directory to NFS clients using the access point.
    
    Parameters:
    
    rootDirectory - The directory on the Amazon EFS file system that the access point exposes as the root directory to NFS clients using the access point.
  - getRootDirectory
```
public RootDirectory getRootDirectory()
```
    The directory on the Amazon EFS file system that the access point exposes as the root directory to NFS clients using the access point.
    
    Returns:
    
    The directory on the Amazon EFS file system that the access point exposes as the root directory to NFS clients using the access point.
  - withRootDirectory
```
public AccessPointDescription withRootDirectory(RootDirectory rootDirectory)
```
    The directory on the Amazon EFS file system that the access point exposes as the root directory to NFS clients using the access point.
    
    Parameters:
    
    rootDirectory - The directory on the Amazon EFS file system that the access point exposes as the root directory to NFS clients using the access point.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setOwnerId
```
public void setOwnerId(String ownerId)
```
    Identified the Amazon Web Services account that owns the access point resource.
    
    Parameters:
    
    ownerId - Identified the Amazon Web Services account that owns the access point resource.
  - getOwnerId
```
public String getOwnerId()
```
    Identified the Amazon Web Services account that owns the access point resource.
    
    Returns:
    
    Identified the Amazon Web Services account that owns the access point resource.
  - withOwnerId
```
public AccessPointDescription withOwnerId(String ownerId)
```
    Identified the Amazon Web Services account that owns the access point resource.
    
    Parameters:
    
    ownerId - Identified the Amazon Web Services account that owns the access point resource.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLifeCycleState
```
public void setLifeCycleState(String lifeCycleState)
```
    Identifies the lifecycle phase of the access point.
    
    Parameters:
    
    lifeCycleState - Identifies the lifecycle phase of the access point.
    
    See Also:
    
    LifeCycleState
  - getLifeCycleState
```
public String getLifeCycleState()
```
    Identifies the lifecycle phase of the access point.
    
    Returns:
    
    Identifies the lifecycle phase of the access point.
    
    See Also:
    
    LifeCycleState
  - withLifeCycleState
```
public AccessPointDescription withLifeCycleState(String lifeCycleState)
```
    Identifies the lifecycle phase of the access point.
    
    Parameters:
    
    lifeCycleState - Identifies the lifecycle phase of the access point.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    LifeCycleState
  - withLifeCycleState
```
public AccessPointDescription withLifeCycleState(LifeCycleState lifeCycleState)
```
    Identifies the lifecycle phase of the access point.
    
    Parameters:
    
    lifeCycleState - Identifies the lifecycle phase of the access point.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    LifeCycleState
  - 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 AccessPointDescription 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.

Did this page help you?

Class AccessPointDescription

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AccessPointDescription

Method Detail

setClientToken

getClientToken

withClientToken

setName

getName

withName

getTags

setTags

withTags

withTags

setAccessPointId

getAccessPointId

withAccessPointId

setAccessPointArn

getAccessPointArn

withAccessPointArn

setFileSystemId

getFileSystemId

withFileSystemId

setPosixUser

getPosixUser

withPosixUser

setRootDirectory

getRootDirectory

withRootDirectory

setOwnerId

getOwnerId

withOwnerId

setLifeCycleState

getLifeCycleState

withLifeCycleState

withLifeCycleState

toString

equals

hashCode

clone

marshall