network_paths

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

Overview

Name	network_paths
Type	Resource
Id	google.networkmanagement.network_paths

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
name	string	Identifier. Name of the resource. Format: projects/{project}/locations/{location}/networkMonitoringProviders/{network_monitoring_provider}/networkPaths/{network_path}
createTime	string (google-datetime)	Output only. The time the NetworkPath was created.
destination	string	Output only. IP address or hostname of the network path destination.
destinationGeoLocation	object	Output only. Geographical location of the destination MonitoringPoint. ; (id: GeoLocation)
displayName	string	Output only. The display name of the network path.
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).
monitoringEnabled	boolean	Output only. Is monitoring enabled for the network path.
monitoringPolicyDisplayName	string	Output only. Display name of the monitoring policy.
monitoringPolicyId	string	Output only. ID of monitoring policy.
monitoringStatus	string	Output only. The monitoring status of the network path.
networkProtocol	string	Output only. The network protocol of the network path.
providerTags	array	Output only. The provider tags of the network path.
providerUiUri	string	Output only. Link to provider's UI; link shows the NetworkPath.
sourceMonitoringPointId	string	Output only. Provider's UUID of the source MonitoringPoint. This id may not point to a resource in the GCP.
updateTime	string (google-datetime)	Output only. The time the NetworkPath was updated.

list

Successful response

Name	Datatype	Description
name	string	Identifier. Name of the resource. Format: projects/{project}/locations/{location}/networkMonitoringProviders/{network_monitoring_provider}/networkPaths/{network_path}
createTime	string (google-datetime)	Output only. The time the NetworkPath was created.
destination	string	Output only. IP address or hostname of the network path destination.
destinationGeoLocation	object	Output only. Geographical location of the destination MonitoringPoint. ; (id: GeoLocation)
displayName	string	Output only. The display name of the network path.
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).
monitoringEnabled	boolean	Output only. Is monitoring enabled for the network path.
monitoringPolicyDisplayName	string	Output only. Display name of the monitoring policy.
monitoringPolicyId	string	Output only. ID of monitoring policy.
monitoringStatus	string	Output only. The monitoring status of the network path.
networkProtocol	string	Output only. The network protocol of the network path.
providerTags	array	Output only. The provider tags of the network path.
providerUiUri	string	Output only. Link to provider's UI; link shows the NetworkPath.
sourceMonitoringPointId	string	Output only. Provider's UUID of the source MonitoringPoint. This id may not point to a resource in the GCP.
updateTime	string (google-datetime)	Output only. The time the NetworkPath was updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, networkMonitoringProvidersId, networkPathsId		Gets the NetworkPath resource.
list	select	projectsId, locationsId, networkMonitoringProvidersId	pageSize, pageToken	Lists NetworkPaths for a given network monitoring provider.

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
locationsId	string
networkMonitoringProvidersId	string
networkPathsId	string
projectsId	string
pageSize	integer (int32)
pageToken	string

SELECT examples

get

Gets the NetworkPath resource.

SELECT
name,
createTime,
destination,
destinationGeoLocation,
displayName,
dualEnded,
monitoringEnabled,
monitoringPolicyDisplayName,
monitoringPolicyId,
monitoringStatus,
networkProtocol,
providerTags,
providerUiUri,
sourceMonitoringPointId,
updateTime
FROM google.networkmanagement.network_paths
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND networkMonitoringProvidersId = '{{ networkMonitoringProvidersId }}' -- required
AND networkPathsId = '{{ networkPathsId }}' -- required;

list

Lists NetworkPaths for a given network monitoring provider.

SELECT
name,
createTime,
destination,
destinationGeoLocation,
displayName,
dualEnded,
monitoringEnabled,
monitoringPolicyDisplayName,
monitoringPolicyId,
monitoringStatus,
networkProtocol,
providerTags,
providerUiUri,
sourceMonitoringPointId,
updateTime
FROM google.networkmanagement.network_paths
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND networkMonitoringProvidersId = '{{ networkMonitoringProvidersId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}';