As of January 1, 2020 this library no longer supports Python 2 on the latest released version. Library versions released prior to that date will continue to be available. For more information please visit Python 2 support on Google Cloud.

Types for Google Cloud Network Management v1 API

class google.cloud.network_management_v1.types.AbortInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Details of the final state “abort” and associated resource.

cause

Causes that the analysis is aborted.

Type

google.cloud.network_management_v1.types.AbortInfo.Cause

resource_uri

URI of the resource that caused the abort.

Type

str

class Cause(value)[source]

Bases: proto.enums.Enum

Abort cause types:

CAUSE_UNSPECIFIED = 0
DESTINATION_ENDPOINT_NOT_FOUND = 13
INTERNAL_ERROR = 10
INVALID_ARGUMENT = 6
MISMATCHED_DESTINATION_NETWORK = 14
MISMATCHED_SOURCE_NETWORK = 12
NO_EXTERNAL_IP = 7
NO_SOURCE_LOCATION = 5
PERMISSION_DENIED = 4
SOURCE_ENDPOINT_NOT_FOUND = 11
TRACE_TOO_LONG = 9
UNINTENDED_DESTINATION = 8
UNKNOWN_IP = 2
UNKNOWN_NETWORK = 1
UNKNOWN_PROJECT = 3
class google.cloud.network_management_v1.types.CloudSQLInstanceInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

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

display_name

Name of a Cloud SQL instance.

Type

str

uri

URI of a Cloud SQL instance.

Type

str

network_uri

URI of a Cloud SQL instance network or empty string if the instance does not have one.

Type

str

internal_ip

Internal IP address of a Cloud SQL instance.

Type

str

external_ip

External IP address of a Cloud SQL instance.

Type

str

region

Region in which the Cloud SQL instance is running.

Type

str

class google.cloud.network_management_v1.types.ConnectivityTest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

A Connectivity Test for a network reachability analysis.

name

Required. Unique name of the resource using the form: projects/{project_id}/locations/global/connectivityTests/{test_id}

Type

str

description

The user-supplied description of the Connectivity Test. Maximum of 512 characters.

Type

str

source

Required. Source specification of the Connectivity Test. You can use a combination of source IP address, virtual machine (VM) instance, or Compute Engine network to uniquely identify the source location.

Examples: If the source IP address is an internal IP address within a Google Cloud Virtual Private Cloud (VPC) network, then you must also specify the VPC network. Otherwise, specify the VM instance, which already contains its internal IP address and VPC network information. If the source of the test is within an on- premises network, then you must provide the destination VPC network.

If the source endpoint is a Compute Engine VM instance with multiple network interfaces, the instance itself is not sufficient to identify the endpoint. So, you must also specify the source IP address or VPC network. A reachability analysis proceeds even if the source location is ambiguous. However, the test result may include endpoints that you don’t intend to test.

Type

google.cloud.network_management_v1.types.Endpoint

destination

Required. Destination specification of the Connectivity Test. You can use a combination of destination IP address, Compute Engine VM instance, or VPC network to uniquely identify the destination location.

Even if the destination IP address is not unique, the source IP location is unique. Usually, the analysis can infer the destination endpoint from route information.

If the destination you specify is a VM instance and the instance has multiple network interfaces, then you must also specify either a destination IP address or VPC network to identify the destination interface.

A reachability analysis proceeds even if the destination location is ambiguous. However, the result can include endpoints that you don’t intend to test.

Type

google.cloud.network_management_v1.types.Endpoint

protocol

IP Protocol of the test. When not provided, “TCP” is assumed.

Type

str

related_projects

Other projects that may be relevant for reachability analysis. This is applicable to scenarios where a test can cross project boundaries.

Type

Sequence[str]

display_name

Output only. The display name of a Connectivity Test.

Type

str

labels

Resource labels to represent user-provided metadata.

Type

Sequence[google.cloud.network_management_v1.types.ConnectivityTest.LabelsEntry]

create_time

Output only. The time the test was created.

Type

google.protobuf.timestamp_pb2.Timestamp

update_time

Output only. The time the test’s configuration was updated.

Type

google.protobuf.timestamp_pb2.Timestamp

reachability_details

Output only. The reachability details of this test from the latest run. The details are updated when creating a new test, updating an existing test, or triggering a one-time rerun of an existing test.

Type

google.cloud.network_management_v1.types.ReachabilityDetails

class LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class google.cloud.network_management_v1.types.CreateConnectivityTestRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request for the CreateConnectivityTest method.

