Package Classes (2.6.0)

Summary of entries of Classes for networkconnectivity.

Classes

HubServiceAsyncClient

Network Connectivity Center is a hub-and-spoke abstraction for network connectivity management in Google Cloud. It reduces operational complexity through a simple, centralized connectivity management model.

HubServiceClient

ListGroupsAsyncPager

A pager for iterating through list_groups requests.

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

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

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

ListGroupsPager

A pager for iterating through list_groups requests.

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

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

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

ListHubSpokesAsyncPager

A pager for iterating through list_hub_spokes requests.

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

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

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

ListHubSpokesPager

A pager for iterating through list_hub_spokes requests.

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

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

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

ListHubsAsyncPager

A pager for iterating through list_hubs requests.

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

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

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

ListHubsPager

A pager for iterating through list_hubs requests.

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

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

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

ListRouteTablesAsyncPager

A pager for iterating through list_route_tables requests.

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

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

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

ListRouteTablesPager

A pager for iterating through list_route_tables requests.

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

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

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

ListRoutesAsyncPager

A pager for iterating through list_routes requests.

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

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

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

ListRoutesPager

A pager for iterating through list_routes requests.

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

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

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

ListSpokesAsyncPager

A pager for iterating through list_spokes requests.

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

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

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

ListSpokesPager

A pager for iterating through list_spokes requests.

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

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

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

QueryHubStatusAsyncPager

A pager for iterating through query_hub_status requests.

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

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

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

QueryHubStatusPager

A pager for iterating through query_hub_status requests.

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

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

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

PolicyBasedRoutingServiceAsyncClient

Policy-Based Routing allows GCP customers to specify flexibile routing policies for Layer 4 traffic traversing through the connected service.

PolicyBasedRoutingServiceClient

Policy-Based Routing allows GCP customers to specify flexibile routing policies for Layer 4 traffic traversing through the connected service.

ListPolicyBasedRoutesAsyncPager

A pager for iterating through list_policy_based_routes requests.

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

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

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

ListPolicyBasedRoutesPager

A pager for iterating through list_policy_based_routes requests.

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

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

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

AcceptHubSpokeRequest

The request for HubService.AcceptHubSpoke.

AcceptHubSpokeResponse

The response for HubService.AcceptHubSpoke.

AutoAccept

The auto-accept setting for a group controls whether proposed spokes are automatically attached to the hub. If auto-accept is enabled, the spoke immediately is attached to the hub and becomes part of the group. In this case, the new spoke is in the ACTIVE state. If auto-accept is disabled, the spoke goes to the INACTIVE state, and it must be reviewed and accepted by a hub administrator.

CreateHubRequest

Request for HubService.CreateHub method.

CreatePolicyBasedRouteRequest

Request for [PolicyBasedRouting.CreatePolicyBasedRoute][] method.

CreateSpokeRequest

The request for HubService.CreateSpoke.

DeleteHubRequest

The request for HubService.DeleteHub.

DeletePolicyBasedRouteRequest

Request for [PolicyBasedRouting.DeletePolicyBasedRoute][] method.

DeleteSpokeRequest

The request for HubService.DeleteSpoke.

GetGroupRequest

The request for HubService.GetGroup.

GetHubRequest

Request for HubService.GetHub method.

GetPolicyBasedRouteRequest

Request for [PolicyBasedRouting.GetPolicyBasedRoute][] method.

GetRouteRequest

The request for HubService.GetRoute.

GetRouteTableRequest

The request for HubService.GetRouteTable.

GetSpokeRequest

The request for HubService.GetSpoke.

Group

A group represents a subset of spokes attached to a hub.

LabelsEntry

The abstract base class for a message.

Hub

A Network Connectivity Center hub is a global management resource to which you attach spokes. A single hub can contain spokes from multiple regions. However, if any of a hub's spokes use the site-to-site data transfer feature, the resources associated with those spokes must all be in the same VPC network. Spokes that do not use site-to-site data transfer can be associated with any VPC network in your project.

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

LabelsEntry

The abstract base class for a message.

HubStatusEntry

A hub status entry represents the status of a set of propagated Private Service Connect connections grouped by certain fields.

LinkedInterconnectAttachments

A collection of VLAN attachment resources. These resources should be redundant attachments that all advertise the same prefixes to Google Cloud. Alternatively, in active/passive configurations, all attachments should be capable of advertising the same prefixes.

LinkedProducerVpcNetwork

LinkedRouterApplianceInstances

A collection of router appliance instances. If you configure multiple router appliance instances to receive data from the same set of sites outside of Google Cloud, we recommend that you associate those instances with the same spoke.

LinkedVpcNetwork

An existing VPC network.

LinkedVpnTunnels

A collection of Cloud VPN tunnel resources. These resources should be redundant HA VPN tunnels that all advertise the same prefixes to Google Cloud. Alternatively, in a passive/active configuration, all tunnels should be capable of advertising the same prefixes.

ListGroupsRequest

Request for HubService.ListGroups method.

ListGroupsResponse

Response for HubService.ListGroups method.

