software.amazon.awssdk.services.codebuild.model

Class ProjectFileSystemLocation

java.lang.Object

software.amazon.awssdk.services.codebuild.model.ProjectFileSystemLocation

All Implemented Interfaces:

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

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

Information about a file system created by Amazon Elastic File System (EFS). For more information, see What Is Amazon Elastic File System?

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ProjectFileSystemLocation.Builder

Method Summary

Modifier and Type	Method and Description
static ProjectFileSystemLocation.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	identifier() The name used to access a file system created by Amazon EFS.
String	location() A string that specifies the location of the file system created by Amazon EFS.
String	mountOptions() The mount options for a file system created by AWS EFS.
String	mountPoint() The location in the container where you mount the file system.
List<SdkField<?>>	sdkFields()
static Class<? extends ProjectFileSystemLocation.Builder>	serializableBuilderClass()
ProjectFileSystemLocation.Builder	toBuilder()
String	toString() Returns a string representation of this object.
FileSystemType	type() The type of the file system.
String	typeAsString() The type of the file system.

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

type

public final FileSystemType type()

The type of the file system. The one supported type is EFS.

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

Returns:

The type of the file system. The one supported type is EFS.

See Also:

FileSystemType

typeAsString

public final String typeAsString()

The type of the file system. The one supported type is EFS.

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

Returns:

The type of the file system. The one supported type is EFS.

See Also:

FileSystemType

location

public final String location()

A string that specifies the location of the file system created by Amazon EFS. Its format is efs-dns-name:/directory-path. You can find the DNS name of file system when you view it in the AWS EFS console. The directory path is a path to a directory in the file system that CodeBuild mounts. For example, if the DNS name of a file system is fs-abcd1234.efs.us-west-2.amazonaws.com, and its mount directory is my-efs-mount-directory, then the location is fs-abcd1234.efs.us-west-2.amazonaws.com:/my-efs-mount-directory.

The directory path in the format efs-dns-name:/directory-path is optional. If you do not specify a directory path, the location is only the DNS name and CodeBuild mounts the entire file system.

Returns:

A string that specifies the location of the file system created by Amazon EFS. Its format is efs-dns-name:/directory-path. You can find the DNS name of file system when you view it in the AWS EFS console. The directory path is a path to a directory in the file system that CodeBuild mounts. For example, if the DNS name of a file system is fs-abcd1234.efs.us-west-2.amazonaws.com, and its mount directory is my-efs-mount-directory, then the location is fs-abcd1234.efs.us-west-2.amazonaws.com:/my-efs-mount-directory.

The directory path in the format efs-dns-name:/directory-path is optional. If you do not specify a directory path, the location is only the DNS name and CodeBuild mounts the entire file system.

mountPoint

public final String mountPoint()

The location in the container where you mount the file system.

Returns:

The location in the container where you mount the file system.

identifier

public final String identifier()

The name used to access a file system created by Amazon EFS. CodeBuild creates an environment variable by appending the identifier in all capital letters to CODEBUILD_. For example, if you specify my_efs for identifier, a new environment variable is create named CODEBUILD_MY_EFS.

The identifier is used to mount your file system.

Returns:

The name used to access a file system created by Amazon EFS. CodeBuild creates an environment variable by appending the identifier in all capital letters to CODEBUILD_. For example, if you specify my_efs for identifier, a new environment variable is create named CODEBUILD_MY_EFS.

The identifier is used to mount your file system.

mountOptions

public final String mountOptions()

The mount options for a file system created by AWS EFS. The default mount options used by CodeBuild are nfsvers=4.1,rsize=1048576,wsize=1048576,hard,timeo=600,retrans=2. For more information, see Recommended NFS Mount Options.

Returns:

The mount options for a file system created by AWS EFS. The default mount options used by CodeBuild are nfsvers=4.1,rsize=1048576,wsize=1048576,hard,timeo=600,retrans=2. For more information, see Recommended NFS Mount Options.

toBuilder

public ProjectFileSystemLocation.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ProjectFileSystemLocation.Builder,ProjectFileSystemLocation>

builder

public static ProjectFileSystemLocation.Builder builder()

serializableBuilderClass

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