com.amazonaws.services.elasticfilesystem.model.CreationInfo Maven / Gradle / Ivy
Show all versions of aws-java-sdk-efs 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.elasticfilesystem.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* Required if the RootDirectory > Path specified does not exist. Specifies the POSIX IDs
* and permissions to apply to the access point's RootDirectory > Path. If the access point
* root directory does not exist, EFS creates it with these settings when a client connects to the access point. When
* specifying CreationInfo, you must include values for all properties.
*
*
* Amazon EFS creates a root directory only if you have provided the CreationInfo: OwnUid, OwnGID, and permissions for
* the directory. If you do not provide this information, Amazon EFS does not create the root directory. If the root
* directory does not exist, attempts to mount using the access point will fail.
*
*
*
* If you do not provide CreationInfo and the specified RootDirectory does not exist, attempts
* to mount the file system using the access point will fail.
*
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class CreationInfo implements Serializable, Cloneable, StructuredPojo {
/**
*
* Specifies the POSIX user ID to apply to the RootDirectory. Accepts values from 0 to 2^32
* (4294967295).
*
*/
private Long ownerUid;
/**
*
* Specifies the POSIX group ID to apply to the RootDirectory. Accepts values from 0 to 2^32
* (4294967295).
*
*/
private Long ownerGid;
/**
*
* Specifies the POSIX permissions to apply to the RootDirectory, in the format of an octal number
* representing the file's mode bits.
*
*/
private String permissions;
/**
*
* Specifies the POSIX user ID to apply to the RootDirectory. Accepts values from 0 to 2^32
* (4294967295).
*
*
* @param ownerUid
* Specifies the POSIX user ID to apply to the RootDirectory. Accepts values from 0 to 2^32
* (4294967295).
*/
public void setOwnerUid(Long ownerUid) {
this.ownerUid = ownerUid;
}
/**
*
* Specifies the POSIX user ID to apply to the RootDirectory. Accepts values from 0 to 2^32
* (4294967295).
*
*
* @return Specifies the POSIX user ID to apply to the RootDirectory. Accepts values from 0 to 2^32
* (4294967295).
*/
public Long getOwnerUid() {
return this.ownerUid;
}
/**
*
* Specifies the POSIX user ID to apply to the RootDirectory. Accepts values from 0 to 2^32
* (4294967295).
*
*
* @param ownerUid
* Specifies the POSIX user ID to apply to the RootDirectory. Accepts values from 0 to 2^32
* (4294967295).
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreationInfo withOwnerUid(Long ownerUid) {
setOwnerUid(ownerUid);
return this;
}
/**
*
* Specifies the POSIX group ID to apply to the RootDirectory. Accepts values from 0 to 2^32
* (4294967295).
*
*
* @param ownerGid
* Specifies the POSIX group ID to apply to the RootDirectory. Accepts values from 0 to 2^32
* (4294967295).
*/
public void setOwnerGid(Long ownerGid) {
this.ownerGid = ownerGid;
}
/**
*
* Specifies the POSIX group ID to apply to the RootDirectory. Accepts values from 0 to 2^32
* (4294967295).
*
*
* @return Specifies the POSIX group ID to apply to the RootDirectory. Accepts values from 0 to 2^32
* (4294967295).
*/
public Long getOwnerGid() {
return this.ownerGid;
}
/**
*
* Specifies the POSIX group ID to apply to the RootDirectory. Accepts values from 0 to 2^32
* (4294967295).
*
*
* @param ownerGid
* Specifies the POSIX group ID to apply to the RootDirectory. Accepts values from 0 to 2^32
* (4294967295).
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreationInfo withOwnerGid(Long ownerGid) {
setOwnerGid(ownerGid);
return this;
}
/**
*
* Specifies the POSIX permissions to apply to the RootDirectory, in the format of an octal number
* representing the file's mode bits.
*
*
* @param permissions
* Specifies the POSIX permissions to apply to the RootDirectory, in the format of an octal
* number representing the file's mode bits.
*/
public void setPermissions(String permissions) {
this.permissions = permissions;
}
/**
*
* Specifies the POSIX permissions to apply to the RootDirectory, in the format of an octal number
* representing the file's mode bits.
*
*
* @return Specifies the POSIX permissions to apply to the RootDirectory, in the format of an octal
* number representing the file's mode bits.
*/
public String getPermissions() {
return this.permissions;
}
/**
*
* Specifies the POSIX permissions to apply to the RootDirectory, in the format of an octal number
* representing the file's mode bits.
*
*
* @param permissions
* Specifies the POSIX permissions to apply to the RootDirectory, in the format of an octal
* number representing the file's mode bits.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreationInfo withPermissions(String permissions) {
setPermissions(permissions);
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 (getOwnerUid() != null)
sb.append("OwnerUid: ").append(getOwnerUid()).append(",");
if (getOwnerGid() != null)
sb.append("OwnerGid: ").append(getOwnerGid()).append(",");
if (getPermissions() != null)
sb.append("Permissions: ").append(getPermissions());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof CreationInfo == false)
return false;
CreationInfo other = (CreationInfo) obj;
if (other.getOwnerUid() == null ^ this.getOwnerUid() == null)
return false;
if (other.getOwnerUid() != null && other.getOwnerUid().equals(this.getOwnerUid()) == false)
return false;
if (other.getOwnerGid() == null ^ this.getOwnerGid() == null)
return false;
if (other.getOwnerGid() != null && other.getOwnerGid().equals(this.getOwnerGid()) == false)
return false;
if (other.getPermissions() == null ^ this.getPermissions() == null)
return false;
if (other.getPermissions() != null && other.getPermissions().equals(this.getPermissions()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getOwnerUid() == null) ? 0 : getOwnerUid().hashCode());
hashCode = prime * hashCode + ((getOwnerGid() == null) ? 0 : getOwnerGid().hashCode());
hashCode = prime * hashCode + ((getPermissions() == null) ? 0 : getPermissions().hashCode());
return hashCode;
}
@Override
public CreationInfo clone() {
try {
return (CreationInfo) 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.CreationInfoMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}