REST Resource: projects.locations.networkMonitoringProviders.networkPaths

Resource: NetworkPath

Message describing NetworkPath resource.

JSON representation
{
  "name": string,
  "createTime": string,
  "updateTime": string,
  "sourceMonitoringPointId": string,
  "destinationMonitoringPointId": string,
  "destination": string,
  "dualEnded": boolean,
  "displayName": string,
  "destinationGeoLocation": {
    object (GeoLocation)
  },
  "networkProtocol": enum (NetworkProtocol),
  "monitoringEnabled": boolean,
  "monitoringStatus": enum (MonitoringStatus),
  "providerTags": [
    {
      object (ProviderTag)
    }
  ],
  "monitoringPolicyId": string,
  "monitoringPolicyDisplayName": string,
  "providerUiUri": string
}
Fields
name

string

Identifier. Name of the resource. Format: projects/{project}/locations/{location}/networkMonitoringProviders/{networkMonitoringProvider}/networkPaths/{network_path}

createTime

string (Timestamp format)

Output only. The time the NetworkPath was created.

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. The time the NetworkPath was updated.

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

sourceMonitoringPointId

string

Output only. Provider's UUID of the source MonitoringPoint. This id may not point to a resource in the Google Cloud.

destinationMonitoringPointId

string

Output only. Provider's UUID of the destination MonitoringPoint. This id may not point to a resource in the Google Cloud.

destination

string

Output only. IP address or hostname of the network path destination.

dualEnded

boolean

Output only. Indicates if the network path is dual ended.

When true, the network path is measured both: from both source to destination, and from destination to source.

When false, the network path is measured from the source through the destination back to the source (round trip measurement).

displayName

string

Output only. The display name of the network path.

destinationGeoLocation

object (GeoLocation)

Output only. Geographical location of the destination MonitoringPoint. ;

networkProtocol

enum (NetworkProtocol)

Output only. The network protocol of the network path.

monitoringEnabled

boolean

Output only. Is monitoring enabled for the network path.

monitoringStatus

enum (MonitoringStatus)

Output only. The monitoring status of the network path.

providerTags[]

object (ProviderTag)

Output only. The provider tags of the network path.

monitoringPolicyId

string

Output only. ID of monitoring policy.

monitoringPolicyDisplayName

string

Output only. Display name of the monitoring policy.

providerUiUri

string

Output only. Link to provider's UI; link shows the NetworkPath.

NetworkProtocol

Enum for the network protocol.

Enums
NETWORK_PROTOCOL_UNSPECIFIED The default value. This value is used if the network protocol is omitted.
ICMP ICMP.
UDP UDP.
TCP TCP.

MonitoringStatus

Enum for the monitoring status of the network path.

Enums
MONITORING_STATUS_UNSPECIFIED The default value. This value is used if the status is omitted.
MONITORING Monitoring is enabled.
POLICY_MISMATCH Policy is mismatched.
MONITORING_POINT_OFFLINE Monitoring point is offline.
DISABLED Monitoring is disabled.

Methods

get

Gets the NetworkPath resource.

list

Lists NetworkPaths for a given network monitoring provider.