API Management API . projects . locations . observationJobs . apiObservations

batchEditTags(parent, body=None, x__xgafv=None)

BatchEditTagsApiObservations adds or removes Tags for ApiObservations.

Args:
  parent: string, Required. The parent resource shared by all ApiObservations being edited. Format: projects/{project}/locations/{location}/observationJobs/{observation_job} (required)
  body: object, The request body.
    The object takes the form of:

{ # Message for requesting batch edit tags for ApiObservations
  "requests": [ # Required. The request message specifying the resources to update. A maximum of 1000 apiObservations can be modified in a batch.
    { # Message for requesting edit tags for ApiObservation
      "apiObservationId": "A String", # Required. Identifier of ApiObservation need to be edit tags Format example: "apigee.googleapis.com|us-west1|443"
      "tagActions": [ # Required. Tag actions to be applied
        { # Message for edit tag action
          "action": "A String", # Required. Action to be applied
          "tag": "A String", # Required. Tag to be added or removed
        },
      ],
    },
  ],
}

  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 edit Tags for ApiObservations
  "apiObservations": [ # ApiObservations that were changed
    { # Message describing ApiObservation object
      "apiOperationCount": "A String", # The number of observed API Operations.
      "createTime": "A String", # Create time stamp
      "hostname": "A String", # The hostname of requests processed for this Observation.
      "lastEventDetectedTime": "A String", # Last event detected time stamp
      "name": "A String", # Identifier. Name of resource
      "serverIps": [ # The IP address (IPv4 or IPv6) of the origin server that the request was sent to. This field can include port information. Examples: `"192.168.1.1"`, `"10.0.0.1:80"`, `"FE80::0202:B3FF:FE1E:8329"`.
        "A String",
      ],
      "sourceLocations": [ # Location of the Observation Source, for example "us-central1" or "europe-west1."
        "A String",
      ],
      "style": "A String", # Style of ApiObservation
      "tags": [ # User-defined tags to organize and sort
        "A String",
      ],
      "updateTime": "A String", # Update time stamp
    },
  ],
}

close()

Close httplib2 connections.

get(name, x__xgafv=None)

GetApiObservation retrieves a single ApiObservation by name.

Args:
  name: string, Required. The name of the ApiObservation to retrieve. Format: projects/{project}/locations/{location}/observationJobs/{observation_job}/apiObservations/{api_observation} (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 ApiObservation object
  "apiOperationCount": "A String", # The number of observed API Operations.
  "createTime": "A String", # Create time stamp
  "hostname": "A String", # The hostname of requests processed for this Observation.
  "lastEventDetectedTime": "A String", # Last event detected time stamp
  "name": "A String", # Identifier. Name of resource
  "serverIps": [ # The IP address (IPv4 or IPv6) of the origin server that the request was sent to. This field can include port information. Examples: `"192.168.1.1"`, `"10.0.0.1:80"`, `"FE80::0202:B3FF:FE1E:8329"`.
    "A String",
  ],
  "sourceLocations": [ # Location of the Observation Source, for example "us-central1" or "europe-west1."
    "A String",
  ],
  "style": "A String", # Style of ApiObservation
  "tags": [ # User-defined tags to organize and sort
    "A String",
  ],
  "updateTime": "A String", # Update time stamp
}

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

ListApiObservations gets all ApiObservations for a given project and location and ObservationJob.

Args:
  parent: string, Required. The parent, which owns this collection of ApiObservations. Format: projects/{project}/locations/{location}/observationJobs/{observation_job} (required)
  pageSize: integer, Optional. The maximum number of ApiObservations to return. The service may return fewer than this value. If unspecified, at most 10 ApiObservations 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 `ListApiObservations` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListApiObservations` 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 ApiObservations
  "apiObservations": [ # The ApiObservation from the specified project and location and ObservationJobs.
    { # Message describing ApiObservation object
      "apiOperationCount": "A String", # The number of observed API Operations.
      "createTime": "A String", # Create time stamp
      "hostname": "A String", # The hostname of requests processed for this Observation.
      "lastEventDetectedTime": "A String", # Last event detected time stamp
      "name": "A String", # Identifier. Name of resource
      "serverIps": [ # The IP address (IPv4 or IPv6) of the origin server that the request was sent to. This field can include port information. Examples: `"192.168.1.1"`, `"10.0.0.1:80"`, `"FE80::0202:B3FF:FE1E:8329"`.
        "A String",
      ],
      "sourceLocations": [ # Location of the Observation Source, for example "us-central1" or "europe-west1."
        "A String",
      ],
      "style": "A String", # Style of ApiObservation
      "tags": [ # User-defined tags to organize and sort
        "A String",
      ],
      "updateTime": "A String", # Update time stamp
    },
  ],
  "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.