com.amazonaws.services.codebuild.model.ProjectFileSystemLocation Maven / Gradle / Ivy
Show all versions of aws-java-sdk-codebuild Show documentation
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.codebuild.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* Information about a file system created by Amazon Elastic File System (EFS). For more information, see What Is Amazon Elastic File System?
*
*
* @see AWS API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class ProjectFileSystemLocation implements Serializable, Cloneable, StructuredPojo {
/**
*
* The type of the file system. The one supported type is EFS.
*
*/
private String type;
/**
*
* 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.
*
*/
private String location;
/**
*
* The location in the container where you mount the file system.
*
*/
private String mountPoint;
/**
*
* 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.
*
*/
private String identifier;
/**
*
* 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.
*
*/
private String mountOptions;
/**
*
* The type of the file system. The one supported type is EFS.
*
*
* @param type
* The type of the file system. The one supported type is EFS.
* @see FileSystemType
*/
public void setType(String type) {
this.type = type;
}
/**
*
* The type of the file system. The one supported type is EFS.
*
*
* @return The type of the file system. The one supported type is EFS.
* @see FileSystemType
*/
public String getType() {
return this.type;
}
/**
*
* The type of the file system. The one supported type is EFS.
*
*
* @param type
* The type of the file system. The one supported type is EFS.
* @return Returns a reference to this object so that method calls can be chained together.
* @see FileSystemType
*/
public ProjectFileSystemLocation withType(String type) {
setType(type);
return this;
}
/**
*
* The type of the file system. The one supported type is EFS.
*
*
* @param type
* The type of the file system. The one supported type is EFS.
* @return Returns a reference to this object so that method calls can be chained together.
* @see FileSystemType
*/
public ProjectFileSystemLocation withType(FileSystemType type) {
this.type = type.toString();
return this;
}
/**
*
* 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.
*
*
* @param 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.
*/
public void setLocation(String location) {
this.location = 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.
*
*
* @return 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.
*/
public String getLocation() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ProjectFileSystemLocation withLocation(String location) {
setLocation(location);
return this;
}
/**
*
* The location in the container where you mount the file system.
*
*
* @param mountPoint
* The location in the container where you mount the file system.
*/
public void setMountPoint(String mountPoint) {
this.mountPoint = mountPoint;
}
/**
*
* The location in the container where you mount the file system.
*
*
* @return The location in the container where you mount the file system.
*/
public String getMountPoint() {
return this.mountPoint;
}
/**
*
* The location in the container where you mount the file system.
*
*
* @param mountPoint
* The location in the container where you mount the file system.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ProjectFileSystemLocation withMountPoint(String mountPoint) {
setMountPoint(mountPoint);
return this;
}
/**
*
* 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.
*
*
* @param 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.
*/
public void setIdentifier(String identifier) {
this.identifier = 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.
*
*
* @return 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.
*/
public String getIdentifier() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ProjectFileSystemLocation withIdentifier(String identifier) {
setIdentifier(identifier);
return this;
}
/**
*
* 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.
*
*
* @param 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.
*/
public void setMountOptions(String mountOptions) {
this.mountOptions = 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.
*
*
* @return 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.
*/
public String getMountOptions() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ProjectFileSystemLocation withMountOptions(String mountOptions) {
setMountOptions(mountOptions);
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getType() != null)
sb.append("Type: ").append(getType()).append(",");
if (getLocation() != null)
sb.append("Location: ").append(getLocation()).append(",");
if (getMountPoint() != null)
sb.append("MountPoint: ").append(getMountPoint()).append(",");
if (getIdentifier() != null)
sb.append("Identifier: ").append(getIdentifier()).append(",");
if (getMountOptions() != null)
sb.append("MountOptions: ").append(getMountOptions());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof ProjectFileSystemLocation == false)
return false;
ProjectFileSystemLocation other = (ProjectFileSystemLocation) obj;
if (other.getType() == null ^ this.getType() == null)
return false;
if (other.getType() != null && other.getType().equals(this.getType()) == false)
return false;
if (other.getLocation() == null ^ this.getLocation() == null)
return false;
if (other.getLocation() != null && other.getLocation().equals(this.getLocation()) == false)
return false;
if (other.getMountPoint() == null ^ this.getMountPoint() == null)
return false;
if (other.getMountPoint() != null && other.getMountPoint().equals(this.getMountPoint()) == false)
return false;
if (other.getIdentifier() == null ^ this.getIdentifier() == null)
return false;
if (other.getIdentifier() != null && other.getIdentifier().equals(this.getIdentifier()) == false)
return false;
if (other.getMountOptions() == null ^ this.getMountOptions() == null)
return false;
if (other.getMountOptions() != null && other.getMountOptions().equals(this.getMountOptions()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getType() == null) ? 0 : getType().hashCode());
hashCode = prime * hashCode + ((getLocation() == null) ? 0 : getLocation().hashCode());
hashCode = prime * hashCode + ((getMountPoint() == null) ? 0 : getMountPoint().hashCode());
hashCode = prime * hashCode + ((getIdentifier() == null) ? 0 : getIdentifier().hashCode());
hashCode = prime * hashCode + ((getMountOptions() == null) ? 0 : getMountOptions().hashCode());
return hashCode;
}
@Override
public ProjectFileSystemLocation clone() {
try {
return (ProjectFileSystemLocation) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
@com.amazonaws.annotation.SdkInternalApi
@Override
public void marshall(ProtocolMarshaller protocolMarshaller) {
com.amazonaws.services.codebuild.model.transform.ProjectFileSystemLocationMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}