package google.events.cloud.networkconnectivity.v1

Get desktop application:
View/edit binary Protocol Buffers messages

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

Used in: ServiceConnectionMap.ConsumerPscConnection, ServiceConnectionPolicy.PscConnection

• CONNECTION_ERROR_TYPE_UNSPECIFIED = 0

  An invalid error type as the default case.

• ERROR_INTERNAL = 1

  The error is due to Service Automation system internal.

• ERROR_CONSUMER_SIDE = 2

  The error is due to the setup on consumer side.

• ERROR_PRODUCER_SIDE = 3

  The error is due to the setup on producer side.

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.

Used in: HubEventData

• string name = 1

  Immutable. The name of the hub. Hub names must be unique. They use the following form: `projects/{project_number}/locations/global/hubs/{hub_id}`

• optional protobuf.Timestamp create_time = 2

  Output only. The time the hub was created.

• optional protobuf.Timestamp update_time = 3

  Output only. The time the hub was last updated.

• map<string, string> labels = 4

  Optional labels in key:value format. For more information about labels, see [Requirements for labels](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements).

• string description = 5

  An optional description of the hub.

• string unique_id = 8

  Output only. The Google-generated UUID for the hub. This value is unique across all hub resources. If a hub is deleted and another with the same name is created, the new hub is assigned a different unique_id.

• State state = 9

  Output only. The current lifecycle state of this hub.

• repeated RoutingVPC routing_vpcs = 10

  The VPC networks associated with this hub's spokes. This field is read-only. Network Connectivity Center automatically populates it based on the set of spokes attached to the hub.

The CloudEvent raised when a Hub is created.

• optional HubEventData data = 1

  The data associated with the event.

The CloudEvent raised when a Hub is deleted.

• optional HubEventData data = 1

  The data associated with the event.

The data within all Hub events.

Used in: HubCreatedEvent, HubDeletedEvent, HubUpdatedEvent

• optional Hub payload = 1

  Optional. The Hub event payload. Unset for deletion events.

The CloudEvent raised when a Hub is updated.

• optional HubEventData data = 1

  The data associated with the event.

The infrastructure used for connections between consumers/producers.

Used in: ServiceConnectionMap, ServiceConnectionPolicy

• INFRASTRUCTURE_UNSPECIFIED = 0

  An invalid infrastructure as the default case.

• PSC = 1

  Private Service Connect is used for connections.

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.

Used in: Spoke

• repeated string uris = 1

  The URIs of linked interconnect attachment resources

• bool site_to_site_data_transfer = 2

  A value that controls whether site-to-site data transfer is enabled for these resources. Data transfer is available only in [supported locations](https://cloud.google.com/network-connectivity/docs/network-connectivity-center/concepts/locations).

• string vpc_network = 3

  Output only. The VPC network where these VLAN attachments are located.

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.

Used in: Spoke

• repeated RouterApplianceInstance instances = 1

  The list of router appliance instances.

• bool site_to_site_data_transfer = 2

  A value that controls whether site-to-site data transfer is enabled for these resources. Data transfer is available only in [supported locations](https://cloud.google.com/network-connectivity/docs/network-connectivity-center/concepts/locations).

• string vpc_network = 3

  Output only. The VPC network where these router appliance instances are located.

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.

Used in: Spoke

• repeated string uris = 1

  The URIs of linked VPN tunnel resources.

• bool site_to_site_data_transfer = 2

  A value that controls whether site-to-site data transfer is enabled for these resources. Data transfer is available only in [supported locations](https://cloud.google.com/network-connectivity/docs/network-connectivity-center/concepts/locations).

• string vpc_network = 3

  Output only. The VPC network where these VPN tunnels are located.

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.

Used in: LinkedRouterApplianceInstances

• string virtual_machine = 1

  The URI of the VM.

• string ip_address = 3

  The IP address on the VM to use for peering.

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

Used in: Hub

• string uri = 1

  The URI of the VPC network.

• bool required_for_new_site_to_site_data_transfer_spokes = 2

  Output only. If true, indicates that this VPC network is currently associated with spokes that use the data transfer feature (spokes where the site_to_site_data_transfer field is set to true). If you create new spokes that use data transfer, they must be associated with this VPC network. At most, one VPC network will have this field set to true.

The ServiceClass resource. Next id: 8

Used in: ServiceClassEventData

• string name = 1

  Immutable. The name of a ServiceClass resource. Format: projects/{project}/locations/{location}/serviceClasses/{service_class} See: https://google.aip.dev/122#fields-representing-resource-names

• string service_class = 7

  Output only. The generated service class name. Use this name to refer to the Service class in Service Connection Maps and Service Connection Policies.

• optional protobuf.Timestamp create_time = 2

  Output only. Time when the ServiceClass was created.

• optional protobuf.Timestamp update_time = 3

  Output only. Time when the ServiceClass was updated.

• map<string, string> labels = 4

  User-defined labels.

• string description = 5

  A description of this resource.

• repeated string service_connection_maps = 6

  Output only. URIs of all Service Connection Maps using this service class.

The CloudEvent raised when a ServiceClass is deleted.

• optional ServiceClassEventData data = 1

  The data associated with the event.

The data within all ServiceClass events.

Used in: ServiceClassDeletedEvent, ServiceClassUpdatedEvent

• optional ServiceClass payload = 1

  Optional. The ServiceClass event payload. Unset for deletion events.

The CloudEvent raised when a ServiceClass is updated.

• optional ServiceClassEventData data = 1

  The data associated with the event.

The ServiceConnectionMap resource. Next id: 14

Used in: ServiceConnectionMapEventData

• string name = 1

  Immutable. The name of a ServiceConnectionMap. Format: projects/{project}/locations/{location}/serviceConnectionMaps/{service_connection_map} See: https://google.aip.dev/122#fields-representing-resource-names

• optional protobuf.Timestamp create_time = 2

  Output only. Time when the ServiceConnectionMap was created.

• optional protobuf.Timestamp update_time = 3

  Output only. Time when the ServiceConnectionMap was updated.

• map<string, string> labels = 4

  User-defined labels.

• string description = 5

  A description of this resource.

• string service_class = 7

  The service class identifier this ServiceConnectionMap is for. The user of ServiceConnectionMap create API needs to have networkconnecitivty.serviceclasses.use iam permission for the service class.

• string service_class_uri = 12

  Output only. The service class uri this ServiceConnectionMap is for.

• Infrastructure infrastructure = 8

  Output only. The infrastructure used for connections between consumers/producers.

• repeated ServiceConnectionMap.ProducerPscConfig producer_psc_configs = 9

  The PSC configurations on producer side.

• repeated ServiceConnectionMap.ConsumerPscConfig consumer_psc_configs = 10

  The PSC configurations on consumer side.

• repeated ServiceConnectionMap.ConsumerPscConnection consumer_psc_connections = 11

  Output only. PSC connection details on consumer side.

Allow the producer to specify which consumers can connect to it.

Used in: ServiceConnectionMap

• string project = 1

  The consumer project where PSC connections are allowed to be created in.

• string network = 2

  The resource path of the consumer network where PSC connections are allowed to be created in. Note, this network does not need be in the ConsumerPscConfig.project in the case of SharedVPC. Example: projects/{projectNumOrId}/global/networks/{networkId}.

• bool disable_global_access = 3

  This is used in PSC consumer ForwardingRule to control whether the PSC endpoint can be accessed from another region.

• ConsumerPscConfig.State state = 4

  Output only. Overall state of PSC Connections management for this consumer psc config.

PSC Consumer Config State.

Used in: ConsumerPscConfig

• STATE_UNSPECIFIED = 0

  Default state, when Connection Map is created initially.

• VALID = 1

  Set when policy and map configuration is valid, and their matching can lead to allowing creation of PSC Connections subject to other constraints like connections limit.

• CONNECTION_POLICY_MISSING = 2

  No Service Connection Policy found for this network and Service Class

PSC connection details on consumer side.

Used in: ServiceConnectionMap

• string service_attachment_uri = 1

  The URI of a service attachment which is the target of the PSC connection.

• ConsumerPscConnection.State state = 2

  The state of the PSC connection.

• string project = 3

  The consumer project whose PSC forwarding rule is connected to the service attachments in this service connection map.

• string network = 4

  The consumer network whose PSC forwarding rule is connected to the service attachments in this service connection map. Note that the network could be on a different project (shared VPC).

• string psc_connection_id = 5

  The PSC connection id of the PSC forwarding rule connected to the service attachments in this service connection map.

• string ip = 6

  The IP literal allocated on the consumer network for the PSC forwarding rule that is created to connect to the producer service attachment in this service connection map.

• ConnectionErrorType error_type = 7

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

• optional rpc.Status error = 8

  The most recent error during operating this connection.

• string gce_operation = 9

  The last Compute Engine operation to setup PSC connection.

• string forwarding_rule = 10

  The URI of the consumer forwarding rule created. Example: projects/{projectNumOrId}/regions/us-east1/networks/{resourceId}.

The state of the PSC connection.

Used in: ConsumerPscConnection

• STATE_UNSPECIFIED = 0

  An invalid state as the default case.

• ACTIVE = 1

  The connection is fully established and ready to use.

• FAILED = 2

  The connection is not functional since some resources on the connection fail to be created.

• CREATING = 3

  The connection is being created.

• DELETING = 4

  The connection is being deleted.

The PSC configurations on producer side.

Used in: ServiceConnectionMap

• string service_attachment_uri = 1

  The resource path of a service attachment. Example: projects/{projectNumOrId}/regions/{region}/serviceAttachments/{resourceId}.

The CloudEvent raised when a ServiceConnectionMap is created.

• optional ServiceConnectionMapEventData data = 1

  The data associated with the event.

The CloudEvent raised when a ServiceConnectionMap is deleted.

• optional ServiceConnectionMapEventData data = 1

  The data associated with the event.

The data within all ServiceConnectionMap events.

Used in: ServiceConnectionMapCreatedEvent, ServiceConnectionMapDeletedEvent, ServiceConnectionMapUpdatedEvent

• optional ServiceConnectionMap payload = 1

  Optional. The ServiceConnectionMap event payload. Unset for deletion events.

The CloudEvent raised when a ServiceConnectionMap is updated.

• optional ServiceConnectionMapEventData data = 1

  The data associated with the event.

The ServiceConnectionPolicy resource. Next id: 11

Used in: ServiceConnectionPolicyEventData

• string name = 1

  Immutable. The name of a ServiceConnectionPolicy. Format: projects/{project}/locations/{location}/serviceConnectionPolicies/{service_connection_policy} See: https://google.aip.dev/122#fields-representing-resource-names

• optional protobuf.Timestamp create_time = 2

  Output only. Time when the ServiceConnectionMap was created.

• optional protobuf.Timestamp update_time = 3

  Output only. Time when the ServiceConnectionMap was updated.

• map<string, string> labels = 4

  User-defined labels.

• string description = 5

  A description of this resource.

• string network = 6

  The resource path of the consumer network. Example: - projects/{projectNumOrId}/global/networks/{resourceId}.

• string service_class = 7

  The service class identifier for which this ServiceConnectionPolicy is for. The service class identifier is a unique, symbolic representation of a ServiceClass. It is provided by the Service Producer. Google services have a prefix of gcp. For example, gcp-cloud-sql. 3rd party services do not. For example, test-service-a3dfcx.

• Infrastructure infrastructure = 8

  Output only. The type of underlying resources used to create the connection.

• optional ServiceConnectionPolicy.PscConfig psc_config = 9

  Configuration used for Private Service Connect connections. Used when Infrastructure is PSC.

• repeated ServiceConnectionPolicy.PscConnection psc_connections = 10

  Output only. [Output only] Information about each Private Service Connect connection.

Configuration used for Private Service Connect connections. Used when Infrastructure is PSC.

Used in: ServiceConnectionPolicy

• repeated string subnetworks = 1

  The resource paths of subnetworks to use for IP address management. Example: projects/{projectNumOrId}/regions/{region}/subnetworks/{resourceId}.

• optional int64 limit = 2

  Optional. Max number of PSC connections for this policy.

Information about a specific Private Service Connect connection.

Used in: ServiceConnectionPolicy

• State state = 1

  State of the PSC Connection

• string consumer_forwarding_rule = 2

  The resource reference of the PSC Forwarding Rule within the consumer VPC.

• string consumer_address = 3

  The resource reference of the consumer address.

• ConnectionErrorType error_type = 4

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

• optional rpc.Status error = 5

  The most recent error during operating this connection.

• string gce_operation = 6

  The last Compute Engine operation to setup PSC connection.

• string consumer_target_project = 7

  The project where the PSC connection is created.

• string psc_connection_id = 8

  The PSC connection id of the PSC forwarding rule.

The state of the PSC connection.

Used in: PscConnection

• STATE_UNSPECIFIED = 0

  An invalid state as the default case.

• ACTIVE = 1

  The connection is fully established and ready to use.

• FAILED = 2

  The connection is not functional since some resources on the connection fail to be created.

• CREATING = 3

  The connection is being created.

• DELETING = 4

  The connection is being deleted.

The CloudEvent raised when a ServiceConnectionPolicy is created.

• optional ServiceConnectionPolicyEventData data = 1

  The data associated with the event.

The CloudEvent raised when a ServiceConnectionPolicy is deleted.

• optional ServiceConnectionPolicyEventData data = 1

  The data associated with the event.

The data within all ServiceConnectionPolicy events.

Used in: ServiceConnectionPolicyCreatedEvent, ServiceConnectionPolicyDeletedEvent, ServiceConnectionPolicyUpdatedEvent

• optional ServiceConnectionPolicy payload = 1

  Optional. The ServiceConnectionPolicy event payload. Unset for deletion events.

The CloudEvent raised when a ServiceConnectionPolicy is updated.

• optional ServiceConnectionPolicyEventData data = 1

  The data associated with the event.

The ServiceConnectionToken resource. Next id: 9

Used in: ServiceConnectionTokenEventData

• string name = 1

  Immutable. The name of a ServiceConnectionToken. Format: projects/{project}/locations/{location}/ServiceConnectionTokens/{service_connection_token} See: https://google.aip.dev/122#fields-representing-resource-names

• optional protobuf.Timestamp create_time = 2

  Output only. Time when the ServiceConnectionToken was created.

• optional protobuf.Timestamp update_time = 3

  Output only. Time when the ServiceConnectionToken was updated.

• map<string, string> labels = 4

  User-defined labels.

• string description = 5

  A description of this resource.

• string network = 6

  The resource path of the network associated with this token. Example: projects/{projectNumOrId}/global/networks/{resourceId}.

The CloudEvent raised when a ServiceConnectionToken is created.

• optional ServiceConnectionTokenEventData data = 1

  The data associated with the event.

The CloudEvent raised when a ServiceConnectionToken is deleted.

• optional ServiceConnectionTokenEventData data = 1

  The data associated with the event.

The data within all ServiceConnectionToken events.

Used in: ServiceConnectionTokenCreatedEvent, ServiceConnectionTokenDeletedEvent

• optional ServiceConnectionToken payload = 1

  Optional. The ServiceConnectionToken event payload. Unset for deletion events.

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

Used in: SpokeEventData

• string name = 1

  Immutable. The name of the spoke. Spoke names must be unique. They use the following form: `projects/{project_number}/locations/{region}/spokes/{spoke_id}`

• optional protobuf.Timestamp create_time = 2

  Output only. The time the spoke was created.

• optional protobuf.Timestamp update_time = 3

  Output only. The time the spoke was last updated.

• map<string, string> labels = 4

  Optional labels in key:value format. For more information about labels, see [Requirements for labels](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements).

• string description = 5

  An optional description of the spoke.

• string hub = 6

  Immutable. The name of the hub that this spoke is attached to.

• optional LinkedVpnTunnels linked_vpn_tunnels = 17

  VPN tunnels that are associated with the spoke.

• optional LinkedInterconnectAttachments linked_interconnect_attachments = 18

  VLAN attachments that are associated with the spoke.

• optional LinkedRouterApplianceInstances linked_router_appliance_instances = 19

  Router appliance instances that are associated with the spoke.

• string unique_id = 11

  Output only. The Google-generated UUID for the spoke. This value is unique across all spoke resources. If a spoke is deleted and another with the same name is created, the new spoke is assigned a different unique_id.

• State state = 15

  Output only. The current lifecycle state of this spoke.

The CloudEvent raised when a Spoke is created.

• optional SpokeEventData data = 1

  The data associated with the event.

The CloudEvent raised when a Spoke is deleted.

• optional SpokeEventData data = 1

  The data associated with the event.

The data within all Spoke events.

Used in: SpokeCreatedEvent, SpokeDeletedEvent, SpokeUpdatedEvent

• optional Spoke payload = 1

  Optional. The Spoke event payload. Unset for deletion events.

The CloudEvent raised when a Spoke is updated.

• optional SpokeEventData data = 1

  The data associated with the event.

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

Used in: Hub, Spoke

• STATE_UNSPECIFIED = 0

  No state information available

• CREATING = 1

  The resource's create operation is in progress.

• ACTIVE = 2

  The resource is active

• DELETING = 3

  The resource's delete operation is in progress.

• UPDATING = 6

  The resource's update operation is in progress.