com.amazonaws.services.batch.model.Device 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;
/**
*
* An object that represents a container instance host device.
*
*
*
* This object isn't applicable to jobs that are running on Fargate resources and shouldn't be provided.
*
*
*
* @see AWS API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class Device implements Serializable, Cloneable, StructuredPojo {
/**
*
* The path for the device on the host container instance.
*
*/
private String hostPath;
/**
*
* The path inside the container that's used to expose the host device. By default, the hostPath value
* is used.
*
*/
private String containerPath;
/**
*
* The explicit permissions to provide to the container for the device. By default, the container has permissions
* for read, write, and mknod for the device.
*
*/
private java.util.List permissions;
/**
*
* The path for the device on the host container instance.
*
*
* @param hostPath
* The path for the device on the host container instance.
*/
public void setHostPath(String hostPath) {
this.hostPath = hostPath;
}
/**
*
* The path for the device on the host container instance.
*
*
* @return The path for the device on the host container instance.
*/
public String getHostPath() {
return this.hostPath;
}
/**
*
* The path for the device on the host container instance.
*
*
* @param hostPath
* The path for the device on the host container instance.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Device withHostPath(String hostPath) {
setHostPath(hostPath);
return this;
}
/**
*
* The path inside the container that's used to expose the host device. By default, the hostPath value
* is used.
*
*
* @param containerPath
* The path inside the container that's used to expose the host device. By default, the hostPath
* value is used.
*/
public void setContainerPath(String containerPath) {
this.containerPath = containerPath;
}
/**
*
* The path inside the container that's used to expose the host device. By default, the hostPath value
* is used.
*
*
* @return The path inside the container that's used to expose the host device. By default, the
* hostPath value is used.
*/
public String getContainerPath() {
return this.containerPath;
}
/**
*
* The path inside the container that's used to expose the host device. By default, the hostPath value
* is used.
*
*
* @param containerPath
* The path inside the container that's used to expose the host device. By default, the hostPath
* value is used.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Device withContainerPath(String containerPath) {
setContainerPath(containerPath);
return this;
}
/**
*
* The explicit permissions to provide to the container for the device. By default, the container has permissions
* for read, write, and mknod for the device.
*
*
* @return The explicit permissions to provide to the container for the device. By default, the container has
* permissions for read, write, and mknod for the device.
* @see DeviceCgroupPermission
*/
public java.util.List getPermissions() {
return permissions;
}
/**
*
* The explicit permissions to provide to the container for the device. By default, the container has permissions
* for read, write, and mknod for the device.
*
*
* @param permissions
* The explicit permissions to provide to the container for the device. By default, the container has
* permissions for read, write, and mknod for the device.
* @see DeviceCgroupPermission
*/
public void setPermissions(java.util.Collection permissions) {
if (permissions == null) {
this.permissions = null;
return;
}
this.permissions = new java.util.ArrayList(permissions);
}
/**
*
* The explicit permissions to provide to the container for the device. By default, the container has permissions
* for read, write, and mknod for the device.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setPermissions(java.util.Collection)} or {@link #withPermissions(java.util.Collection)} if you want to
* override the existing values.
*
*
* @param permissions
* The explicit permissions to provide to the container for the device. By default, the container has
* permissions for read, write, and mknod for the device.
* @return Returns a reference to this object so that method calls can be chained together.
* @see DeviceCgroupPermission
*/
public Device withPermissions(String... permissions) {
if (this.permissions == null) {
setPermissions(new java.util.ArrayList(permissions.length));
}
for (String ele : permissions) {
this.permissions.add(ele);
}
return this;
}
/**
*
* The explicit permissions to provide to the container for the device. By default, the container has permissions
* for read, write, and mknod for the device.
*
*
* @param permissions
* The explicit permissions to provide to the container for the device. By default, the container has
* permissions for read, write, and mknod for the device.
* @return Returns a reference to this object so that method calls can be chained together.
* @see DeviceCgroupPermission
*/
public Device withPermissions(java.util.Collection permissions) {
setPermissions(permissions);
return this;
}
/**
*
* The explicit permissions to provide to the container for the device. By default, the container has permissions
* for read, write, and mknod for the device.
*
*
* @param permissions
* The explicit permissions to provide to the container for the device. By default, the container has
* permissions for read, write, and mknod for the device.
* @return Returns a reference to this object so that method calls can be chained together.
* @see DeviceCgroupPermission
*/
public Device withPermissions(DeviceCgroupPermission... permissions) {
java.util.ArrayList permissionsCopy = new java.util.ArrayList(permissions.length);
for (DeviceCgroupPermission value : permissions) {
permissionsCopy.add(value.toString());
}
if (getPermissions() == null) {
setPermissions(permissionsCopy);
} else {
getPermissions().addAll(permissionsCopy);
}
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 (getHostPath() != null)
sb.append("HostPath: ").append(getHostPath()).append(",");
if (getContainerPath() != null)
sb.append("ContainerPath: ").append(getContainerPath()).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 Device == false)
return false;
Device other = (Device) obj;
if (other.getHostPath() == null ^ this.getHostPath() == null)
return false;
if (other.getHostPath() != null && other.getHostPath().equals(this.getHostPath()) == false)
return false;
if (other.getContainerPath() == null ^ this.getContainerPath() == null)
return false;
if (other.getContainerPath() != null && other.getContainerPath().equals(this.getContainerPath()) == 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 + ((getHostPath() == null) ? 0 : getHostPath().hashCode());
hashCode = prime * hashCode + ((getContainerPath() == null) ? 0 : getContainerPath().hashCode());
hashCode = prime * hashCode + ((getPermissions() == null) ? 0 : getPermissions().hashCode());
return hashCode;
}
@Override
public Device clone() {
try {
return (Device) 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.DeviceMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}