de.gesellix.docker.remote.api.Mount.kt Maven / Gradle / Ivy

Go to download
/**
 *
 * Please note:
 * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * Do not edit this file manually.
 *
 */

@file:Suppress(
  "ArrayInDataClass",
  "EnumEntryName",
  "RemoveRedundantQualifierName",
  "UnusedImport"
)

package de.gesellix.docker.remote.api

import com.squareup.moshi.Json
import com.squareup.moshi.JsonClass

/**
 *
 *
 * @param target Container path.
 * @param source Mount source (e.g. a volume name, a host path).
 * @param type The mount type. Available types:  - `bind` Mounts a file or directory from the host into the container. Must exist prior to creating the container. - `volume` Creates a volume with the given name and options (or uses a pre-existing volume with the same name and options). These are **not** removed when the container is removed. - `tmpfs` Create a tmpfs with the given options. The mount source cannot be specified for tmpfs. - `npipe` Mounts a named pipe from the host into the container. Must exist prior to creating the container.
 * @param readOnly Whether the mount should be read-only.
 * @param consistency The consistency requirement for the mount: `default`, `consistent`, `cached`, or `delegated`.
 * @param bindOptions
 * @param volumeOptions
 * @param tmpfsOptions
 */
@JsonClass(generateAdapter = true)

data class Mount(

  /* Container path. */
  @Json(name = "Target")
  var target: kotlin.String? = null,

  /* Mount source (e.g. a volume name, a host path). */
  @Json(name = "Source")
  var source: kotlin.String? = null,

  /* The mount type. Available types:  - `bind` Mounts a file or directory from the host into the container. Must exist prior to creating the container. - `volume` Creates a volume with the given name and options (or uses a pre-existing volume with the same name and options). These are **not** removed when the container is removed. - `tmpfs` Create a tmpfs with the given options. The mount source cannot be specified for tmpfs. - `npipe` Mounts a named pipe from the host into the container. Must exist prior to creating the container.  */
  @Json(name = "Type")
  var type: Mount.Type? = null,

  /* Whether the mount should be read-only. */
  @Json(name = "ReadOnly")
  var readOnly: kotlin.Boolean? = null,

  /* The consistency requirement for the mount: `default`, `consistent`, `cached`, or `delegated`. */
  @Json(name = "Consistency")
  var consistency: kotlin.String? = null,

  @Json(name = "BindOptions")
  var bindOptions: MountBindOptions? = null,

  @Json(name = "VolumeOptions")
  var volumeOptions: MountVolumeOptions? = null,

  @Json(name = "TmpfsOptions")
  var tmpfsOptions: MountTmpfsOptions? = null

) {

  /**
   * The mount type. Available types:  - `bind` Mounts a file or directory from the host into the container. Must exist prior to creating the container. - `volume` Creates a volume with the given name and options (or uses a pre-existing volume with the same name and options). These are **not** removed when the container is removed. - `tmpfs` Create a tmpfs with the given options. The mount source cannot be specified for tmpfs. - `npipe` Mounts a named pipe from the host into the container. Must exist prior to creating the container.
   *
   * Values: Bind,Volume,Tmpfs,Npipe
   */
  @JsonClass(generateAdapter = false)
  enum class Type(val value: kotlin.String) {

    @Json(name = "bind")
    Bind("bind"),

    @Json(name = "volume")
    Volume("volume"),

    @Json(name = "tmpfs")
    Tmpfs("tmpfs"),

    @Json(name = "npipe")
    Npipe("npipe");
  }
}