CnsEntityMetadata

CnsEntityMetadata
CnsEntityMetadata

Base data object that represents the metadata associated with an entity in container orchestrators like Kubernetes, Docker swarm etc.

This structure may be used only with operations rendered under /vsan.

AllOf
This class requires all of the following:
JSON Example
{
    "_typeName": "string",
    "entityName": "string",
    "labels": [
        {
            "_typeName": "string",
            "key": "string",
            "value": "string"
        }
    ],
    "delete": false,
    "clusterId": "string"
}
string
entityName
Required

Represents the name of entity.

array of KeyValue
labels
Optional

Labels for this entity.

Labels are opaque to CNS and it will neither try to parse the key nor the value. A maximum of 32 labels will be supported for each entity. Label key should be less than 320 bytes and value should be less than 64 bytes.

If the constraints are not honored, then InvalidArgument will be thrown.

boolean
delete
Optional

If not set, False is assumed.

  • True indicates that the EntityMetadata should be deleted in VolumeManager.Update API.
  • False indicates that the EntityMetadata should be added or replaced in VolumeManager.Create, VolumeManager.Update APIs.
string
clusterId
Optional

Represents the container orchestrator cluster the entity belongs to.

This is a mandatory field as the VolumeMetadata.containerCluster is deprecated.

This field points to a cluster in containerClusterArray

Property Of
Used By