All Known Implementing Classes:

Protos.CSIPluginInfo, Protos.CSIPluginInfo.Builder

Enclosing class:

Protos

public static interface Protos.CSIPluginInfoOrBuilder

• Method Summary

  All Methods

  Modifier and Type	Method and Description
  Protos.CSIPluginContainerInfo	getContainers (int index) A list of container configurations to run managed CSI plugin.
  int	getContainersCount () A list of container configurations to run managed CSI plugin.
  java.util.List<Protos.CSIPluginContainerInfo>	getContainersList () A list of container configurations to run managed CSI plugin.
  Protos.CSIPluginContainerInfoOrBuilder	getContainersOrBuilder (int index) A list of container configurations to run managed CSI plugin.
  java.util.List<? extends Protos.CSIPluginContainerInfoOrBuilder>	getContainersOrBuilderList () A list of container configurations to run managed CSI plugin.
  Protos.CSIPluginEndpoint	getEndpoints (int index) The service endpoints of the unmanaged CSI plugin.
  int	getEndpointsCount () The service endpoints of the unmanaged CSI plugin.
  java.util.List<Protos.CSIPluginEndpoint>	getEndpointsList () The service endpoints of the unmanaged CSI plugin.
  Protos.CSIPluginEndpointOrBuilder	getEndpointsOrBuilder (int index) The service endpoints of the unmanaged CSI plugin.
  java.util.List<? extends Protos.CSIPluginEndpointOrBuilder>	getEndpointsOrBuilderList () The service endpoints of the unmanaged CSI plugin.
  java.lang.String	getName () The name of the CSI plugin.
  com.google.protobuf.ByteString	getNameBytes () The name of the CSI plugin.
  boolean	getTargetPathExists () For some CSI plugins which implement CSI v1 spec, they expect the target path is an existing path which is actually not CSI v1 spec compliant.
  java.lang.String	getTargetPathRoot () The root directory of all the target paths managed by the CSI plugin.
  com.google.protobuf.ByteString	getTargetPathRootBytes () The root directory of all the target paths managed by the CSI plugin.
  java.lang.String	getType () The type of the CSI plugin.
  com.google.protobuf.ByteString	getTypeBytes () The type of the CSI plugin.
  boolean	hasName () The name of the CSI plugin.
  boolean	hasTargetPathExists () For some CSI plugins which implement CSI v1 spec, they expect the target path is an existing path which is actually not CSI v1 spec compliant.
  boolean	hasTargetPathRoot () The root directory of all the target paths managed by the CSI plugin.
  boolean	hasType () The type of the CSI plugin.