ListHubSpokesRequest

The request for HubService.ListHubSpokes.

SpokeView

Enum that controls which spoke fields are included in the response.

ListHubSpokesResponse

The response for HubService.ListHubSpokes.

ListHubsRequest

Request for HubService.ListHubs method.

ListHubsResponse

Response for HubService.ListHubs method.

ListPolicyBasedRoutesRequest

Request for [PolicyBasedRouting.ListPolicyBasedRoutes][] method.

ListPolicyBasedRoutesResponse

Response for [PolicyBasedRouting.ListPolicyBasedRoutes][] method.

ListRouteTablesRequest

Request for HubService.ListRouteTables method.

ListRouteTablesResponse

Response for HubService.ListRouteTables method.

ListRoutesRequest

Request for HubService.ListRoutes method.

ListRoutesResponse

Response for HubService.ListRoutes method.

ListSpokesRequest

The request for HubService.ListSpokes.

ListSpokesResponse

The response for HubService.ListSpokes.

LocationFeature

Supported features for a location

LocationMetadata

Metadata about locations

NextHopInterconnectAttachment

A route next hop that leads to an interconnect attachment resource.

NextHopRouterApplianceInstance

A route next hop that leads to a Router appliance instance.

NextHopVPNTunnel

A route next hop that leads to a VPN tunnel resource.

NextHopVpcNetwork

OperationMetadata

Represents the metadata of the long-running operation.

PolicyBasedRoute

Policy Based Routes (PBR) are more powerful routes that allows GCP customers to route their L4 network traffic based on not just destination IP, but also source IP, protocol and more. A PBR always take precedence when it conflicts with other types of routes. Next id: 22

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

Filter

Filter matches L4 traffic.

ProtocolVersion

The internet protocol version.

InterconnectAttachment

InterconnectAttachment to which this route applies to.

LabelsEntry

The abstract base class for a message.

OtherRoutes

The other routing cases.

VirtualMachine

VM instances to which this policy based route applies to.

Warnings

Informational warning message.

Code

Warning code for Policy Based Routing. Expect to add values in the future.

DataEntry

The abstract base class for a message.

PolicyMode

This enum controls the policy mode used in a hub.

PresetTopology

The list of available preset topologies.

PscPropagationStatus

The status of one or more propagated Private Service Connect connections in a hub.

Code

The Code enum represents the state of the Private Service Connect propagation.

QueryHubStatusRequest

The request for HubService.QueryHubStatus.

QueryHubStatusResponse

The response for HubService.QueryHubStatus.

RejectHubSpokeRequest

The request for HubService.RejectHubSpoke.

RejectHubSpokeResponse

The response for HubService.RejectHubSpoke.

Route

A route defines a path from VM instances within a spoke to a specific destination resource. Only VPC spokes have routes.

LabelsEntry

The abstract base class for a message.

RouteTable

LabelsEntry

The abstract base class for a message.

RouteType

The route's type

RouterApplianceInstance

A router appliance instance is a Compute Engine virtual machine (VM) instance that acts as a BGP speaker. A router appliance instance is specified by the URI of the VM and the internal IP address of one of the VM's network interfaces.

RoutingVPC

RoutingVPC contains information about the VPC networks associated with the spokes of a Network Connectivity Center hub.

Spoke

A Network Connectivity Center spoke represents one or more network connectivity resources.

When you create a spoke, you associate it with a hub. You must also identify a value for exactly one of the following fields:

linked_vpn_tunnels
linked_interconnect_attachments
linked_router_appliance_instances
linked_vpc_network

LabelsEntry

The abstract base class for a message.

StateReason

The reason a spoke is inactive.

Code

The Code enum represents the various reasons a state can be INACTIVE.

SpokeSummary

Summarizes information about the spokes associated with a hub. The summary includes a count of spokes according to type and according to state. If any spokes are inactive, the summary also lists the reasons they are inactive, including a count for each reason.

SpokeStateCount

The number of spokes that are in a particular state and associated with a given hub.

SpokeStateReasonCount

The number of spokes in the hub that are inactive for this reason.

SpokeTypeCount

The number of spokes of a given type that are associated with a specific hub. The type indicates what kind of resource is associated with the spoke.

SpokeType

The SpokeType enum represents the type of spoke. The type reflects the kind of resource that a spoke is associated with.

State

The State enum represents the lifecycle stage of a Network Connectivity Center resource.

UpdateGroupRequest

Request for HubService.UpdateGroup method.

UpdateHubRequest

Request for HubService.UpdateHub method.

UpdateSpokeRequest

Request for HubService.UpdateSpoke method.

HubServiceAsyncClient

HubServiceClient

ListHubsAsyncPager

A pager for iterating through list_hubs requests.

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

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

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

ListHubsPager

A pager for iterating through list_hubs requests.

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

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

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

ListSpokesAsyncPager

A pager for iterating through list_spokes requests.

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

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

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

ListSpokesPager

A pager for iterating through list_spokes requests.

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

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

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

Package Classes (2.6.0)

Classes

Modules