software.amazon.awssdk.services.efs.model

Class AccessPointDescription

java.lang.Object

software.amazon.awssdk.services.efs.model.AccessPointDescription

All Implemented Interfaces:

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

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

Provides a description of an EFS file system access point.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AccessPointDescription.Builder

Method Summary

Modifier and Type	Method and Description
String	accessPointArn() The unique Amazon Resource Name (ARN) associated with the access point.
String	accessPointId() The ID of the access point, assigned by Amazon EFS.
static AccessPointDescription.Builder	builder()
String	clientToken() The opaque string specified in the request to ensure idempotent creation.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	fileSystemId() The ID of the EFS file system that the access point applies to.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags() Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
LifeCycleState	lifeCycleState() Identifies the lifecycle phase of the access point.
String	lifeCycleStateAsString() Identifies the lifecycle phase of the access point.
String	name() The name of the access point.
String	ownerId() Identified the AWS account that owns the access point resource.
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.
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.
List<SdkField<?>>	sdkFields()
static Class<? extends AccessPointDescription.Builder>	serializableBuilderClass()
List<Tag>	tags() The tags associated with the access point, presented as an array of Tag objects.
AccessPointDescription.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

clientToken

public final String clientToken()

The opaque string specified in the request to ensure idempotent creation.

Returns:

The opaque string specified in the request to ensure idempotent creation.

name

public final String name()

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.

hasTags

public final boolean hasTags()

Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

tags

public final List<Tag> tags()

The tags associated with the access point, presented as an array of Tag objects.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasTags() to see if a value was sent in this field.

Returns:

The tags associated with the access point, presented as an array of Tag objects.

accessPointId

public final String accessPointId()

The ID of the access point, assigned by Amazon EFS.

Returns:

The ID of the access point, assigned by Amazon EFS.

accessPointArn

public final String accessPointArn()

The unique Amazon Resource Name (ARN) associated with the access point.

Returns:

The unique Amazon Resource Name (ARN) associated with the access point.

fileSystemId

public final String fileSystemId()

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.

posixUser

public final 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.

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.

rootDirectory

public final 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.

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.

ownerId

public final String ownerId()

Identified the AWS account that owns the access point resource.

Returns:

Identified the AWS account that owns the access point resource.

lifeCycleState

public final LifeCycleState lifeCycleState()

Identifies the lifecycle phase of the access point.

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

Returns:

Identifies the lifecycle phase of the access point.

See Also:

LifeCycleState

lifeCycleStateAsString

public final String lifeCycleStateAsString()

Identifies the lifecycle phase of the access point.

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

Returns:

Identifies the lifecycle phase of the access point.

See Also:

LifeCycleState

toBuilder

public AccessPointDescription.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AccessPointDescription.Builder,AccessPointDescription>

builder

public static AccessPointDescription.Builder builder()

serializableBuilderClass

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