1. Types
  2. vstats
  3. cache

vstats cache: sync result

The sync_result structure contains fields sent by server which will be consumed/synced by client. Warning: This structure is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

Representation:

{
    "next" : "string",
    "created_acq_specs" : [
        {
            "endpoints" : [
                "obj-103",
                "obj-103"
            ],
            "counters" : {
                "cid_mid" : {
                    "mid" : "obj-103",
                    "cid" : "obj-103"
                },
                "set_id" : "obj-103"
            },
            "resources" : [
                {
                    "predicate" : "EQUAL",
                    "scheme" : "string",
                    "type" : "string",
                    "key" : "string",
                    "id_value" : "string"
                },
                {
                    "predicate" : "EQUAL",
                    "scheme" : "string",
                    "type" : "string",
                    "key" : "string",
                    "id_value" : "string"
                }
            ],
            "interval" : 1,
            "expiration" : 1,
            "memo_" : "string",
            "id" : "obj-103",
            "status_reason" : "string",
            "status" : "ENABLED"
        },
        {
            "endpoints" : [
                "obj-103",
                "obj-103"
            ],
            "counters" : {
                "cid_mid" : {
                    "mid" : "obj-103",
                    "cid" : "obj-103"
                },
                "set_id" : "obj-103"
            },
            "resources" : [
                {
                    "predicate" : "EQUAL",
                    "scheme" : "string",
                    "type" : "string",
                    "key" : "string",
                    "id_value" : "string"
                },
                {
                    "predicate" : "EQUAL",
                    "scheme" : "string",
                    "type" : "string",
                    "key" : "string",
                    "id_value" : "string"
                }
            ],
            "interval" : 1,
            "expiration" : 1,
            "memo_" : "string",
            "id" : "obj-103",
            "status_reason" : "string",
            "status" : "ENABLED"
        }
    ],
    "updated_acq_specs" : [
        {
            "endpoints" : [
                "obj-103",
                "obj-103"
            ],
            "counters" : {
                "cid_mid" : {
                    "mid" : "obj-103",
                    "cid" : "obj-103"
                },
                "set_id" : "obj-103"
            },
            "resources" : [
                {
                    "predicate" : "EQUAL",
                    "scheme" : "string",
                    "type" : "string",
                    "key" : "string",
                    "id_value" : "string"
                },
                {
                    "predicate" : "EQUAL",
                    "scheme" : "string",
                    "type" : "string",
                    "key" : "string",
                    "id_value" : "string"
                }
            ],
            "interval" : 1,
            "expiration" : 1,
            "memo_" : "string",
            "id" : "obj-103",
            "status_reason" : "string",
            "status" : "ENABLED"
        },
        {
            "endpoints" : [
                "obj-103",
                "obj-103"
            ],
            "counters" : {
                "cid_mid" : {
                    "mid" : "obj-103",
                    "cid" : "obj-103"
                },
                "set_id" : "obj-103"
            },
            "resources" : [
                {
                    "predicate" : "EQUAL",
                    "scheme" : "string",
                    "type" : "string",
                    "key" : "string",
                    "id_value" : "string"
                },
                {
                    "predicate" : "EQUAL",
                    "scheme" : "string",
                    "type" : "string",
                    "key" : "string",
                    "id_value" : "string"
                }
            ],
            "interval" : 1,
            "expiration" : 1,
            "memo_" : "string",
            "id" : "obj-103",
            "status_reason" : "string",
            "status" : "ENABLED"
        }
    ],
    "deleted_acq_specs" : [
        "obj-103",
        "obj-103"
    ]
}

Attributes:

Name Type Description
Required
created_acq_specs acq_spec[] List of acquisition specifications created post time epoch provided by client in query_spec. If the time is "0" then all the acqSpecs will be sent. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
created_acq_specs[].id string Acquisition specification identifier. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.vstats.model.AcqSpec. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.vstats.model.AcqSpec.
created_acq_specs[].counters counter_spec Designates the counter(s) to be sampled. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
created_acq_specs[].counters.cid_mid.cid string Counter Id. CID is a string with rather strong semantic consistency across deployments and versions. If two CIDs are identical it implies the corresponding counters are the same. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.vstats.model.Counter. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.vstats.model.Counter.
updated_acq_specs acq_spec[] List of acquisition specifications updated post time epoch provided by client in query_spec. In case of full sync this field will be empty. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
deleted_acq_specs string[] List of acquisition specifications deleted post time epoch. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

When clients pass a value of this structure as a parameter, the field must contain identifiers for the resource type: com.vmware.vstats.model.AcqSpec. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: com.vmware.vstats.model.AcqSpec.
Optional
created_acq_specs[].counters.cid_mid cid_mid Counter and optional metadata identifier. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

Optional. When unset the set_id field will be used.
created_acq_specs[].counters.cid_mid.mid string MID is a 64-bit integer with strong consistency. Given a particular CID=cid, if two MIDs are the same, then the corresponding counter-metadata objects are same. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

Optional. When this field is unset vStats will use default for the counter metadata as obtained from the provider.When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.vstats.model.CounterMetadata. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.vstats.model.CounterMetadata.
next string The next field is a token used to retrieve paged data for larger result sets. This is opaque token generated by the server. It is to be sent in the vstats.cache.query_spec.page field to issue a subsequent call to the query operation for retrieving results that did not fit the current page. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

Optional. set when there are more results to retrieve.