QueryPointInTimeReplicaParam

QueryPointInTimeReplicaParam
QueryPointInTimeReplicaParam

Describes the search criteria for the PiT query.

If none of the fields is set, or if the number of PiT replicas is too large, VASA provider can return QueryPointInTimeReplicaSummaryResult.

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

AllOf
This class requires all of the following:
JSON Example
{
    "_typeName": "string",
    "replicaTimeQueryParam": {
        "_typeName": "string",
        "fromDate": "string",
        "toDate": "string",
        "number": 0
    },
    "pitName": "string",
    "tags": [
        "string"
    ],
    "preferDetails": false
}
replicaTimeQueryParam
Optional

Defines the parameters for a Point In Time replica (PiT) query.

vSphere will not set all the three fields.

In other words, the following combinations of fields are allowed:

When all the fields are omitted, VASA provider should return QueryPointInTimeReplicaSummaryResult. But, returned result can be either QueryPointInTimeReplicaSuccessResult or QueryPointInTimeReplicaSummaryResult based on value i.e true or false respectively for field preferDetails.

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

string
pitName
Optional

Only the replicas that match the given name are requested.

A regexp according to http://www.w3.org/TR/xmlschema-2/#regexs.

array of string
tags
Optional

Only the replicas with tags that match the given tag(s) are requested.

Each entry may be a regexp according to http://www.w3.org/TR/xmlschema-2/#regexs.

boolean
preferDetails
Optional

This field is hint for the preferred type of return results.

It can be either true for QueryPointInTimeReplicaSuccessResult or false for QueryPointInTimeReplicaSummaryResult. If not set, VP may choose the appropriate type, as described in ReplicaQueryIntervalParam.