CnsVolumeOperationResult

CnsVolumeOperationResult
CnsVolumeOperationResult

Base class for returning result of operation invoked on a specific volume.

Operations that require some additional fields in their result can extend this class. E.g. result classes for create and attach operations extend this class to add additional fields.

If an operation allows batch input, then the output should contain same number of result objects. One object corresponding to each input entry.

Since every result object will have its own fault, that fault will be limited to the corresponding input object and should not be used for overall operation failure.

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

AllOf
This class requires all of the following:
JSON Example
{
    "_typeName": "string",
    "volumeId": {
        "_typeName": "string",
        "id": "string"
    },
    "fault": {
        "_typeName": "string",
        "faultCause": "MethodFault Object",
        "faultMessage": [
            {
                "_typeName": "string",
                "key": "string",
                "arg": [
                    {
                        "_typeName": "string",
                        "key": "string",
                        "value": {
                            "_typeName": "string"
                        }
                    }
                ],
                "message": "string"
            }
        ]
    }
}
volumeId
Optional

Unique identifier and datastore information for the volume.

Result object for all operations, other than create, will get volumeId as part of its input parameter and should always have this field set. For the result of create operation, this field will not be set. Please see CnsVolumeCreateResult for details.

fault
Optional

Fault, if any, corresponding to the specified volume ID that caused operation to fail.

Absence of fault will indicate successful result.

For create operation, volumeId field will not be set. Instead, volume name will be set, to associated fault with appropriate request. Please see CnsVolumeCreateResult for details.

Property Of
Used By