software.amazon.awssdk.services.batch.model

Class Device

java.lang.Object

software.amazon.awssdk.services.batch.model.Device

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Device.Builder,Device>

@Generated(value="software.amazon.awssdk:codegen")
public final class Device
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Device.Builder,Device>

An object representing a container instance host device.

This object isn't applicable to jobs that are running on Fargate resources and shouldn't be provided.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Device.Builder

Method Summary

Modifier and Type	Method and Description
static Device.Builder	builder()
String	containerPath() The path inside the container that's used to expose the host device.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasPermissions() For responses, this returns true if the service returned a value for the Permissions property.
String	hostPath() The path for the device on the host container instance.
List<DeviceCgroupPermission>	permissions() The explicit permissions to provide to the container for the device.
List<String>	permissionsAsStrings() The explicit permissions to provide to the container for the device.
List<SdkField<?>>	sdkFields()
static Class<? extends Device.Builder>	serializableBuilderClass()
Device.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

hostPath

public final String hostPath()

The path for the device on the host container instance.

Returns:

The path for the device on the host container instance.

containerPath

public final String containerPath()

The path inside the container that's used to expose the host device. By default, the hostPath value is used.

Returns:

The path inside the container that's used to expose the host device. By default, the hostPath value is used.

permissions

public final List<DeviceCgroupPermission> 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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasPermissions() method.

Returns:

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.

hasPermissions

public final boolean hasPermissions()

For responses, this returns true if the service returned a value for the Permissions property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

permissionsAsStrings

public final List<String> permissionsAsStrings()

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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasPermissions() method.

Returns:

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.

toBuilder

public Device.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Device.Builder,Device>

builder

public static Device.Builder builder()

serializableBuilderClass

public static Class<? extends Device.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

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.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo