Index
EdgeNetwork
(interface)CreateInterconnectAttachmentRequest
(message)CreateNetworkRequest
(message)CreateRouterRequest
(message)CreateSubnetRequest
(message)DeleteInterconnectAttachmentRequest
(message)DeleteNetworkRequest
(message)DeleteRouterRequest
(message)DeleteSubnetRequest
(message)DiagnoseInterconnectRequest
(message)DiagnoseInterconnectResponse
(message)DiagnoseNetworkRequest
(message)DiagnoseNetworkResponse
(message)DiagnoseNetworkResponse.NetworkStatus
(message)DiagnoseNetworkResponse.NetworkStatus.MacsecStatus
(enum)DiagnoseRouterRequest
(message)DiagnoseRouterResponse
(message)GetInterconnectAttachmentRequest
(message)GetInterconnectRequest
(message)GetNetworkRequest
(message)GetRouterRequest
(message)GetSubnetRequest
(message)GetZoneRequest
(message) (deprecated)InitializeZoneRequest
(message)InitializeZoneResponse
(message)Interconnect
(message)Interconnect.InterconnectType
(enum)InterconnectAttachment
(message)InterconnectDiagnostics
(message)InterconnectDiagnostics.LinkLACPStatus
(message)InterconnectDiagnostics.LinkLACPStatus.State
(enum)InterconnectDiagnostics.LinkLLDPStatus
(message)InterconnectDiagnostics.LinkStatus
(message)InterconnectDiagnostics.PacketCounts
(message)LinkLayerAddress
(message)ListInterconnectAttachmentsRequest
(message)ListInterconnectAttachmentsResponse
(message)ListInterconnectsRequest
(message)ListInterconnectsResponse
(message)ListNetworksRequest
(message)ListNetworksResponse
(message)ListRoutersRequest
(message)ListRoutersResponse
(message)ListSubnetsRequest
(message)ListSubnetsResponse
(message)ListZonesRequest
(message) (deprecated)ListZonesResponse
(message) (deprecated)Network
(message)OperationMetadata
(message)ResourceState
(enum)Router
(message)Router.Bgp
(message)Router.BgpPeer
(message)Router.Interface
(message)RouterStatus
(message)RouterStatus.BgpPeerStatus
(message)RouterStatus.BgpPeerStatus.BgpStatus
(enum)RouterStatus.PrefixCounter
(message)Subnet
(message)SubnetStatus
(message)UpdateRouterRequest
(message)UpdateSubnetRequest
(message)Zone
(message)
EdgeNetwork
EdgeNetwork API provides managed, highly available cloud dynamic network configuration service to the GEC customer to enable edge application and network function solutions. This allows the customers to easily define and configure the network setup and property to meet the workload requirement.
CreateInterconnectAttachment |
---|
Creates a new InterconnectAttachment in a given project and location.
|
CreateNetwork |
---|
Creates a new Network in a given project and location.
|
CreateRouter |
---|
Creates a new Router in a given project and location.
|
CreateSubnet |
---|
Creates a new Subnet in a given project and location.
|
DeleteInterconnectAttachment |
---|
Deletes a single InterconnectAttachment.
|
DeleteNetwork |
---|
Deletes a single Network.
|
DeleteRouter |
---|
Deletes a single Router.
|
DeleteSubnet |
---|
Deletes a single Subnet.
|
DiagnoseInterconnect |
---|
Get the diagnostics of a single interconnect resource.
|
DiagnoseNetwork |
---|
Get the diagnostics of a single network resource.
|
DiagnoseRouter |
---|
Get the diagnostics of a single router resource.
|
GetInterconnect |
---|
Gets details of a single Interconnect.
|
GetInterconnectAttachment |
---|
Gets details of a single InterconnectAttachment.
|
GetNetwork |
---|
Gets details of a single Network.
|
GetRouter |
---|
Gets details of a single Router.
|
GetSubnet |
---|
Gets details of a single Subnet.
|
GetZone |
---|
Deprecated: not implemented. Gets details of a single Zone.
|
InitializeZone |
---|
InitializeZone will initialize resources for a zone in a project.
|
ListInterconnectAttachments |
---|
Lists InterconnectAttachments in a given project and location.
|
ListInterconnects |
---|
Lists Interconnects in a given project and location.
|
ListNetworks |
---|
Lists Networks in a given project and location.
|
ListRouters |
---|
Lists Routers in a given project and location.
|
ListSubnets |
---|
Lists Subnets in a given project and location.
|
ListZones |
---|
Deprecated: not implemented. Lists Zones in a given project and location.
|
UpdateRouter |
---|
Updates the parameters of a single Router.
|
UpdateSubnet |
---|
Updates the parameters of a single Subnet.
|
CreateInterconnectAttachmentRequest
Message for creating a InterconnectAttachment
Fields | |
---|---|
parent |
Required. Value for parent. |
interconnect_attachment_id |
Required. Id of the requesting object If auto-generating Id server-side, remove this field and interconnect_attachment_id from the method_signature of Create RPC |
interconnect_attachment |
Required. The resource being created |
request_id |
Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). |
CreateNetworkRequest
Message for creating a Network
Fields | |
---|---|
parent |
Required. Value for parent. |
network_id |
Required. Id of the requesting object If auto-generating Id server-side, remove this field and network_id from the method_signature of Create RPC |
network |
Required. The resource being created |
request_id |
Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). |
CreateRouterRequest
Message for creating a Router
Fields | |
---|---|
parent |
Required. Value for parent. |
router_id |
Required. Id of the requesting object If auto-generating Id server-side, remove this field and router_id from the method_signature of Create RPC |
router |
Required. The resource being created |
request_id |
Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). |
CreateSubnetRequest
Message for creating a Subnet
Fields | |
---|---|
parent |
Required. Value for parent. |
subnet_id |
Required. Id of the requesting object If auto-generating Id server-side, remove this field and subnet_id from the method_signature of Create RPC |
subnet |
Required. The resource being created |
request_id |
Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). |
DeleteInterconnectAttachmentRequest
Message for deleting a InterconnectAttachment
Fields | |
---|---|
name |
Required. Name of the resource |
request_id |
Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). |
DeleteNetworkRequest
Message for deleting a Network
Fields | |
---|---|
name |
Required. Name of the resource |
request_id |
Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). |
DeleteRouterRequest
Message for deleting a Router
Fields | |
---|---|
name |
Required. Name of the resource |
request_id |
Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). |
DeleteSubnetRequest
Message for deleting a Subnet
Fields | |
---|---|
name |
Required. Name of the resource |
request_id |
Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). |
DiagnoseInterconnectRequest
Message for requesting the diagnostics of an interconnect within a specific zone.
Fields | |
---|---|
name |
Required. The name of the interconnect resource. |
DiagnoseInterconnectResponse
DiagnoseInterconnectResponse contains the current diagnostics for a specific interconnect.
Fields | |
---|---|
update_time |
The time when the interconnect diagnostics was last updated. |
result |
The network status of a specific interconnect. |
DiagnoseNetworkRequest
Message for requesting the diagnostics of a network within a specific zone.
Fields | |
---|---|
name |
Required. The name of the network resource. |
DiagnoseNetworkResponse
DiagnoseNetworkResponse contains the current status for a specific network.
Fields | |
---|---|
update_time |
The time when the network status was last updated. |
result |
The network status of a specific network. |
NetworkStatus
NetworkStatus has a list of status for the subnets under the current network.
Fields | |
---|---|
subnet_status[] |
A list of status for the subnets under the current network. |
macsec_status_internal_links |
The MACsec status of internal links. |
MacsecStatus
Denotes the status of MACsec sessions for the links of a zone.
Enums | |
---|---|
MACSEC_STATUS_UNSPECIFIED |
MACsec status not specified, likely due to missing metrics. |
SECURE |
All relevant links have at least one MACsec session up. |
UNSECURE |
At least one relevant link does not have any MACsec sessions up. |
DiagnoseRouterRequest
Message for requesting diagnositcs of a router within a specific zone.
Fields | |
---|---|
name |
Required. The name of the router resource. |
DiagnoseRouterResponse
DiagnoseRouterResponse contains the current status for a specific router.
Fields | |
---|---|
update_time |
The time when the router status was last updated. |
result |
The network status of a specific router. |
GetInterconnectAttachmentRequest
Message for getting a InterconnectAttachment
Fields | |
---|---|
name |
Required. Name of the resource |
GetInterconnectRequest
Message for getting a Interconnect
Fields | |
---|---|
name |
Required. Name of the resource |
GetNetworkRequest
Message for getting a Network
Fields | |
---|---|
name |
Required. Name of the resource |
GetRouterRequest
Message for getting a Router
Fields | |
---|---|
name |
Required. Name of the resource |
GetSubnetRequest
Message for getting a Subnet
Fields | |
---|---|
name |
Required. Name of the resource |
GetZoneRequest
Deprecated: not implemented. Message for getting a Zone
Fields | |
---|---|
name |
Required. Name of the resource |
InitializeZoneRequest
Message for initializing a specified zone
Fields | |
---|---|
name |
Required. The name of the zone resource. |
InitializeZoneResponse
This type has no fields.
The response of initializing a zone
Interconnect
Message describing Interconnect object
Fields | |
---|---|
name |
Required. The canonical resource name of the interconnect. |
create_time |
Output only. The time when the subnet was created. |
update_time |
Output only. The time when the subnet was last updated. |
labels |
Labels associated with this resource. |
description |
Optional. A free-text description of the resource. Max length 1024 characters. |
interconnect_type |
Optional. Type of interconnect, which takes only the value 'DEDICATED' for now. |
uuid |
Output only. Unique identifier for the link. |
device_cloud_resource_name |
Output only. Cloud resource name of the switch device. |
physical_ports[] |
Output only. Physical ports (e.g., TenGigE0/0/0/1) that form the interconnect. |
InterconnectType
Type of interconnect.
Enums | |
---|---|
INTERCONNECT_TYPE_UNSPECIFIED |
Unspecified. |
DEDICATED |
Dedicated Interconnect. |
InterconnectAttachment
Message describing InterconnectAttachment object
Fields | |
---|---|
name |
Required. The canonical resource name of the interconnect attachment. |
create_time |
Output only. The time when the interconnect attachment was created. |
update_time |
Output only. The time when the interconnect attachment was last updated. |
labels |
Labels associated with this resource. |
description |
Optional. A free-text description of the resource. Max length 1024 characters. |
interconnect |
Required. The canonical name of underlying Interconnect object that this attachment's traffic will traverse through. The name is in the form of |
network |
Optional. The canonical Network name in the form of |
vlan_id |
Required. VLAN id provided by user. Must be site-wise unique. |
mtu |
IP (L3) MTU value of the virtual edge cloud. Valid values are: 1500 and 9000. Default to 1500 if not set. |
state |
Output only. Current stage of the resource to the device by config push. |
InterconnectDiagnostics
Diagnostics information about interconnect, contains detailed and current technical information about Google's side of the connection.
Fields | |
---|---|
mac_address |
The MAC address of the Interconnect's bundle interface. |
link_layer_addresses[] |
A list of LinkLayerAddress, describing the ip address and corresponding link-layer address of the neighbors for this interconnect. |
links[] |
A list of LinkStatus objects, used to describe the status for each link on the Interconnect. |
LinkLACPStatus
Describing the status of a LACP link.
Fields | |
---|---|
state |
The state of a LACP link. |
google_system_id |
System ID of the port on Google's side of the LACP exchange. |
neighbor_system_id |
System ID of the port on the neighbor's side of the LACP exchange. |
aggregatable |
A true value indicates that the participant will allow the link to be used as part of the aggregate. A false value indicates the link should be used as an individual link. |
collecting |
If true, the participant is collecting incoming frames on the link, otherwise false |
distributing |
When true, the participant is distributing outgoing frames; when false, distribution is disabled |
State
State enum for LACP link.
Enums | |
---|---|
UNKNOWN |
The default state indicating state is in unknown state. |
ACTIVE |
The link is configured and active within the bundle. |
DETACHED |
The link is not configured within the bundle, this means the rest of the object should be empty. |
LinkLLDPStatus
Describing a LLDP link.
Fields | |
---|---|
peer_system_name |
The peer system's administratively assigned name. |
peer_system_description |
The textual description of the network entity of LLDP peer. |
peer_chassis_id |
The peer chassis component of the endpoint identifier associated with the transmitting LLDP agent. |
peer_chassis_id_type |
The format and source of the peer chassis identifier string. |
peer_port_id |
The port component of the endpoint identifier associated with the transmitting LLDP agent. If the specified port is an IEEE 802.3 Repeater port, then this TLV is optional. |
peer_port_id_type |
The format and source of the peer port identifier string. |
LinkStatus
Describing the status for each link on the Interconnect.
Fields | |
---|---|
circuit_id |
The unique ID for this link assigned during turn up by Google. |
lacp_status |
Describing the state of a LACP link. |
lldp_statuses[] |
A list of LinkLLDPStatus objects, used to describe LLDP status of each peer for each link on the Interconnect. |
packet_counts |
Packet counts specific statistics for this link. |
PacketCounts
Containing a collection of interface-related statistics objects.
Fields | |
---|---|
inbound_unicast |
The number of packets that are delivered. |
inbound_errors |
The number of inbound packets that contained errors. |
inbound_discards |
The number of inbound packets that were chosen to be discarded even though no errors had been detected to prevent their being deliverable. |
outbound_unicast |
The total number of packets that are requested be transmitted. |
outbound_errors |
The number of outbound packets that could not be transmitted because of errors. |
outbound_discards |
The number of outbound packets that were chosen to be discarded even though no errors had been detected to prevent their being transmitted. |
LinkLayerAddress
LinkLayerAddress contains an IP address and corresponding link-layer address.
Fields | |
---|---|
mac_address |
The MAC address of this neighbor. |
ip_address |
The IP address of this neighbor. |
ListInterconnectAttachmentsRequest
Message for requesting list of InterconnectAttachments
Fields | |
---|---|
parent |
Required. Parent value for ListInterconnectAttachmentsRequest |
page_size |
Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. |
page_token |
A token identifying a page of results the server should return. |
filter |
Filtering results |
order_by |
Hint for how to order the results |
ListInterconnectAttachmentsResponse
Message for response to listing InterconnectAttachments
Fields | |
---|---|
interconnect_attachments[] |
The list of InterconnectAttachment |
next_page_token |
A token identifying a page of results the server should return. |
unreachable[] |
Locations that could not be reached. |
ListInterconnectsRequest
Message for requesting list of Interconnects
Fields | |
---|---|
parent |
Required. Parent value for ListInterconnectsRequest |
page_size |
Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. |
page_token |
A token identifying a page of results the server should return. |
filter |
Filtering results |
order_by |
Hint for how to order the results |
ListInterconnectsResponse
Message for response to listing Interconnects
Fields | |
---|---|
interconnects[] |
The list of Interconnect |
next_page_token |
A token identifying a page of results the server should return. |
unreachable[] |
Locations that could not be reached. |
ListNetworksRequest
Message for requesting list of Networks
Fields | |
---|---|
parent |
Required. Parent value for ListNetworksRequest |
page_size |
Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. |
page_token |
A token identifying a page of results the server should return. |
filter |
Filtering results |
order_by |
Hint for how to order the results |
ListNetworksResponse
Message for response to listing Networks
Fields | |
---|---|
networks[] |
The list of Network |
next_page_token |
A token identifying a page of results the server should return. |
unreachable[] |
Locations that could not be reached. |
ListRoutersRequest
Message for requesting list of Routers
Fields | |
---|---|
parent |
Required. Parent value for ListRoutersRequest |
page_size |
Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. |
page_token |
A token identifying a page of results the server should return. |
filter |
Filtering results |
order_by |
Hint for how to order the results |
ListRoutersResponse
Message for response to listing Routers
Fields | |
---|---|
routers[] |
The list of Router |
next_page_token |
A token identifying a page of results the server should return. |
unreachable[] |
Locations that could not be reached. |
ListSubnetsRequest
Message for requesting list of Subnets
Fields | |
---|---|
parent |
Required. Parent value for ListSubnetsRequest |
page_size |
Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. |
page_token |
A token identifying a page of results the server should return. |
filter |
Filtering results |
order_by |
Hint for how to order the results |
ListSubnetsResponse
Message for response to listing Subnets
Fields | |
---|---|
subnets[] |
The list of Subnet |
next_page_token |
A token identifying a page of results the server should return. |
unreachable[] |
Locations that could not be reached. |
ListZonesRequest
Deprecated: not implemented. Message for requesting list of Zones
Fields | |
---|---|
parent |
Required. Parent value for ListZonesRequest |
page_size |
Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. |
page_token |
A token identifying a page of results the server should return. |
filter |
Filtering results |
order_by |
Hint for how to order the results |
ListZonesResponse
Deprecated: not implemented. Message for response to listing Zones
Fields | |
---|---|
zones[] |
The list of Zone |
next_page_token |
A token identifying a page of results the server should return. |
unreachable[] |
Locations that could not be reached. |
Network
Message describing Network object
Fields | |
---|---|
name |
Required. The canonical resource name of the network. |
create_time |
Output only. The time when the network was created. |
update_time |
Output only. The time when the network was last updated. |
labels |
Labels associated with this resource. |
description |
Optional. A free-text description of the resource. Max length 1024 characters. |
mtu |
IP (L3) MTU value of the network. Valid values are: 1500 and 9000. Default to 1500 if not set. |
OperationMetadata
Represents the metadata of the long-running operation.
Fields | |
---|---|
create_time |
Output only. The time the operation was created. |
end_time |
Output only. The time the operation finished running. |
target |
Output only. Server-defined resource path for the target of the operation. |
verb |
Output only. Name of the verb executed by the operation. |
status_message |
Output only. Human-readable status of the operation, if any. |
requested_cancellation |
Output only. Identifies whether the user has requested cancellation of the operation. Operations that have been cancelled successfully have [Operation.error][] value with a |
api_version |
Output only. API version used to start the operation. |
ResourceState
ResourceState describes the state the resource. A normal lifecycle of a new resource being created would be: PENDING -> PROVISIONING -> RUNNING. A normal lifecycle of an existing resource being deleted would be: RUNNING -> DELETING. Any failures during processing will result the resource to be in a SUSPENDED state.
Enums | |
---|---|
STATE_UNKNOWN |
Unspecified state. |
STATE_PENDING |
The resource is being prepared to be applied to the rack. |
STATE_PROVISIONING |
The resource has started being applied to the rack. |
STATE_RUNNING |
The resource has been pushed to the rack. |
STATE_SUSPENDED |
The resource failed to push to the rack. |
STATE_DELETING |
The resource is under deletion. |
Router
Message describing Router object
Fields | |
---|---|
name |
Required. The canonical resource name of the router. |
create_time |
Output only. The time when the router was created. |
update_time |
Output only. The time when the router was last updated. |
labels |
Labels associated with this resource. |
description |
Optional. A free-text description of the resource. Max length 1024 characters. |
network |
Required. The canonical name of the network to which this router belongs. The name is in the form of |
interface[] |
Router interfaces. |
bgp_peer[] |
BGP peers. |
bgp |
BGP information specific to this router. |
state |
Output only. Current stage of the resource to the device by config push. |
route_advertisements[] |
Optional. A list of CIDRs in IP/Length format to advertise northbound as static routes from this router. |
Bgp
BGP information specific to this router.
Fields | |
---|---|
asn |
Locally assigned BGP ASN. |
keepalive_interval_in_seconds |
The interval in seconds between BGP keepalive messages that are sent to the peer. Default is 20 with value between 20 and 60. |
BgpPeer
BGPPeer defines the peer side layer-3 information for building the BGP session.
Fields | |
---|---|
name |
Name of this BGP peer. Unique within the Zones resource. |
interface |
Name of the RouterInterface the BGP peer is associated with. |
interface_ipv4_cidr |
IP range of the interface within Google. |
interface_ipv6_cidr |
IPv6 range of the interface within Google. |
peer_ipv4_cidr |
IP range of the BGP interface outside Google. |
peer_ipv6_cidr |
IPv6 range of the BGP interface outside Google. |
peer_asn |
Peer BGP Autonomous System Number (ASN). Each BGP interface may use a different value. |
local_asn |
Output only. Local BGP Autonomous System Number (ASN). This field is ST_NOT_REQUIRED because it stores private ASNs, which are meaningless outside the zone in which they are being used. |
Interface
Router Interface defines the GDCE zone side layer-3 information for building the BGP session.
Fields | |
---|---|
name |
Name of this interface entry. Unique within the Zones resource. |
ipv4_cidr |
IP address and range of the interface. |
ipv6_cidr |
IPv6 address and range of the interface. |
linked_interconnect_attachment |
The canonical name of the linked Interconnect attachment. |
subnetwork |
The canonical name of the subnetwork resource that this interface belongs to. |
loopback_ip_addresses[] |
Create loopback interface in the router when specified. The number of IP addresses must match the number of TOR devices. |
RouterStatus
Describing the current status of a router.
Fields | |
---|---|
network |
The canonical name of the network to which this router belongs. |
bgp_peer_status[] |
A list of BgpPeerStatus objects, describing all BGP peers related to this router. |
BgpPeerStatus
Status of a BGP peer.
Fields | |
---|---|
name |
Name of this BGP peer. Unique within the Routers resource. |
ip_address |
IP address of the local BGP interface. |
peer_ip_address |
IP address of the remote BGP interface. |
status |
The current status of BGP. |
state |
BGP state as specified in RFC1771. |
uptime |
Time this session has been up. Format: 14 years, 51 weeks, 6 days, 23 hours, 59 minutes, 59 seconds |
uptime_seconds |
Time this session has been up, in seconds. |
prefix_counter |
A collection of counts for prefixes. |
BgpStatus
Status of the BGP peer: {UP, DOWN}
Enums | |
---|---|
UNKNOWN |
The default status indicating BGP session is in unknown state. |
UP |
The UP status indicating BGP session is established. |
DOWN |
The DOWN state indicating BGP session is not established yet. |
PrefixCounter
PrefixCounter contains a collection of prefixes related counts.
Fields | |
---|---|
advertised |
Number of prefixes advertised. |
denied |
Number of prefixes denied. |
received |
Number of prefixes received. |
sent |
Number of prefixes sent. |
suppressed |
Number of prefixes suppressed. |
withdrawn |
Number of prefixes withdrawn. |
Subnet
Message describing Subnet object
Fields | |
---|---|
name |
Required. The canonical resource name of the subnet. |
create_time |
Output only. The time when the subnet was created. |
update_time |
Output only. The time when the subnet was last updated. |
labels |
Labels associated with this resource. |
description |
Optional. A free-text description of the resource. Max length 1024 characters. |
network |
Required. The network that this subnetwork belongs to. |
ipv4_cidr[] |
The ranges of ipv4 addresses that are owned by this subnetwork. |
ipv6_cidr[] |
The ranges of ipv6 addresses that are owned by this subnetwork. |
vlan_id |
Optional. VLAN id provided by user. If not specified we assign one automatically. |
state |
Output only. Current stage of the resource to the device by config push. |
SubnetStatus
SubnetStatus contains detailed and current technical information about this subnet resource.
Fields | |
---|---|
name |
The name of CCFE subnet resource. |
mac_address |
BVI MAC address. |
link_layer_addresses[] |
A list of LinkLayerAddress, describing the ip address and corresponding link-layer address of the neighbors for this subnet. |
UpdateRouterRequest
Message for updating a Router
Fields | |
---|---|
update_mask |
Required. Field mask is used to specify the fields to be overwritten in the Router resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. |
router |
Required. The resource being updated |
request_id |
Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). |
UpdateSubnetRequest
Message for updating a Subnet
Fields | |
---|---|
update_mask |
Required. Field mask is used to specify the fields to be overwritten in the Subnet resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. |
subnet |
Required. The resource being updated |
request_id |
Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). |
Zone
A Google Edge Cloud zone.
Fields | |
---|---|
name |
Required. The resource name of the zone. |
create_time |
Output only. The time when the zone was created. |
update_time |
Output only. The time when the zone was last updated. |
labels |
Deprecated: not implemented. Labels as key value pairs. |
layout_name |
Deprecated: not implemented. The deployment layout type. |