Class ProjectFileSystemLocation

java.lang.Object
software.amazon.awssdk.services.codebuild.model.ProjectFileSystemLocation
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<ProjectFileSystemLocation.Builder,ProjectFileSystemLocation>
@Generated("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:

  • Method Details

    • 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:

    • 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:

    • 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 Amazon 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 Amazon 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 Amazon 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 Amazon 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()
      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 interface ToCopyableBuilder<ProjectFileSystemLocation.Builder,ProjectFileSystemLocation>
      Returns:
      a builder for type T

    • 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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.