Google Cloud Api Hub V1 Client - Class DiscoveredApiObservation (0.3.0)

Reference documentation and code samples for the Google Cloud Api Hub V1 Client class DiscoveredApiObservation.

Respresents an API Observation observed in one of the sources.

Generated from protobuf message google.cloud.apihub.v1.DiscoveredApiObservation

Namespace

Google \ Cloud \ ApiHub \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ name string

Identifier. The name of the discovered API Observation. Format: projects/{project}/locations/{location}/discoveredApiObservations/{discovered_api_observation}

↳ style int

Optional. Style of ApiObservation

↳ server_ips 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".

↳ hostname string

Optional. The hostname of requests processed for this Observation.

↳ last_event_detected_time Google\Protobuf\Timestamp

Optional. Last event detected time stamp

↳ source_locations array

Optional. The location of the observation source.

↳ api_operation_count int|string

Optional. The number of observed API Operations.

↳ origin string

Optional. For an observation pushed from a gcp resource, this would be the gcp project id.

↳ source_types array

Optional. The type of the source from which the observation was collected.

↳ known_operations_count int|string

Output only. The number of known API Operations.

↳ unknown_operations_count int|string

Output only. The number of unknown API Operations.

↳ create_time Google\Protobuf\Timestamp

Output only. Create time stamp of the observation in API Hub.

↳ update_time Google\Protobuf\Timestamp

Output only. Update time stamp of the observation in API Hub.

↳ source_metadata SourceMetadata

Output only. The metadata of the source from which the observation was collected.

getName

Identifier. The name of the discovered API Observation.

Format: projects/{project}/locations/{location}/discoveredApiObservations/{discovered_api_observation}

Returns
Type Description
string

setName

Identifier. The name of the discovered API Observation.

Format: projects/{project}/locations/{location}/discoveredApiObservations/{discovered_api_observation}

Parameter
Name Description
var string
Returns
Type Description
$this

getStyle

Optional. Style of ApiObservation

Returns
Type Description
int Enum of type Style.

setStyle

Optional. Style of ApiObservation

Parameter
Name Description
var int

Enum of type Style.

Returns
Type Description
$this

getServerIps

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

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setServerIps

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

Parameter
Name Description
var string[]
Returns
Type Description
$this

getHostname

Optional. The hostname of requests processed for this Observation.

Returns
Type Description
string

setHostname

Optional. The hostname of requests processed for this Observation.

Parameter
Name Description
var string
Returns
Type Description
$this

getLastEventDetectedTime

Optional. Last event detected time stamp

Returns
Type Description
Google\Protobuf\Timestamp|null

hasLastEventDetectedTime

clearLastEventDetectedTime

setLastEventDetectedTime

Optional. Last event detected time stamp

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getSourceLocations

Optional. The location of the observation source.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setSourceLocations

Optional. The location of the observation source.

Parameter
Name Description
var string[]
Returns
Type Description
$this

getApiOperationCount

Optional. The number of observed API Operations.

Returns
Type Description
int|string

setApiOperationCount

Optional. The number of observed API Operations.

Parameter
Name Description
var int|string
Returns
Type Description
$this

getOrigin

Optional. For an observation pushed from a gcp resource, this would be the gcp project id.

Returns
Type Description
string

setOrigin

Optional. For an observation pushed from a gcp resource, this would be the gcp project id.

Parameter
Name Description
var string
Returns
Type Description
$this

getSourceTypes

Optional. The type of the source from which the observation was collected.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setSourceTypes

Optional. The type of the source from which the observation was collected.

Parameter
Name Description
var int[]
Returns
Type Description
$this

getKnownOperationsCount

Output only. The number of known API Operations.

Returns
Type Description
int|string

setKnownOperationsCount

Output only. The number of known API Operations.

Parameter
Name Description
var int|string
Returns
Type Description
$this

getUnknownOperationsCount

Output only. The number of unknown API Operations.

Returns
Type Description
int|string

setUnknownOperationsCount

Output only. The number of unknown API Operations.

Parameter
Name Description
var int|string
Returns
Type Description
$this

getCreateTime

Output only. Create time stamp of the observation in API Hub.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. Create time stamp of the observation in API Hub.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getUpdateTime

Output only. Update time stamp of the observation in API Hub.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. Update time stamp of the observation in API Hub.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getSourceMetadata

Output only. The metadata of the source from which the observation was collected.

Returns
Type Description
SourceMetadata|null

hasSourceMetadata

clearSourceMetadata

setSourceMetadata

Output only. The metadata of the source from which the observation was collected.

Parameter
Name Description
var SourceMetadata
Returns
Type Description
$this