NSX-T Data Center REST API

TraceflowObservationListParameters (type)

{
  "extends": {
    "$ref": "ListRequestParameters
  }, 
  "id": "TraceflowObservationListParameters", 
  "module_id": "Traceflow", 
  "properties": {
    "component_name": {
      "description": "Observations of all component names will be listed if not given.", 
      "required": false, 
      "title": "Observations having the given component name will be listed.", 
      "type": "string"
    }, 
    "component_type": {
      "$ref": "TraceflowComponentType, 
      "description": "Observations of all component types will be listed if not given.", 
      "required": false, 
      "title": "Observations having the given component type will be listed."
    }, 
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "included_fields": {
      "description": "Note - this parameter currently only works when used with the search APIs /policy/api/v1/search/query and /policy/api/v1/search/dsl. It is ignored for other list APIs.", 
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "resource_type": {
      "$ref": "TraceflowObservationType, 
      "description": "Prefix matching; e.g. TraceflowObservationReceived will also matches TraceflowObservationReceivedLogical. Observations of all types will be listed if not given.", 
      "required": false, 
      "title": "The type of observations that will be listed."
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }, 
    "transport_node_name": {
      "description": "Observations of all transport node names will be listed if not given.", 
      "required": false, 
      "title": "Observations having the given transport node name will be listed.", 
      "type": "string"
    }
  }, 
  "title": "Traceflow Observation list parameters", 
  "type": "object"
}