Network Management API . projects . locations . networkMonitoringProviders . networkPaths

Instance Methods

close()

Close httplib2 connections.

get(name, x__xgafv=None)

Gets the NetworkPath resource.

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

Lists NetworkPaths for a given network monitoring provider.

list_next()

Retrieves the next page of results.

Method Details

close()
Close httplib2 connections.
get(name, x__xgafv=None)
Gets the NetworkPath resource.

Args:
  name: string, Required. Name of the resource. Format: projects/{project}/locations/{location}/networkMonitoringProviders/{network_monitoring_provider}/networkPaths/{network_path} (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 NetworkPath resource.
  "createTime": "A String", # Output only. The time the NetworkPath was created.
  "destination": "A String", # Output only. IP address or hostname of the network path destination.
  "destinationGeoLocation": { # The geographical location of the MonitoringPoint. # Output only. Geographical location of the destination MonitoringPoint. ;
    "country": "A String", # Country.
    "formattedAddress": "A String", # Formatted address.
  },
  "displayName": "A String", # Output only. The display name of the network path.
  "dualEnded": True or False, # 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": True or False, # Output only. Is monitoring enabled for the network path.
  "monitoringPolicyDisplayName": "A String", # Output only. Display name of the monitoring policy.
  "monitoringPolicyId": "A String", # Output only. ID of monitoring policy.
  "monitoringStatus": "A String", # Output only. The monitoring status of the network path.
  "name": "A String", # Identifier. Name of the resource. Format: `projects/{project}/locations/{location}/networkMonitoringProviders/{network_monitoring_provider}/networkPaths/{network_path}`
  "networkProtocol": "A String", # Output only. The network protocol of the network path.
  "providerTags": [ # Output only. The provider tags of the network path.
    { # Message describing the provider tag.
      "category": "A String", # Output only. The category of the provider tag.
      "resourceType": "A String", # Output only. The resource type of the provider tag.
      "value": "A String", # Output only. The value of the provider tag.
    },
  ],
  "providerUiUri": "A String", # Output only. Link to provider's UI; link shows the NetworkPath.
  "sourceMonitoringPointId": "A String", # Output only. Provider's UUID of the source MonitoringPoint. This id may not point to a resource in the GCP.
  "updateTime": "A String", # Output only. The time the NetworkPath was updated.
}
list(parent, pageSize=None, pageToken=None, x__xgafv=None)
Lists NetworkPaths for a given network monitoring provider.

Args:
  parent: string, Required. Parent value for ListNetworkPathsRequest. Format: projects/{project}/locations/{location}/networkMonitoringProviders/{network_monitoring_provider} (required)
  pageSize: integer, Optional. The maximum number of network paths to return. The service may return fewer than this value. If unspecified, at most 20 network pathswill 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 `ListNetworkPaths` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListNetworkPaths` 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 NetworkPaths
  "networkPaths": [ # The list of NetworkPath
    { # Message describing NetworkPath resource.
      "createTime": "A String", # Output only. The time the NetworkPath was created.
      "destination": "A String", # Output only. IP address or hostname of the network path destination.
      "destinationGeoLocation": { # The geographical location of the MonitoringPoint. # Output only. Geographical location of the destination MonitoringPoint. ;
        "country": "A String", # Country.
        "formattedAddress": "A String", # Formatted address.
      },
      "displayName": "A String", # Output only. The display name of the network path.
      "dualEnded": True or False, # 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": True or False, # Output only. Is monitoring enabled for the network path.
      "monitoringPolicyDisplayName": "A String", # Output only. Display name of the monitoring policy.
      "monitoringPolicyId": "A String", # Output only. ID of monitoring policy.
      "monitoringStatus": "A String", # Output only. The monitoring status of the network path.
      "name": "A String", # Identifier. Name of the resource. Format: `projects/{project}/locations/{location}/networkMonitoringProviders/{network_monitoring_provider}/networkPaths/{network_path}`
      "networkProtocol": "A String", # Output only. The network protocol of the network path.
      "providerTags": [ # Output only. The provider tags of the network path.
        { # Message describing the provider tag.
          "category": "A String", # Output only. The category of the provider tag.
          "resourceType": "A String", # Output only. The resource type of the provider tag.
          "value": "A String", # Output only. The value of the provider tag.
        },
      ],
      "providerUiUri": "A String", # Output only. Link to provider's UI; link shows the NetworkPath.
      "sourceMonitoringPointId": "A String", # Output only. Provider's UUID of the source MonitoringPoint. This id may not point to a resource in the GCP.
      "updateTime": "A String", # Output only. The time the NetworkPath was updated.
    },
  ],
  "nextPageToken": "A String", # A token identifying a page of results the server should return.
}
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.