Package types (2.8.1)

API documentation for networkconnectivity_v1.types package.

Classes

AcceptHubSpokeRequest

The request for HubService.AcceptHubSpoke.

AcceptHubSpokeResponse

The response for HubService.AcceptHubSpoke.

AcceptSpokeUpdateRequest

The request for HubService.AcceptSpokeUpdate.

AcceptSpokeUpdateResponse

The response for HubService.AcceptSpokeUpdate.

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.

ConnectionErrorType

The error type indicates whether a connection error is consumer facing, producer facing or system internal.

CreateHubRequest

Request for HubService.CreateHub method.

CreatePolicyBasedRouteRequest

Request for PolicyBasedRoutingService.CreatePolicyBasedRoute method.

CreateServiceConnectionMapRequest

Request for CreateServiceConnectionMap.

CreateServiceConnectionPolicyRequest

Request for CreateServiceConnectionPolicy.

CreateServiceConnectionTokenRequest

Request for CreateServiceConnectionToken.

CreateSpokeRequest

The request for HubService.CreateSpoke.

DeleteHubRequest

The request for HubService.DeleteHub.

DeletePolicyBasedRouteRequest

Request for PolicyBasedRoutingService.DeletePolicyBasedRoute method.

DeleteServiceClassRequest

Request for DeleteServiceClass.

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

DeleteServiceConnectionMapRequest

Request for DeleteServiceConnectionMap.

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

DeleteServiceConnectionPolicyRequest

Request for DeleteServiceConnectionPolicy.

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

DeleteServiceConnectionTokenRequest

Request for DeleteServiceConnectionToken.

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

DeleteSpokeRequest

The request for HubService.DeleteSpoke.

GetGroupRequest

The request for HubService.GetGroup.

GetHubRequest

Request for HubService.GetHub method.

GetPolicyBasedRouteRequest

Request for PolicyBasedRoutingService.GetPolicyBasedRoute method.

GetRouteRequest

The request for HubService.GetRoute.

GetRouteTableRequest

The request for HubService.GetRouteTable.

GetServiceClassRequest

Request for GetServiceClass.

GetServiceConnectionMapRequest

Request for GetServiceConnectionMap.

GetServiceConnectionPolicyRequest

Request for GetServiceConnectionPolicy.

GetServiceConnectionTokenRequest

Request for GetServiceConnectionToken.

GetSpokeRequest

The request for HubService.GetSpoke.

Group

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

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

HubStatusEntry

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

IPVersion

The requested IP version for the PSC connection.

Infrastructure

The infrastructure used for connections between consumers/producers.

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.

ListHubSpokesResponse

The response for HubService.ListHubSpokes.

ListHubsRequest

Request for HubService.ListHubs method.

ListHubsResponse

Response for HubService.ListHubs method.

ListPolicyBasedRoutesRequest

Request for PolicyBasedRoutingService.ListPolicyBasedRoutes method.

ListPolicyBasedRoutesResponse

Response for PolicyBasedRoutingService.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.

ListServiceClassesRequest

Request for ListServiceClasses.

ListServiceClassesResponse

Response for ListServiceClasses.

ListServiceConnectionMapsRequest

Request for ListServiceConnectionMaps.

ListServiceConnectionMapsResponse

Response for ListServiceConnectionMaps.

ListServiceConnectionPoliciesRequest

Request for ListServiceConnectionPolicies.

ListServiceConnectionPoliciesResponse

Response for ListServiceConnectionPolicies.

ListServiceConnectionTokensRequest

Request for ListServiceConnectionTokens.

ListServiceConnectionTokensResponse

Response for ListServiceConnectionTokens.

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 route L4 network traffic based on not just destination IP address, but also source IP address, protocol, and more. If a policy-based route conflicts with other types of routes, the policy-based route always takes precedence.

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

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.

QueryHubStatusRequest

The request for HubService.QueryHubStatus.

QueryHubStatusResponse

The response for HubService.QueryHubStatus.

RejectHubSpokeRequest

The request for HubService.RejectHubSpoke.

RejectHubSpokeResponse

The response for HubService.RejectHubSpoke.

RejectSpokeUpdateRequest

The request for HubService.RejectSpokeUpdate.

RejectSpokeUpdateResponse

The response for HubService.RejectSpokeUpdate.

Route

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

RouteTable

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.

ServiceClass

The ServiceClass resource.

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

ServiceConnectionMap

The ServiceConnectionMap resource.

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

ServiceConnectionPolicy

The ServiceConnectionPolicy resource.

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

ServiceConnectionToken

The ServiceConnectionToken resource.

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

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

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.

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.

UpdateServiceClassRequest

Request for UpdateServiceClass.

UpdateServiceConnectionMapRequest

Request for UpdateServiceConnectionMap.

UpdateServiceConnectionPolicyRequest

Request for UpdateServiceConnectionPolicy.

UpdateSpokeRequest

Request for HubService.UpdateSpoke method.