Traceflow (type)

{
  "extends": {
    "$ref": "ManagedResource
  }, 
  "id": "Traceflow", 
  "module_id": "Traceflow", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "analysis": {
      "items": {
        "type": "string"
      }, 
      "readonly": true, 
      "title": "Traceflow result analysis notes", 
      "type": "array"
    }, 
    "counters": {
      "$ref": "TraceflowObservationCounters, 
      "readonly": true, 
      "required": false, 
      "title": "observation counters"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "readonly": true, 
      "required": true, 
      "title": "The id of the traceflow round", 
      "type": "string"
    }, 
    "logical_counters": {
      "$ref": "TraceflowObservationCounters, 
      "readonly": true, 
      "required": false, 
      "title": "counters of observations from logical components"
    }, 
    "lport_id": {
      "readonly": true, 
      "required": false, 
      "title": "id of the source logical port used for injecting the traceflow packet", 
      "type": "string"
    }, 
    "operation_state": {
      "enum": [
        "IN_PROGRESS", 
        "FINISHED", 
        "FAILED"
      ], 
      "readonly": true, 
      "required": true, 
      "title": "Represents the traceflow operation state", 
      "type": "string"
    }, 
    "request_status": {
      "description": "The status of the traceflow RPC request. SUCCESS - The traceflow request is sent successfully. TIMEOUT - The traceflow request gets timeout. SOURCE_PORT_NOT_FOUND - The source port of the request cannot be found. DATA_PATH_NOT_READY - The datapath component cannot be ready to receive request. CONNECTION_ERROR - There is connection error on datapath component. UNKNOWN - The status of traceflow request cannot be determined.", 
      "enum": [
        "SUCCESS", 
        "TIMEOUT", 
        "SOURCE_PORT_NOT_FOUND", 
        "DATA_PATH_NOT_READY", 
        "CONNECTION_ERROR", 
        "UNKNOWN"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "Traceflow request status", 
      "type": "string"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "result_overflowed": {
      "readonly": true, 
      "required": false, 
      "title": "A flag, when set true, indicates some observations were deleted from the result set.", 
      "type": "boolean"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "timeout": {
      "description": "Maximum time (in ms) the management plane will be waiting for this traceflow round.", 
      "maximum": 15000, 
      "minimum": 5000, 
      "readonly": true, 
      "required": false, 
      "title": "Timeout (in ms) for traceflow observations result list", 
      "type": "integer"
    }
  }, 
  "type": "object"
}