com.amazonaws.services.elasticfilesystem.model.RootDirectory Maven / Gradle / Ivy
Show all versions of aws-java-sdk-efs Show documentation
/*
* Copyright 2018-2023 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.elasticfilesystem.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* Specifies the directory on the Amazon EFS file system that the access point provides access to. The access point
* exposes the specified file system path as the root directory of your file system to applications using the access
* point. NFS clients using the access point can only access data in the access point's RootDirectory and
* it's subdirectories.
*
*
* @see AWS
* API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class RootDirectory implements Serializable, Cloneable, StructuredPojo {
/**
*
* Specifies the path on the EFS file system to expose as the root directory to NFS clients using the access point
* to access the EFS file system. A path can have up to four subdirectories. If the specified path does not exist,
* you are required to provide the CreationInfo.
*
*/
private String path;
/**
*
* (Optional) Specifies the POSIX IDs and permissions to apply to the access point's RootDirectory. If
* the RootDirectory > Path specified does not exist, EFS creates the root directory
* using the CreationInfo settings when a client connects to an access point. When specifying the
* CreationInfo, you must provide values for all properties.
*
*
*
* If you do not provide CreationInfo and the specified RootDirectory >
* Path does not exist, attempts to mount the file system using the access point will fail.
*
*
*/
private CreationInfo creationInfo;
/**
*
* Specifies the path on the EFS file system to expose as the root directory to NFS clients using the access point
* to access the EFS file system. A path can have up to four subdirectories. If the specified path does not exist,
* you are required to provide the CreationInfo.
*
*
* @param path
* Specifies the path on the EFS file system to expose as the root directory to NFS clients using the access
* point to access the EFS file system. A path can have up to four subdirectories. If the specified path does
* not exist, you are required to provide the CreationInfo.
*/
public void setPath(String path) {
this.path = path;
}
/**
*
* Specifies the path on the EFS file system to expose as the root directory to NFS clients using the access point
* to access the EFS file system. A path can have up to four subdirectories. If the specified path does not exist,
* you are required to provide the CreationInfo.
*
*
* @return Specifies the path on the EFS file system to expose as the root directory to NFS clients using the access
* point to access the EFS file system. A path can have up to four subdirectories. If the specified path
* does not exist, you are required to provide the CreationInfo.
*/
public String getPath() {
return this.path;
}
/**
*
* Specifies the path on the EFS file system to expose as the root directory to NFS clients using the access point
* to access the EFS file system. A path can have up to four subdirectories. If the specified path does not exist,
* you are required to provide the CreationInfo.
*
*
* @param path
* Specifies the path on the EFS file system to expose as the root directory to NFS clients using the access
* point to access the EFS file system. A path can have up to four subdirectories. If the specified path does
* not exist, you are required to provide the CreationInfo.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RootDirectory withPath(String path) {
setPath(path);
return this;
}
/**
*
* (Optional) Specifies the POSIX IDs and permissions to apply to the access point's RootDirectory. If
* the RootDirectory > Path specified does not exist, EFS creates the root directory
* using the CreationInfo settings when a client connects to an access point. When specifying the
* CreationInfo, you must provide values for all properties.
*
*
*
* If you do not provide CreationInfo and the specified RootDirectory >
* Path does not exist, attempts to mount the file system using the access point will fail.
*
*
*
* @param creationInfo
* (Optional) Specifies the POSIX IDs and permissions to apply to the access point's
* RootDirectory. If the RootDirectory > Path specified does not
* exist, EFS creates the root directory using the CreationInfo settings when a client connects
* to an access point. When specifying the CreationInfo, you must provide values for all
* properties.
*
* If you do not provide CreationInfo and the specified RootDirectory >
* Path does not exist, attempts to mount the file system using the access point will fail.
*
*/
public void setCreationInfo(CreationInfo creationInfo) {
this.creationInfo = creationInfo;
}
/**
*
* (Optional) Specifies the POSIX IDs and permissions to apply to the access point's RootDirectory. If
* the RootDirectory > Path specified does not exist, EFS creates the root directory
* using the CreationInfo settings when a client connects to an access point. When specifying the
* CreationInfo, you must provide values for all properties.
*
*
*
* If you do not provide CreationInfo and the specified RootDirectory >
* Path does not exist, attempts to mount the file system using the access point will fail.
*
*
*
* @return (Optional) Specifies the POSIX IDs and permissions to apply to the access point's
* RootDirectory. If the RootDirectory > Path specified does not
* exist, EFS creates the root directory using the CreationInfo settings when a client connects
* to an access point. When specifying the CreationInfo, you must provide values for all
* properties.
*
* If you do not provide CreationInfo and the specified RootDirectory >
* Path does not exist, attempts to mount the file system using the access point will fail.
*
*/
public CreationInfo getCreationInfo() {
return this.creationInfo;
}
/**
*
* (Optional) Specifies the POSIX IDs and permissions to apply to the access point's RootDirectory. If
* the RootDirectory > Path specified does not exist, EFS creates the root directory
* using the CreationInfo settings when a client connects to an access point. When specifying the
* CreationInfo, you must provide values for all properties.
*
*
*
* If you do not provide CreationInfo and the specified RootDirectory >
* Path does not exist, attempts to mount the file system using the access point will fail.
*
*
*
* @param creationInfo
* (Optional) Specifies the POSIX IDs and permissions to apply to the access point's
* RootDirectory. If the RootDirectory > Path specified does not
* exist, EFS creates the root directory using the CreationInfo settings when a client connects
* to an access point. When specifying the CreationInfo, you must provide values for all
* properties.
*
* If you do not provide CreationInfo and the specified RootDirectory >
* Path does not exist, attempts to mount the file system using the access point will fail.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RootDirectory withCreationInfo(CreationInfo creationInfo) {
setCreationInfo(creationInfo);
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 (getPath() != null)
sb.append("Path: ").append(getPath()).append(",");
if (getCreationInfo() != null)
sb.append("CreationInfo: ").append(getCreationInfo());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof RootDirectory == false)
return false;
RootDirectory other = (RootDirectory) obj;
if (other.getPath() == null ^ this.getPath() == null)
return false;
if (other.getPath() != null && other.getPath().equals(this.getPath()) == false)
return false;
if (other.getCreationInfo() == null ^ this.getCreationInfo() == null)
return false;
if (other.getCreationInfo() != null && other.getCreationInfo().equals(this.getCreationInfo()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getPath() == null) ? 0 : getPath().hashCode());
hashCode = prime * hashCode + ((getCreationInfo() == null) ? 0 : getCreationInfo().hashCode());
return hashCode;
}
@Override
public RootDirectory clone() {
try {
return (RootDirectory) 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.elasticfilesystem.model.transform.RootDirectoryMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}