software.amazon.awssdk.services.transfer.model

Class PosixProfile

java.lang.Object

software.amazon.awssdk.services.transfer.model.PosixProfile

All Implemented Interfaces:

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

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

The full POSIX identity, including user ID (Uid), group ID (Gid), and any secondary groups IDs (SecondaryGids), that controls your users' access to your Amazon EFS file systems. The POSIX permissions that are set on files and directories in your file system determine the level of access your users get when transferring files into and out of your Amazon EFS file systems.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	PosixProfile.Builder

Method Summary

Modifier and Type	Method and Description
static PosixProfile.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
Long	gid() The POSIX group ID used for all EFS operations by this user.
int	hashCode()
boolean	hasSecondaryGids() For responses, this returns true if the service returned a value for the SecondaryGids property.
List<SdkField<?>>	sdkFields()
List<Long>	secondaryGids() The secondary POSIX group IDs used for all EFS operations by this user.
static Class<? extends PosixProfile.Builder>	serializableBuilderClass()
PosixProfile.Builder	toBuilder()
String	toString() Returns a string representation of this object.
Long	uid() The POSIX user ID used for all EFS operations by this user.

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

uid

public final Long uid()

The POSIX user ID used for all EFS operations by this user.

Returns:

The POSIX user ID used for all EFS operations by this user.

gid

public final Long gid()

The POSIX group ID used for all EFS operations by this user.

Returns:

The POSIX group ID used for all EFS operations by this user.

hasSecondaryGids

public final boolean hasSecondaryGids()

For responses, this returns true if the service returned a value for the SecondaryGids 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.

secondaryGids

public final List<Long> secondaryGids()

The secondary POSIX group IDs used for all EFS operations by this user.

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 hasSecondaryGids() method.

Returns:

The secondary POSIX group IDs used for all EFS operations by this user.

toBuilder

public PosixProfile.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<PosixProfile.Builder,PosixProfile>

builder

public static PosixProfile.Builder builder()

serializableBuilderClass

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