software.amazon.awssdk.services.codebuild.model.ProjectFileSystemLocation Maven / Gradle / Ivy
Show all versions of codebuild Show documentation
/*
* Copyright 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 software.amazon.awssdk.services.codebuild.model;
import java.io.Serializable;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Function;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* Information about a file system created by Amazon Elastic File System (EFS). For more information, see What Is Amazon Elastic File System?
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class ProjectFileSystemLocation implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField TYPE_FIELD = SdkField. builder(MarshallingType.STRING).memberName("type")
.getter(getter(ProjectFileSystemLocation::typeAsString)).setter(setter(Builder::type))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("type").build()).build();
private static final SdkField LOCATION_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("location").getter(getter(ProjectFileSystemLocation::location)).setter(setter(Builder::location))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("location").build()).build();
private static final SdkField MOUNT_POINT_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("mountPoint").getter(getter(ProjectFileSystemLocation::mountPoint)).setter(setter(Builder::mountPoint))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("mountPoint").build()).build();
private static final SdkField IDENTIFIER_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("identifier").getter(getter(ProjectFileSystemLocation::identifier)).setter(setter(Builder::identifier))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("identifier").build()).build();
private static final SdkField MOUNT_OPTIONS_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("mountOptions").getter(getter(ProjectFileSystemLocation::mountOptions))
.setter(setter(Builder::mountOptions))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("mountOptions").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(TYPE_FIELD, LOCATION_FIELD,
MOUNT_POINT_FIELD, IDENTIFIER_FIELD, MOUNT_OPTIONS_FIELD));
private static final long serialVersionUID = 1L;
private final String type;
private final String location;
private final String mountPoint;
private final String identifier;
private final String mountOptions;
private ProjectFileSystemLocation(BuilderImpl builder) {
this.type = builder.type;
this.location = builder.location;
this.mountPoint = builder.mountPoint;
this.identifier = builder.identifier;
this.mountOptions = builder.mountOptions;
}
/**
*
* 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, {@link #type} will return
* {@link FileSystemType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #typeAsString}.
*
*
* @return The type of the file system. The one supported type is EFS.
* @see FileSystemType
*/
public final FileSystemType type() {
return FileSystemType.fromValue(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, {@link #type} will return
* {@link FileSystemType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #typeAsString}.
*
*
* @return The type of the file system. The one supported type is EFS.
* @see FileSystemType
*/
public final String typeAsString() {
return 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.
*
*
* @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 final String location() {
return location;
}
/**
*
* The location in the container where you mount the file system.
*
*
* @return The location in the container where you mount the file system.
*/
public final String mountPoint() {
return 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.
*
*
* @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 final String identifier() {
return 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.
*
*
* @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 final String mountOptions() {
return mountOptions;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + Objects.hashCode(typeAsString());
hashCode = 31 * hashCode + Objects.hashCode(location());
hashCode = 31 * hashCode + Objects.hashCode(mountPoint());
hashCode = 31 * hashCode + Objects.hashCode(identifier());
hashCode = 31 * hashCode + Objects.hashCode(mountOptions());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof ProjectFileSystemLocation)) {
return false;
}
ProjectFileSystemLocation other = (ProjectFileSystemLocation) obj;
return Objects.equals(typeAsString(), other.typeAsString()) && Objects.equals(location(), other.location())
&& Objects.equals(mountPoint(), other.mountPoint()) && Objects.equals(identifier(), other.identifier())
&& Objects.equals(mountOptions(), other.mountOptions());
}
/**
* 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.
*/
@Override
public final String toString() {
return ToString.builder("ProjectFileSystemLocation").add("Type", typeAsString()).add("Location", location())
.add("MountPoint", mountPoint()).add("Identifier", identifier()).add("MountOptions", mountOptions()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "type":
return Optional.ofNullable(clazz.cast(typeAsString()));
case "location":
return Optional.ofNullable(clazz.cast(location()));
case "mountPoint":
return Optional.ofNullable(clazz.cast(mountPoint()));
case "identifier":
return Optional.ofNullable(clazz.cast(identifier()));
case "mountOptions":
return Optional.ofNullable(clazz.cast(mountOptions()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((ProjectFileSystemLocation) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* 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
* @return Returns a reference to this object so that method calls can be chained together.
* @see FileSystemType
*/
Builder type(String 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.
* @see FileSystemType
* @return Returns a reference to this object so that method calls can be chained together.
* @see FileSystemType
*/
Builder type(FileSystemType 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.
*
*
* @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.
*/
Builder location(String location);
/**
*
* 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.
*/
Builder mountPoint(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.
*
*
* @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.
*/
Builder identifier(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.
*
*
* @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.
*/
Builder mountOptions(String mountOptions);
}
static final class BuilderImpl implements Builder {
private String type;
private String location;
private String mountPoint;
private String identifier;
private String mountOptions;
private BuilderImpl() {
}
private BuilderImpl(ProjectFileSystemLocation model) {
type(model.type);
location(model.location);
mountPoint(model.mountPoint);
identifier(model.identifier);
mountOptions(model.mountOptions);
}
public final String getType() {
return type;
}
public final void setType(String type) {
this.type = type;
}
@Override
public final Builder type(String type) {
this.type = type;
return this;
}
@Override
public final Builder type(FileSystemType type) {
this.type(type == null ? null : type.toString());
return this;
}
public final String getLocation() {
return location;
}
public final void setLocation(String location) {
this.location = location;
}
@Override
public final Builder location(String location) {
this.location = location;
return this;
}
public final String getMountPoint() {
return mountPoint;
}
public final void setMountPoint(String mountPoint) {
this.mountPoint = mountPoint;
}
@Override
public final Builder mountPoint(String mountPoint) {
this.mountPoint = mountPoint;
return this;
}
public final String getIdentifier() {
return identifier;
}
public final void setIdentifier(String identifier) {
this.identifier = identifier;
}
@Override
public final Builder identifier(String identifier) {
this.identifier = identifier;
return this;
}
public final String getMountOptions() {
return mountOptions;
}
public final void setMountOptions(String mountOptions) {
this.mountOptions = mountOptions;
}
@Override
public final Builder mountOptions(String mountOptions) {
this.mountOptions = mountOptions;
return this;
}
@Override
public ProjectFileSystemLocation build() {
return new ProjectFileSystemLocation(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}