REST Resource: projects.locations.observationJobs.apiObservations.apiOperations

Resource: ApiOperation

Message describing ApiOperation object

JSON representation 
{
  "name": string,
  "firstSeenTime": string,
  "lastSeenTime": string,
  "count": string,

  // Union field operation can be only one of the following:
  "httpOperation": {
    object (HttpOperation)
  }
  // End of list of possible types for union field operation.
}
Fields
name

string

Identifier. Name of resource
firstSeenTime

string (Timestamp format)

First seen time stamp

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
lastSeenTime

string (Timestamp format)

Last seen time stamp

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
count

string (int64 format)

The number of occurrences of this API Operation.
Union field operation. ApiOperation protocol style operation can be only one of the following:
httpOperation

object (HttpOperation)

An HTTP Operation.

HttpOperation

An HTTP-based API Operation, sometimes called a "REST" Operation.

JSON representation 
{
  "path": string,
  "pathParams": [
    {
      object (PathParam)
    }
  ],
  "queryParams": {
    string: {
      object (QueryParam)
    },
    ...
  },
  "method": enum (HttpMethod),
  "request": {
    object (HttpRequest)
  },
  "response": {
    object (HttpResponse)
  }
}
Fields
path

string

Path of the HTTP request.
pathParams[]

object (PathParam)

Path params of HttpOperation
queryParams

map (key: string, value: object (QueryParam))

Query params of HttpOperation

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
method

enum (HttpMethod)

HTTP Method.
request

object (HttpRequest)

Request metadata.
response

object (HttpResponse)

Response metadata.

PathParam

HTTP Path parameter.

JSON representation 
{
  "position": integer,
  "dataType": enum (DataType)
}
Fields
position

integer

Segment location in the path, 1-indexed
dataType

enum (DataType)

Data type of path param

DataType

Type of data

Enums
DATA_TYPE_UNSPECIFIED Unspecified data type
BOOL Boolean data type
INTEGER Integer data type
FLOAT Float data type
STRING String data type
UUID UUID data type

QueryParam

An aggregation of HTTP query parameter occurrences.

JSON representation 
{
  "name": string,
  "count": string,
  "dataType": enum (DataType)
}
Fields
name

string

Name of query param
count

string (int64 format)

The number of occurrences of this query parameter across transactions.
dataType

enum (DataType)

Data type of path param

HttpMethod

HTTP method

Enums
HTTP_METHOD_UNSPECIFIED Unspecified HTTP method
GET GET HTTP method
HEAD HEAD HTTP method
POST POST HTTP method
PUT PUT HTTP method
PATCH PATCH HTTP method
DELETE DELETE HTTP method
TRACE TRACE HTTP method
OPTIONS OPTIONS HTTP method
CONNECT CONNECT HTTP method

HttpRequest

An aggregation of HTTP requests.

JSON representation 
{
  "headers": {
    string: {
      object (Header)
    },
    ...
  }
}
Fields
headers

map (key: string, value: object (Header))

Unordered map from header name to header metadata

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

HttpResponse

An aggregation of HTTP responses.

JSON representation 
{
  "headers": {
    string: {
      object (Header)
    },
    ...
  },
  "responseCodes": {
    integer: string,
    ...
  }
}
Fields
headers

map (key: string, value: object (Header))

Unordered map from header name to header metadata

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
responseCodes

map (key: integer, value: string (int64 format))

Map of status code to observed count

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

Methods

get

 GetApiOperation retrieves a single ApiOperation by name.

list

 ListApiOperations gets all ApiOperations for a given project and location and ObservationJob and ApiObservation.