parent

Required. The parent resource of the Connectivity Test to create: projects/{project_id}/locations/global

Type

str

test_id

Required. The logical name of the Connectivity Test in your project with the following restrictions:

  • Must contain only lowercase letters, numbers, and hyphens.

  • Must start with a letter.

  • Must be between 1-40 characters.

  • Must end with a number or a letter.

  • Must be unique within the customer project

Type

str

resource

Required. A ConnectivityTest resource

Type

google.cloud.network_management_v1.types.ConnectivityTest

class google.cloud.network_management_v1.types.DeleteConnectivityTestRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request for the DeleteConnectivityTest method.

name

Required. Connectivity Test resource name using the form: projects/{project_id}/locations/global/connectivityTests/{test_id}

Type

str

class google.cloud.network_management_v1.types.DeliverInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Details of the final state “deliver” and associated resource.

target

Target type where the packet is delivered to.

Type

google.cloud.network_management_v1.types.DeliverInfo.Target

resource_uri

URI of the resource that the packet is delivered to.

Type

str

class Target(value)[source]

Bases: proto.enums.Enum

Deliver target types:

CLOUD_SQL_INSTANCE = 5
GKE_MASTER = 4
GOOGLE_API = 3
INSTANCE = 1
INTERNET = 2
TARGET_UNSPECIFIED = 0
class google.cloud.network_management_v1.types.DropInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Details of the final state “drop” and associated resource.

cause

Cause that the packet is dropped.

Type

google.cloud.network_management_v1.types.DropInfo.Cause

resource_uri

URI of the resource that caused the drop.

Type

str

class Cause(value)[source]

Bases: proto.enums.Enum

Drop cause types:

