discovered_api_observations

Creates, updates, deletes, gets or lists a discovered_api_observations resource.

Overview

Name	discovered_api_observations
Type	Resource
Id	google.apihub.discovered_api_observations

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
name	string	Identifier. The name of the discovered API Observation. Format: projects/{project}/locations/{location}/discoveredApiObservations/{discovered_api_observation}
apiOperationCount	string (int64)	Optional. The number of observed API Operations.
createTime	string (google-datetime)	Output only. Create time stamp of the observation in API Hub.
hostname	string	Optional. The hostname of requests processed for this Observation.
knownOperationsCount	string (int64)	Output only. The number of known API Operations.
lastEventDetectedTime	string (google-datetime)	Optional. Last event detected time stamp
origin	string	Optional. For an observation pushed from a gcp resource, this would be the gcp project id.
serverIps	array	Optional. 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".
sourceLocations	array	Optional. The location of the observation source.
sourceMetadata	object	SourceMetadata represents the metadata for a resource at the source. (id: GoogleCloudApihubV1SourceMetadata)
sourceTypes	array	Optional. The type of the source from which the observation was collected.
style	string	Optional. Style of ApiObservation
unknownOperationsCount	string (int64)	Output only. The number of unknown API Operations.
updateTime	string (google-datetime)	Output only. Update time stamp of the observation in API Hub.

list

Successful response

Name	Datatype	Description
name	string	Identifier. The name of the discovered API Observation. Format: projects/{project}/locations/{location}/discoveredApiObservations/{discovered_api_observation}
apiOperationCount	string (int64)	Optional. The number of observed API Operations.
createTime	string (google-datetime)	Output only. Create time stamp of the observation in API Hub.
hostname	string	Optional. The hostname of requests processed for this Observation.
knownOperationsCount	string (int64)	Output only. The number of known API Operations.
lastEventDetectedTime	string (google-datetime)	Optional. Last event detected time stamp
origin	string	Optional. For an observation pushed from a gcp resource, this would be the gcp project id.
serverIps	array	Optional. 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".
sourceLocations	array	Optional. The location of the observation source.
sourceMetadata	object	SourceMetadata represents the metadata for a resource at the source. (id: GoogleCloudApihubV1SourceMetadata)
sourceTypes	array	Optional. The type of the source from which the observation was collected.
style	string	Optional. Style of ApiObservation
unknownOperationsCount	string (int64)	Output only. The number of unknown API Operations.
updateTime	string (google-datetime)	Output only. Update time stamp of the observation in API Hub.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, discoveredApiObservationsId		Gets a DiscoveredAPIObservation in a given project, location and ApiObservation.
list	select	projectsId, locationsId	pageSize, pageToken	Lists all the DiscoveredAPIObservations in a given project and location.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
discoveredApiObservationsId	string
locationsId	string
projectsId	string
pageSize	integer (int32)
pageToken	string

SELECT examples

get

Gets a DiscoveredAPIObservation in a given project, location and ApiObservation.

SELECT
name,
apiOperationCount,
createTime,
hostname,
knownOperationsCount,
lastEventDetectedTime,
origin,
serverIps,
sourceLocations,
sourceMetadata,
sourceTypes,
style,
unknownOperationsCount,
updateTime
FROM google.apihub.discovered_api_observations
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND discoveredApiObservationsId = '{{ discoveredApiObservationsId }}' -- required;

list

Lists all the DiscoveredAPIObservations in a given project and location.

SELECT
name,
apiOperationCount,
createTime,
hostname,
knownOperationsCount,
lastEventDetectedTime,
origin,
serverIps,
sourceLocations,
sourceMetadata,
sourceTypes,
style,
unknownOperationsCount,
updateTime
FROM google.apihub.discovered_api_observations
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}';