Package software.amazon.awssdk.services.efs.model

Class CreateAccessPointRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.efs.model.EfsRequest

software.amazon.awssdk.services.efs.model.CreateAccessPointRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateAccessPointRequest.Builder,CreateAccessPointRequest>

@Generated("software.amazon.awssdk:codegen")
public final class CreateAccessPointRequest
extends EfsRequest
implements ToCopyableBuilder<CreateAccessPointRequest.Builder,CreateAccessPointRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateAccessPointRequest.Builder

Method Summary

Modifier and Type	Method	Description
static CreateAccessPointRequest.Builder	builder()
String	clientToken()	A string of up to 64 ASCII characters that Amazon EFS uses 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 provides access 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.
PosixUser	posixUser()	The operating system user and group applied to all file system requests made using the access point.
RootDirectory	rootDirectory()	Specifies the directory on the EFS file system that the access point exposes as the root directory of your file system to NFS clients using the access point.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateAccessPointRequest.Builder>	serializableBuilderClass()
List<Tag>	tags()	Creates tags associated with the access point.
CreateAccessPointRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

A string of up to 64 ASCII characters that Amazon EFS uses to ensure idempotent creation.

Returns:

A string of up to 64 ASCII characters that Amazon EFS uses to ensure idempotent creation.

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

Creates tags associated with the access point. Each tag is a key-value pair, each key must be unique. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.

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:

Creates tags associated with the access point. Each tag is a key-value pair, each key must be unique. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.

fileSystemId

public final String fileSystemId()

The ID of the EFS file system that the access point provides access to.

Returns:

The ID of the EFS file system that the access point provides access to.

posixUser

public final PosixUser posixUser()

The operating system user and group applied to all file system requests made using the access point.

Returns:

The operating system user and group applied to all file system requests made using the access point.

rootDirectory

public final RootDirectory rootDirectory()

Specifies the directory on the EFS file system that the access point exposes as the root directory of your file system to NFS clients using the access point. The clients using the access point can only access the root directory and below. If the RootDirectory > Path specified does not exist, Amazon EFS creates it and applies the CreationInfo settings when a client connects to an access point. When specifying a RootDirectory, you must provide the Path, and the CreationInfo.

Amazon EFS creates a root directory only if you have provided the CreationInfo: OwnUid, OwnGID, and permissions for the directory. If you do not provide this information, Amazon EFS does not create the root directory. If the root directory does not exist, attempts to mount using the access point will fail.

Returns:

Specifies the directory on the EFS file system that the access point exposes as the root directory of your file system to NFS clients using the access point. The clients using the access point can only access the root directory and below. If the RootDirectory > Path specified does not exist, Amazon EFS creates it and applies the CreationInfo settings when a client connects to an access point. When specifying a RootDirectory, you must provide the Path, and the CreationInfo.

Amazon EFS creates a root directory only if you have provided the CreationInfo: OwnUid, OwnGID, and permissions for the directory. If you do not provide this information, Amazon EFS does not create the root directory. If the root directory does not exist, attempts to mount using the access point will fail.

toBuilder

public CreateAccessPointRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateAccessPointRequest.Builder,CreateAccessPointRequest>

Specified by:

toBuilder in class EfsRequest

builder

public static CreateAccessPointRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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 SdkRequest

sdkFields

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

Specified by:

sdkFields in interface SdkPojo