CAUSE_UNSPECIFIED = 0
CLOUD_SQL_INSTANCE_NO_IP_ADDRESS = 21
CLOUD_SQL_INSTANCE_UNAUTHORIZED_ACCESS = 17
DROPPED_INSIDE_CLOUD_SQL_SERVICE = 19
DROPPED_INSIDE_GKE_SERVICE = 18
FIREWALL_BLOCKING_LOAD_BALANCER_BACKEND_HEALTH_CHECK = 13
FIREWALL_RULE = 3
FOREIGN_IP_DISALLOWED = 2
FORWARDING_RULE_MISMATCH = 11
FORWARDING_RULE_NO_INSTANCES = 12
GKE_MASTER_UNAUTHORIZED_ACCESS = 16
GOOGLE_MANAGED_SERVICE_NO_PEERING = 20
INSTANCE_NOT_RUNNING = 14
NO_EXTERNAL_ADDRESS = 9
NO_ROUTE = 4
PRIVATE_GOOGLE_ACCESS_DISALLOWED = 8
PRIVATE_TRAFFIC_TO_INTERNET = 7
ROUTE_BLACKHOLE = 5
ROUTE_WRONG_NETWORK = 6
TRAFFIC_TYPE_BLOCKED = 15
UNKNOWN_EXTERNAL_ADDRESS = 1
UNKNOWN_INTERNAL_ADDRESS = 10
class google.cloud.network_management_v1.types.Endpoint(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Source or destination of the Connectivity Test.

ip_address

The IP address of the endpoint, which can be an external or internal IP. An IPv6 address is only allowed when the test’s destination is a global load balancer VIP.

Type

str

port

The IP protocol port of the endpoint. Only applicable when protocol is TCP or UDP.

Type

int

instance

A Compute Engine instance URI.

Type

str

gke_master_cluster

A cluster URI for Google Kubernetes Engine master.

Type

str

cloud_sql_instance

A Cloud SQL instance URI.

Type

str

network

A Compute Engine network URI.

Type

str

network_type

Type of the network where the endpoint is located. Applicable only to source endpoint, as destination network type can be inferred from the source.

Type

google.cloud.network_management_v1.types.Endpoint.NetworkType

project_id

Project ID where the endpoint is located. The Project ID can be derived from the URI if you provide a VM instance or network URI. The following are two cases where you must provide the project ID: 1. Only the IP address is specified, and the IP address is within a GCP project. 2. When you are using Shared VPC and the IP address that you provide is from the service project. In this case, the network that the IP address resides in is defined in the host project.

Type

str

class NetworkType(value)[source]

Bases: proto.enums.Enum

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

GCP_NETWORK = 1
NETWORK_TYPE_UNSPECIFIED = 0
NON_GCP_NETWORK = 2
class google.cloud.network_management_v1.types.EndpointInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

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.

source_ip

Source IP address.

Type

str

destination_ip

Destination IP address.

Type

str

protocol

IP protocol in string format, for example: “TCP”, “UDP”, “ICMP”.

Type

str

source_port

Source port. Only valid when protocol is TCP or UDP.

Type

int

destination_port

Destination port. Only valid when protocol is TCP or UDP.

Type

int

source_network_uri

URI of the network where this packet originates from.

Type

str

destination_network_uri

URI of the network where this packet is sent to.

Type

str

class google.cloud.network_management_v1.types.FirewallInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

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

display_name

The display name of the VPC firewall rule. This field is not applicable to hierarchical firewall policy rules.

Type

str

uri

The URI of the VPC firewall rule. This field is not applicable to implied firewall rules or hierarchical firewall policy rules.

Type

str

direction

Possible values: INGRESS, EGRESS

Type

str

action

Possible values: ALLOW, DENY

Type

str

priority

The priority of the firewall rule.

Type

int

network_uri

The URI of the VPC network that the firewall rule is associated with. This field is not applicable to hierarchical firewall policy rules.

Type

str

target_tags

The target tags defined by the VPC firewall rule. This field is not applicable to hierarchical firewall policy rules.

Type

Sequence[str]

target_service_accounts

The target service accounts specified by the firewall rule.

Type

Sequence[str]

policy

The hierarchical firewall policy that this rule is associated with. This field is not applicable to VPC firewall rules.

Type

str

firewall_rule_type

The firewall rule’s type.

Type

google.cloud.network_management_v1.types.FirewallInfo.FirewallRuleType

class FirewallRuleType(value)[source]

Bases: proto.enums.Enum

The firewall rule’s type.

FIREWALL_RULE_TYPE_UNSPECIFIED = 0
HIERARCHICAL_FIREWALL_POLICY_RULE = 1
IMPLIED_VPC_FIREWALL_RULE = 3
VPC_FIREWALL_RULE = 2
class google.cloud.network_management_v1.types.ForwardInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Details of the final state “forward” and associated resource.

target

Target type where this packet is forwarded to.

Type

google.cloud.network_management_v1.types.ForwardInfo.Target

resource_uri

URI of the resource that the packet is forwarded to.

Type

str

class Target(value)[source]

Bases: proto.enums.Enum

Forward target types.

CLOUD_SQL_INSTANCE = 6
GKE_MASTER = 4
IMPORTED_CUSTOM_ROUTE_NEXT_HOP = 5
INTERCONNECT = 3
PEERING_VPC = 1
TARGET_UNSPECIFIED = 0
VPN_GATEWAY = 2
class google.cloud.network_management_v1.types.ForwardingRuleInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

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

display_name

Name of a Compute Engine forwarding rule.

Type

str

uri

URI of a Compute Engine forwarding rule.

Type

str

matched_protocol

Protocol defined in the forwarding rule that matches the test.

Type

str

matched_port_range

Port range defined in the forwarding rule that matches the test.

Type

str

vip

VIP of the forwarding rule.

Type

str

target

Target type of the forwarding rule.

Type

str

network_uri

Network URI. Only valid for Internal Load Balancer.

Type

str

class google.cloud.network_management_v1.types.GKEMasterInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

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

cluster_uri

URI of a GKE cluster.

Type

str

cluster_network_uri

URI of a GKE cluster network.

Type

str

internal_ip

Internal IP address of a GKE cluster master.

Type

str

external_ip

External IP address of a GKE cluster master.

Type

str

class google.cloud.network_management_v1.types.GetConnectivityTestRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request for the GetConnectivityTest method.

name

Required. ConnectivityTest resource name using the form: projects/{project_id}/locations/global/connectivityTests/{test_id}

Type

str

class google.cloud.network_management_v1.types.InstanceInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

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

display_name

Name of a Compute Engine instance.

Type

str

uri

URI of a Compute Engine instance.

Type

str

interface

Name of the network interface of a Compute Engine instance.

Type

str

network_uri

URI of a Compute Engine network.

Type

str

internal_ip

Internal IP address of the network interface.

Type

str

external_ip

External IP address of the network interface.

Type

str

network_tags

Network tags configured on the instance.

Type

Sequence[str]

service_account

Service account authorized for the instance.

Type

str

class google.cloud.network_management_v1.types.ListConnectivityTestsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request for the ListConnectivityTests method.

parent

Required. The parent resource of the Connectivity Tests: projects/{project_id}/locations/global

Type

str

page_size

Number of ConnectivityTests to return.

Type

int

page_token

Page token from an earlier query, as returned in next_page_token.

Type

str

filter

Lists the ConnectivityTests that match the filter expression. A filter expression filters the resources listed in the response. The expression must be of the form <field> <operator> <value> where operators: <, >, <=, >=, !=, =, : are supported (colon : represents a HAS operator which is roughly synonymous with equality). can refer to a proto or JSON field, or a synthetic field. Field names can be camelCase or snake_case.

Examples:

  • Filter by name: name = “projects/proj-1/locations/global/connectivityTests/test-1

  • Filter by labels:

    • Resources that have a key called foo labels.foo:*

    • Resources that have a key called foo whose value is bar labels.foo = bar

Type

str

order_by

Field to use to sort the list.

Type

str

class google.cloud.network_management_v1.types.ListConnectivityTestsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Response for the ListConnectivityTests method.

resources

List of Connectivity Tests.

Type

Sequence[google.cloud.network_management_v1.types.ConnectivityTest]

next_page_token

Page token to fetch the next set of Connectivity Tests.

Type

str

unreachable

Locations that could not be reached (when querying all locations with -).

Type

Sequence[str]

property raw_page
class google.cloud.network_management_v1.types.LoadBalancerBackend(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

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

display_name

Name of a Compute Engine instance or network endpoint.

Type

str

uri

URI of a Compute Engine instance or network endpoint.

Type

str

health_check_firewall_state

State of the health check firewall configuration.

Type

google.cloud.network_management_v1.types.LoadBalancerBackend.HealthCheckFirewallState

health_check_allowing_firewall_rules

A list of firewall rule URIs allowing probes from health check IP ranges.

Type

Sequence[str]

health_check_blocking_firewall_rules

A list of firewall rule URIs blocking probes from health check IP ranges.

Type

Sequence[str]

class HealthCheckFirewallState(value)[source]

Bases: proto.enums.Enum

State of a health check firewall configuration:

CONFIGURED = 1
HEALTH_CHECK_FIREWALL_STATE_UNSPECIFIED = 0
MISCONFIGURED = 2
class google.cloud.network_management_v1.types.LoadBalancerInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

For display only. Metadata associated with a load balancer.

load_balancer_type

Type of the load balancer.

Type

google.cloud.network_management_v1.types.LoadBalancerInfo.LoadBalancerType

health_check_uri

URI of the health check for the load balancer.

Type

str

backends

Information for the loadbalancer backends.

Type

Sequence[google.cloud.network_management_v1.types.LoadBalancerBackend]

backend_type

Type of load balancer’s backend configuration.

Type

google.cloud.network_management_v1.types.LoadBalancerInfo.BackendType

backend_uri

Backend configuration URI.

Type

str

class BackendType(value)[source]

Bases: proto.enums.Enum

The type definition for a load balancer backend configuration:

BACKEND_SERVICE = 1
BACKEND_TYPE_UNSPECIFIED = 0
TARGET_POOL = 2
class LoadBalancerType(value)[source]

Bases: proto.enums.Enum

The type definition for a load balancer:

HTTP_PROXY = 3
INTERNAL_TCP_UDP = 1
LOAD_BALANCER_TYPE_UNSPECIFIED = 0
NETWORK_TCP_UDP = 2
SSL_PROXY = 5
TCP_PROXY = 4
class google.cloud.network_management_v1.types.NetworkInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

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

display_name

Name of a Compute Engine network.

Type

str

uri

URI of a Compute Engine network.

Type

str

matched_ip_range

The IP range that matches the test.

Type

str

class google.cloud.network_management_v1.types.OperationMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

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

create_time

The time the operation was created.

Type

google.protobuf.timestamp_pb2.Timestamp

end_time

The time the operation finished running.

Type

google.protobuf.timestamp_pb2.Timestamp

target

Target of the operation - for example projects/project-1/locations/global/connectivityTests/test-1

Type

str

verb

Name of the verb executed by the operation.

Type

str

status_detail

Human-readable status of the operation, if any.

Type

str

cancel_requested

Specifies if cancellation was requested for the operation.

Type

bool

api_version

API version.

Type

str

class google.cloud.network_management_v1.types.ReachabilityDetails(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

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

result

The overall result of the test’s configuration analysis.

Type

google.cloud.network_management_v1.types.ReachabilityDetails.Result

verify_time

The time of the configuration analysis.

Type

google.protobuf.timestamp_pb2.Timestamp

error

The details of a failure or a cancellation of reachability analysis.

Type

google.rpc.status_pb2.Status

traces

Result may contain a list of traces if a test has multiple possible paths in the network, such as when destination endpoint is a load balancer with multiple backends.

Type

Sequence[google.cloud.network_management_v1.types.Trace]

class Result(value)[source]

Bases: proto.enums.Enum

The overall result of the test’s configuration analysis.

AMBIGUOUS = 4
REACHABLE = 1
RESULT_UNSPECIFIED = 0
UNDETERMINED = 5
UNREACHABLE = 2
class google.cloud.network_management_v1.types.RerunConnectivityTestRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request for the RerunConnectivityTest method.

name

Required. Connectivity Test resource name using the form: projects/{project_id}/locations/global/connectivityTests/{test_id}

Type

str

class google.cloud.network_management_v1.types.RouteInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

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

route_type

Type of route.

Type

google.cloud.network_management_v1.types.RouteInfo.RouteType

next_hop_type

Type of next hop.

Type

google.cloud.network_management_v1.types.RouteInfo.NextHopType

display_name

Name of a Compute Engine route.

Type

str

uri

URI of a Compute Engine route. Dynamic route from cloud router does not have a URI. Advertised route from Google Cloud VPC to on-premises network also does not have a URI.

Type

str

dest_ip_range

Destination IP range of the route.

Type

str

next_hop

Next hop of the route.

Type

str

network_uri

URI of a Compute Engine network.

Type

str

priority

Priority of the route.

Type

int

instance_tags

Instance tags of the route.

Type

Sequence[str]

class NextHopType(value)[source]

Bases: proto.enums.Enum

Type of next hop:

NEXT_HOP_BLACKHOLE = 9
NEXT_HOP_ILB = 10
NEXT_HOP_INSTANCE = 2
NEXT_HOP_INTERCONNECT = 5
NEXT_HOP_INTERNET_GATEWAY = 8
NEXT_HOP_IP = 1
NEXT_HOP_NETWORK = 3
NEXT_HOP_PEERING = 4
NEXT_HOP_TYPE_UNSPECIFIED = 0
NEXT_HOP_VPN_GATEWAY = 7
NEXT_HOP_VPN_TUNNEL = 6
class RouteType(value)[source]

Bases: proto.enums.Enum

Type of route:

DYNAMIC = 3
PEERING_DYNAMIC = 6
PEERING_STATIC = 5
PEERING_SUBNET = 4
ROUTE_TYPE_UNSPECIFIED = 0
STATIC = 2
SUBNET = 1
class google.cloud.network_management_v1.types.Step(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

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

description

A description of the step. Usually this is a summary of the state.

Type

str

state

Each step is in one of the pre-defined states.

Type

google.cloud.network_management_v1.types.Step.State

causes_drop

This is a step that leads to the final state Drop.

Type

bool

project_id

Project ID that contains the configuration this step is validating.

Type

str

instance

Display information of a Compute Engine instance.

Type

google.cloud.network_management_v1.types.InstanceInfo

firewall

Display information of a Compute Engine firewall rule.

Type

google.cloud.network_management_v1.types.FirewallInfo

route

Display information of a Compute Engine route.

Type

google.cloud.network_management_v1.types.RouteInfo

endpoint

Display information of the source and destination under analysis. The endpoint information in an intermediate state may differ with the initial input, as it might be modified by state like NAT, or Connection Proxy.

Type

google.cloud.network_management_v1.types.EndpointInfo

forwarding_rule

Display information of a Compute Engine forwarding rule.

Type

google.cloud.network_management_v1.types.ForwardingRuleInfo

vpn_gateway

Display information of a Compute Engine VPN gateway.

Type

google.cloud.network_management_v1.types.VpnGatewayInfo

vpn_tunnel

Display information of a Compute Engine VPN tunnel.

Type

google.cloud.network_management_v1.types.VpnTunnelInfo

deliver

Display information of the final state “deliver” and reason.

Type

google.cloud.network_management_v1.types.DeliverInfo

forward

Display information of the final state “forward” and reason.

Type

google.cloud.network_management_v1.types.ForwardInfo

abort

Display information of the final state “abort” and reason.

Type

google.cloud.network_management_v1.types.AbortInfo

drop

Display information of the final state “drop” and reason.

Type

google.cloud.network_management_v1.types.DropInfo

load_balancer

Display information of the load balancers.

Type

google.cloud.network_management_v1.types.LoadBalancerInfo

network

Display information of a Google Cloud network.

Type

google.cloud.network_management_v1.types.NetworkInfo

gke_master

Display information of a Google Kubernetes Engine cluster master.

Type

google.cloud.network_management_v1.types.GKEMasterInfo

cloud_sql_instance

Display information of a Cloud SQL instance.

Type

google.cloud.network_management_v1.types.CloudSQLInstanceInfo

class State(value)[source]

Bases: proto.enums.Enum

Type of states that are defined in the network state machine. Each step in the packet trace is in a specific state.

ABORT = 19
APPLY_EGRESS_FIREWALL_RULE = 5
APPLY_FORWARDING_RULE = 7
APPLY_INGRESS_FIREWALL_RULE = 4
APPLY_ROUTE = 6
ARRIVE_AT_EXTERNAL_LOAD_BALANCER = 11
ARRIVE_AT_INSTANCE = 9
ARRIVE_AT_INTERNAL_LOAD_BALANCER = 10
ARRIVE_AT_VPN_GATEWAY = 12
ARRIVE_AT_VPN_TUNNEL = 13
DELIVER = 16
DROP = 17
FORWARD = 18
NAT = 14
PROXY_CONNECTION = 15
SPOOFING_APPROVED = 8
START_FROM_CLOUD_SQL_INSTANCE = 22
START_FROM_GKE_MASTER = 21
START_FROM_INSTANCE = 1
START_FROM_INTERNET = 2
START_FROM_PRIVATE_NETWORK = 3
STATE_UNSPECIFIED = 0
VIEWER_PERMISSION_MISSING = 20
class google.cloud.network_management_v1.types.Trace(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Trace represents one simulated packet forwarding path.

  • 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))
endpoint_info

Derived from the source and destination endpoints definition specified by user request, and validated by the data plane model. If there are multiple traces starting from different source locations, then the endpoint_info may be different between traces.

Type

google.cloud.network_management_v1.types.EndpointInfo

steps

A trace of a test contains multiple steps from the initial state to the final state (delivered, dropped, forwarded, or aborted). The steps are ordered by the processing sequence within the simulated network state machine. It is critical to preserve the order of the steps and avoid reordering or sorting them.

Type

Sequence[google.cloud.network_management_v1.types.Step]

class google.cloud.network_management_v1.types.UpdateConnectivityTestRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request for the UpdateConnectivityTest method.

update_mask

Required. Mask of fields to update. At least one path must be supplied in this field.

Type

google.protobuf.field_mask_pb2.FieldMask

resource

Required. Only fields specified in update_mask are updated.

Type

google.cloud.network_management_v1.types.ConnectivityTest

class google.cloud.network_management_v1.types.VpnGatewayInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

For display only. Metadata associated with a Compute Engine VPN gateway.

display_name

Name of a VPN gateway.

Type

str

uri

URI of a VPN gateway.

Type

str

network_uri

URI of a Compute Engine network where the VPN gateway is configured.

Type

str

ip_address

IP address of the VPN gateway.

Type

str

vpn_tunnel_uri

A VPN tunnel that is associated with this VPN gateway. There may be multiple VPN tunnels configured on a VPN gateway, and only the one relevant to the test is displayed.

Type

str

region

Name of a Google Cloud region where this VPN gateway is configured.

Type

str

class google.cloud.network_management_v1.types.VpnTunnelInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

For display only. Metadata associated with a Compute Engine VPN tunnel.

display_name

Name of a VPN tunnel.

Type

str

uri

URI of a VPN tunnel.

Type

str

source_gateway

URI of the VPN gateway at local end of the tunnel.

Type

str

remote_gateway

URI of a VPN gateway at remote end of the tunnel.

Type

str

remote_gateway_ip

Remote VPN gateway’s IP address.

Type

str

source_gateway_ip

Local VPN gateway’s IP address.

Type

str

network_uri

URI of a Compute Engine network where the VPN tunnel is configured.

Type

str

region

Name of a Google Cloud region where this VPN tunnel is configured.

Type

str

routing_type

Type of the routing policy.

Type

google.cloud.network_management_v1.types.VpnTunnelInfo.RoutingType

class RoutingType(value)[source]

Bases: proto.enums.Enum

Types of VPN routing policy. For details, refer to Networks and Tunnel routing.

DYNAMIC = 3
POLICY_BASED = 2
ROUTE_BASED = 1
ROUTING_TYPE_UNSPECIFIED = 0