software.amazon.awssdk.services.efs.model

Class CreateAccessPointResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.efs.model.EfsResponse

software.amazon.awssdk.services.efs.model.CreateAccessPointResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateAccessPointResponse.Builder,CreateAccessPointResponse>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateAccessPointResponse
extends EfsResponse
implements ToCopyableBuilder<CreateAccessPointResponse.Builder,CreateAccessPointResponse>

Provides a description of an EFS file system access point.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateAccessPointResponse.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 CreateAccessPointResponse.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() For responses, this returns true if the service returned a value for the Tags property.
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() Identifies the Amazon Web Services 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 CreateAccessPointResponse.Builder>	serializableBuilderClass()
List<Tag>	tags() The tags associated with the access point, presented as an array of Tag objects.
CreateAccessPointResponse.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.efs.model.EfsResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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

For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

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.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

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

Identifies the Amazon Web Services account that owns the access point resource.

Returns:

Identifies the Amazon Web Services 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 CreateAccessPointResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateAccessPointResponse.Builder,CreateAccessPointResponse>

Overrides:

toBuilder in class AwsResponse

builder

public static CreateAccessPointResponse.Builder builder()

serializableBuilderClass

public static Class<? extends CreateAccessPointResponse.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

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)

Overrides:

getValueForField in class SdkResponse

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo