org.apache.mesos

Class Protos.CSIPluginInfo

java.lang.Object

com.google.protobuf.GeneratedMessageV3

org.apache.mesos.Protos.CSIPluginInfo

All Implemented Interfaces:

Protos.CSIPluginInfoOrBuilder

Enclosing class:

Protos

public static final class Protos.CSIPluginInfo
extends com.google.protobuf.GeneratedMessageV3
implements Protos.CSIPluginInfoOrBuilder

 Describes a CSI plugin.
 

Protobuf type mesos.CSIPluginInfo

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Protos.CSIPluginInfo.Builder Describes a CSI plugin.

Field Summary

Fields

Modifier and Type	Field and Description
static int	CONTAINERS_FIELD_NUMBER
static int	ENDPOINTS_FIELD_NUMBER
static int	NAME_FIELD_NUMBER
static <any>	PARSER Deprecated.
static int	TARGET_PATH_EXISTS_FIELD_NUMBER
static int	TARGET_PATH_ROOT_FIELD_NUMBER
static int	TYPE_FIELD_NUMBER

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
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.
static Protos.CSIPluginInfo	getDefaultInstance()
Protos.CSIPluginInfo	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
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.
<any>	getParserForType()
int	getSerializedSize()
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.
com.google.protobuf.UnknownFieldSet	getUnknownFields()
int	hashCode()
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.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static Protos.CSIPluginInfo.Builder	newBuilder()
static Protos.CSIPluginInfo.Builder	newBuilder(Protos.CSIPluginInfo prototype)
Protos.CSIPluginInfo.Builder	newBuilderForType()
protected Protos.CSIPluginInfo.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
static Protos.CSIPluginInfo	parseDelimitedFrom(java.io.InputStream input)
static Protos.CSIPluginInfo	parseDelimitedFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Protos.CSIPluginInfo	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Protos.CSIPluginInfo	parseFrom(java.nio.ByteBuffer data)
static Protos.CSIPluginInfo	parseFrom(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Protos.CSIPluginInfo	parseFrom(com.google.protobuf.ByteString data)
static Protos.CSIPluginInfo	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Protos.CSIPluginInfo	parseFrom(com.google.protobuf.CodedInputStream input)
static Protos.CSIPluginInfo	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Protos.CSIPluginInfo	parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static <any>	parser()
Protos.CSIPluginInfo.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class java.lang.Object

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

Field Detail

TYPE_FIELD_NUMBER

public static final int TYPE_FIELD_NUMBER

See Also:

Constant Field Values

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

See Also:

Constant Field Values

CONTAINERS_FIELD_NUMBER

public static final int CONTAINERS_FIELD_NUMBER

See Also:

Constant Field Values

ENDPOINTS_FIELD_NUMBER

public static final int ENDPOINTS_FIELD_NUMBER

See Also:

Constant Field Values

TARGET_PATH_ROOT_FIELD_NUMBER

public static final int TARGET_PATH_ROOT_FIELD_NUMBER

See Also:

Constant Field Values

TARGET_PATH_EXISTS_FIELD_NUMBER

public static final int TARGET_PATH_EXISTS_FIELD_NUMBER

See Also:

Constant Field Values

PARSER

@Deprecated
public static final <any> PARSER

Deprecated.

Method Detail

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

hasType

public 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;

Specified by:

hasType in interface Protos.CSIPluginInfoOrBuilder

getType

public 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;

Specified by:

getType in interface Protos.CSIPluginInfoOrBuilder

getTypeBytes

public 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;

Specified by:

getTypeBytes in interface Protos.CSIPluginInfoOrBuilder

hasName

public 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"];

Specified by:

hasName in interface Protos.CSIPluginInfoOrBuilder

getName

public 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"];

Specified by:

getName in interface Protos.CSIPluginInfoOrBuilder

getNameBytes

public 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"];

Specified by:

getNameBytes in interface Protos.CSIPluginInfoOrBuilder

getContainersList

public 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;

Specified by:

getContainersList in interface Protos.CSIPluginInfoOrBuilder

getContainersOrBuilderList

public 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;

Specified by:

getContainersOrBuilderList in interface Protos.CSIPluginInfoOrBuilder

getContainersCount

public 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;

Specified by:

getContainersCount in interface Protos.CSIPluginInfoOrBuilder

getContainers

public 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;

Specified by:

getContainers in interface Protos.CSIPluginInfoOrBuilder

getContainersOrBuilder

public 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;

Specified by:

getContainersOrBuilder in interface Protos.CSIPluginInfoOrBuilder

getEndpointsList

public 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;

Specified by:

getEndpointsList in interface Protos.CSIPluginInfoOrBuilder

getEndpointsOrBuilderList

public 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;

Specified by:

getEndpointsOrBuilderList in interface Protos.CSIPluginInfoOrBuilder

getEndpointsCount

public 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;

Specified by:

getEndpointsCount in interface Protos.CSIPluginInfoOrBuilder

getEndpoints

public 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;

Specified by:

getEndpoints in interface Protos.CSIPluginInfoOrBuilder

getEndpointsOrBuilder

public 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;

Specified by:

getEndpointsOrBuilder in interface Protos.CSIPluginInfoOrBuilder

hasTargetPathRoot

public 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;

Specified by:

hasTargetPathRoot in interface Protos.CSIPluginInfoOrBuilder

getTargetPathRoot

public 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;

Specified by:

getTargetPathRoot in interface Protos.CSIPluginInfoOrBuilder

getTargetPathRootBytes

public 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;

Specified by:

getTargetPathRootBytes in interface Protos.CSIPluginInfoOrBuilder

hasTargetPathExists

public 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;

Specified by:

hasTargetPathExists in interface Protos.CSIPluginInfoOrBuilder

getTargetPathExists

public 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;

Specified by:

getTargetPathExists in interface Protos.CSIPluginInfoOrBuilder

isInitialized

public final boolean isInitialized()

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws java.io.IOException

Throws:

java.io.IOException

getSerializedSize

public int getSerializedSize()

equals

public boolean equals(java.lang.Object obj)

hashCode

public int hashCode()

parseFrom

public static Protos.CSIPluginInfo parseFrom(java.nio.ByteBuffer data)
                                      throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Protos.CSIPluginInfo parseFrom(java.nio.ByteBuffer data,
                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                      throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Protos.CSIPluginInfo parseFrom(com.google.protobuf.ByteString data)
                                      throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Protos.CSIPluginInfo parseFrom(com.google.protobuf.ByteString data,
                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                      throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Protos.CSIPluginInfo parseFrom(byte[] data,
                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                      throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Protos.CSIPluginInfo parseFrom(java.io.InputStream input,
                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                      throws java.io.IOException

Throws:

java.io.IOException

parseDelimitedFrom

public static Protos.CSIPluginInfo parseDelimitedFrom(java.io.InputStream input)
                                               throws java.io.IOException

Throws:

java.io.IOException

parseDelimitedFrom

public static Protos.CSIPluginInfo parseDelimitedFrom(java.io.InputStream input,
                                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                               throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static Protos.CSIPluginInfo parseFrom(com.google.protobuf.CodedInputStream input)
                                      throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static Protos.CSIPluginInfo parseFrom(com.google.protobuf.CodedInputStream input,
                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                      throws java.io.IOException

Throws:

java.io.IOException

newBuilderForType

public Protos.CSIPluginInfo.Builder newBuilderForType()

newBuilder

public static Protos.CSIPluginInfo.Builder newBuilder()

newBuilder

public static Protos.CSIPluginInfo.Builder newBuilder(Protos.CSIPluginInfo prototype)

toBuilder

public Protos.CSIPluginInfo.Builder toBuilder()

newBuilderForType

protected Protos.CSIPluginInfo.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

getDefaultInstance

public static Protos.CSIPluginInfo getDefaultInstance()

parser

public static <any> parser()

getParserForType

public <any> getParserForType()

getDefaultInstanceForType

public Protos.CSIPluginInfo getDefaultInstanceForType()