com.amazonaws.services.batch.model.MountPoint Maven / Gradle / Ivy
Show all versions of aws-java-sdk-batch 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.batch.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* Details for a Docker volume mount point that's used in a job's container properties. This parameter maps to
* Volumes in the Create a container
* section of the Docker Remote API and the --volume option to docker run.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class MountPoint implements Serializable, Cloneable, StructuredPojo {
/**
*
* The path on the container where the host volume is mounted.
*
*/
private String containerPath;
/**
*
* If this value is true, the container has read-only access to the volume. Otherwise, the container
* can write to the volume. The default value is false.
*
*/
private Boolean readOnly;
/**
*
* The name of the volume to mount.
*
*/
private String sourceVolume;
/**
*
* The path on the container where the host volume is mounted.
*
*
* @param containerPath
* The path on the container where the host volume is mounted.
*/
public void setContainerPath(String containerPath) {
this.containerPath = containerPath;
}
/**
*
* The path on the container where the host volume is mounted.
*
*
* @return The path on the container where the host volume is mounted.
*/
public String getContainerPath() {
return this.containerPath;
}
/**
*
* The path on the container where the host volume is mounted.
*
*
* @param containerPath
* The path on the container where the host volume is mounted.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public MountPoint withContainerPath(String containerPath) {
setContainerPath(containerPath);
return this;
}
/**
*
* If this value is true, the container has read-only access to the volume. Otherwise, the container
* can write to the volume. The default value is false.
*
*
* @param readOnly
* If this value is true, the container has read-only access to the volume. Otherwise, the
* container can write to the volume. The default value is false.
*/
public void setReadOnly(Boolean readOnly) {
this.readOnly = readOnly;
}
/**
*
* If this value is true, the container has read-only access to the volume. Otherwise, the container
* can write to the volume. The default value is false.
*
*
* @return If this value is true, the container has read-only access to the volume. Otherwise, the
* container can write to the volume. The default value is false.
*/
public Boolean getReadOnly() {
return this.readOnly;
}
/**
*
* If this value is true, the container has read-only access to the volume. Otherwise, the container
* can write to the volume. The default value is false.
*
*
* @param readOnly
* If this value is true, the container has read-only access to the volume. Otherwise, the
* container can write to the volume. The default value is false.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public MountPoint withReadOnly(Boolean readOnly) {
setReadOnly(readOnly);
return this;
}
/**
*
* If this value is true, the container has read-only access to the volume. Otherwise, the container
* can write to the volume. The default value is false.
*
*
* @return If this value is true, the container has read-only access to the volume. Otherwise, the
* container can write to the volume. The default value is false.
*/
public Boolean isReadOnly() {
return this.readOnly;
}
/**
*
* The name of the volume to mount.
*
*
* @param sourceVolume
* The name of the volume to mount.
*/
public void setSourceVolume(String sourceVolume) {
this.sourceVolume = sourceVolume;
}
/**
*
* The name of the volume to mount.
*
*
* @return The name of the volume to mount.
*/
public String getSourceVolume() {
return this.sourceVolume;
}
/**
*
* The name of the volume to mount.
*
*
* @param sourceVolume
* The name of the volume to mount.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public MountPoint withSourceVolume(String sourceVolume) {
setSourceVolume(sourceVolume);
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 (getContainerPath() != null)
sb.append("ContainerPath: ").append(getContainerPath()).append(",");
if (getReadOnly() != null)
sb.append("ReadOnly: ").append(getReadOnly()).append(",");
if (getSourceVolume() != null)
sb.append("SourceVolume: ").append(getSourceVolume());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof MountPoint == false)
return false;
MountPoint other = (MountPoint) obj;
if (other.getContainerPath() == null ^ this.getContainerPath() == null)
return false;
if (other.getContainerPath() != null && other.getContainerPath().equals(this.getContainerPath()) == false)
return false;
if (other.getReadOnly() == null ^ this.getReadOnly() == null)
return false;
if (other.getReadOnly() != null && other.getReadOnly().equals(this.getReadOnly()) == false)
return false;
if (other.getSourceVolume() == null ^ this.getSourceVolume() == null)
return false;
if (other.getSourceVolume() != null && other.getSourceVolume().equals(this.getSourceVolume()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getContainerPath() == null) ? 0 : getContainerPath().hashCode());
hashCode = prime * hashCode + ((getReadOnly() == null) ? 0 : getReadOnly().hashCode());
hashCode = prime * hashCode + ((getSourceVolume() == null) ? 0 : getSourceVolume().hashCode());
return hashCode;
}
@Override
public MountPoint clone() {
try {
return (MountPoint) 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.batch.model.transform.MountPointMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}