• Method Detail

  • hasType

    boolean hasType()

     The type of the CSI plugin. This uniquely identifies a CSI
     implementation. For instance:
     org.apache.mesos.csi.test
     Please follow to Java package naming convention
     (https://en.wikipedia.org/wiki/Java_package#Package_naming_conventions)
     to avoid conflicts on type names.
     

    required string type = 1;

  • getType

    java.lang.String getType()

     The type of the CSI plugin. This uniquely identifies a CSI
     implementation. For instance:
     org.apache.mesos.csi.test
     Please follow to Java package naming convention
     (https://en.wikipedia.org/wiki/Java_package#Package_naming_conventions)
     to avoid conflicts on type names.
     

    required string type = 1;

  • getTypeBytes

    com.google.protobuf.ByteString getTypeBytes()

     The type of the CSI plugin. This uniquely identifies a CSI
     implementation. For instance:
     org.apache.mesos.csi.test
     Please follow to Java package naming convention
     (https://en.wikipedia.org/wiki/Java_package#Package_naming_conventions)
     to avoid conflicts on type names.
     

    required string type = 1;

  • hasName

    boolean hasName()

     The name of the CSI plugin. There could be multiple instances of a
     type of CSI plugin within a Mesos cluster. The name field is used to
     distinguish these instances. It should be a legal Java identifier
     (https://docs.oracle.com/javase/tutorial/java/nutsandbolts/variables.html)
     to avoid conflicts on concatenation of type and name.
     The type and name together provide the means to uniquely identify a storage
     backend and its resources in the cluster, so the operator should ensure
     that the concatenation of type and name is unique in the cluster, and it
     remains the same if the instance is migrated to another agent (e.g., there
     is a change in the agent ID).
     

    optional string name = 2 [default = "default"];

  • getName

    java.lang.String getName()

     The name of the CSI plugin. There could be multiple instances of a
     type of CSI plugin within a Mesos cluster. The name field is used to
     distinguish these instances. It should be a legal Java identifier
     (https://docs.oracle.com/javase/tutorial/java/nutsandbolts/variables.html)
     to avoid conflicts on concatenation of type and name.
     The type and name together provide the means to uniquely identify a storage
     backend and its resources in the cluster, so the operator should ensure
     that the concatenation of type and name is unique in the cluster, and it
     remains the same if the instance is migrated to another agent (e.g., there
     is a change in the agent ID).
     

    optional string name = 2 [default = "default"];

  • getNameBytes

    com.google.protobuf.ByteString getNameBytes()

     The name of the CSI plugin. There could be multiple instances of a
     type of CSI plugin within a Mesos cluster. The name field is used to
     distinguish these instances. It should be a legal Java identifier
     (https://docs.oracle.com/javase/tutorial/java/nutsandbolts/variables.html)
     to avoid conflicts on concatenation of type and name.
     The type and name together provide the means to uniquely identify a storage
     backend and its resources in the cluster, so the operator should ensure
     that the concatenation of type and name is unique in the cluster, and it
     remains the same if the instance is migrated to another agent (e.g., there
     is a change in the agent ID).
     

    optional string name = 2 [default = "default"];

  • getContainersList

    java.util.List<Protos.CSIPluginContainerInfo> getContainersList()

     A list of container configurations to run managed CSI plugin.
     The controller service will be served by the first configuration
     that contains `CONTROLLER_SERVICE`, and the node service will be
     served by the first configuration that contains `NODE_SERVICE`.
     

    repeated .mesos.CSIPluginContainerInfo containers = 3;

  • getContainers

    Protos.CSIPluginContainerInfo getContainers(int index)

     A list of container configurations to run managed CSI plugin.
     The controller service will be served by the first configuration
     that contains `CONTROLLER_SERVICE`, and the node service will be
     served by the first configuration that contains `NODE_SERVICE`.
     

    repeated .mesos.CSIPluginContainerInfo containers = 3;

  • getContainersCount

    int getContainersCount()

     A list of container configurations to run managed CSI plugin.
     The controller service will be served by the first configuration
     that contains `CONTROLLER_SERVICE`, and the node service will be
     served by the first configuration that contains `NODE_SERVICE`.
     

    repeated .mesos.CSIPluginContainerInfo containers = 3;

  • getContainersOrBuilderList

    java.util.List<? extends Protos.CSIPluginContainerInfoOrBuilder> getContainersOrBuilderList()

     A list of container configurations to run managed CSI plugin.
     The controller service will be served by the first configuration
     that contains `CONTROLLER_SERVICE`, and the node service will be
     served by the first configuration that contains `NODE_SERVICE`.
     

    repeated .mesos.CSIPluginContainerInfo containers = 3;

  • getContainersOrBuilder

    Protos.CSIPluginContainerInfoOrBuilder getContainersOrBuilder(int index)

     A list of container configurations to run managed CSI plugin.
     The controller service will be served by the first configuration
     that contains `CONTROLLER_SERVICE`, and the node service will be
     served by the first configuration that contains `NODE_SERVICE`.
     

    repeated .mesos.CSIPluginContainerInfo containers = 3;

  • getEndpointsList

    java.util.List<Protos.CSIPluginEndpoint> getEndpointsList()

     The service endpoints of the unmanaged CSI plugin. An endpoint is usually
     a path to a Unix domain socket.
     

    repeated .mesos.CSIPluginEndpoint endpoints = 4;

  • getEndpoints

    Protos.CSIPluginEndpoint getEndpoints(int index)

     The service endpoints of the unmanaged CSI plugin. An endpoint is usually
     a path to a Unix domain socket.
     

    repeated .mesos.CSIPluginEndpoint endpoints = 4;

  • getEndpointsCount

    int getEndpointsCount()

     The service endpoints of the unmanaged CSI plugin. An endpoint is usually
     a path to a Unix domain socket.
     

    repeated .mesos.CSIPluginEndpoint endpoints = 4;

  • getEndpointsOrBuilderList

    java.util.List<? extends Protos.CSIPluginEndpointOrBuilder> getEndpointsOrBuilderList()

     The service endpoints of the unmanaged CSI plugin. An endpoint is usually
     a path to a Unix domain socket.
     

    repeated .mesos.CSIPluginEndpoint endpoints = 4;

  • getEndpointsOrBuilder

    Protos.CSIPluginEndpointOrBuilder getEndpointsOrBuilder(int index)

     The service endpoints of the unmanaged CSI plugin. An endpoint is usually
     a path to a Unix domain socket.
     

    repeated .mesos.CSIPluginEndpoint endpoints = 4;

  • hasTargetPathRoot

    boolean hasTargetPathRoot()

     The root directory of all the target paths managed by the CSI plugin.
     Each volume will be published by the CSI plugin at a sub-directory
     under this path.
     

    optional string target_path_root = 5;

  • getTargetPathRoot

    java.lang.String getTargetPathRoot()

     The root directory of all the target paths managed by the CSI plugin.
     Each volume will be published by the CSI plugin at a sub-directory
     under this path.
     

    optional string target_path_root = 5;

  • getTargetPathRootBytes

    com.google.protobuf.ByteString getTargetPathRootBytes()

     The root directory of all the target paths managed by the CSI plugin.
     Each volume will be published by the CSI plugin at a sub-directory
     under this path.
     

    optional string target_path_root = 5;

  • hasTargetPathExists

    boolean hasTargetPathExists()

     For some CSI plugins which implement CSI v1 spec, they expect the target
     path is an existing path which is actually not CSI v1 spec compliant. In
     such case this field should be set to `true` as a work around for those
     plugins. For the CSI plugins which implement CSI v0 spec, this field will
     be just ignored.
     

    optional bool target_path_exists = 6;

  • getTargetPathExists

    boolean getTargetPathExists()

     For some CSI plugins which implement CSI v1 spec, they expect the target
     path is an existing path which is actually not CSI v1 spec compliant. In
     such case this field should be set to `true` as a work around for those
     plugins. For the CSI plugins which implement CSI v0 spec, this field will
     be just ignored.
     

    optional bool target_path_exists = 6;