REST Resource: projects.locations.discoveredApiObservations.discoveredApiOperations

Resource: DiscoveredApiOperation

DiscoveredApiOperation represents an API Operation observed in one of the sources.

JSON representation 
{
  "name": string,
  "firstSeenTime": string,
  "lastSeenTime": string,
  "count": string,
  "classification": enum (Classification),
  "matchResults": [
    {
      object (MatchResult)
    }
  ],
  "sourceMetadata": {
    object (SourceMetadata)
  },
  "createTime": string,
  "updateTime": string,

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

string

Identifier. The name of the discovered API Operation.

Format: projects/{project}/locations/{location}/discoveredApiObservations/{discoveredApiObservation}/discoveredApiOperations/{discoveredApiOperation}
firstSeenTime

string (Timestamp format)

Optional. First seen time stamp

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
lastSeenTime

string (Timestamp format)

Optional. Last seen time stamp

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
count

string (int64 format)

Optional. The number of occurrences of this API Operation.
classification

enum (Classification)

Output only. The classification of the discovered API operation.
matchResults[]

object (MatchResult)

Output only. The list of matched results for the discovered API operation. This will be populated only if the classification is known. The current usecase is for a single match. Keeping it repeated to support multiple matches in future.
sourceMetadata

object (SourceMetadata)

Output only. The metadata of the source from which the api operation was collected.
createTime

string (Timestamp format)

Output only. Create time stamp of the discovered API operation in API Hub.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

Output only. Update time stamp of the discovered API operation in API Hub.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
Union field operation. ApiOperation protocol style operation can be only one of the following:
httpOperation

object (HttpOperationDetails)

Optional. An HTTP Operation.

HttpOperationDetails

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

JSON representation 
{
  "httpOperation": {
    object (HttpOperation)
  },
  "pathParams": [
    {
      object (PathParam)
    }
  ],
  "queryParams": {
    string: {
      object (QueryParam)
    },
    ...
  },
  "request": {
    object (HttpRequest)
  },
  "response": {
    object (HttpResponse)
  }
}
Fields
httpOperation

object (HttpOperation)

Required. An HTTP Operation.
pathParams[]

object (PathParam)

Optional. Path params of HttpOperation
queryParams

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

Optional. Query params of HttpOperation

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

object (HttpRequest)

Optional. Request metadata.
response

object (HttpResponse)

Optional. Response metadata.

PathParam

HTTP Path parameter.

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

integer

Optional. Segment location in the path, 1-indexed
dataType

enum (DataType)

Optional. 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

Required. Name of query param
count

string (int64 format)

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

enum (DataType)

Optional. Data type of path param

HttpRequest

An aggregation of HTTP requests.

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

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

Optional. 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))

Optional. 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))

Optional. Map of status code to observed count

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

Classification

The classification of the discovered API operation.

Enums
CLASSIFICATION_UNSPECIFIED Operation is not classified as known or unknown.
KNOWN Operation has a matched catalog operation.
UNKNOWN Operation does not have a matched catalog operation.

MatchResult

MatchResult represents the result of matching a discovered API operation with a catalog API operation.

JSON representation 
{
  "name": string
}
Fields
name

string

Output only. The name of the matched API Operation.

Format: projects/{project}/locations/{location}/apis/{api}/versions/{version}/operations/{operation}

Methods

get

 Gets a DiscoveredAPIOperation in a given project, location, ApiObservation and ApiOperation.

list

 Lists all the DiscoveredAPIOperations in a given project, location and ApiObservation.