Package io.github.alersrt.pod4j.openapi.model

Class VolumeConfigResponse

java.lang.Object
io.github.alersrt.pod4j.openapi.model.VolumeConfigResponse
All Implemented Interfaces:
Serializable
@Generated("org.openapitools.codegen.languages.JavaClientCodegen") public class VolumeConfigResponse extends Object implements Serializable
VolumeConfigResponse
See Also:

  • Field Details

  • Constructor Details

    • VolumeConfigResponse

      public VolumeConfigResponse()

  • Method Details

    • anonymous

      public VolumeConfigResponse anonymous(Boolean anonymous)

    • getAnonymous

      @Nullable public Boolean getAnonymous()
      Anonymous indicates that the volume was created as an anonymous volume for a specific container, and will be removed when any container using it is removed.
      Returns:
      anonymous

    • setAnonymous

      public void setAnonymous(Boolean anonymous)

    • createdAt

      public VolumeConfigResponse createdAt(OffsetDateTime createdAt)

    • getCreatedAt

      @Nullable @Valid public @Valid OffsetDateTime getCreatedAt()
      CreatedAt is the date and time the volume was created at. This is not stored for older Libpod volumes; if so, it will be omitted.
      Returns:
      createdAt

    • setCreatedAt

      public void setCreatedAt(OffsetDateTime createdAt)

    • driver

      public VolumeConfigResponse driver(String driver)

    • getDriver

      @Nullable public String getDriver()
      Driver is the driver used to create the volume. If set to \"local\" or \"\", the Local driver (Podman built-in code) is used to service the volume; otherwise, a volume plugin with the given name is used to mount and manage the volume.
      Returns:
      driver

    • setDriver

      public void setDriver(String driver)

    • GID

      public VolumeConfigResponse GID(Long GID)

    • getGID

      @Nullable public Long getGID()
      GID is the GID that the volume was created with.
      Returns:
      GID

    • setGID

      public void setGID(Long GID)

    • labels

      public VolumeConfigResponse labels(Map<String,String> labels)

    • putLabelsItem

      public VolumeConfigResponse putLabelsItem(String key, String labelsItem)

    • getLabels

      @Nullable public Map<String,String> getLabels()
      Labels includes the volume's configured labels, key:value pairs that can be passed during volume creation to provide information for third party tools.
      Returns:
      labels

    • setLabels

      public void setLabels(Map<String,String> labels)

    • lockNumber

      public VolumeConfigResponse lockNumber(Integer lockNumber)

    • getLockNumber

      @Nullable public Integer getLockNumber()
      LockNumber is the number of the volume's Libpod lock.
      Returns:
      lockNumber

    • setLockNumber

      public void setLockNumber(Integer lockNumber)

    • mountCount

      public VolumeConfigResponse mountCount(Integer mountCount)

    • getMountCount

      @Nullable public Integer getMountCount()
      MountCount is the number of times this volume has been mounted.
      Returns:
      mountCount

    • setMountCount

      public void setMountCount(Integer mountCount)

    • mountpoint

      public VolumeConfigResponse mountpoint(String mountpoint)

    • getMountpoint

      @Nullable public String getMountpoint()
      Mountpoint is the path on the host where the volume is mounted.
      Returns:
      mountpoint

    • setMountpoint

      public void setMountpoint(String mountpoint)

    • name

      public VolumeConfigResponse name(String name)

    • getName

      @Nullable public String getName()
      Name is the name of the volume.
      Returns:
      name

    • setName

      public void setName(String name)

    • needsChown

      public VolumeConfigResponse needsChown(Boolean needsChown)

    • getNeedsChown

      @Nullable public Boolean getNeedsChown()
      NeedsChown indicates that the next time the volume is mounted into a container, the container will chown the volume to the container process UID/GID.
      Returns:
      needsChown

    • setNeedsChown

      public void setNeedsChown(Boolean needsChown)

    • needsCopyUp

      public VolumeConfigResponse needsCopyUp(Boolean needsCopyUp)

    • getNeedsCopyUp

      @Nullable public Boolean getNeedsCopyUp()
      NeedsCopyUp indicates that the next time the volume is mounted into
      Returns:
      needsCopyUp

    • setNeedsCopyUp

      public void setNeedsCopyUp(Boolean needsCopyUp)

    • options

      public VolumeConfigResponse options(Map<String,String> options)

    • putOptionsItem

      public VolumeConfigResponse putOptionsItem(String key, String optionsItem)

    • getOptions

      @Nullable public Map<String,String> getOptions()
      Options is a set of options that were used when creating the volume. For the Local driver, these are mount options that will be used to determine how a local filesystem is mounted; they are handled as parameters to Mount in a manner described in the volume create manpage. For non-local drivers, these are passed as-is to the volume plugin.
      Returns:
      options

    • setOptions

      public void setOptions(Map<String,String> options)

    • scope

      public VolumeConfigResponse scope(String scope)

    • getScope

      @Nullable public String getScope()
      Scope is unused and provided solely for Docker compatibility. It is unconditionally set to \"local\".
      Returns:
      scope

    • setScope

      public void setScope(String scope)

    • status

      public VolumeConfigResponse status(Map<String,Object> status)

    • putStatusItem

      public VolumeConfigResponse putStatusItem(String key, Object statusItem)

    • getStatus

      @Nullable public Map<String,Object> getStatus()
      Status is used to return information on the volume's current state, if the volume was created using a volume plugin (uses a Driver that is not the local driver). Status is provided to us by an external program, so no guarantees are made about its format or contents. Further, it is an optional field, so it may not be set even in cases where a volume plugin is in use.
      Returns:
      status

    • setStatus

      public void setStatus(Map<String,Object> status)

    • storageID

      public VolumeConfigResponse storageID(String storageID)

    • getStorageID

      @Nullable public String getStorageID()
      StorageID is the ID of the container backing the volume in c/storage. Only used with Image Volumes.
      Returns:
      storageID

    • setStorageID

      public void setStorageID(String storageID)

    • timeout

      public VolumeConfigResponse timeout(Integer timeout)

    • getTimeout

      @Nullable public Integer getTimeout()
      Timeout is the specified driver timeout if given
      Returns:
      timeout

    • setTimeout

      public void setTimeout(Integer timeout)

    • UID

      public VolumeConfigResponse UID(Long UID)

    • getUID

      @Nullable public Long getUID()
      UID is the UID that the volume was created with.
      Returns:
      UID

    • setUID

      public void setUID(Long UID)

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • validateJsonObject

      public static void validateJsonObject(com.google.gson.JsonObject jsonObj) throws IOException
      Validates the JSON Object and throws an exception if issues found
      Parameters:
      jsonObj - JSON Object
      Throws:
      IOException - if the JSON Object is invalid with respect to VolumeConfigResponse

    • fromJson

      public static VolumeConfigResponse fromJson(String jsonString) throws IOException
      Create an instance of VolumeConfigResponse given an JSON string
      Parameters:
      jsonString - JSON string
      Returns:
      An instance of VolumeConfigResponse
      Throws:
      IOException - if the JSON string is invalid with respect to VolumeConfigResponse

    • toJson

      public String toJson()
      Convert an instance of VolumeConfigResponse to an JSON string
      Returns:
      JSON string