Package Classes (1.23.0)

Summary of entries of Classes for networkmanagement.

Classes

ReachabilityServiceAsyncClient

The Reachability service in the Google Cloud Network Management API provides services that analyze the reachability within a single Google Virtual Private Cloud (VPC) network, between peered VPC networks, between VPC and on-premises networks, or between VPC networks and internet hosts. A reachability analysis is based on Google Cloud network configurations.

You can use the analysis results to verify these configurations and to troubleshoot connectivity issues.

ReachabilityServiceClient

You can use the analysis results to verify these configurations and to troubleshoot connectivity issues.

ListConnectivityTestsAsyncPager

A pager for iterating through list_connectivity_tests requests.

This class thinly wraps an initial ListConnectivityTestsResponse object, and provides an __aiter__ method to iterate through its resources field.

If there are more pages, the __aiter__ method will make additional ListConnectivityTests requests and continue to iterate through the resources field on the corresponding responses.

All the usual ListConnectivityTestsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListConnectivityTestsPager

A pager for iterating through list_connectivity_tests requests.

This class thinly wraps an initial ListConnectivityTestsResponse object, and provides an __iter__ method to iterate through its resources field.

If there are more pages, the __iter__ method will make additional ListConnectivityTests requests and continue to iterate through the resources field on the corresponding responses.

All the usual ListConnectivityTestsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

AbortInfo

Details of the final state "abort" and associated resource.

Cause

Abort cause types:

    - The request might contain malformed resource
      URI, project ID, or IP address.
    - The request might contain inconsistent
      information (for example, the request might
      include both the instance and the network, but
      the instance might not have a NIC in that
      network).
TRACE_TOO_LONG (9):
    Aborted because the number of steps in the
    trace exceeds a certain limit. It might be
    caused by a routing loop.
INTERNAL_ERROR (10):
    Aborted due to internal server error.
UNSUPPORTED (15):
    Aborted because the test scenario is not
    supported.
MISMATCHED_IP_VERSION (16):
    Aborted because the source and destination
    resources have no common IP version.
GKE_KONNECTIVITY_PROXY_UNSUPPORTED (17):
    Aborted because the connection between the
    control plane and the node of the source cluster
    is initiated by the node and managed by the
    Konnectivity proxy.
RESOURCE_CONFIG_NOT_FOUND (18):
    Aborted because expected resource
    configuration was missing.
VM_INSTANCE_CONFIG_NOT_FOUND (24):
    Aborted because expected VM instance
    configuration was missing.
NETWORK_CONFIG_NOT_FOUND (25):
    Aborted because expected network
    configuration was missing.
FIREWALL_CONFIG_NOT_FOUND (26):
    Aborted because expected firewall
    configuration was missing.
ROUTE_CONFIG_NOT_FOUND (27):
    Aborted because expected route configuration
    was missing.
GOOGLE_MANAGED_SERVICE_AMBIGUOUS_PSC_ENDPOINT (19):
    Aborted because a PSC endpoint selection for
    the Google-managed service is ambiguous (several
    PSC endpoints satisfy test input).
SOURCE_PSC_CLOUD_SQL_UNSUPPORTED (20):
    Aborted because tests with a PSC-based Cloud
    SQL instance as a source are not supported.
SOURCE_REDIS_CLUSTER_UNSUPPORTED (34):
    Aborted because tests with a Redis Cluster as
    a source are not supported.
SOURCE_REDIS_INSTANCE_UNSUPPORTED (35):
    Aborted because tests with a Redis Instance
    as a source are not supported.
SOURCE_FORWARDING_RULE_UNSUPPORTED (21):
    Aborted because tests with a forwarding rule
    as a source are not supported.
NON_ROUTABLE_IP_ADDRESS (22):
    Aborted because one of the endpoints is a
    non-routable IP address (loopback, link-local,
    etc).
UNKNOWN_ISSUE_IN_GOOGLE_MANAGED_PROJECT (30):
    Aborted due to an unknown issue in the
    Google-managed project.
UNSUPPORTED_GOOGLE_MANAGED_PROJECT_CONFIG (31):
    Aborted due to an unsupported configuration
    of the Google-managed project.

AppEngineVersionInfo

For display only. Metadata associated with an App Engine version.

CloudFunctionInfo

For display only. Metadata associated with a Cloud Function.

CloudRunRevisionInfo

For display only. Metadata associated with a Cloud Run revision.

CloudSQLInstanceInfo

For display only. Metadata associated with a Cloud SQL instance.

ConnectivityTest

A Connectivity Test for a network reachability analysis.

LabelsEntry

The abstract base class for a message.

CreateConnectivityTestRequest

Request for the CreateConnectivityTest method.

DeleteConnectivityTestRequest

Request for the DeleteConnectivityTest method.

DeliverInfo

Details of the final state "deliver" and associated resource.

Target

Deliver target types:

DropInfo

Details of the final state "drop" and associated resource.

Cause

Drop cause types:

Endpoint

Source or destination of the Connectivity Test.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

AppEngineVersionEndpoint

Wrapper for the App Engine service version attributes.

CloudFunctionEndpoint

Wrapper for Cloud Function attributes.

CloudRunRevisionEndpoint

Wrapper for Cloud Run revision attributes.

ForwardingRuleTarget

Type of the target of a forwarding rule.

NetworkType

The type definition of an endpoint's network. Use one of the following choices:

EndpointInfo

For display only. The specification of the endpoints for the test. EndpointInfo is derived from source and destination Endpoint and validated by the backend data plane model.

FirewallInfo

For display only. Metadata associated with a VPC firewall rule, an implied VPC firewall rule, or a firewall policy rule.

