API Management API . projects . locations . observationJobs . apiObservations . apiOperations

Instance Methods

close()

Close httplib2 connections.

get(name, x__xgafv=None)

GetApiOperation retrieves a single ApiOperation by name.

list(parent, pageSize=None, pageToken=None, x__xgafv=None)

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

list_next()

Retrieves the next page of results.

Method Details

close()
Close httplib2 connections.
get(name, x__xgafv=None)
GetApiOperation retrieves a single ApiOperation by name.

Args:
  name: string, Required. The name of the ApiOperation to retrieve. Format: projects/{project}/locations/{location}/observationJobs/{observation_job}/apiObservations/{api_observation}/apiOperation/{api_operation} (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Message describing ApiOperation object
  "count": "A String", # The number of occurrences of this API Operation.
  "firstSeenTime": "A String", # First seen time stamp
  "httpOperation": { # An HTTP-based API Operation, sometimes called a "REST" Operation. # An HTTP Operation.
    "method": "A String", # HTTP Method.
    "path": "A String", # Path of the HTTP request.
    "pathParams": [ # Path params of HttpOperation
      { # HTTP Path parameter.
        "dataType": "A String", # Data type of path param
        "position": 42, # Segment location in the path, 1-indexed
      },
    ],
    "queryParams": { # Query params of HttpOperation
      "a_key": { # An aggregation of HTTP query parameter occurrences.
        "count": "A String", # The number of occurrences of this query parameter across transactions.
        "dataType": "A String", # Data type of path param
        "name": "A String", # Name of query param
      },
    },
    "request": { # An aggregation of HTTP requests. # Request metadata.
      "headers": { # Unordered map from header name to header metadata
        "a_key": { # An aggregation of HTTP header occurrences.
          "count": "A String", # The number of occurrences of this Header across transactions.
          "dataType": "A String", # Data type of header
          "name": "A String", # Header name.
        },
      },
    },
    "response": { # An aggregation of HTTP responses. # Response metadata.
      "headers": { # Unordered map from header name to header metadata
        "a_key": { # An aggregation of HTTP header occurrences.
          "count": "A String", # The number of occurrences of this Header across transactions.
          "dataType": "A String", # Data type of header
          "name": "A String", # Header name.
        },
      },
      "responseCodes": { # Map of status code to observed count
        "a_key": "A String",
      },
    },
  },
  "lastSeenTime": "A String", # Last seen time stamp
  "name": "A String", # Identifier. Name of resource
}
list(parent, pageSize=None, pageToken=None, x__xgafv=None)
ListApiOperations gets all ApiOperations for a given project and location and ObservationJob and ApiObservation.

Args:
  parent: string, Required. The parent, which owns this collection of ApiOperations. Format: projects/{project}/locations/{location}/observationJobs/{observation_job}/apiObservations/{api_observation} (required)
  pageSize: integer, Optional. The maximum number of ApiOperations to return. The service may return fewer than this value. If unspecified, at most 10 ApiOperations will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
  pageToken: string, Optional. A page token, received from a previous `ListApiApiOperations` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListApiApiOperations` must match the call that provided the page token.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Message for response to listing ApiOperations
  "apiOperations": [ # The ApiOperations from the specified project and location and ObservationJob and ApiObservation.
    { # Message describing ApiOperation object
      "count": "A String", # The number of occurrences of this API Operation.
      "firstSeenTime": "A String", # First seen time stamp
      "httpOperation": { # An HTTP-based API Operation, sometimes called a "REST" Operation. # An HTTP Operation.
        "method": "A String", # HTTP Method.
        "path": "A String", # Path of the HTTP request.
        "pathParams": [ # Path params of HttpOperation
          { # HTTP Path parameter.
            "dataType": "A String", # Data type of path param
            "position": 42, # Segment location in the path, 1-indexed
          },
        ],
        "queryParams": { # Query params of HttpOperation
          "a_key": { # An aggregation of HTTP query parameter occurrences.
            "count": "A String", # The number of occurrences of this query parameter across transactions.
            "dataType": "A String", # Data type of path param
            "name": "A String", # Name of query param
          },
        },
        "request": { # An aggregation of HTTP requests. # Request metadata.
          "headers": { # Unordered map from header name to header metadata
            "a_key": { # An aggregation of HTTP header occurrences.
              "count": "A String", # The number of occurrences of this Header across transactions.
              "dataType": "A String", # Data type of header
              "name": "A String", # Header name.
            },
          },
        },
        "response": { # An aggregation of HTTP responses. # Response metadata.
          "headers": { # Unordered map from header name to header metadata
            "a_key": { # An aggregation of HTTP header occurrences.
              "count": "A String", # The number of occurrences of this Header across transactions.
              "dataType": "A String", # Data type of header
              "name": "A String", # Header name.
            },
          },
          "responseCodes": { # Map of status code to observed count
            "a_key": "A String",
          },
        },
      },
      "lastSeenTime": "A String", # Last seen time stamp
      "name": "A String", # Identifier. Name of resource
    },
  ],
  "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
}
list_next()
Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call 'execute()' on to request the next
          page. Returns None if there are no more items in the collection.