Class CreateAccessPointRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<CreateAccessPointRequest.Builder,
CreateAccessPointRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final String
A string of up to 64 ASCII characters that Amazon EFS uses to ensure idempotent creation.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
The ID of the EFS file system that the access point provides access to.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final PosixUser
The operating system user and group applied to all file system requests made using the access point.final 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.static Class
<? extends CreateAccessPointRequest.Builder> tags()
Creates tags associated with the access point.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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 theisEmpty()
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
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
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
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
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 theCreationInfo
settings when a client connects to an access point. When specifying aRootDirectory
, you must provide thePath
, and theCreationInfo
.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 theCreationInfo
settings when a client connects to an access point. When specifying aRootDirectory
, you must provide thePath
, and theCreationInfo
.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
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<CreateAccessPointRequest.Builder,
CreateAccessPointRequest> - Specified by:
toBuilder
in classEfsRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-