FirewallRuleType

The firewall rule's type.

ForwardInfo

Details of the final state "forward" and associated resource.

Target

Forward target types.

ForwardingRuleInfo

For display only. Metadata associated with a Compute Engine forwarding rule.

GKEMasterInfo

For display only. Metadata associated with a Google Kubernetes Engine (GKE) cluster master.

GetConnectivityTestRequest

Request for the GetConnectivityTest method.

GoogleServiceInfo

For display only. Details of a Google Service sending packets to a VPC network. Although the source IP might be a publicly routable address, some Google Services use special routes within Google production infrastructure to reach Compute Engine Instances. https://cloud.google.com/vpc/docs/routes#special_return_paths

GoogleServiceType

Recognized type of a Google Service.

    -  Load Balancer proxy
    -  Centralized Health Check prober
       https://cloud.google.com/load-balancing/docs/firewall-rules
CLOUD_DNS (3):
    Connectivity from Cloud DNS to forwarding
    targets or alternate name servers that use
    private routing.
    https://cloud.google.com/dns/docs/zones/forwarding-zones#firewall-rules
    https://cloud.google.com/dns/docs/policies#firewall-rules
GOOGLE_API (4):
    private.googleapis.com and
    restricted.googleapis.com
GOOGLE_API_PSC (5):
    Google API via Private Service Connect.
    https://cloud.google.com/vpc/docs/configure-private-service-connect-apis
GOOGLE_API_VPC_SC (6):
    Google API via VPC Service Controls.
    https://cloud.google.com/vpc/docs/configure-private-service-connect-apis

InstanceInfo

For display only. Metadata associated with a Compute Engine instance.

LatencyDistribution

Describes measured latency distribution.

LatencyPercentile

Latency percentile rank and value.

ListConnectivityTestsRequest

Request for the ListConnectivityTests method.

ListConnectivityTestsResponse

Response for the ListConnectivityTests method.

LoadBalancerBackend

For display only. Metadata associated with a specific load balancer backend.

HealthCheckFirewallState

State of a health check firewall configuration:

LoadBalancerBackendInfo

For display only. Metadata associated with the load balancer backend.

HealthCheckFirewallsConfigState

Health check firewalls configuration state enum.

    https://cloud.google.com/network-intelligence-center/docs/connectivity-tests/concepts/overview#unsupported-configs

LoadBalancerInfo

For display only. Metadata associated with a load balancer.

BackendType

The type definition for a load balancer backend configuration:

LoadBalancerType

The type definition for a load balancer:

LoadBalancerType

Type of a load balancer. For more information, see Summary of Google Cloud load balancers <https://cloud.google.com/load-balancing/docs/load-balancing-overview#summary-of-google-cloud-load-balancers>__.

NatInfo

For display only. Metadata associated with NAT.

Type

Types of NAT.

NetworkInfo

For display only. Metadata associated with a Compute Engine network. Next ID: 7

OperationMetadata

Metadata describing an Operation][google.longrunning.Operation]

ProbingDetails

Results of active probing from the last run of the test.

EdgeLocation

Representation of a network edge location as per https://cloud.google.com/vpc/docs/edge-locations.

ProbingAbortCause

Abort cause types.

ProbingResult

Overall probing result of the test.

    -  The user lacks permission to access some of the network
       resources required to run the test.
    -  No valid source endpoint could be derived from the
       request.
    -  An internal error occurred.

ProxyConnectionInfo

For display only. Metadata associated with ProxyConnection.

ReachabilityDetails

Results of the configuration analysis from the last run of the test.

Result

The overall result of the test's configuration analysis.

    -  The configuration analysis determined that a packet
       originating from the source is expected to reach the
       destination.
    -  The analysis didn't complete because the user lacks
       permission for some of the resources in the trace.
       However, at the time the user's permission became
       insufficient, the trace had been successful so far.
UNREACHABLE (2):
    A packet originating from the source is
    expected to be dropped before reaching the
    destination.
AMBIGUOUS (4):
    The source and destination endpoints do not
    uniquely identify the test location in the
    network, and the reachability result contains
    multiple traces. For some traces, a packet could
    be delivered, and for others, it would not be.
    This result is also assigned to configuration
    analysis of return path if on its own it should
    be REACHABLE, but configuration analysis of
    forward path is AMBIGUOUS.
UNDETERMINED (5):
    The configuration analysis did not complete. Possible
    reasons are:

    -  A permissions error occurred--for example, the user might
       not have read permission for all of the resources named
       in the test.
    -  An internal error occurred.
    -  The analyzer received an invalid or unsupported argument
       or was unable to identify a known endpoint.

RedisClusterInfo

For display only. Metadata associated with a Redis Cluster.

RedisInstanceInfo

For display only. Metadata associated with a Cloud Redis Instance.

RerunConnectivityTestRequest

Request for the RerunConnectivityTest method.

RouteInfo

For display only. Metadata associated with a Compute Engine route.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

NextHopType

Type of next hop:

RouteScope

Indicates where routes are applicable.

RouteType

Type of route:

ServerlessNegInfo

For display only. Metadata associated with the serverless network endpoint group backend.

Step

A simulated forwarding path is composed of multiple steps. Each step has a well-defined state and an associated configuration.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Each trace contains multiple ordered steps.
Each step is in a particular state with associated configuration.
State is categorized as final or non-final states.
Each final state has a reason associated.
Each trace must end with a final state (the last step).

 |---------------------Trace----------------------|
 Step1(State) Step2(State) ---  StepN(State(final))

Modules

pagers

API documentation for network_management_v1.services.reachability_service.pagers module.