1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="networkconnectivity_v1.html">Network Connectivity API</a> . <a href="networkconnectivity_v1.projects.html">projects</a> . <a href="networkconnectivity_v1.projects.locations.html">locations</a> . <a href="networkconnectivity_v1.projects.locations.global_.html">global_</a> . <a href="networkconnectivity_v1.projects.locations.global_.hubs.html">hubs</a> . <a href="networkconnectivity_v1.projects.locations.global_.hubs.routeTables.html">routeTables</a> . <a href="networkconnectivity_v1.projects.locations.global_.hubs.routeTables.routes.html">routes</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets details about the specified route.</p>
<p class="toc_element">
<code><a href="#list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists routes in a given route table.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>Gets details about the specified route.
Args:
name: string, Required. The name of the route resource. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A route defines a path from VM instances within a spoke to a specific destination resource. Only VPC spokes have routes.
"createTime": "A String", # Output only. The time the route was created.
"description": "A String", # An optional description of the route.
"ipCidrRange": "A String", # The destination IP address range.
"labels": { # Optional labels in key-value pair format. For more information about labels, see [Requirements for labels](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements).
"a_key": "A String",
},
"location": "A String", # Output only. The origin location of the route. Uses the following form: "projects/{project}/locations/{location}" Example: projects/1234/locations/us-central1
"name": "A String", # Immutable. The name of the route. Route names must be unique. Route names use the following form: `projects/{project_number}/locations/global/hubs/{hub}/routeTables/{route_table_id}/routes/{route_id}`
"nextHopInterconnectAttachment": { # A route next hop that leads to an interconnect attachment resource. # Immutable. The next-hop VLAN attachment for packets on this route.
"siteToSiteDataTransfer": True or False, # Indicates whether site-to-site data transfer is allowed for this interconnect attachment resource. Data transfer is available only in [supported locations](https://cloud.google.com/network-connectivity/docs/network-connectivity-center/concepts/locations).
"uri": "A String", # The URI of the interconnect attachment resource.
"vpcNetwork": "A String", # The VPC network where this interconnect attachment is located.
},
"nextHopRouterApplianceInstance": { # A route next hop that leads to a Router appliance instance. # Immutable. The next-hop Router appliance instance for packets on this route.
"siteToSiteDataTransfer": True or False, # Indicates whether site-to-site data transfer is allowed for this Router appliance instance resource. Data transfer is available only in [supported locations](https://cloud.google.com/network-connectivity/docs/network-connectivity-center/concepts/locations).
"uri": "A String", # The URI of the Router appliance instance.
"vpcNetwork": "A String", # The VPC network where this VM is located.
},
"nextHopSpoke": { # A route next hop that leads to a spoke resource. # Immutable. The next-hop spoke for packets on this route.
"siteToSiteDataTransfer": True or False, # Indicates whether site-to-site data transfer is allowed for this spoke resource. Data transfer is available only in [supported locations](https://cloud.google.com/network-connectivity/docs/network-connectivity-center/concepts/locations). Whether this route is accessible to other hybrid spokes with site-to-site data transfer enabled. If this is false, the route is only accessible to VPC spokes of the connected Hub.
"uri": "A String", # The URI of the spoke resource.
},
"nextHopVpcNetwork": { # Immutable. The destination VPC network for packets on this route.
"uri": "A String", # The URI of the VPC network resource
},
"nextHopVpnTunnel": { # A route next hop that leads to a VPN tunnel resource. # Immutable. The next-hop VPN tunnel for packets on this route.
"siteToSiteDataTransfer": True or False, # Indicates whether site-to-site data transfer is allowed for this VPN tunnel resource. Data transfer is available only in [supported locations](https://cloud.google.com/network-connectivity/docs/network-connectivity-center/concepts/locations).
"uri": "A String", # The URI of the VPN tunnel resource.
"vpcNetwork": "A String", # The VPC network where this VPN tunnel is located.
},
"priority": "A String", # Output only. The priority of this route. Priority is used to break ties in cases where a destination matches more than one route. In these cases the route with the lowest-numbered priority value wins.
"spoke": "A String", # Immutable. The spoke that this route leads to. Example: projects/12345/locations/global/spokes/SPOKE
"state": "A String", # Output only. The current lifecycle state of the route.
"type": "A String", # Output only. The route's type. Its type is determined by the properties of its IP address range.
"uid": "A String", # Output only. The Google-generated UUID for the route. This value is unique across all Network Connectivity Center route resources. If a route is deleted and another with the same name is created, the new route is assigned a different `uid`.
"updateTime": "A String", # Output only. The time the route was last updated.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists routes in a given route table.
Args:
parent: string, Required. The parent resource's name. (required)
filter: string, An expression that filters the list of results.
orderBy: string, Sort the results by a certain order.
pageSize: integer, The maximum number of results to return per page.
pageToken: string, The page token.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response for HubService.ListRoutes method.
"nextPageToken": "A String", # The token for the next page of the response. To see more results, use this value as the page_token for your next request. If this value is empty, there are no more results.
"routes": [ # The requested routes.
{ # A route defines a path from VM instances within a spoke to a specific destination resource. Only VPC spokes have routes.
"createTime": "A String", # Output only. The time the route was created.
"description": "A String", # An optional description of the route.
"ipCidrRange": "A String", # The destination IP address range.
"labels": { # Optional labels in key-value pair format. For more information about labels, see [Requirements for labels](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements).
"a_key": "A String",
},
"location": "A String", # Output only. The origin location of the route. Uses the following form: "projects/{project}/locations/{location}" Example: projects/1234/locations/us-central1
"name": "A String", # Immutable. The name of the route. Route names must be unique. Route names use the following form: `projects/{project_number}/locations/global/hubs/{hub}/routeTables/{route_table_id}/routes/{route_id}`
"nextHopInterconnectAttachment": { # A route next hop that leads to an interconnect attachment resource. # Immutable. The next-hop VLAN attachment for packets on this route.
"siteToSiteDataTransfer": True or False, # Indicates whether site-to-site data transfer is allowed for this interconnect attachment resource. Data transfer is available only in [supported locations](https://cloud.google.com/network-connectivity/docs/network-connectivity-center/concepts/locations).
"uri": "A String", # The URI of the interconnect attachment resource.
"vpcNetwork": "A String", # The VPC network where this interconnect attachment is located.
},
"nextHopRouterApplianceInstance": { # A route next hop that leads to a Router appliance instance. # Immutable. The next-hop Router appliance instance for packets on this route.
"siteToSiteDataTransfer": True or False, # Indicates whether site-to-site data transfer is allowed for this Router appliance instance resource. Data transfer is available only in [supported locations](https://cloud.google.com/network-connectivity/docs/network-connectivity-center/concepts/locations).
"uri": "A String", # The URI of the Router appliance instance.
"vpcNetwork": "A String", # The VPC network where this VM is located.
},
"nextHopSpoke": { # A route next hop that leads to a spoke resource. # Immutable. The next-hop spoke for packets on this route.
"siteToSiteDataTransfer": True or False, # Indicates whether site-to-site data transfer is allowed for this spoke resource. Data transfer is available only in [supported locations](https://cloud.google.com/network-connectivity/docs/network-connectivity-center/concepts/locations). Whether this route is accessible to other hybrid spokes with site-to-site data transfer enabled. If this is false, the route is only accessible to VPC spokes of the connected Hub.
"uri": "A String", # The URI of the spoke resource.
},
"nextHopVpcNetwork": { # Immutable. The destination VPC network for packets on this route.
"uri": "A String", # The URI of the VPC network resource
},
"nextHopVpnTunnel": { # A route next hop that leads to a VPN tunnel resource. # Immutable. The next-hop VPN tunnel for packets on this route.
"siteToSiteDataTransfer": True or False, # Indicates whether site-to-site data transfer is allowed for this VPN tunnel resource. Data transfer is available only in [supported locations](https://cloud.google.com/network-connectivity/docs/network-connectivity-center/concepts/locations).
"uri": "A String", # The URI of the VPN tunnel resource.
"vpcNetwork": "A String", # The VPC network where this VPN tunnel is located.
},
"priority": "A String", # Output only. The priority of this route. Priority is used to break ties in cases where a destination matches more than one route. In these cases the route with the lowest-numbered priority value wins.
"spoke": "A String", # Immutable. The spoke that this route leads to. Example: projects/12345/locations/global/spokes/SPOKE
"state": "A String", # Output only. The current lifecycle state of the route.
"type": "A String", # Output only. The route's type. Its type is determined by the properties of its IP address range.
"uid": "A String", # Output only. The Google-generated UUID for the route. This value is unique across all Network Connectivity Center route resources. If a route is deleted and another with the same name is created, the new route is assigned a different `uid`.
"updateTime": "A String", # Output only. The time the route was last updated.
},
],
"unreachable": [ # RouteTables that could not be reached.
"A String",
],
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>
|
