Blame - docs/dyn/compute_alpha.routers.html - platform/external/python/google-api-python-client

2016-10-21 13:59:49 -0700

[diff] [blame]

79

<p class="firstline">Retrieves an aggregated list of routers.</p>

80

81

<code><a href="#aggregatedList_next">aggregatedList_next(previous_request, previous_response)</a></code></p>

82

<p class="firstline">Retrieves the next page of results.</p>

83

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

84

<code><a href="#close">close()</a></code></p>

85

<p class="firstline">Close httplib2 connections.</p>

86

Sai Cheemalapati

c30d2b5

2017-03-13 12:12:03 -0400

[diff] [blame]

87

<code><a href="#delete">delete(project, region, router, requestId=None)</a></code></p>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

88

<p class="firstline">Deletes the specified Router resource.</p>

89

90

<code><a href="#get">get(project, region, router)</a></code></p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

91

<p class="firstline">Returns the specified Router resource. Gets a list of available routers by making a list() request.</p>

92

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

93

<code><a href="#getNatMappingInfo">getNatMappingInfo(project, region, router, filter=None, maxResults=None, natName=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</a></code></p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

94

<p class="firstline">Retrieves runtime Nat mapping information of VM endpoints.</p>

95

96

<code><a href="#getNatMappingInfo_next">getNatMappingInfo_next(previous_request, previous_response)</a></code></p>

97

<p class="firstline">Retrieves the next page of results.</p>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

98

99

<code><a href="#getRouterStatus">getRouterStatus(project, region, router)</a></code></p>

100

<p class="firstline">Retrieves runtime information of the specified router.</p>

101

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

102

<code><a href="#insert">insert(project, region, body=None, requestId=None)</a></code></p>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

103

<p class="firstline">Creates a Router resource in the specified project and region using the data included in the request.</p>

104

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

105

<code><a href="#list">list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</a></code></p>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

106

<p class="firstline">Retrieves a list of Router resources available to the specified project.</p>

107

108

<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>

109

<p class="firstline">Retrieves the next page of results.</p>

110

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

111

<code><a href="#patch">patch(project, region, router, body=None, requestId=None)</a></code></p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

112

<p class="firstline">Patches the specified Router resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.</p>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

113

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

114

<code><a href="#preview">preview(project, region, router, body=None)</a></code></p>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

115

<p class="firstline">Preview fields auto-generated during router create and update operations. Calling this method does NOT create or update the router.</p>

116

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

117

<code><a href="#testIamPermissions">testIamPermissions(project, region, resource, body=None)</a></code></p>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

118

<p class="firstline">Returns permissions that a caller has on the specified resource.</p>

119

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

120

<code><a href="#update">update(project, region, router, body=None, requestId=None)</a></code></p>

121

<p class="firstline">Updates the specified Router resource with the data included in the request. This method conforms to PUT semantics, which requests that the state of the target resource be created or replaced with the state defined by the representation enclosed in the request message payload.</p>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

122

<h3>Method Details</h3>

123

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

124

<code class="details" id="aggregatedList">aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</code>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

125

<pre>Retrieves an aggregated list of routers.

126

127

Args:

128

project: string, Project ID for this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

129

filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

130

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

131

For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

132

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

133

You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

134

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

135

To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ```

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

136

includeAllScopes: boolean, Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

137

maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)

138

orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

139

140

You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

141

142

Currently, only sorting by `name` or `creationTimestamp desc` is supported.

143

pageToken: string, Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame^]

144

returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

145

146

Returns:

147

An object of the form:

148

149

{ # Contains a list of routers.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

150

"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.

151

"items": { # A list of Router resources.

152

"a_key": { # Name of the scope containing this set of routers.

153

"routers": [ # A list of routers contained in this scope.

154

{ # Represents a Cloud Router resource.

155

#

156

# For more information about Cloud Router, read the Cloud Router overview.

157

"bgp": { # BGP information specific to this router.

158

"advertiseMode": "A String", # User-specified flag to indicate which mode to use for advertisement. The options are DEFAULT or CUSTOM.

159

"advertisedGroups": [ # User-specified list of prefix groups to advertise in custom mode. This field can only be populated if advertise_mode is CUSTOM and is advertised to all peers of the router. These groups will be advertised in addition to any specified prefixes. Leave this field blank to advertise no custom groups.

160

"A String",

161

],

162

"advertisedIpRanges": [ # User-specified list of individual IP ranges to advertise in custom mode. This field can only be populated if advertise_mode is CUSTOM and is advertised to all peers of the router. These IP ranges will be advertised in addition to any specified groups. Leave this field blank to advertise no custom IP ranges.

163

{ # Description-tagged IP ranges for the router to advertise.

164

"description": "A String", # User-specified description for the IP range.

165

"range": "A String", # The IP range to advertise. The value must be a CIDR-formatted string.

166

},

167

],

168

"asn": 42, # Local BGP Autonomous System Number (ASN). Must be an RFC6996 private ASN, either 16-bit or 32-bit. The value will be fixed for this router resource. All VPN tunnels that link to this router will have the same local ASN.

169

"keepaliveInterval": 42, # The interval in seconds between BGP keepalive messages that are sent to the peer.

170

# Not currently available publicly.

171

# Hold time is three times the interval at which keepalive messages are sent, and the hold time is the maximum number of seconds allowed to elapse between successive keepalive messages that BGP receives from a peer.

172

# BGP will use the smaller of either the local hold time value or the peer's hold time value as the hold time for the BGP connection between the two peers.

173

# If set, this value must be between 1 and 120. The default is 20.

174

},

175

"bgpPeers": [ # BGP information that must be configured into the routing stack to establish BGP peering. This information must specify the peer ASN and either the interface name, IP address, or peer IP address. Please refer to RFC4273.

176

{

177

"advertiseMode": "A String", # User-specified flag to indicate which mode to use for advertisement.

178

"advertisedGroups": [ # User-specified list of prefix groups to advertise in custom mode, which can take one of the following options:

179

# - ALL_SUBNETS: Advertises all available subnets, including peer VPC subnets.

180

# - ALL_VPC_SUBNETS: Advertises the router's own VPC subnets.

181

# - ALL_PEER_VPC_SUBNETS: Advertises peer subnets of the router's VPC network. Note that this field can only be populated if advertise_mode is CUSTOM and overrides the list defined for the router (in the "bgp" message). These groups are advertised in addition to any specified prefixes. Leave this field blank to advertise no custom groups.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

182

"A String",

183

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

184

"advertisedIpRanges": [ # User-specified list of individual IP ranges to advertise in custom mode. This field can only be populated if advertise_mode is CUSTOM and overrides the list defined for the router (in the "bgp" message). These IP ranges are advertised in addition to any specified groups. Leave this field blank to advertise no custom IP ranges.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

185

{ # Description-tagged IP ranges for the router to advertise.

186

"description": "A String", # User-specified description for the IP range.

187

"range": "A String", # The IP range to advertise. The value must be a CIDR-formatted string.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

188

},

189

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

190

"advertisedRoutePriority": 42, # The priority of routes advertised to this BGP peer. Where there is more than one matching route of maximum length, the routes with the lowest priority value win.

191

"bfd": { # BFD configuration for the BGP peering.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

192

# Not currently available publicly.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

193

"minReceiveInterval": 42, # The minimum interval, in milliseconds, between BFD control packets received from the peer router. The actual value is negotiated between the two routers and is equal to the greater of this value and the transmit interval of the other router.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

194

# Not currently available publicly.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

195

# If set, this value must be between 100 and 30000.

196

# The default is 300.

197

"minTransmitInterval": 42, # The minimum interval, in milliseconds, between BFD control packets transmitted to the peer router. The actual value is negotiated between the two routers and is equal to the greater of this value and the corresponding receive interval of the other router.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

198

# Not currently available publicly.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

199

# If set, this value must be between 100 and 30000.

200

# The default is 300.

201

"mode": "A String", # The BFD session initialization mode for this BGP peer. If set to ACTIVE, the Cloud Router will initiate the BFD session for this BGP peer. If set to PASSIVE, the Cloud Router will wait for the peer router to initiate the BFD session for this BGP peer. If set to DISABLED, BFD is disabled for this BGP peer. The default is PASSIVE.

202

"multiplier": 42, # The number of consecutive BFD packets that must be missed before BFD declares that a peer is unavailable.

203

# Not currently available publicly.

204

# If set, the value must be a value between 2 and 16.

205

# The default is 3.

206

"packetMode": "A String", # The BFD packet mode for this BGP peer. If set to CONTROL_AND_ECHO, BFD echo mode is enabled for this BGP peer. In this mode, if the peer router also has BFD echo mode enabled, BFD echo packets will be sent to the other router. If the peer router does not have BFD echo mode enabled, only control packets will be sent. If set to CONTROL_ONLY, BFD echo mode is disabled for this BGP peer. If this router and the peer router have a multihop connection, this should be set to CONTROL_ONLY as BFD echo mode is only supported on singlehop connections. The default is CONTROL_AND_ECHO.

207

"sessionInitializationMode": "A String", # The BFD session initialization mode for this BGP peer.

208

# Not currently available publicly.

209

# If set to ACTIVE, the Cloud Router will initiate the BFD session for this BGP peer. If set to PASSIVE, the Cloud Router will wait for the peer router to initiate the BFD session for this BGP peer. If set to DISABLED, BFD is disabled for this BGP peer. The default is PASSIVE.

210

"slowTimerInterval": 42, # The minimum interval, in milliseconds, between BFD control packets transmitted to and received from the peer router when BFD echo mode is enabled on both routers. The actual transmit and receive intervals are negotiated between the two routers and are equal to the greater of this value and the corresponding interval on the other router. If set, this value must be between 1000 and 30000. The default is 5000.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

211

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

212

"enable": "A String", # The status of the BGP peer connection.

213

# Not currently available publicly.

214

# If set to FALSE, any active session with the peer is terminated and all associated routing information is removed. If set to TRUE, the peer connection can be established with routing information. The default is TRUE.

215

"interfaceName": "A String", # Name of the interface the BGP peer is associated with.

216

"ipAddress": "A String", # IP address of the interface inside Google Cloud Platform. Only IPv4 is supported.

217

"managementType": "A String", # [Output Only] The resource that configures and manages this BGP peer.

218

# - MANAGED_BY_USER is the default value and can be managed by you or other users

219

# - MANAGED_BY_ATTACHMENT is a BGP peer that is configured and managed by Cloud Interconnect, specifically by an InterconnectAttachment of type PARTNER. Google automatically creates, updates, and deletes this type of BGP peer when the PARTNER InterconnectAttachment is created, updated, or deleted.

220

"name": "A String", # Name of this BGP peer. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

221

"peerAsn": 42, # Peer BGP Autonomous System Number (ASN). Each BGP interface may use a different value.

222

"peerIpAddress": "A String", # IP address of the BGP interface outside Google Cloud Platform. Only IPv4 is supported.

223

"routerApplianceInstance": "A String", # URI of the VM instance that is used as third-party router appliances such as Next Gen Firewalls, Virtual Routers, or Router Appliances. The VM instance must be located in zones contained in the same region as this Cloud Router. The VM instance is the peer side of the BGP session.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

224

},

225

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

226

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

227

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

228

"encryptedInterconnectRouter": True or False, # Field to indicate if a router is dedicated to use with encrypted Interconnect Attachment (Encrypted Interconnect feature).

229

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

230

"interfaces": [ # Router interfaces. Each interface requires either one linked resource, (for example, linkedVpnTunnel), or IP address and IP address range (for example, ipRange), or both.

231

{

232

"ipRange": "A String", # IP address and range of the interface. The IP range must be in the RFC3927 link-local IP address space. The value must be a CIDR-formatted string, for example: 169.254.0.1/30. NOTE: Do not truncate the address as it represents the IP address of the interface.

233

"linkedInterconnectAttachment": "A String", # URI of the linked Interconnect attachment. It must be in the same region as the router. Each interface can have one linked resource, which can be a VPN tunnel, an Interconnect attachment, or a virtual machine instance.

234

"linkedVpnTunnel": "A String", # URI of the linked VPN tunnel, which must be in the same region as the router. Each interface can have one linked resource, which can be a VPN tunnel, an Interconnect attachment, or a virtual machine instance.

235

"managementType": "A String", # [Output Only] The resource that configures and manages this interface.

236

# - MANAGED_BY_USER is the default value and can be managed directly by users.

237

# - MANAGED_BY_ATTACHMENT is an interface that is configured and managed by Cloud Interconnect, specifically, by an InterconnectAttachment of type PARTNER. Google automatically creates, updates, and deletes this type of interface when the PARTNER InterconnectAttachment is created, updated, or deleted.

238

"name": "A String", # Name of this interface entry. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

239

"privateIpAddress": "A String", # The regional private internal IP address that is used to establish BGP sessions to a VM instance acting as a third-party Router Appliance, such as a Next Gen Firewall, a Virtual Router, or an SD-WAN VM.

240

"redundantInterface": "A String", # Name of the interface that will be redundant with the current interface you are creating. The redundantInterface must belong to the same Cloud Router as the interface here. To establish the BGP session to a Router Appliance VM, you must create two BGP peers. The two BGP peers must be attached to two separate interfaces that are redundant with each other. The redundant_interface must be 1-63 characters long, and comply with RFC1035. Specifically, the redundant_interface must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

241

"subnetwork": "A String", # The URL of the subnetwork resource that this interface belongs to, which must be in the same region as the Cloud Router. When you establish a BGP session to a VM instance using this interface, the VM instance must belong to the same subnetwork as the subnetwork specified here.

242

},

243

],

244

"kind": "compute#router", # [Output Only] Type of resource. Always compute#router for routers.

245

"name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

246

"nats": [ # A list of NAT services created in this router.

247

{ # Represents a Nat resource. It enables the VMs within the specified subnetworks to access Internet without external IP addresses. It specifies a list of subnetworks (and the ranges within) that want to use NAT. Customers can also provide the external IPs that would be used for NAT. GCP would auto-allocate ephemeral IPs if no external IPs are provided.

248

"drainNatIps": [ # A list of URLs of the IP resources to be drained. These IPs must be valid static external IPs that have been assigned to the NAT. These IPs should be used for updating/patching a NAT only.

249

"A String",

250

],

251

"enableEndpointIndependentMapping": True or False,

252

"icmpIdleTimeoutSec": 42, # Timeout (in seconds) for ICMP connections. Defaults to 30s if not set.

253

"logConfig": { # Configuration of logging on a NAT. # Configure logging on this NAT.

254

"enable": True or False, # Indicates whether or not to export logs. This is false by default.

255

"filter": "A String", # Specify the desired filtering of logs on this NAT. If unspecified, logs are exported for all connections handled by this NAT. This option can take one of the following values:

256

# - ERRORS_ONLY: Export logs only for connection failures.

257

# - TRANSLATIONS_ONLY: Export logs only for successful connections.

258

# - ALL: Export logs for all connections, successful and unsuccessful.

259

},

260

"minPortsPerVm": 42, # Minimum number of ports allocated to a VM from this NAT config. If not set, a default number of ports is allocated to a VM. This is rounded up to the nearest power of 2. For example, if the value of this field is 50, at least 64 ports are allocated to a VM.

261

"name": "A String", # Unique name of this Nat service. The name must be 1-63 characters long and comply with RFC1035.

262

"natIpAllocateOption": "A String", # Specify the NatIpAllocateOption, which can take one of the following values:

263

# - MANUAL_ONLY: Uses only Nat IP addresses provided by customers. When there are not enough specified Nat IPs, the Nat service fails for new VMs.

264

# - AUTO_ONLY: Nat IPs are allocated by Google Cloud Platform; customers can't specify any Nat IPs. When choosing AUTO_ONLY, then nat_ip should be empty.

265

"natIps": [ # A list of URLs of the IP resources used for this Nat service. These IP addresses must be valid static external IP addresses assigned to the project.

266

"A String",

267

],

268

"rules": [ # A list of rules associated with this NAT.

269

{

270

"action": { # The action to be enforced for traffic that matches this rule.

271

"sourceNatActiveIps": [ # A list of URLs of the IP resources used for this NAT rule. These IP addresses must be valid static external IP addresses assigned to the project.

272

"A String",

273

],

274

"sourceNatDrainIps": [ # A list of URLs of the IP resources to be drained. These IPs must be valid static external IPs that have been assigned to the NAT. These IPs should be used for updating/patching a NAT rule only.

"A String",

],

},

"description": "A String", # An optional description of this rule.

279

"match": "A String", # CEL expression that specifies the match condition that egress traffic from a VM is evaluated against. If it evaluates to true, the corresponding ?action? is enforced.

280

#

281

# The following examples are valid match expressions:

282

#

283

# "inIpRange(destination.ip, '1.1.0.0/16') || inIpRange(destination.ip, '2.2.0.0/16')"

284

#

285

# "destination.ip == '1.1.0.1' || destination.ip == '8.8.8.8'"

286

"ruleNumber": 42, # An integer uniquely identifying a rule in the list. The rule number must be a positive value between 0 and 65000, and must be unique among rules within a NAT.

287

},

288

],

289

"sourceSubnetworkIpRangesToNat": "A String", # Specify the Nat option, which can take one of the following values:

290

# - ALL_SUBNETWORKS_ALL_IP_RANGES: All of the IP ranges in every Subnetwork are allowed to Nat.

291

# - ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES: All of the primary IP ranges in every Subnetwork are allowed to Nat.

292

# - LIST_OF_SUBNETWORKS: A list of Subnetworks are allowed to Nat (specified in the field subnetwork below) The default is SUBNETWORK_IP_RANGE_TO_NAT_OPTION_UNSPECIFIED. Note that if this field contains ALL_SUBNETWORKS_ALL_IP_RANGES or ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES, then there should not be any other Router.Nat section in any Router for this network in this region.

293

"subnetworks": [ # A list of Subnetwork resources whose traffic should be translated by NAT Gateway. It is used only when LIST_OF_SUBNETWORKS is selected for the SubnetworkIpRangeToNatOption above.

294

{ # Defines the IP ranges that want to use NAT for a subnetwork.

295

"name": "A String", # URL for the subnetwork resource that will use NAT.

296

"secondaryIpRangeNames": [ # A list of the secondary ranges of the Subnetwork that are allowed to use NAT. This can be populated only if "LIST_OF_SECONDARY_IP_RANGES" is one of the values in source_ip_ranges_to_nat.

297

"A String",

298

],

299

"sourceIpRangesToNat": [ # Specify the options for NAT ranges in the Subnetwork. All options of a single value are valid except NAT_IP_RANGE_OPTION_UNSPECIFIED. The only valid option with multiple values is: ["PRIMARY_IP_RANGE", "LIST_OF_SECONDARY_IP_RANGES"] Default: [ALL_IP_RANGES]

"A String",

],

},

],

"tcpEstablishedIdleTimeoutSec": 42, # Timeout (in seconds) for TCP established connections. Defaults to 1200s if not set.

305

"tcpTimeWaitTimeoutSec": 42, # Timeout (in seconds) for TCP connections that are in TIME_WAIT state. Defaults to 120s if not set.

306

"tcpTransitoryIdleTimeoutSec": 42, # Timeout (in seconds) for TCP transitory connections. Defaults to 30s if not set.

307

"udpIdleTimeoutSec": 42, # Timeout (in seconds) for UDP connections. Defaults to 30s if not set.

308

},

309

],

310

"network": "A String", # URI of the network to which this router belongs.

311

"region": "A String", # [Output Only] URI of the region where the router resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

312

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

313

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

314

},

315

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

316

"warning": { # Informational warning which replaces the list of routers when the list is empty.

317

"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

318

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

319

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

320

{

321

"key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).

322

"value": "A String", # [Output Only] A warning data value corresponding to the key.

323

},

324

],

325

"message": "A String", # [Output Only] A human-readable description of the warning code.

326

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

327

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

328

},

329

"kind": "compute#routerAggregatedList", # Type of resource.

330

"nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

331

"selfLink": "A String", # [Output Only] Server-defined URL for this resource.

332

"unreachables": [ # [Output Only] Unreachable resources.

333

"A String",

334

],

335

"warning": { # [Output Only] Informational warning message.

336

"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

337

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

338

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

339

{

340

"key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).

341

"value": "A String", # [Output Only] A warning data value corresponding to the key.

342

},

343

],

344

"message": "A String", # [Output Only] A human-readable description of the warning code.

345

},

346

}</pre>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

</div>

<code class="details" id="aggregatedList_next">aggregatedList_next(previous_request, previous_response)</code>

351

<pre>Retrieves the next page of results.

352

353

Args:

354

previous_request: The request for the previous page. (required)

355

previous_response: The response from the request for the previous page. (required)

356

357

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

358

A request object that you can call 'execute()' on to request the next

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

359

page. Returns None if there are no more items in the collection.

</pre>

</div>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

364

<code class="details" id="close">close()</code>

365

<pre>Close httplib2 connections.</pre>

</div>

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

369

<code class="details" id="delete">delete(project, region, router, requestId=None)</code>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

370

<pre>Deletes the specified Router resource.

371

372

Args:

373

project: string, Project ID for this request. (required)

374

region: string, Name of the region for this request. (required)

375

router: string, Name of the Router resource to delete. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

376

requestId: string, 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.

377

378

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.

379

380

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

381

382

Returns:

383

An object of the form:

384

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

385

{ # Represents an Operation resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

386

#

387

# Google Compute Engine has three Operation resources:

388

#

389

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

390

#

391

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

392

#

393

# Operations can be global, regional or zonal.

394

# - For global operations, use the `globalOperations` resource.

395

# - For regional operations, use the `regionOperations` resource.

396

# - For zonal operations, use the `zonalOperations` resource.

397

#

398

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

399

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

400

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

401

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

402

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

403

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

404

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

405

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

406

"code": "A String", # [Output Only] The error type identifier for this error.

407

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

408

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

409

},

410

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

411

},

412

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

413

"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.

414

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

415

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

416

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame^]

417

"metadata": { # `Any` contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message. # [Output Only] Service-specific metadata attached to this operation.

418

#

419

# Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type.

420

#

421

# Example 1: Pack and unpack a message in C++.

422

#

423

# Foo foo = ...; Any any; any.PackFrom(foo); ... if (any.UnpackTo(&foo)) { ... }

424

#

425

# Example 2: Pack and unpack a message in Java.

426

#

427

# Foo foo = ...; Any any = Any.pack(foo); ... if (any.is(Foo.class)) { foo = any.unpack(Foo.class); }

428

#

429

# Example 3: Pack and unpack a message in Python.

430

#

431

# foo = Foo(...) any = Any() any.Pack(foo) ... if any.Is(Foo.DESCRIPTOR): any.Unpack(foo) ...

432

#

433

# Example 4: Pack and unpack a message in Go

434

#

435

# foo := &pb.Foo{...} any, err := anypb.New(foo) if err != nil { ... } ... foo := &pb.Foo{} if err := any.UnmarshalTo(foo); err != nil { ... }

436

#

437

# The pack methods provided by protobuf library will by default use 'type.googleapis.com/full.type.name' as the type URL and the unpack methods only use the fully qualified type name after the last '/' in the type URL, for example "foo.bar.com/x/y.z" will yield type name "y.z".

#

#

#

# JSON ==== The JSON representation of an `Any` value uses the regular representation of the deserialized, embedded message, with an additional field `@type` which contains the type URL. Example:

442

#

443

# package google.profile; message Person { string first_name = 1; string last_name = 2; }

444

#

445

# { "@type": "type.googleapis.com/google.profile.Person", "firstName": , "lastName": }

446

#

447

# If the embedded message type is well-known and has a custom JSON representation, that representation will be embedded adding a field `value` which holds the custom JSON in addition to the `@type` field. Example (for message [google.protobuf.Duration][]):

448

#

449

# { "@type": "type.googleapis.com/google.protobuf.Duration", "value": "1.212s" }

450

"typeUrl": "A String", # A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in `path/google.protobuf.Duration`). The name should be in a canonical form (e.g., leading "." is not accepted).

451

#

452

# In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme `http`, `https`, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:

453

#

454

# * If no scheme is provided, `https` is assumed. * An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error. * Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)

455

#

456

# Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.

457

#

458

# Schemes other than `http`, `https` (or the empty scheme) might be used with implementation specific semantics.

459

"value": "A String", # Must be a valid serialized protocol buffer of the above specified type.

460

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

461

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame^]

462

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

463

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

464

"progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.

465

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

466

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

467

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

468

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

469

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

470

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

471

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

472

"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.

473

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

474

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

475

{

476

"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

477

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

478

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

479

{

480

"key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).

481

"value": "A String", # [Output Only] A warning data value corresponding to the key.

482

},

483

],

484

"message": "A String", # [Output Only] A human-readable description of the warning code.

485

},

486

],

487

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

488

}</pre>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

</div>

<code class="details" id="get">get(project, region, router)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

493

<pre>Returns the specified Router resource. Gets a list of available routers by making a list() request.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

494

495

Args:

496

project: string, Project ID for this request. (required)

497

region: string, Name of the region for this request. (required)

498

router: string, Name of the Router resource to return. (required)

499

500

Returns:

501

An object of the form:

502

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

503

{ # Represents a Cloud Router resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

504

#

505

# For more information about Cloud Router, read the Cloud Router overview.

506

"bgp": { # BGP information specific to this router.

507

"advertiseMode": "A String", # User-specified flag to indicate which mode to use for advertisement. The options are DEFAULT or CUSTOM.

508

"advertisedGroups": [ # User-specified list of prefix groups to advertise in custom mode. This field can only be populated if advertise_mode is CUSTOM and is advertised to all peers of the router. These groups will be advertised in addition to any specified prefixes. Leave this field blank to advertise no custom groups.

509

"A String",

510

],

511

"advertisedIpRanges": [ # User-specified list of individual IP ranges to advertise in custom mode. This field can only be populated if advertise_mode is CUSTOM and is advertised to all peers of the router. These IP ranges will be advertised in addition to any specified groups. Leave this field blank to advertise no custom IP ranges.

512

{ # Description-tagged IP ranges for the router to advertise.

513

"description": "A String", # User-specified description for the IP range.

514

"range": "A String", # The IP range to advertise. The value must be a CIDR-formatted string.

515

},

516

],

517

"asn": 42, # Local BGP Autonomous System Number (ASN). Must be an RFC6996 private ASN, either 16-bit or 32-bit. The value will be fixed for this router resource. All VPN tunnels that link to this router will have the same local ASN.

518

"keepaliveInterval": 42, # The interval in seconds between BGP keepalive messages that are sent to the peer.

519

# Not currently available publicly.

520

# Hold time is three times the interval at which keepalive messages are sent, and the hold time is the maximum number of seconds allowed to elapse between successive keepalive messages that BGP receives from a peer.

521

# BGP will use the smaller of either the local hold time value or the peer's hold time value as the hold time for the BGP connection between the two peers.

522

# If set, this value must be between 1 and 120. The default is 20.

523

},

524

"bgpPeers": [ # BGP information that must be configured into the routing stack to establish BGP peering. This information must specify the peer ASN and either the interface name, IP address, or peer IP address. Please refer to RFC4273.

525

{

526

"advertiseMode": "A String", # User-specified flag to indicate which mode to use for advertisement.

527

"advertisedGroups": [ # User-specified list of prefix groups to advertise in custom mode, which can take one of the following options:

528

# - ALL_SUBNETS: Advertises all available subnets, including peer VPC subnets.

529

# - ALL_VPC_SUBNETS: Advertises the router's own VPC subnets.

530

# - ALL_PEER_VPC_SUBNETS: Advertises peer subnets of the router's VPC network. Note that this field can only be populated if advertise_mode is CUSTOM and overrides the list defined for the router (in the "bgp" message). These groups are advertised in addition to any specified prefixes. Leave this field blank to advertise no custom groups.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

531

"A String",

532

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

533

"advertisedIpRanges": [ # User-specified list of individual IP ranges to advertise in custom mode. This field can only be populated if advertise_mode is CUSTOM and overrides the list defined for the router (in the "bgp" message). These IP ranges are advertised in addition to any specified groups. Leave this field blank to advertise no custom IP ranges.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

534

{ # Description-tagged IP ranges for the router to advertise.

535

"description": "A String", # User-specified description for the IP range.

536

"range": "A String", # The IP range to advertise. The value must be a CIDR-formatted string.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

537

},

538

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

539

"advertisedRoutePriority": 42, # The priority of routes advertised to this BGP peer. Where there is more than one matching route of maximum length, the routes with the lowest priority value win.

540

"bfd": { # BFD configuration for the BGP peering.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

541

# Not currently available publicly.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

542

"minReceiveInterval": 42, # The minimum interval, in milliseconds, between BFD control packets received from the peer router. The actual value is negotiated between the two routers and is equal to the greater of this value and the transmit interval of the other router.

543

# Not currently available publicly.

544

# If set, this value must be between 100 and 30000.

545

# The default is 300.

546

"minTransmitInterval": 42, # The minimum interval, in milliseconds, between BFD control packets transmitted to the peer router. The actual value is negotiated between the two routers and is equal to the greater of this value and the corresponding receive interval of the other router.

547

# Not currently available publicly.

548

# If set, this value must be between 100 and 30000.

549

# The default is 300.

550

"mode": "A String", # The BFD session initialization mode for this BGP peer. If set to ACTIVE, the Cloud Router will initiate the BFD session for this BGP peer. If set to PASSIVE, the Cloud Router will wait for the peer router to initiate the BFD session for this BGP peer. If set to DISABLED, BFD is disabled for this BGP peer. The default is PASSIVE.

551

"multiplier": 42, # The number of consecutive BFD packets that must be missed before BFD declares that a peer is unavailable.

552

# Not currently available publicly.

553

# If set, the value must be a value between 2 and 16.

554

# The default is 3.

555

"packetMode": "A String", # The BFD packet mode for this BGP peer. If set to CONTROL_AND_ECHO, BFD echo mode is enabled for this BGP peer. In this mode, if the peer router also has BFD echo mode enabled, BFD echo packets will be sent to the other router. If the peer router does not have BFD echo mode enabled, only control packets will be sent. If set to CONTROL_ONLY, BFD echo mode is disabled for this BGP peer. If this router and the peer router have a multihop connection, this should be set to CONTROL_ONLY as BFD echo mode is only supported on singlehop connections. The default is CONTROL_AND_ECHO.

556

"sessionInitializationMode": "A String", # The BFD session initialization mode for this BGP peer.

557

# Not currently available publicly.

558

# If set to ACTIVE, the Cloud Router will initiate the BFD session for this BGP peer. If set to PASSIVE, the Cloud Router will wait for the peer router to initiate the BFD session for this BGP peer. If set to DISABLED, BFD is disabled for this BGP peer. The default is PASSIVE.

559

"slowTimerInterval": 42, # The minimum interval, in milliseconds, between BFD control packets transmitted to and received from the peer router when BFD echo mode is enabled on both routers. The actual transmit and receive intervals are negotiated between the two routers and are equal to the greater of this value and the corresponding interval on the other router. If set, this value must be between 1000 and 30000. The default is 5000.

560

},

561

"enable": "A String", # The status of the BGP peer connection.

562

# Not currently available publicly.

563

# If set to FALSE, any active session with the peer is terminated and all associated routing information is removed. If set to TRUE, the peer connection can be established with routing information. The default is TRUE.

564

"interfaceName": "A String", # Name of the interface the BGP peer is associated with.

565

"ipAddress": "A String", # IP address of the interface inside Google Cloud Platform. Only IPv4 is supported.

566

"managementType": "A String", # [Output Only] The resource that configures and manages this BGP peer.

567

# - MANAGED_BY_USER is the default value and can be managed by you or other users

568

# - MANAGED_BY_ATTACHMENT is a BGP peer that is configured and managed by Cloud Interconnect, specifically by an InterconnectAttachment of type PARTNER. Google automatically creates, updates, and deletes this type of BGP peer when the PARTNER InterconnectAttachment is created, updated, or deleted.

569

"name": "A String", # Name of this BGP peer. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

570

"peerAsn": 42, # Peer BGP Autonomous System Number (ASN). Each BGP interface may use a different value.

571

"peerIpAddress": "A String", # IP address of the BGP interface outside Google Cloud Platform. Only IPv4 is supported.

572

"routerApplianceInstance": "A String", # URI of the VM instance that is used as third-party router appliances such as Next Gen Firewalls, Virtual Routers, or Router Appliances. The VM instance must be located in zones contained in the same region as this Cloud Router. The VM instance is the peer side of the BGP session.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

573

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

574

],

575

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

576

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

577

"encryptedInterconnectRouter": True or False, # Field to indicate if a router is dedicated to use with encrypted Interconnect Attachment (Encrypted Interconnect feature).

578

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

579

"interfaces": [ # Router interfaces. Each interface requires either one linked resource, (for example, linkedVpnTunnel), or IP address and IP address range (for example, ipRange), or both.

580

{

581

"ipRange": "A String", # IP address and range of the interface. The IP range must be in the RFC3927 link-local IP address space. The value must be a CIDR-formatted string, for example: 169.254.0.1/30. NOTE: Do not truncate the address as it represents the IP address of the interface.

582

"linkedInterconnectAttachment": "A String", # URI of the linked Interconnect attachment. It must be in the same region as the router. Each interface can have one linked resource, which can be a VPN tunnel, an Interconnect attachment, or a virtual machine instance.

583

"linkedVpnTunnel": "A String", # URI of the linked VPN tunnel, which must be in the same region as the router. Each interface can have one linked resource, which can be a VPN tunnel, an Interconnect attachment, or a virtual machine instance.

584

"managementType": "A String", # [Output Only] The resource that configures and manages this interface.

585

# - MANAGED_BY_USER is the default value and can be managed directly by users.

586

# - MANAGED_BY_ATTACHMENT is an interface that is configured and managed by Cloud Interconnect, specifically, by an InterconnectAttachment of type PARTNER. Google automatically creates, updates, and deletes this type of interface when the PARTNER InterconnectAttachment is created, updated, or deleted.

587

"name": "A String", # Name of this interface entry. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

588

"privateIpAddress": "A String", # The regional private internal IP address that is used to establish BGP sessions to a VM instance acting as a third-party Router Appliance, such as a Next Gen Firewall, a Virtual Router, or an SD-WAN VM.

589

"redundantInterface": "A String", # Name of the interface that will be redundant with the current interface you are creating. The redundantInterface must belong to the same Cloud Router as the interface here. To establish the BGP session to a Router Appliance VM, you must create two BGP peers. The two BGP peers must be attached to two separate interfaces that are redundant with each other. The redundant_interface must be 1-63 characters long, and comply with RFC1035. Specifically, the redundant_interface must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

590

"subnetwork": "A String", # The URL of the subnetwork resource that this interface belongs to, which must be in the same region as the Cloud Router. When you establish a BGP session to a VM instance using this interface, the VM instance must belong to the same subnetwork as the subnetwork specified here.

591

},

592

],

593

"kind": "compute#router", # [Output Only] Type of resource. Always compute#router for routers.

594

"name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

595

"nats": [ # A list of NAT services created in this router.

596

{ # Represents a Nat resource. It enables the VMs within the specified subnetworks to access Internet without external IP addresses. It specifies a list of subnetworks (and the ranges within) that want to use NAT. Customers can also provide the external IPs that would be used for NAT. GCP would auto-allocate ephemeral IPs if no external IPs are provided.

597

"drainNatIps": [ # A list of URLs of the IP resources to be drained. These IPs must be valid static external IPs that have been assigned to the NAT. These IPs should be used for updating/patching a NAT only.

598

"A String",

599

],

600

"enableEndpointIndependentMapping": True or False,

601

"icmpIdleTimeoutSec": 42, # Timeout (in seconds) for ICMP connections. Defaults to 30s if not set.

602

"logConfig": { # Configuration of logging on a NAT. # Configure logging on this NAT.

603

"enable": True or False, # Indicates whether or not to export logs. This is false by default.

604

"filter": "A String", # Specify the desired filtering of logs on this NAT. If unspecified, logs are exported for all connections handled by this NAT. This option can take one of the following values:

605

# - ERRORS_ONLY: Export logs only for connection failures.

606

# - TRANSLATIONS_ONLY: Export logs only for successful connections.

607

# - ALL: Export logs for all connections, successful and unsuccessful.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

608

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

609

"minPortsPerVm": 42, # Minimum number of ports allocated to a VM from this NAT config. If not set, a default number of ports is allocated to a VM. This is rounded up to the nearest power of 2. For example, if the value of this field is 50, at least 64 ports are allocated to a VM.

610

"name": "A String", # Unique name of this Nat service. The name must be 1-63 characters long and comply with RFC1035.

611

"natIpAllocateOption": "A String", # Specify the NatIpAllocateOption, which can take one of the following values:

612

# - MANUAL_ONLY: Uses only Nat IP addresses provided by customers. When there are not enough specified Nat IPs, the Nat service fails for new VMs.

613

# - AUTO_ONLY: Nat IPs are allocated by Google Cloud Platform; customers can't specify any Nat IPs. When choosing AUTO_ONLY, then nat_ip should be empty.

614

"natIps": [ # A list of URLs of the IP resources used for this Nat service. These IP addresses must be valid static external IP addresses assigned to the project.

615

"A String",

616

],

617

"rules": [ # A list of rules associated with this NAT.

618

{

619

"action": { # The action to be enforced for traffic that matches this rule.

620

"sourceNatActiveIps": [ # A list of URLs of the IP resources used for this NAT rule. These IP addresses must be valid static external IP addresses assigned to the project.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

621

"A String",

622

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

623

"sourceNatDrainIps": [ # A list of URLs of the IP resources to be drained. These IPs must be valid static external IPs that have been assigned to the NAT. These IPs should be used for updating/patching a NAT rule only.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

624

"A String",

625

],

626

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

627

"description": "A String", # An optional description of this rule.

628

"match": "A String", # CEL expression that specifies the match condition that egress traffic from a VM is evaluated against. If it evaluates to true, the corresponding ?action? is enforced.

629

#

630

# The following examples are valid match expressions:

631

#

632

# "inIpRange(destination.ip, '1.1.0.0/16') || inIpRange(destination.ip, '2.2.0.0/16')"

633

#

634

# "destination.ip == '1.1.0.1' || destination.ip == '8.8.8.8'"

635

"ruleNumber": 42, # An integer uniquely identifying a rule in the list. The rule number must be a positive value between 0 and 65000, and must be unique among rules within a NAT.

636

},

637

],

638

"sourceSubnetworkIpRangesToNat": "A String", # Specify the Nat option, which can take one of the following values:

639

# - ALL_SUBNETWORKS_ALL_IP_RANGES: All of the IP ranges in every Subnetwork are allowed to Nat.

640

# - ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES: All of the primary IP ranges in every Subnetwork are allowed to Nat.

641

# - LIST_OF_SUBNETWORKS: A list of Subnetworks are allowed to Nat (specified in the field subnetwork below) The default is SUBNETWORK_IP_RANGE_TO_NAT_OPTION_UNSPECIFIED. Note that if this field contains ALL_SUBNETWORKS_ALL_IP_RANGES or ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES, then there should not be any other Router.Nat section in any Router for this network in this region.

642

"subnetworks": [ # A list of Subnetwork resources whose traffic should be translated by NAT Gateway. It is used only when LIST_OF_SUBNETWORKS is selected for the SubnetworkIpRangeToNatOption above.

643

{ # Defines the IP ranges that want to use NAT for a subnetwork.

644

"name": "A String", # URL for the subnetwork resource that will use NAT.

645

"secondaryIpRangeNames": [ # A list of the secondary ranges of the Subnetwork that are allowed to use NAT. This can be populated only if "LIST_OF_SECONDARY_IP_RANGES" is one of the values in source_ip_ranges_to_nat.

646

"A String",

647

],

648

"sourceIpRangesToNat": [ # Specify the options for NAT ranges in the Subnetwork. All options of a single value are valid except NAT_IP_RANGE_OPTION_UNSPECIFIED. The only valid option with multiple values is: ["PRIMARY_IP_RANGE", "LIST_OF_SECONDARY_IP_RANGES"] Default: [ALL_IP_RANGES]

"A String",

],

},

],

"tcpEstablishedIdleTimeoutSec": 42, # Timeout (in seconds) for TCP established connections. Defaults to 1200s if not set.

654

"tcpTimeWaitTimeoutSec": 42, # Timeout (in seconds) for TCP connections that are in TIME_WAIT state. Defaults to 120s if not set.

655

"tcpTransitoryIdleTimeoutSec": 42, # Timeout (in seconds) for TCP transitory connections. Defaults to 30s if not set.

656

"udpIdleTimeoutSec": 42, # Timeout (in seconds) for UDP connections. Defaults to 30s if not set.

657

},

658

],

659

"network": "A String", # URI of the network to which this router belongs.

660

"region": "A String", # [Output Only] URI of the region where the router resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

661

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

662

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

663

}</pre>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

</div>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

667

<code class="details" id="getNatMappingInfo">getNatMappingInfo(project, region, router, filter=None, maxResults=None, natName=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

668

<pre>Retrieves runtime Nat mapping information of VM endpoints.

669

670

Args:

671

project: string, Project ID for this request. (required)

672

region: string, Name of the region for this request. (required)

673

router: string, Name of the Router resource to query for Nat Mapping information of VM endpoints. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

674

filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

675

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

676

For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

677

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

678

You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

679

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

680

To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ```

681

maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)

682

natName: string, Name of the nat service to filter the Nat Mapping information. If it is omitted, all nats for this router will be returned. Name should conform to RFC1035.

683

orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

684

685

You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

686

687

Currently, only sorting by `name` or `creationTimestamp desc` is supported.

688

pageToken: string, Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame^]

689

returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

690

691

Returns:

692

An object of the form:

693

694

{ # Contains a list of VmEndpointNatMappings.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

695

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

696

"kind": "compute#vmEndpointNatMappingsList", # [Output Only] Type of resource. Always compute#vmEndpointNatMappingsList for lists of Nat mappings of VM endpoints.

697

"nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

698

"result": [ # [Output Only] A list of Nat mapping information of VM endpoints.

699

{ # Contain information of Nat mapping for a VM endpoint (i.e., NIC).

700

"instanceName": "A String", # Name of the VM instance which the endpoint belongs to

701

"interfaceNatMappings": [

702

{ # Contain information of Nat mapping for an interface of this endpoint.

703

"drainNatIpPortRanges": [ # List of all drain IP:port-range mappings assigned to this interface. These ranges are inclusive, that is, both the first and the last ports can be used for NAT. Example: ["2.2.2.2:12345-12355", "1.1.1.1:2234-2234"].

704

"A String",

705

],

706

"natIpPortRanges": [ # A list of all IP:port-range mappings assigned to this interface. These ranges are inclusive, that is, both the first and the last ports can be used for NAT. Example: ["2.2.2.2:12345-12355", "1.1.1.1:2234-2234"].

707

"A String",

708

],

709

"numTotalDrainNatPorts": 42, # Total number of drain ports across all NAT IPs allocated to this interface. It equals to the aggregated port number in the field drain_nat_ip_port_ranges.

710

"numTotalNatPorts": 42, # Total number of ports across all NAT IPs allocated to this interface. It equals to the aggregated port number in the field nat_ip_port_ranges.

711

"ruleMappings": [ # Information about mappings provided by rules in this NAT.

712

{ # Contains information of NAT Mappings provided by a NAT Rule.

713

"drainNatIpPortRanges": [ # List of all drain IP:port-range mappings assigned to this interface by this rule. These ranges are inclusive, that is, both the first and the last ports can be used for NAT. Example: ["2.2.2.2:12345-12355", "1.1.1.1:2234-2234"].

714

"A String",

715

],

716

"natIpPortRanges": [ # A list of all IP:port-range mappings assigned to this interface by this rule. These ranges are inclusive, that is, both the first and the last ports can be used for NAT. Example: ["2.2.2.2:12345-12355", "1.1.1.1:2234-2234"].

717

"A String",

718

],

719

"numTotalDrainNatPorts": 42, # Total number of drain ports across all NAT IPs allocated to this interface by this rule. It equals the aggregated port number in the field drain_nat_ip_port_ranges.

720

"numTotalNatPorts": 42, # Total number of ports across all NAT IPs allocated to this interface by this rule. It equals the aggregated port number in the field nat_ip_port_ranges.

721

"ruleNumber": 42, # Rule number of the NAT Rule.

722

},

723

],

724

"sourceAliasIpRange": "A String", # Alias IP range for this interface endpoint. It will be a private (RFC 1918) IP range. Examples: "10.33.4.55/32", or "192.168.5.0/24".

725

"sourceVirtualIp": "A String", # Primary IP of the VM for this NIC.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

726

},

727

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

728

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

729

],

730

"selfLink": "A String", # [Output Only] Server-defined URL for this resource.

731

"warning": { # [Output Only] Informational warning message.

732

"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

733

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

734

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

735

{

736

"key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).

737

"value": "A String", # [Output Only] A warning data value corresponding to the key.

738

},

739

],

740

"message": "A String", # [Output Only] A human-readable description of the warning code.

741

},

742

}</pre>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

</div>

<code class="details" id="getNatMappingInfo_next">getNatMappingInfo_next(previous_request, previous_response)</code>

747

<pre>Retrieves the next page of results.

748

749

Args:

750

previous_request: The request for the previous page. (required)

751

previous_response: The response from the request for the previous page. (required)

752

753

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

754

A request object that you can call 'execute()' on to request the next

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

755

page. Returns None if there are no more items in the collection.

</pre>

</div>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

760

<code class="details" id="getRouterStatus">getRouterStatus(project, region, router)</code>

761

<pre>Retrieves runtime information of the specified router.

762

763

Args:

764

project: string, Project ID for this request. (required)

765

region: string, Name of the region for this request. (required)

766

router: string, Name of the Router resource to query. (required)

767

768

Returns:

769

An object of the form:

770

771

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

772

"kind": "compute#routerStatusResponse", # Type of resource.

773

"result": {

774

"bestRoutes": [ # Best routes for this router's network.

775

{ # Represents a Route resource.

776

#

777

# A route defines a path from VM instances in the VPC network to a specific destination. This destination can be inside or outside the VPC network. For more information, read the Routes overview. (== resource_for {$api_version}.routes ==)

778

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

779

"description": "A String", # An optional description of this resource. Provide this field when you create the resource.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame^]

780

"destRange": "A String", # The destination range of outgoing packets that this route applies to. Both IPv4 and IPv6 are supported.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

781

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

782

"kind": "compute#route", # [Output Only] Type of this resource. Always compute#routes for Route resources.

783

"name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit.

784

"network": "A String", # Fully-qualified URL of the network that this route applies to.

785

"nextHopGateway": "A String", # The URL to a gateway that should handle matching packets. You can only specify the internet gateway using a full or partial valid URL: projects/project/global/gateways/default-internet-gateway

786

"nextHopIlb": "A String", # The URL to a forwarding rule of type loadBalancingScheme=INTERNAL that should handle matching packets or the IP address of the forwarding Rule. For example, the following are all valid URLs:

787

# - 10.128.0.56

788

# - https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule

789

# - regions/region/forwardingRules/forwardingRule

790

"nextHopInstance": "A String", # The URL to an instance that should handle matching packets. You can specify this as a full or partial URL. For example:

791

# https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/

792

"nextHopInterconnectAttachment": "A String", # [Output Only] The URL to an InterconnectAttachment which is the next hop for the route. This field will only be populated for the dynamic routes generated by Cloud Router with a linked interconnectAttachment.

793

"nextHopIp": "A String", # The network IP address of an instance that should handle matching packets. Only IPv4 is supported.

794

"nextHopNetwork": "A String", # The URL of the local network if it should handle matching packets.

795

"nextHopPeering": "A String", # [Output Only] The network peering name that should handle matching packets, which should conform to RFC1035.

796

"nextHopVpnTunnel": "A String", # The URL to a VpnTunnel that should handle matching packets.

797

"priority": 42, # The priority of this route. Priority is used to break ties in cases where there is more than one matching route of equal prefix length. In cases where multiple routes have equal prefix length, the one with the lowest-numbered priority value wins. The default value is `1000`. The priority value must be from `0` to `65535`, inclusive.

798

"selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.

799

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

800

"tags": [ # A list of instance tags to which this route applies.

801

"A String",

802

],

803

"warnings": [ # [Output Only] If potential misconfigurations are detected for this route, this field will be populated with warning messages.

804

{

805

"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

806

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

807

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

808

{

809

"key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).

810

"value": "A String", # [Output Only] A warning data value corresponding to the key.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

811

},

812

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

813

"message": "A String", # [Output Only] A human-readable description of the warning code.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

814

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

],

},

],

"bestRoutesForRouter": [ # Best routes learned by this router.

819

{ # Represents a Route resource.

820

#

821

# A route defines a path from VM instances in the VPC network to a specific destination. This destination can be inside or outside the VPC network. For more information, read the Routes overview. (== resource_for {$api_version}.routes ==)

822

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

823

"description": "A String", # An optional description of this resource. Provide this field when you create the resource.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame^]

824

"destRange": "A String", # The destination range of outgoing packets that this route applies to. Both IPv4 and IPv6 are supported.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

825

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

826

"kind": "compute#route", # [Output Only] Type of this resource. Always compute#routes for Route resources.

827

"name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit.

828

"network": "A String", # Fully-qualified URL of the network that this route applies to.

829

"nextHopGateway": "A String", # The URL to a gateway that should handle matching packets. You can only specify the internet gateway using a full or partial valid URL: projects/project/global/gateways/default-internet-gateway

830

"nextHopIlb": "A String", # The URL to a forwarding rule of type loadBalancingScheme=INTERNAL that should handle matching packets or the IP address of the forwarding Rule. For example, the following are all valid URLs:

831

# - 10.128.0.56

832

# - https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule

833

# - regions/region/forwardingRules/forwardingRule

834

"nextHopInstance": "A String", # The URL to an instance that should handle matching packets. You can specify this as a full or partial URL. For example:

835

# https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/

836

"nextHopInterconnectAttachment": "A String", # [Output Only] The URL to an InterconnectAttachment which is the next hop for the route. This field will only be populated for the dynamic routes generated by Cloud Router with a linked interconnectAttachment.

837

"nextHopIp": "A String", # The network IP address of an instance that should handle matching packets. Only IPv4 is supported.

838

"nextHopNetwork": "A String", # The URL of the local network if it should handle matching packets.

839

"nextHopPeering": "A String", # [Output Only] The network peering name that should handle matching packets, which should conform to RFC1035.

840

"nextHopVpnTunnel": "A String", # The URL to a VpnTunnel that should handle matching packets.

841

"priority": 42, # The priority of this route. Priority is used to break ties in cases where there is more than one matching route of equal prefix length. In cases where multiple routes have equal prefix length, the one with the lowest-numbered priority value wins. The default value is `1000`. The priority value must be from `0` to `65535`, inclusive.

842

"selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.

843

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

844

"tags": [ # A list of instance tags to which this route applies.

845

"A String",

846

],

847

"warnings": [ # [Output Only] If potential misconfigurations are detected for this route, this field will be populated with warning messages.

848

{

849

"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

850

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

851

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

852

{

853

"key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).

854

"value": "A String", # [Output Only] A warning data value corresponding to the key.

855

},

856

],

857

"message": "A String", # [Output Only] A human-readable description of the warning code.

},

],

},

],

"bgpPeerStatus": [

{

"advertisedRoutes": [ # Routes that were advertised to the remote BGP peer

865

{ # Represents a Route resource.

866

#

867

# A route defines a path from VM instances in the VPC network to a specific destination. This destination can be inside or outside the VPC network. For more information, read the Routes overview. (== resource_for {$api_version}.routes ==)

868

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

869

"description": "A String", # An optional description of this resource. Provide this field when you create the resource.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame^]

870

"destRange": "A String", # The destination range of outgoing packets that this route applies to. Both IPv4 and IPv6 are supported.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

871

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

872

"kind": "compute#route", # [Output Only] Type of this resource. Always compute#routes for Route resources.

873

"name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit.

874

"network": "A String", # Fully-qualified URL of the network that this route applies to.

875

"nextHopGateway": "A String", # The URL to a gateway that should handle matching packets. You can only specify the internet gateway using a full or partial valid URL: projects/project/global/gateways/default-internet-gateway

876

"nextHopIlb": "A String", # The URL to a forwarding rule of type loadBalancingScheme=INTERNAL that should handle matching packets or the IP address of the forwarding Rule. For example, the following are all valid URLs:

877

# - 10.128.0.56

878

# - https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule

879

# - regions/region/forwardingRules/forwardingRule

880

"nextHopInstance": "A String", # The URL to an instance that should handle matching packets. You can specify this as a full or partial URL. For example:

881

# https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/

882

"nextHopInterconnectAttachment": "A String", # [Output Only] The URL to an InterconnectAttachment which is the next hop for the route. This field will only be populated for the dynamic routes generated by Cloud Router with a linked interconnectAttachment.

883

"nextHopIp": "A String", # The network IP address of an instance that should handle matching packets. Only IPv4 is supported.

884

"nextHopNetwork": "A String", # The URL of the local network if it should handle matching packets.

885

"nextHopPeering": "A String", # [Output Only] The network peering name that should handle matching packets, which should conform to RFC1035.

886

"nextHopVpnTunnel": "A String", # The URL to a VpnTunnel that should handle matching packets.

887

"priority": 42, # The priority of this route. Priority is used to break ties in cases where there is more than one matching route of equal prefix length. In cases where multiple routes have equal prefix length, the one with the lowest-numbered priority value wins. The default value is `1000`. The priority value must be from `0` to `65535`, inclusive.

888

"selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.

889

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

890

"tags": [ # A list of instance tags to which this route applies.

891

"A String",

892

],

893

"warnings": [ # [Output Only] If potential misconfigurations are detected for this route, this field will be populated with warning messages.

894

{

895

"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

896

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

897

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

898

{

899

"key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).

900

"value": "A String", # [Output Only] A warning data value corresponding to the key.

901

},

902

],

903

"message": "A String", # [Output Only] A human-readable description of the warning code.

},

],

},

],

"bfdStatus": { # Next free: 15

909

"bfdSessionInitializationMode": "A String", # The BFD session initialization mode for this BGP peer. If set to ACTIVE, the Cloud Router will initiate the BFD session for this BGP peer. If set to PASSIVE, the Cloud Router will wait for the peer router to initiate the BFD session for this BGP peer. If set to DISABLED, BFD is disabled for this BGP peer.

910

"configUpdateTimestampMicros": "A String", # Unix timestamp of the most recent config update.

911

"controlPacketCounts": { # Control packet counts for the current BFD session.

912

"numRx": 42, # Number of packets received since the beginning of the current BFD session.

913

"numRxRejected": 42, # Number of packets received that were rejected because of errors since the beginning of the current BFD session.

914

"numRxSuccessful": 42, # Number of packets received that were successfully processed since the beginning of the current BFD session.

915

"numTx": 42, # Number of packets transmitted since the beginning of the current BFD session.

916

},

917

"controlPacketIntervals": [ # Inter-packet time interval statistics for control packets.

918

{ # Next free: 7

919

"avgMs": "A String", # Average observed inter-packet interval in milliseconds.

920

"duration": "A String", # From how long ago in the past these intervals were observed.

921

"maxMs": "A String", # Maximum observed inter-packet interval in milliseconds.

922

"minMs": "A String", # Minimum observed inter-packet interval in milliseconds.

923

"numIntervals": "A String", # Number of inter-packet intervals from which these statistics were derived.

924

"type": "A String", # The type of packets for which inter-packet intervals were computed.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

925

},

926

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

927

"echoPacketCounts": { # Echo packet counts for the current BFD session.

928

"numRx": 42, # Number of packets received since the beginning of the current BFD session.

929

"numRxRejected": 42, # Number of packets received that were rejected because of errors since the beginning of the current BFD session.

930

"numRxSuccessful": 42, # Number of packets received that were successfully processed since the beginning of the current BFD session.

931

"numTx": 42, # Number of packets transmitted since the beginning of the current BFD session.

932

},

933

"echoPacketIntervals": [ # Inter-packet time interval statistics for echo packets.

934

{ # Next free: 7

935

"avgMs": "A String", # Average observed inter-packet interval in milliseconds.

936

"duration": "A String", # From how long ago in the past these intervals were observed.

937

"maxMs": "A String", # Maximum observed inter-packet interval in milliseconds.

938

"minMs": "A String", # Minimum observed inter-packet interval in milliseconds.

939

"numIntervals": "A String", # Number of inter-packet intervals from which these statistics were derived.

940

"type": "A String", # The type of packets for which inter-packet intervals were computed.

941

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

942

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

943

"localDiagnostic": "A String", # The diagnostic code specifies the local system's reason for the last change in session state. This allows remote systems to determine the reason that the previous session failed, for example. These diagnostic codes are specified in section 4.1 of RFC5880

944

"localState": "A String", # The current BFD session state as seen by the transmitting system. These states are specified in section 4.1 of RFC5880

945

"negotiatedLocalControlTxIntervalMs": 42, # Negotiated transmit interval for control packets.

946

"negotiatedLocalEchoTxIntervalMs": 42, # Negotiated transmit interval for echo packets.

947

"rxPacket": { # The most recent Rx control packet for this BFD session.

948

"authenticationPresent": True or False, # The Authentication Present bit of the BFD packet. This is specified in section 4.1 of RFC5880

949

"controlPlaneIndependent": True or False, # The Control Plane Independent bit of the BFD packet. This is specified in section 4.1 of RFC5880

950

"demand": True or False, # The demand bit of the BFD packet. This is specified in section 4.1 of RFC5880

951

"diagnostic": "A String", # The diagnostic code specifies the local system's reason for the last change in session state. This allows remote systems to determine the reason that the previous session failed, for example. These diagnostic codes are specified in section 4.1 of RFC5880

952

"final": True or False, # The Final bit of the BFD packet. This is specified in section 4.1 of RFC5880

953

"length": 42, # The length of the BFD Control packet in bytes. This is specified in section 4.1 of RFC5880

954

"minEchoRxIntervalMs": 42, # The Required Min Echo RX Interval value in the BFD packet. This is specified in section 4.1 of RFC5880

955

"minRxIntervalMs": 42, # The Required Min RX Interval value in the BFD packet. This is specified in section 4.1 of RFC5880

956

"minTxIntervalMs": 42, # The Desired Min TX Interval value in the BFD packet. This is specified in section 4.1 of RFC5880

957

"multiplier": 42, # The detection time multiplier of the BFD packet. This is specified in section 4.1 of RFC5880

958

"multipoint": True or False, # The multipoint bit of the BFD packet. This is specified in section 4.1 of RFC5880

959

"myDiscriminator": 42, # The My Discriminator value in the BFD packet. This is specified in section 4.1 of RFC5880

960

"poll": True or False, # The Poll bit of the BFD packet. This is specified in section 4.1 of RFC5880

961

"state": "A String", # The current BFD session state as seen by the transmitting system. These states are specified in section 4.1 of RFC5880

962

"version": 42, # The version number of the BFD protocol, as specified in section 4.1 of RFC5880.

963

"yourDiscriminator": 42, # The Your Discriminator value in the BFD packet. This is specified in section 4.1 of RFC5880

964

},

965

"txPacket": { # The most recent Tx control packet for this BFD session.

966

"authenticationPresent": True or False, # The Authentication Present bit of the BFD packet. This is specified in section 4.1 of RFC5880

967

"controlPlaneIndependent": True or False, # The Control Plane Independent bit of the BFD packet. This is specified in section 4.1 of RFC5880

968

"demand": True or False, # The demand bit of the BFD packet. This is specified in section 4.1 of RFC5880

969

"diagnostic": "A String", # The diagnostic code specifies the local system's reason for the last change in session state. This allows remote systems to determine the reason that the previous session failed, for example. These diagnostic codes are specified in section 4.1 of RFC5880

970

"final": True or False, # The Final bit of the BFD packet. This is specified in section 4.1 of RFC5880

971

"length": 42, # The length of the BFD Control packet in bytes. This is specified in section 4.1 of RFC5880

972

"minEchoRxIntervalMs": 42, # The Required Min Echo RX Interval value in the BFD packet. This is specified in section 4.1 of RFC5880

973

"minRxIntervalMs": 42, # The Required Min RX Interval value in the BFD packet. This is specified in section 4.1 of RFC5880

974

"minTxIntervalMs": 42, # The Desired Min TX Interval value in the BFD packet. This is specified in section 4.1 of RFC5880

975

"multiplier": 42, # The detection time multiplier of the BFD packet. This is specified in section 4.1 of RFC5880

976

"multipoint": True or False, # The multipoint bit of the BFD packet. This is specified in section 4.1 of RFC5880

977

"myDiscriminator": 42, # The My Discriminator value in the BFD packet. This is specified in section 4.1 of RFC5880

978

"poll": True or False, # The Poll bit of the BFD packet. This is specified in section 4.1 of RFC5880

979

"state": "A String", # The current BFD session state as seen by the transmitting system. These states are specified in section 4.1 of RFC5880

980

"version": 42, # The version number of the BFD protocol, as specified in section 4.1 of RFC5880.

981

"yourDiscriminator": 42, # The Your Discriminator value in the BFD packet. This is specified in section 4.1 of RFC5880

982

},

983

"uptimeMs": "A String", # Session uptime in milliseconds. Value will be 0 if session is not up.

984

"usingEchoMode": True or False, # Indicates if echo mode is currently being used.

Sai Cheemalapati

c30d2b5

2017-03-13 12:12:03 -0400

[diff] [blame]

985

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

986

"ipAddress": "A String", # IP address of the local BGP interface.

987

"linkedVpnTunnel": "A String", # URL of the VPN tunnel that this BGP peer controls.

988

"name": "A String", # Name of this BGP peer. Unique within the Routers resource.

989

"numLearnedRoutes": 42, # Number of routes learned from the remote BGP Peer.

990

"peerIpAddress": "A String", # IP address of the remote BGP interface.

991

"state": "A String", # BGP state as specified in RFC1771.

992

"status": "A String", # Status of the BGP peer: {UP, DOWN}

993

"uptime": "A String", # Time this session has been up. Format: 14 years, 51 weeks, 6 days, 23 hours, 59 minutes, 59 seconds

994

"uptimeSeconds": "A String", # Time this session has been up, in seconds. Format: 145

},

],

"natStatus": [

{ # Status of a NAT contained in this router.

999

"autoAllocatedNatIps": [ # A list of IPs auto-allocated for NAT. Example: ["1.1.1.1", "129.2.16.89"]

1000

"A String",

1001

],

1002

"drainAutoAllocatedNatIps": [ # A list of IPs auto-allocated for NAT that are in drain mode. Example: ["1.1.1.1", "179.12.26.133"].

1003

"A String",

1004

],

1005

"drainUserAllocatedNatIps": [ # A list of IPs user-allocated for NAT that are in drain mode. Example: ["1.1.1.1", "179.12.26.133"].

1006

"A String",

1007

],

1008

"minExtraNatIpsNeeded": 42, # The number of extra IPs to allocate. This will be greater than 0 only if user-specified IPs are NOT enough to allow all configured VMs to use NAT. This value is meaningful only when auto-allocation of NAT IPs is *not* used.

1009

"name": "A String", # Unique name of this NAT.

1010

"numVmEndpointsWithNatMappings": 42, # Number of VM endpoints (i.e., Nics) that can use NAT.

1011

"ruleStatus": [ # Status of rules in this NAT.

1012

{ # Status of a NAT Rule contained in this NAT.

1013

"activeNatIps": [ # A list of active IPs for NAT. Example: ["1.1.1.1", "179.12.26.133"].

1014

"A String",

1015

],

1016

"drainNatIps": [ # A list of IPs for NAT that are in drain mode. Example: ["1.1.1.1", "179.12.26.133"].

1017

"A String",

1018

],

1019

"minExtraIpsNeeded": 42, # The number of extra IPs to allocate. This will be greater than 0 only if the existing IPs in this NAT Rule are NOT enough to allow all configured VMs to use NAT.

1020

"numVmEndpointsWithNatMappings": 42, # Number of VM endpoints (i.e., NICs) that have NAT Mappings from this NAT Rule.

1021

"ruleNumber": 42, # Rule number of the rule.

1022

},

1023

],

1024

"userAllocatedNatIpResources": [ # A list of fully qualified URLs of reserved IP address resources.

1025

"A String",

1026

],

1027

"userAllocatedNatIps": [ # A list of IPs user-allocated for NAT. They will be raw IP strings like "179.12.26.133".

"A String",

],

},

],

"network": "A String", # URI of the network to which this router belongs.

1033

},

1034

}</pre>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1038

<code class="details" id="insert">insert(project, region, body=None, requestId=None)</code>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1039

<pre>Creates a Router resource in the specified project and region using the data included in the request.

1040

1041

Args:

1042

project: string, Project ID for this request. (required)

1043

region: string, Name of the region for this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1044

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1045

The object takes the form of:

1046

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1047

{ # Represents a Cloud Router resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1048

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1049

# For more information about Cloud Router, read the Cloud Router overview.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1050

"bgp": { # BGP information specific to this router.

1051

"advertiseMode": "A String", # User-specified flag to indicate which mode to use for advertisement. The options are DEFAULT or CUSTOM.

1052

"advertisedGroups": [ # User-specified list of prefix groups to advertise in custom mode. This field can only be populated if advertise_mode is CUSTOM and is advertised to all peers of the router. These groups will be advertised in addition to any specified prefixes. Leave this field blank to advertise no custom groups.

1053

"A String",

1054

],

1055

"advertisedIpRanges": [ # User-specified list of individual IP ranges to advertise in custom mode. This field can only be populated if advertise_mode is CUSTOM and is advertised to all peers of the router. These IP ranges will be advertised in addition to any specified groups. Leave this field blank to advertise no custom IP ranges.

1056

{ # Description-tagged IP ranges for the router to advertise.

1057

"description": "A String", # User-specified description for the IP range.

1058

"range": "A String", # The IP range to advertise. The value must be a CIDR-formatted string.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1059

},

1060

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1061

"asn": 42, # Local BGP Autonomous System Number (ASN). Must be an RFC6996 private ASN, either 16-bit or 32-bit. The value will be fixed for this router resource. All VPN tunnels that link to this router will have the same local ASN.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1062

"keepaliveInterval": 42, # The interval in seconds between BGP keepalive messages that are sent to the peer.

1063

# Not currently available publicly.

1064

# Hold time is three times the interval at which keepalive messages are sent, and the hold time is the maximum number of seconds allowed to elapse between successive keepalive messages that BGP receives from a peer.

1065

# BGP will use the smaller of either the local hold time value or the peer's hold time value as the hold time for the BGP connection between the two peers.

1066

# If set, this value must be between 1 and 120. The default is 20.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1067

},

1068

"bgpPeers": [ # BGP information that must be configured into the routing stack to establish BGP peering. This information must specify the peer ASN and either the interface name, IP address, or peer IP address. Please refer to RFC4273.

1069

{

1070

"advertiseMode": "A String", # User-specified flag to indicate which mode to use for advertisement.

1071

"advertisedGroups": [ # User-specified list of prefix groups to advertise in custom mode, which can take one of the following options:

1072

# - ALL_SUBNETS: Advertises all available subnets, including peer VPC subnets.

1073

# - ALL_VPC_SUBNETS: Advertises the router's own VPC subnets.

1074

# - ALL_PEER_VPC_SUBNETS: Advertises peer subnets of the router's VPC network. Note that this field can only be populated if advertise_mode is CUSTOM and overrides the list defined for the router (in the "bgp" message). These groups are advertised in addition to any specified prefixes. Leave this field blank to advertise no custom groups.

1075

"A String",

1076

],

1077

"advertisedIpRanges": [ # User-specified list of individual IP ranges to advertise in custom mode. This field can only be populated if advertise_mode is CUSTOM and overrides the list defined for the router (in the "bgp" message). These IP ranges are advertised in addition to any specified groups. Leave this field blank to advertise no custom IP ranges.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1078

{ # Description-tagged IP ranges for the router to advertise.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1079

"description": "A String", # User-specified description for the IP range.

1080

"range": "A String", # The IP range to advertise. The value must be a CIDR-formatted string.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

1081

},

1082

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1083

"advertisedRoutePriority": 42, # The priority of routes advertised to this BGP peer. Where there is more than one matching route of maximum length, the routes with the lowest priority value win.

1084

"bfd": { # BFD configuration for the BGP peering.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1085

# Not currently available publicly.

1086

"minReceiveInterval": 42, # The minimum interval, in milliseconds, between BFD control packets received from the peer router. The actual value is negotiated between the two routers and is equal to the greater of this value and the transmit interval of the other router.

1087

# Not currently available publicly.

1088

# If set, this value must be between 100 and 30000.

1089

# The default is 300.

1090

"minTransmitInterval": 42, # The minimum interval, in milliseconds, between BFD control packets transmitted to the peer router. The actual value is negotiated between the two routers and is equal to the greater of this value and the corresponding receive interval of the other router.

1091

# Not currently available publicly.

1092

# If set, this value must be between 100 and 30000.

1093

# The default is 300.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1094

"mode": "A String", # The BFD session initialization mode for this BGP peer. If set to ACTIVE, the Cloud Router will initiate the BFD session for this BGP peer. If set to PASSIVE, the Cloud Router will wait for the peer router to initiate the BFD session for this BGP peer. If set to DISABLED, BFD is disabled for this BGP peer. The default is PASSIVE.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1095

"multiplier": 42, # The number of consecutive BFD packets that must be missed before BFD declares that a peer is unavailable.

1096

# Not currently available publicly.

1097

# If set, the value must be a value between 2 and 16.

1098

# The default is 3.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1099

"packetMode": "A String", # The BFD packet mode for this BGP peer. If set to CONTROL_AND_ECHO, BFD echo mode is enabled for this BGP peer. In this mode, if the peer router also has BFD echo mode enabled, BFD echo packets will be sent to the other router. If the peer router does not have BFD echo mode enabled, only control packets will be sent. If set to CONTROL_ONLY, BFD echo mode is disabled for this BGP peer. If this router and the peer router have a multihop connection, this should be set to CONTROL_ONLY as BFD echo mode is only supported on singlehop connections. The default is CONTROL_AND_ECHO.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1100

"sessionInitializationMode": "A String", # The BFD session initialization mode for this BGP peer.

1101

# Not currently available publicly.

1102

# If set to ACTIVE, the Cloud Router will initiate the BFD session for this BGP peer. If set to PASSIVE, the Cloud Router will wait for the peer router to initiate the BFD session for this BGP peer. If set to DISABLED, BFD is disabled for this BGP peer. The default is PASSIVE.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1103

"slowTimerInterval": 42, # The minimum interval, in milliseconds, between BFD control packets transmitted to and received from the peer router when BFD echo mode is enabled on both routers. The actual transmit and receive intervals are negotiated between the two routers and are equal to the greater of this value and the corresponding interval on the other router. If set, this value must be between 1000 and 30000. The default is 5000.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1104

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1105

"enable": "A String", # The status of the BGP peer connection.

1106

# Not currently available publicly.

1107

# If set to FALSE, any active session with the peer is terminated and all associated routing information is removed. If set to TRUE, the peer connection can be established with routing information. The default is TRUE.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1108

"interfaceName": "A String", # Name of the interface the BGP peer is associated with.

1109

"ipAddress": "A String", # IP address of the interface inside Google Cloud Platform. Only IPv4 is supported.

1110

"managementType": "A String", # [Output Only] The resource that configures and manages this BGP peer.

1111

# - MANAGED_BY_USER is the default value and can be managed by you or other users

1112

# - MANAGED_BY_ATTACHMENT is a BGP peer that is configured and managed by Cloud Interconnect, specifically by an InterconnectAttachment of type PARTNER. Google automatically creates, updates, and deletes this type of BGP peer when the PARTNER InterconnectAttachment is created, updated, or deleted.

1113

"name": "A String", # Name of this BGP peer. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

1114

"peerAsn": 42, # Peer BGP Autonomous System Number (ASN). Each BGP interface may use a different value.

1115

"peerIpAddress": "A String", # IP address of the BGP interface outside Google Cloud Platform. Only IPv4 is supported.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1116

"routerApplianceInstance": "A String", # URI of the VM instance that is used as third-party router appliances such as Next Gen Firewalls, Virtual Routers, or Router Appliances. The VM instance must be located in zones contained in the same region as this Cloud Router. The VM instance is the peer side of the BGP session.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1117

},

1118

],

1119

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

1120

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1121

"encryptedInterconnectRouter": True or False, # Field to indicate if a router is dedicated to use with encrypted Interconnect Attachment (Encrypted Interconnect feature).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1122

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

1123

"interfaces": [ # Router interfaces. Each interface requires either one linked resource, (for example, linkedVpnTunnel), or IP address and IP address range (for example, ipRange), or both.

1124

{

1125

"ipRange": "A String", # IP address and range of the interface. The IP range must be in the RFC3927 link-local IP address space. The value must be a CIDR-formatted string, for example: 169.254.0.1/30. NOTE: Do not truncate the address as it represents the IP address of the interface.

1126

"linkedInterconnectAttachment": "A String", # URI of the linked Interconnect attachment. It must be in the same region as the router. Each interface can have one linked resource, which can be a VPN tunnel, an Interconnect attachment, or a virtual machine instance.

1127

"linkedVpnTunnel": "A String", # URI of the linked VPN tunnel, which must be in the same region as the router. Each interface can have one linked resource, which can be a VPN tunnel, an Interconnect attachment, or a virtual machine instance.

1128

"managementType": "A String", # [Output Only] The resource that configures and manages this interface.

1129

# - MANAGED_BY_USER is the default value and can be managed directly by users.

1130

# - MANAGED_BY_ATTACHMENT is an interface that is configured and managed by Cloud Interconnect, specifically, by an InterconnectAttachment of type PARTNER. Google automatically creates, updates, and deletes this type of interface when the PARTNER InterconnectAttachment is created, updated, or deleted.

1131

"name": "A String", # Name of this interface entry. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1132

"privateIpAddress": "A String", # The regional private internal IP address that is used to establish BGP sessions to a VM instance acting as a third-party Router Appliance, such as a Next Gen Firewall, a Virtual Router, or an SD-WAN VM.

1133

"redundantInterface": "A String", # Name of the interface that will be redundant with the current interface you are creating. The redundantInterface must belong to the same Cloud Router as the interface here. To establish the BGP session to a Router Appliance VM, you must create two BGP peers. The two BGP peers must be attached to two separate interfaces that are redundant with each other. The redundant_interface must be 1-63 characters long, and comply with RFC1035. Specifically, the redundant_interface must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

1134

"subnetwork": "A String", # The URL of the subnetwork resource that this interface belongs to, which must be in the same region as the Cloud Router. When you establish a BGP session to a VM instance using this interface, the VM instance must belong to the same subnetwork as the subnetwork specified here.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1135

},

1136

],

1137

"kind": "compute#router", # [Output Only] Type of resource. Always compute#router for routers.

1138

"name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

1139

"nats": [ # A list of NAT services created in this router.

1140

{ # Represents a Nat resource. It enables the VMs within the specified subnetworks to access Internet without external IP addresses. It specifies a list of subnetworks (and the ranges within) that want to use NAT. Customers can also provide the external IPs that would be used for NAT. GCP would auto-allocate ephemeral IPs if no external IPs are provided.

1141

"drainNatIps": [ # A list of URLs of the IP resources to be drained. These IPs must be valid static external IPs that have been assigned to the NAT. These IPs should be used for updating/patching a NAT only.

1142

"A String",

1143

],

1144

"enableEndpointIndependentMapping": True or False,

1145

"icmpIdleTimeoutSec": 42, # Timeout (in seconds) for ICMP connections. Defaults to 30s if not set.

1146

"logConfig": { # Configuration of logging on a NAT. # Configure logging on this NAT.

1147

"enable": True or False, # Indicates whether or not to export logs. This is false by default.

1148

"filter": "A String", # Specify the desired filtering of logs on this NAT. If unspecified, logs are exported for all connections handled by this NAT. This option can take one of the following values:

1149

# - ERRORS_ONLY: Export logs only for connection failures.

1150

# - TRANSLATIONS_ONLY: Export logs only for successful connections.

1151

# - ALL: Export logs for all connections, successful and unsuccessful.

1152

},

1153

"minPortsPerVm": 42, # Minimum number of ports allocated to a VM from this NAT config. If not set, a default number of ports is allocated to a VM. This is rounded up to the nearest power of 2. For example, if the value of this field is 50, at least 64 ports are allocated to a VM.

1154

"name": "A String", # Unique name of this Nat service. The name must be 1-63 characters long and comply with RFC1035.

1155

"natIpAllocateOption": "A String", # Specify the NatIpAllocateOption, which can take one of the following values:

1156

# - MANUAL_ONLY: Uses only Nat IP addresses provided by customers. When there are not enough specified Nat IPs, the Nat service fails for new VMs.

1157

# - AUTO_ONLY: Nat IPs are allocated by Google Cloud Platform; customers can't specify any Nat IPs. When choosing AUTO_ONLY, then nat_ip should be empty.

1158

"natIps": [ # A list of URLs of the IP resources used for this Nat service. These IP addresses must be valid static external IP addresses assigned to the project.

1159

"A String",

1160

],

1161

"rules": [ # A list of rules associated with this NAT.

1162

{

1163

"action": { # The action to be enforced for traffic that matches this rule.

1164

"sourceNatActiveIps": [ # A list of URLs of the IP resources used for this NAT rule. These IP addresses must be valid static external IP addresses assigned to the project.

1165

"A String",

1166

],

1167

"sourceNatDrainIps": [ # A list of URLs of the IP resources to be drained. These IPs must be valid static external IPs that have been assigned to the NAT. These IPs should be used for updating/patching a NAT rule only.

"A String",

],

},

"description": "A String", # An optional description of this rule.

1172

"match": "A String", # CEL expression that specifies the match condition that egress traffic from a VM is evaluated against. If it evaluates to true, the corresponding ?action? is enforced.

1173

#

1174

# The following examples are valid match expressions:

1175

#

1176

# "inIpRange(destination.ip, '1.1.0.0/16') || inIpRange(destination.ip, '2.2.0.0/16')"

1177

#

1178

# "destination.ip == '1.1.0.1' || destination.ip == '8.8.8.8'"

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1179

"ruleNumber": 42, # An integer uniquely identifying a rule in the list. The rule number must be a positive value between 0 and 65000, and must be unique among rules within a NAT.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1180

},

1181

],

1182

"sourceSubnetworkIpRangesToNat": "A String", # Specify the Nat option, which can take one of the following values:

1183

# - ALL_SUBNETWORKS_ALL_IP_RANGES: All of the IP ranges in every Subnetwork are allowed to Nat.

1184

# - ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES: All of the primary IP ranges in every Subnetwork are allowed to Nat.

1185

# - LIST_OF_SUBNETWORKS: A list of Subnetworks are allowed to Nat (specified in the field subnetwork below) The default is SUBNETWORK_IP_RANGE_TO_NAT_OPTION_UNSPECIFIED. Note that if this field contains ALL_SUBNETWORKS_ALL_IP_RANGES or ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES, then there should not be any other Router.Nat section in any Router for this network in this region.

1186

"subnetworks": [ # A list of Subnetwork resources whose traffic should be translated by NAT Gateway. It is used only when LIST_OF_SUBNETWORKS is selected for the SubnetworkIpRangeToNatOption above.

1187

{ # Defines the IP ranges that want to use NAT for a subnetwork.

1188

"name": "A String", # URL for the subnetwork resource that will use NAT.

1189

"secondaryIpRangeNames": [ # A list of the secondary ranges of the Subnetwork that are allowed to use NAT. This can be populated only if "LIST_OF_SECONDARY_IP_RANGES" is one of the values in source_ip_ranges_to_nat.

1190

"A String",

1191

],

1192

"sourceIpRangesToNat": [ # Specify the options for NAT ranges in the Subnetwork. All options of a single value are valid except NAT_IP_RANGE_OPTION_UNSPECIFIED. The only valid option with multiple values is: ["PRIMARY_IP_RANGE", "LIST_OF_SECONDARY_IP_RANGES"] Default: [ALL_IP_RANGES]

"A String",

],

},

],

"tcpEstablishedIdleTimeoutSec": 42, # Timeout (in seconds) for TCP established connections. Defaults to 1200s if not set.

1198

"tcpTimeWaitTimeoutSec": 42, # Timeout (in seconds) for TCP connections that are in TIME_WAIT state. Defaults to 120s if not set.

1199

"tcpTransitoryIdleTimeoutSec": 42, # Timeout (in seconds) for TCP transitory connections. Defaults to 30s if not set.

1200

"udpIdleTimeoutSec": 42, # Timeout (in seconds) for UDP connections. Defaults to 30s if not set.

1201

},

1202

],

1203

"network": "A String", # URI of the network to which this router belongs.

1204

"region": "A String", # [Output Only] URI of the region where the router resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

1205

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

1206

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

1207

}

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1208

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1209

requestId: string, 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.

1210

1211

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.

1212

1213

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1214

1215

Returns:

1216

An object of the form:

1217

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1218

{ # Represents an Operation resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1219

#

1220

# Google Compute Engine has three Operation resources:

1221

#

1222

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

1223

#

1224

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

1225

#

1226

# Operations can be global, regional or zonal.

1227

# - For global operations, use the `globalOperations` resource.

1228

# - For regional operations, use the `regionOperations` resource.

1229

# - For zonal operations, use the `zonalOperations` resource.

1230

#

1231

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

1232

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

1233

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

1234

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

1235

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

1236

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

1237

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1238

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1239

"code": "A String", # [Output Only] The error type identifier for this error.

1240

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

1241

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1242

},

1243

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1244

},

1245

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

1246

"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.

1247

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

1248

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

1249

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame^]

1250

"metadata": { # `Any` contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message. # [Output Only] Service-specific metadata attached to this operation.

1251

#

1252

# Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type.

1253

#

1254

# Example 1: Pack and unpack a message in C++.

1255

#

1256

# Foo foo = ...; Any any; any.PackFrom(foo); ... if (any.UnpackTo(&foo)) { ... }

1257

#

1258

# Example 2: Pack and unpack a message in Java.

1259

#

1260

# Foo foo = ...; Any any = Any.pack(foo); ... if (any.is(Foo.class)) { foo = any.unpack(Foo.class); }

1261

#

1262

# Example 3: Pack and unpack a message in Python.

1263

#

1264

# foo = Foo(...) any = Any() any.Pack(foo) ... if any.Is(Foo.DESCRIPTOR): any.Unpack(foo) ...

1265

#

1266

# Example 4: Pack and unpack a message in Go

1267

#

1268

# foo := &pb.Foo{...} any, err := anypb.New(foo) if err != nil { ... } ... foo := &pb.Foo{} if err := any.UnmarshalTo(foo); err != nil { ... }

1269

#

1270

# The pack methods provided by protobuf library will by default use 'type.googleapis.com/full.type.name' as the type URL and the unpack methods only use the fully qualified type name after the last '/' in the type URL, for example "foo.bar.com/x/y.z" will yield type name "y.z".

#

#

#

# JSON ==== The JSON representation of an `Any` value uses the regular representation of the deserialized, embedded message, with an additional field `@type` which contains the type URL. Example:

1275

#

1276

# package google.profile; message Person { string first_name = 1; string last_name = 2; }

1277

#

1278

# { "@type": "type.googleapis.com/google.profile.Person", "firstName": , "lastName": }

1279

#

1280

# If the embedded message type is well-known and has a custom JSON representation, that representation will be embedded adding a field `value` which holds the custom JSON in addition to the `@type` field. Example (for message [google.protobuf.Duration][]):

1281

#

1282

# { "@type": "type.googleapis.com/google.protobuf.Duration", "value": "1.212s" }

1283

"typeUrl": "A String", # A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in `path/google.protobuf.Duration`). The name should be in a canonical form (e.g., leading "." is not accepted).

1284

#

1285

# In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme `http`, `https`, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:

1286

#

1287

# * If no scheme is provided, `https` is assumed. * An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error. * Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)

1288

#

1289

# Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.

1290

#

1291

# Schemes other than `http`, `https` (or the empty scheme) might be used with implementation specific semantics.

1292

"value": "A String", # Must be a valid serialized protocol buffer of the above specified type.

1293

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1294

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame^]

1295

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1296

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

1297

"progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.

1298

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

1299

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

1300

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

1301

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

1302

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

1303

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

1304

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

1305

"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.

1306

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

1307

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

1308

{

1309

"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

1310

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

1311

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

1312

{

1313

"key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).

1314

"value": "A String", # [Output Only] A warning data value corresponding to the key.

1315

},

1316

],

1317

"message": "A String", # [Output Only] A human-readable description of the warning code.

1318

},

1319

],

1320

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

1321

}</pre>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

</div>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1325

<code class="details" id="list">list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</code>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1326

<pre>Retrieves a list of Router resources available to the specified project.

1327

1328

Args:

1329

project: string, Project ID for this request. (required)

1330

region: string, Name of the region for this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1331

filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1332

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1333

For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1334

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1335

You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1336

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1337

To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ```

1338

maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)

1339

orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

1340

1341

You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

1342

1343

Currently, only sorting by `name` or `creationTimestamp desc` is supported.

1344

pageToken: string, Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame^]

1345

returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1346

1347

Returns:

1348

An object of the form:

1349

1350

{ # Contains a list of Router resources.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1351

"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.

1352

"items": [ # A list of Router resources.

1353

{ # Represents a Cloud Router resource.

1354

#

1355

# For more information about Cloud Router, read the Cloud Router overview.

1356

"bgp": { # BGP information specific to this router.

1357

"advertiseMode": "A String", # User-specified flag to indicate which mode to use for advertisement. The options are DEFAULT or CUSTOM.

1358

"advertisedGroups": [ # User-specified list of prefix groups to advertise in custom mode. This field can only be populated if advertise_mode is CUSTOM and is advertised to all peers of the router. These groups will be advertised in addition to any specified prefixes. Leave this field blank to advertise no custom groups.

1359

"A String",

1360

],

1361

"advertisedIpRanges": [ # User-specified list of individual IP ranges to advertise in custom mode. This field can only be populated if advertise_mode is CUSTOM and is advertised to all peers of the router. These IP ranges will be advertised in addition to any specified groups. Leave this field blank to advertise no custom IP ranges.

1362

{ # Description-tagged IP ranges for the router to advertise.

1363

"description": "A String", # User-specified description for the IP range.

1364

"range": "A String", # The IP range to advertise. The value must be a CIDR-formatted string.

1365

},

1366

],

1367

"asn": 42, # Local BGP Autonomous System Number (ASN). Must be an RFC6996 private ASN, either 16-bit or 32-bit. The value will be fixed for this router resource. All VPN tunnels that link to this router will have the same local ASN.

1368

"keepaliveInterval": 42, # The interval in seconds between BGP keepalive messages that are sent to the peer.

1369

# Not currently available publicly.

1370

# Hold time is three times the interval at which keepalive messages are sent, and the hold time is the maximum number of seconds allowed to elapse between successive keepalive messages that BGP receives from a peer.

1371

# BGP will use the smaller of either the local hold time value or the peer's hold time value as the hold time for the BGP connection between the two peers.

1372

# If set, this value must be between 1 and 120. The default is 20.

1373

},

1374

"bgpPeers": [ # BGP information that must be configured into the routing stack to establish BGP peering. This information must specify the peer ASN and either the interface name, IP address, or peer IP address. Please refer to RFC4273.

1375

{

1376

"advertiseMode": "A String", # User-specified flag to indicate which mode to use for advertisement.

1377

"advertisedGroups": [ # User-specified list of prefix groups to advertise in custom mode, which can take one of the following options:

1378

# - ALL_SUBNETS: Advertises all available subnets, including peer VPC subnets.

1379

# - ALL_VPC_SUBNETS: Advertises the router's own VPC subnets.

1380

# - ALL_PEER_VPC_SUBNETS: Advertises peer subnets of the router's VPC network. Note that this field can only be populated if advertise_mode is CUSTOM and overrides the list defined for the router (in the "bgp" message). These groups are advertised in addition to any specified prefixes. Leave this field blank to advertise no custom groups.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1381

"A String",

1382

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1383

"advertisedIpRanges": [ # User-specified list of individual IP ranges to advertise in custom mode. This field can only be populated if advertise_mode is CUSTOM and overrides the list defined for the router (in the "bgp" message). These IP ranges are advertised in addition to any specified groups. Leave this field blank to advertise no custom IP ranges.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1384

{ # Description-tagged IP ranges for the router to advertise.

1385

"description": "A String", # User-specified description for the IP range.

1386

"range": "A String", # The IP range to advertise. The value must be a CIDR-formatted string.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1387

},

1388

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1389

"advertisedRoutePriority": 42, # The priority of routes advertised to this BGP peer. Where there is more than one matching route of maximum length, the routes with the lowest priority value win.

1390

"bfd": { # BFD configuration for the BGP peering.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1391

# Not currently available publicly.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1392

"minReceiveInterval": 42, # The minimum interval, in milliseconds, between BFD control packets received from the peer router. The actual value is negotiated between the two routers and is equal to the greater of this value and the transmit interval of the other router.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1393

# Not currently available publicly.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1394

# If set, this value must be between 100 and 30000.

1395

# The default is 300.

1396

"minTransmitInterval": 42, # The minimum interval, in milliseconds, between BFD control packets transmitted to the peer router. The actual value is negotiated between the two routers and is equal to the greater of this value and the corresponding receive interval of the other router.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1397

# Not currently available publicly.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1398

# If set, this value must be between 100 and 30000.

1399

# The default is 300.

1400

"mode": "A String", # The BFD session initialization mode for this BGP peer. If set to ACTIVE, the Cloud Router will initiate the BFD session for this BGP peer. If set to PASSIVE, the Cloud Router will wait for the peer router to initiate the BFD session for this BGP peer. If set to DISABLED, BFD is disabled for this BGP peer. The default is PASSIVE.

1401

"multiplier": 42, # The number of consecutive BFD packets that must be missed before BFD declares that a peer is unavailable.

1402

# Not currently available publicly.

1403

# If set, the value must be a value between 2 and 16.

1404

# The default is 3.

1405

"packetMode": "A String", # The BFD packet mode for this BGP peer. If set to CONTROL_AND_ECHO, BFD echo mode is enabled for this BGP peer. In this mode, if the peer router also has BFD echo mode enabled, BFD echo packets will be sent to the other router. If the peer router does not have BFD echo mode enabled, only control packets will be sent. If set to CONTROL_ONLY, BFD echo mode is disabled for this BGP peer. If this router and the peer router have a multihop connection, this should be set to CONTROL_ONLY as BFD echo mode is only supported on singlehop connections. The default is CONTROL_AND_ECHO.

1406

"sessionInitializationMode": "A String", # The BFD session initialization mode for this BGP peer.

1407

# Not currently available publicly.

1408

# If set to ACTIVE, the Cloud Router will initiate the BFD session for this BGP peer. If set to PASSIVE, the Cloud Router will wait for the peer router to initiate the BFD session for this BGP peer. If set to DISABLED, BFD is disabled for this BGP peer. The default is PASSIVE.

1409

"slowTimerInterval": 42, # The minimum interval, in milliseconds, between BFD control packets transmitted to and received from the peer router when BFD echo mode is enabled on both routers. The actual transmit and receive intervals are negotiated between the two routers and are equal to the greater of this value and the corresponding interval on the other router. If set, this value must be between 1000 and 30000. The default is 5000.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1410

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1411

"enable": "A String", # The status of the BGP peer connection.

1412

# Not currently available publicly.

1413

# If set to FALSE, any active session with the peer is terminated and all associated routing information is removed. If set to TRUE, the peer connection can be established with routing information. The default is TRUE.

1414

"interfaceName": "A String", # Name of the interface the BGP peer is associated with.

1415

"ipAddress": "A String", # IP address of the interface inside Google Cloud Platform. Only IPv4 is supported.

1416

"managementType": "A String", # [Output Only] The resource that configures and manages this BGP peer.

1417

# - MANAGED_BY_USER is the default value and can be managed by you or other users

1418

# - MANAGED_BY_ATTACHMENT is a BGP peer that is configured and managed by Cloud Interconnect, specifically by an InterconnectAttachment of type PARTNER. Google automatically creates, updates, and deletes this type of BGP peer when the PARTNER InterconnectAttachment is created, updated, or deleted.

1419

"name": "A String", # Name of this BGP peer. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

1420

"peerAsn": 42, # Peer BGP Autonomous System Number (ASN). Each BGP interface may use a different value.

1421

"peerIpAddress": "A String", # IP address of the BGP interface outside Google Cloud Platform. Only IPv4 is supported.

1422

"routerApplianceInstance": "A String", # URI of the VM instance that is used as third-party router appliances such as Next Gen Firewalls, Virtual Routers, or Router Appliances. The VM instance must be located in zones contained in the same region as this Cloud Router. The VM instance is the peer side of the BGP session.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1423

},

1424

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1425

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

1426

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

1427

"encryptedInterconnectRouter": True or False, # Field to indicate if a router is dedicated to use with encrypted Interconnect Attachment (Encrypted Interconnect feature).

1428

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

1429

"interfaces": [ # Router interfaces. Each interface requires either one linked resource, (for example, linkedVpnTunnel), or IP address and IP address range (for example, ipRange), or both.

1430

{

1431

"ipRange": "A String", # IP address and range of the interface. The IP range must be in the RFC3927 link-local IP address space. The value must be a CIDR-formatted string, for example: 169.254.0.1/30. NOTE: Do not truncate the address as it represents the IP address of the interface.

1432

"linkedInterconnectAttachment": "A String", # URI of the linked Interconnect attachment. It must be in the same region as the router. Each interface can have one linked resource, which can be a VPN tunnel, an Interconnect attachment, or a virtual machine instance.

1433

"linkedVpnTunnel": "A String", # URI of the linked VPN tunnel, which must be in the same region as the router. Each interface can have one linked resource, which can be a VPN tunnel, an Interconnect attachment, or a virtual machine instance.

1434

"managementType": "A String", # [Output Only] The resource that configures and manages this interface.

1435

# - MANAGED_BY_USER is the default value and can be managed directly by users.

1436

# - MANAGED_BY_ATTACHMENT is an interface that is configured and managed by Cloud Interconnect, specifically, by an InterconnectAttachment of type PARTNER. Google automatically creates, updates, and deletes this type of interface when the PARTNER InterconnectAttachment is created, updated, or deleted.

1437

"name": "A String", # Name of this interface entry. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

1438

"privateIpAddress": "A String", # The regional private internal IP address that is used to establish BGP sessions to a VM instance acting as a third-party Router Appliance, such as a Next Gen Firewall, a Virtual Router, or an SD-WAN VM.

1439

"redundantInterface": "A String", # Name of the interface that will be redundant with the current interface you are creating. The redundantInterface must belong to the same Cloud Router as the interface here. To establish the BGP session to a Router Appliance VM, you must create two BGP peers. The two BGP peers must be attached to two separate interfaces that are redundant with each other. The redundant_interface must be 1-63 characters long, and comply with RFC1035. Specifically, the redundant_interface must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

1440

"subnetwork": "A String", # The URL of the subnetwork resource that this interface belongs to, which must be in the same region as the Cloud Router. When you establish a BGP session to a VM instance using this interface, the VM instance must belong to the same subnetwork as the subnetwork specified here.

1441

},

1442

],

1443

"kind": "compute#router", # [Output Only] Type of resource. Always compute#router for routers.

1444

"name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

1445

"nats": [ # A list of NAT services created in this router.

1446

{ # Represents a Nat resource. It enables the VMs within the specified subnetworks to access Internet without external IP addresses. It specifies a list of subnetworks (and the ranges within) that want to use NAT. Customers can also provide the external IPs that would be used for NAT. GCP would auto-allocate ephemeral IPs if no external IPs are provided.

1447

"drainNatIps": [ # A list of URLs of the IP resources to be drained. These IPs must be valid static external IPs that have been assigned to the NAT. These IPs should be used for updating/patching a NAT only.

1448

"A String",

1449

],

1450

"enableEndpointIndependentMapping": True or False,

1451

"icmpIdleTimeoutSec": 42, # Timeout (in seconds) for ICMP connections. Defaults to 30s if not set.

1452

"logConfig": { # Configuration of logging on a NAT. # Configure logging on this NAT.

1453

"enable": True or False, # Indicates whether or not to export logs. This is false by default.

1454

"filter": "A String", # Specify the desired filtering of logs on this NAT. If unspecified, logs are exported for all connections handled by this NAT. This option can take one of the following values:

1455

# - ERRORS_ONLY: Export logs only for connection failures.

1456

# - TRANSLATIONS_ONLY: Export logs only for successful connections.

1457

# - ALL: Export logs for all connections, successful and unsuccessful.

1458

},

1459

"minPortsPerVm": 42, # Minimum number of ports allocated to a VM from this NAT config. If not set, a default number of ports is allocated to a VM. This is rounded up to the nearest power of 2. For example, if the value of this field is 50, at least 64 ports are allocated to a VM.

1460

"name": "A String", # Unique name of this Nat service. The name must be 1-63 characters long and comply with RFC1035.

1461

"natIpAllocateOption": "A String", # Specify the NatIpAllocateOption, which can take one of the following values:

1462

# - MANUAL_ONLY: Uses only Nat IP addresses provided by customers. When there are not enough specified Nat IPs, the Nat service fails for new VMs.

1463

# - AUTO_ONLY: Nat IPs are allocated by Google Cloud Platform; customers can't specify any Nat IPs. When choosing AUTO_ONLY, then nat_ip should be empty.

1464

"natIps": [ # A list of URLs of the IP resources used for this Nat service. These IP addresses must be valid static external IP addresses assigned to the project.

1465

"A String",

1466

],

1467

"rules": [ # A list of rules associated with this NAT.

1468

{

1469

"action": { # The action to be enforced for traffic that matches this rule.

1470

"sourceNatActiveIps": [ # A list of URLs of the IP resources used for this NAT rule. These IP addresses must be valid static external IP addresses assigned to the project.

1471

"A String",

1472

],

1473

"sourceNatDrainIps": [ # A list of URLs of the IP resources to be drained. These IPs must be valid static external IPs that have been assigned to the NAT. These IPs should be used for updating/patching a NAT rule only.

"A String",

],

},

"description": "A String", # An optional description of this rule.

1478

"match": "A String", # CEL expression that specifies the match condition that egress traffic from a VM is evaluated against. If it evaluates to true, the corresponding ?action? is enforced.

1479

#

1480

# The following examples are valid match expressions:

1481

#

1482

# "inIpRange(destination.ip, '1.1.0.0/16') || inIpRange(destination.ip, '2.2.0.0/16')"

1483

#

1484

# "destination.ip == '1.1.0.1' || destination.ip == '8.8.8.8'"

1485

"ruleNumber": 42, # An integer uniquely identifying a rule in the list. The rule number must be a positive value between 0 and 65000, and must be unique among rules within a NAT.

1486

},

1487

],

1488

"sourceSubnetworkIpRangesToNat": "A String", # Specify the Nat option, which can take one of the following values:

1489

# - ALL_SUBNETWORKS_ALL_IP_RANGES: All of the IP ranges in every Subnetwork are allowed to Nat.

1490

# - ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES: All of the primary IP ranges in every Subnetwork are allowed to Nat.

1491

# - LIST_OF_SUBNETWORKS: A list of Subnetworks are allowed to Nat (specified in the field subnetwork below) The default is SUBNETWORK_IP_RANGE_TO_NAT_OPTION_UNSPECIFIED. Note that if this field contains ALL_SUBNETWORKS_ALL_IP_RANGES or ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES, then there should not be any other Router.Nat section in any Router for this network in this region.

1492

"subnetworks": [ # A list of Subnetwork resources whose traffic should be translated by NAT Gateway. It is used only when LIST_OF_SUBNETWORKS is selected for the SubnetworkIpRangeToNatOption above.

1493

{ # Defines the IP ranges that want to use NAT for a subnetwork.

1494

"name": "A String", # URL for the subnetwork resource that will use NAT.

1495

"secondaryIpRangeNames": [ # A list of the secondary ranges of the Subnetwork that are allowed to use NAT. This can be populated only if "LIST_OF_SECONDARY_IP_RANGES" is one of the values in source_ip_ranges_to_nat.

1496

"A String",

1497

],

1498

"sourceIpRangesToNat": [ # Specify the options for NAT ranges in the Subnetwork. All options of a single value are valid except NAT_IP_RANGE_OPTION_UNSPECIFIED. The only valid option with multiple values is: ["PRIMARY_IP_RANGE", "LIST_OF_SECONDARY_IP_RANGES"] Default: [ALL_IP_RANGES]

"A String",

],

},

],

"tcpEstablishedIdleTimeoutSec": 42, # Timeout (in seconds) for TCP established connections. Defaults to 1200s if not set.

1504

"tcpTimeWaitTimeoutSec": 42, # Timeout (in seconds) for TCP connections that are in TIME_WAIT state. Defaults to 120s if not set.

1505

"tcpTransitoryIdleTimeoutSec": 42, # Timeout (in seconds) for TCP transitory connections. Defaults to 30s if not set.

1506

"udpIdleTimeoutSec": 42, # Timeout (in seconds) for UDP connections. Defaults to 30s if not set.

1507

},

1508

],

1509

"network": "A String", # URI of the network to which this router belongs.

1510

"region": "A String", # [Output Only] URI of the region where the router resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

1511

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

1512

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1513

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1514

],

1515

"kind": "compute#routerList", # [Output Only] Type of resource. Always compute#router for routers.

1516

"nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

1517

"selfLink": "A String", # [Output Only] Server-defined URL for this resource.

1518

"warning": { # [Output Only] Informational warning message.

1519

"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

1520

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

1521

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

1522

{

1523

"key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).

1524

"value": "A String", # [Output Only] A warning data value corresponding to the key.

1525

},

1526

],

1527

"message": "A String", # [Output Only] A human-readable description of the warning code.

1528

},

1529

}</pre>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

</div>

<code class="details" id="list_next">list_next(previous_request, previous_response)</code>

1534

<pre>Retrieves the next page of results.

1535

1536

Args:

1537

previous_request: The request for the previous page. (required)

1538

previous_response: The response from the request for the previous page. (required)

1539

1540

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1541

A request object that you can call 'execute()' on to request the next

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1542

page. Returns None if there are no more items in the collection.

</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1547

<code class="details" id="patch">patch(project, region, router, body=None, requestId=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1548

<pre>Patches the specified Router resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1549

1550

Args:

1551

project: string, Project ID for this request. (required)

1552

region: string, Name of the region for this request. (required)

Sai Cheemalapati

c30d2b5

2017-03-13 12:12:03 -0400

[diff] [blame]

1553

router: string, Name of the Router resource to patch. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1554

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1555

The object takes the form of:

1556

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1557

{ # Represents a Cloud Router resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1558

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1559

# For more information about Cloud Router, read the Cloud Router overview.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1560

"bgp": { # BGP information specific to this router.

1561

"advertiseMode": "A String", # User-specified flag to indicate which mode to use for advertisement. The options are DEFAULT or CUSTOM.

1562

"advertisedGroups": [ # User-specified list of prefix groups to advertise in custom mode. This field can only be populated if advertise_mode is CUSTOM and is advertised to all peers of the router. These groups will be advertised in addition to any specified prefixes. Leave this field blank to advertise no custom groups.

1563

"A String",

1564

],

1565

"advertisedIpRanges": [ # User-specified list of individual IP ranges to advertise in custom mode. This field can only be populated if advertise_mode is CUSTOM and is advertised to all peers of the router. These IP ranges will be advertised in addition to any specified groups. Leave this field blank to advertise no custom IP ranges.

1566

{ # Description-tagged IP ranges for the router to advertise.

1567

"description": "A String", # User-specified description for the IP range.

1568

"range": "A String", # The IP range to advertise. The value must be a CIDR-formatted string.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1569

},

1570

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1571

"asn": 42, # Local BGP Autonomous System Number (ASN). Must be an RFC6996 private ASN, either 16-bit or 32-bit. The value will be fixed for this router resource. All VPN tunnels that link to this router will have the same local ASN.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1572

"keepaliveInterval": 42, # The interval in seconds between BGP keepalive messages that are sent to the peer.

1573

# Not currently available publicly.

1574

# Hold time is three times the interval at which keepalive messages are sent, and the hold time is the maximum number of seconds allowed to elapse between successive keepalive messages that BGP receives from a peer.

1575

# BGP will use the smaller of either the local hold time value or the peer's hold time value as the hold time for the BGP connection between the two peers.

1576

# If set, this value must be between 1 and 120. The default is 20.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1577

},

1578

"bgpPeers": [ # BGP information that must be configured into the routing stack to establish BGP peering. This information must specify the peer ASN and either the interface name, IP address, or peer IP address. Please refer to RFC4273.

1579

{

1580

"advertiseMode": "A String", # User-specified flag to indicate which mode to use for advertisement.

1581

"advertisedGroups": [ # User-specified list of prefix groups to advertise in custom mode, which can take one of the following options:

1582

# - ALL_SUBNETS: Advertises all available subnets, including peer VPC subnets.

1583

# - ALL_VPC_SUBNETS: Advertises the router's own VPC subnets.

1584

# - ALL_PEER_VPC_SUBNETS: Advertises peer subnets of the router's VPC network. Note that this field can only be populated if advertise_mode is CUSTOM and overrides the list defined for the router (in the "bgp" message). These groups are advertised in addition to any specified prefixes. Leave this field blank to advertise no custom groups.

1585

"A String",

1586

],

1587

"advertisedIpRanges": [ # User-specified list of individual IP ranges to advertise in custom mode. This field can only be populated if advertise_mode is CUSTOM and overrides the list defined for the router (in the "bgp" message). These IP ranges are advertised in addition to any specified groups. Leave this field blank to advertise no custom IP ranges.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1588

{ # Description-tagged IP ranges for the router to advertise.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1589

"description": "A String", # User-specified description for the IP range.

1590

"range": "A String", # The IP range to advertise. The value must be a CIDR-formatted string.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

1591

},

1592

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1593

"advertisedRoutePriority": 42, # The priority of routes advertised to this BGP peer. Where there is more than one matching route of maximum length, the routes with the lowest priority value win.

1594

"bfd": { # BFD configuration for the BGP peering.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1595

# Not currently available publicly.

1596

"minReceiveInterval": 42, # The minimum interval, in milliseconds, between BFD control packets received from the peer router. The actual value is negotiated between the two routers and is equal to the greater of this value and the transmit interval of the other router.

1597

# Not currently available publicly.

1598

# If set, this value must be between 100 and 30000.

1599

# The default is 300.

1600

"minTransmitInterval": 42, # The minimum interval, in milliseconds, between BFD control packets transmitted to the peer router. The actual value is negotiated between the two routers and is equal to the greater of this value and the corresponding receive interval of the other router.

1601

# Not currently available publicly.

1602

# If set, this value must be between 100 and 30000.

1603

# The default is 300.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1604

"mode": "A String", # The BFD session initialization mode for this BGP peer. If set to ACTIVE, the Cloud Router will initiate the BFD session for this BGP peer. If set to PASSIVE, the Cloud Router will wait for the peer router to initiate the BFD session for this BGP peer. If set to DISABLED, BFD is disabled for this BGP peer. The default is PASSIVE.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1605

"multiplier": 42, # The number of consecutive BFD packets that must be missed before BFD declares that a peer is unavailable.

1606

# Not currently available publicly.

1607

# If set, the value must be a value between 2 and 16.

1608

# The default is 3.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1609

"packetMode": "A String", # The BFD packet mode for this BGP peer. If set to CONTROL_AND_ECHO, BFD echo mode is enabled for this BGP peer. In this mode, if the peer router also has BFD echo mode enabled, BFD echo packets will be sent to the other router. If the peer router does not have BFD echo mode enabled, only control packets will be sent. If set to CONTROL_ONLY, BFD echo mode is disabled for this BGP peer. If this router and the peer router have a multihop connection, this should be set to CONTROL_ONLY as BFD echo mode is only supported on singlehop connections. The default is CONTROL_AND_ECHO.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1610

"sessionInitializationMode": "A String", # The BFD session initialization mode for this BGP peer.

1611

# Not currently available publicly.

1612

# If set to ACTIVE, the Cloud Router will initiate the BFD session for this BGP peer. If set to PASSIVE, the Cloud Router will wait for the peer router to initiate the BFD session for this BGP peer. If set to DISABLED, BFD is disabled for this BGP peer. The default is PASSIVE.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1613

"slowTimerInterval": 42, # The minimum interval, in milliseconds, between BFD control packets transmitted to and received from the peer router when BFD echo mode is enabled on both routers. The actual transmit and receive intervals are negotiated between the two routers and are equal to the greater of this value and the corresponding interval on the other router. If set, this value must be between 1000 and 30000. The default is 5000.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1614

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1615

"enable": "A String", # The status of the BGP peer connection.

1616

# Not currently available publicly.

1617

# If set to FALSE, any active session with the peer is terminated and all associated routing information is removed. If set to TRUE, the peer connection can be established with routing information. The default is TRUE.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1618

"interfaceName": "A String", # Name of the interface the BGP peer is associated with.

1619

"ipAddress": "A String", # IP address of the interface inside Google Cloud Platform. Only IPv4 is supported.

1620

"managementType": "A String", # [Output Only] The resource that configures and manages this BGP peer.

1621

# - MANAGED_BY_USER is the default value and can be managed by you or other users

1622

# - MANAGED_BY_ATTACHMENT is a BGP peer that is configured and managed by Cloud Interconnect, specifically by an InterconnectAttachment of type PARTNER. Google automatically creates, updates, and deletes this type of BGP peer when the PARTNER InterconnectAttachment is created, updated, or deleted.

1623

"name": "A String", # Name of this BGP peer. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

1624

"peerAsn": 42, # Peer BGP Autonomous System Number (ASN). Each BGP interface may use a different value.

1625

"peerIpAddress": "A String", # IP address of the BGP interface outside Google Cloud Platform. Only IPv4 is supported.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1626

"routerApplianceInstance": "A String", # URI of the VM instance that is used as third-party router appliances such as Next Gen Firewalls, Virtual Routers, or Router Appliances. The VM instance must be located in zones contained in the same region as this Cloud Router. The VM instance is the peer side of the BGP session.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1627

},

1628

],

1629

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

1630

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1631

"encryptedInterconnectRouter": True or False, # Field to indicate if a router is dedicated to use with encrypted Interconnect Attachment (Encrypted Interconnect feature).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1632

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

1633

"interfaces": [ # Router interfaces. Each interface requires either one linked resource, (for example, linkedVpnTunnel), or IP address and IP address range (for example, ipRange), or both.

1634

{

1635

"ipRange": "A String", # IP address and range of the interface. The IP range must be in the RFC3927 link-local IP address space. The value must be a CIDR-formatted string, for example: 169.254.0.1/30. NOTE: Do not truncate the address as it represents the IP address of the interface.

1636

"linkedInterconnectAttachment": "A String", # URI of the linked Interconnect attachment. It must be in the same region as the router. Each interface can have one linked resource, which can be a VPN tunnel, an Interconnect attachment, or a virtual machine instance.

1637

"linkedVpnTunnel": "A String", # URI of the linked VPN tunnel, which must be in the same region as the router. Each interface can have one linked resource, which can be a VPN tunnel, an Interconnect attachment, or a virtual machine instance.

1638

"managementType": "A String", # [Output Only] The resource that configures and manages this interface.

1639

# - MANAGED_BY_USER is the default value and can be managed directly by users.

1640

# - MANAGED_BY_ATTACHMENT is an interface that is configured and managed by Cloud Interconnect, specifically, by an InterconnectAttachment of type PARTNER. Google automatically creates, updates, and deletes this type of interface when the PARTNER InterconnectAttachment is created, updated, or deleted.

1641

"name": "A String", # Name of this interface entry. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1642

"privateIpAddress": "A String", # The regional private internal IP address that is used to establish BGP sessions to a VM instance acting as a third-party Router Appliance, such as a Next Gen Firewall, a Virtual Router, or an SD-WAN VM.

1643

"redundantInterface": "A String", # Name of the interface that will be redundant with the current interface you are creating. The redundantInterface must belong to the same Cloud Router as the interface here. To establish the BGP session to a Router Appliance VM, you must create two BGP peers. The two BGP peers must be attached to two separate interfaces that are redundant with each other. The redundant_interface must be 1-63 characters long, and comply with RFC1035. Specifically, the redundant_interface must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

1644

"subnetwork": "A String", # The URL of the subnetwork resource that this interface belongs to, which must be in the same region as the Cloud Router. When you establish a BGP session to a VM instance using this interface, the VM instance must belong to the same subnetwork as the subnetwork specified here.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1645

},

1646

],

1647

"kind": "compute#router", # [Output Only] Type of resource. Always compute#router for routers.

1648

"name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

1649

"nats": [ # A list of NAT services created in this router.

1650

{ # Represents a Nat resource. It enables the VMs within the specified subnetworks to access Internet without external IP addresses. It specifies a list of subnetworks (and the ranges within) that want to use NAT. Customers can also provide the external IPs that would be used for NAT. GCP would auto-allocate ephemeral IPs if no external IPs are provided.

1651

"drainNatIps": [ # A list of URLs of the IP resources to be drained. These IPs must be valid static external IPs that have been assigned to the NAT. These IPs should be used for updating/patching a NAT only.

1652

"A String",

1653

],

1654

"enableEndpointIndependentMapping": True or False,

1655

"icmpIdleTimeoutSec": 42, # Timeout (in seconds) for ICMP connections. Defaults to 30s if not set.

1656

"logConfig": { # Configuration of logging on a NAT. # Configure logging on this NAT.

1657

"enable": True or False, # Indicates whether or not to export logs. This is false by default.

1658

"filter": "A String", # Specify the desired filtering of logs on this NAT. If unspecified, logs are exported for all connections handled by this NAT. This option can take one of the following values:

1659

# - ERRORS_ONLY: Export logs only for connection failures.

1660

# - TRANSLATIONS_ONLY: Export logs only for successful connections.

1661

# - ALL: Export logs for all connections, successful and unsuccessful.

1662

},

1663

"minPortsPerVm": 42, # Minimum number of ports allocated to a VM from this NAT config. If not set, a default number of ports is allocated to a VM. This is rounded up to the nearest power of 2. For example, if the value of this field is 50, at least 64 ports are allocated to a VM.

1664

"name": "A String", # Unique name of this Nat service. The name must be 1-63 characters long and comply with RFC1035.

1665

"natIpAllocateOption": "A String", # Specify the NatIpAllocateOption, which can take one of the following values:

1666

# - MANUAL_ONLY: Uses only Nat IP addresses provided by customers. When there are not enough specified Nat IPs, the Nat service fails for new VMs.

1667

# - AUTO_ONLY: Nat IPs are allocated by Google Cloud Platform; customers can't specify any Nat IPs. When choosing AUTO_ONLY, then nat_ip should be empty.

1668

"natIps": [ # A list of URLs of the IP resources used for this Nat service. These IP addresses must be valid static external IP addresses assigned to the project.

1669

"A String",

1670

],

1671

"rules": [ # A list of rules associated with this NAT.

1672

{

1673

"action": { # The action to be enforced for traffic that matches this rule.

1674

"sourceNatActiveIps": [ # A list of URLs of the IP resources used for this NAT rule. These IP addresses must be valid static external IP addresses assigned to the project.

1675

"A String",

1676

],

1677

"sourceNatDrainIps": [ # A list of URLs of the IP resources to be drained. These IPs must be valid static external IPs that have been assigned to the NAT. These IPs should be used for updating/patching a NAT rule only.

"A String",

],

},

"description": "A String", # An optional description of this rule.

1682

"match": "A String", # CEL expression that specifies the match condition that egress traffic from a VM is evaluated against. If it evaluates to true, the corresponding ?action? is enforced.

1683

#

1684

# The following examples are valid match expressions:

1685

#

1686

# "inIpRange(destination.ip, '1.1.0.0/16') || inIpRange(destination.ip, '2.2.0.0/16')"

1687

#

1688

# "destination.ip == '1.1.0.1' || destination.ip == '8.8.8.8'"

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1689

"ruleNumber": 42, # An integer uniquely identifying a rule in the list. The rule number must be a positive value between 0 and 65000, and must be unique among rules within a NAT.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1690

},

1691

],

1692

"sourceSubnetworkIpRangesToNat": "A String", # Specify the Nat option, which can take one of the following values:

1693

# - ALL_SUBNETWORKS_ALL_IP_RANGES: All of the IP ranges in every Subnetwork are allowed to Nat.

1694

# - ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES: All of the primary IP ranges in every Subnetwork are allowed to Nat.

1695

# - LIST_OF_SUBNETWORKS: A list of Subnetworks are allowed to Nat (specified in the field subnetwork below) The default is SUBNETWORK_IP_RANGE_TO_NAT_OPTION_UNSPECIFIED. Note that if this field contains ALL_SUBNETWORKS_ALL_IP_RANGES or ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES, then there should not be any other Router.Nat section in any Router for this network in this region.

1696

"subnetworks": [ # A list of Subnetwork resources whose traffic should be translated by NAT Gateway. It is used only when LIST_OF_SUBNETWORKS is selected for the SubnetworkIpRangeToNatOption above.

1697

{ # Defines the IP ranges that want to use NAT for a subnetwork.

1698

"name": "A String", # URL for the subnetwork resource that will use NAT.

1699

"secondaryIpRangeNames": [ # A list of the secondary ranges of the Subnetwork that are allowed to use NAT. This can be populated only if "LIST_OF_SECONDARY_IP_RANGES" is one of the values in source_ip_ranges_to_nat.

1700

"A String",

1701

],

1702

"sourceIpRangesToNat": [ # Specify the options for NAT ranges in the Subnetwork. All options of a single value are valid except NAT_IP_RANGE_OPTION_UNSPECIFIED. The only valid option with multiple values is: ["PRIMARY_IP_RANGE", "LIST_OF_SECONDARY_IP_RANGES"] Default: [ALL_IP_RANGES]

"A String",

],

},

],

"tcpEstablishedIdleTimeoutSec": 42, # Timeout (in seconds) for TCP established connections. Defaults to 1200s if not set.

1708

"tcpTimeWaitTimeoutSec": 42, # Timeout (in seconds) for TCP connections that are in TIME_WAIT state. Defaults to 120s if not set.

1709

"tcpTransitoryIdleTimeoutSec": 42, # Timeout (in seconds) for TCP transitory connections. Defaults to 30s if not set.

1710

"udpIdleTimeoutSec": 42, # Timeout (in seconds) for UDP connections. Defaults to 30s if not set.

1711

},

1712

],

1713

"network": "A String", # URI of the network to which this router belongs.

1714

"region": "A String", # [Output Only] URI of the region where the router resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

1715

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

1716

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

1717

}

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1718

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1719

requestId: string, 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.

1720

1721

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.

1722

1723

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1724

1725

Returns:

1726

An object of the form:

1727

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1728

{ # Represents an Operation resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1729

#

1730

# Google Compute Engine has three Operation resources:

1731

#

1732

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

1733

#

1734

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

1735

#

1736

# Operations can be global, regional or zonal.

1737

# - For global operations, use the `globalOperations` resource.

1738

# - For regional operations, use the `regionOperations` resource.

1739

# - For zonal operations, use the `zonalOperations` resource.

1740

#

1741

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

1742

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

1743

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

1744

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

1745

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

1746

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

1747

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1748

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1749

"code": "A String", # [Output Only] The error type identifier for this error.

1750

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

1751

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1752

},

1753

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1754

},

1755

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

1756

"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.

1757

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

1758

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

1759

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame^]

1760

"metadata": { # `Any` contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message. # [Output Only] Service-specific metadata attached to this operation.

1761

#

1762

# Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type.

1763

#

1764

# Example 1: Pack and unpack a message in C++.

1765

#

1766

# Foo foo = ...; Any any; any.PackFrom(foo); ... if (any.UnpackTo(&foo)) { ... }

1767

#

1768

# Example 2: Pack and unpack a message in Java.

1769

#

1770

# Foo foo = ...; Any any = Any.pack(foo); ... if (any.is(Foo.class)) { foo = any.unpack(Foo.class); }

1771

#

1772

# Example 3: Pack and unpack a message in Python.

1773

#

1774

# foo = Foo(...) any = Any() any.Pack(foo) ... if any.Is(Foo.DESCRIPTOR): any.Unpack(foo) ...

1775

#

1776

# Example 4: Pack and unpack a message in Go

1777

#

1778

# foo := &pb.Foo{...} any, err := anypb.New(foo) if err != nil { ... } ... foo := &pb.Foo{} if err := any.UnmarshalTo(foo); err != nil { ... }

1779

#

1780

# The pack methods provided by protobuf library will by default use 'type.googleapis.com/full.type.name' as the type URL and the unpack methods only use the fully qualified type name after the last '/' in the type URL, for example "foo.bar.com/x/y.z" will yield type name "y.z".

#

#

#

# JSON ==== The JSON representation of an `Any` value uses the regular representation of the deserialized, embedded message, with an additional field `@type` which contains the type URL. Example:

1785

#

1786

# package google.profile; message Person { string first_name = 1; string last_name = 2; }

1787

#

1788

# { "@type": "type.googleapis.com/google.profile.Person", "firstName": , "lastName": }

1789

#

1790

# If the embedded message type is well-known and has a custom JSON representation, that representation will be embedded adding a field `value` which holds the custom JSON in addition to the `@type` field. Example (for message [google.protobuf.Duration][]):

1791

#

1792

# { "@type": "type.googleapis.com/google.protobuf.Duration", "value": "1.212s" }

1793

"typeUrl": "A String", # A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in `path/google.protobuf.Duration`). The name should be in a canonical form (e.g., leading "." is not accepted).

1794

#

1795

# In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme `http`, `https`, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:

1796

#

1797

# * If no scheme is provided, `https` is assumed. * An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error. * Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)

1798

#

1799

# Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.

1800

#

1801

# Schemes other than `http`, `https` (or the empty scheme) might be used with implementation specific semantics.

1802

"value": "A String", # Must be a valid serialized protocol buffer of the above specified type.

1803

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1804

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame^]

1805

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1806

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

1807

"progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.

1808

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

1809

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

1810

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

1811

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

1812

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

1813

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

1814

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

1815

"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.

1816

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

1817

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

1818

{

1819

"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

1820

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

1821

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

1822

{

1823

"key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).

1824

"value": "A String", # [Output Only] A warning data value corresponding to the key.

1825

},

1826

],

1827

"message": "A String", # [Output Only] A human-readable description of the warning code.

1828

},

1829

],

1830

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

1831

}</pre>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1835

<code class="details" id="preview">preview(project, region, router, body=None)</code>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1836

<pre>Preview fields auto-generated during router create and update operations. Calling this method does NOT create or update the router.

1837

1838

Args:

1839

project: string, Project ID for this request. (required)

1840

region: string, Name of the region for this request. (required)

1841

router: string, Name of the Router resource to query. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1842

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1843

The object takes the form of:

1844

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1845

{ # Represents a Cloud Router resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1846

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1847

# For more information about Cloud Router, read the Cloud Router overview.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1848

"bgp": { # BGP information specific to this router.

1849

"advertiseMode": "A String", # User-specified flag to indicate which mode to use for advertisement. The options are DEFAULT or CUSTOM.

1850

"advertisedGroups": [ # User-specified list of prefix groups to advertise in custom mode. This field can only be populated if advertise_mode is CUSTOM and is advertised to all peers of the router. These groups will be advertised in addition to any specified prefixes. Leave this field blank to advertise no custom groups.

1851

"A String",

1852

],

1853

"advertisedIpRanges": [ # User-specified list of individual IP ranges to advertise in custom mode. This field can only be populated if advertise_mode is CUSTOM and is advertised to all peers of the router. These IP ranges will be advertised in addition to any specified groups. Leave this field blank to advertise no custom IP ranges.

1854

{ # Description-tagged IP ranges for the router to advertise.

1855

"description": "A String", # User-specified description for the IP range.

1856

"range": "A String", # The IP range to advertise. The value must be a CIDR-formatted string.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1857

},

1858

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1859

"asn": 42, # Local BGP Autonomous System Number (ASN). Must be an RFC6996 private ASN, either 16-bit or 32-bit. The value will be fixed for this router resource. All VPN tunnels that link to this router will have the same local ASN.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1860

"keepaliveInterval": 42, # The interval in seconds between BGP keepalive messages that are sent to the peer.

1861

# Not currently available publicly.

1862

# Hold time is three times the interval at which keepalive messages are sent, and the hold time is the maximum number of seconds allowed to elapse between successive keepalive messages that BGP receives from a peer.

1863

# BGP will use the smaller of either the local hold time value or the peer's hold time value as the hold time for the BGP connection between the two peers.

1864

# If set, this value must be between 1 and 120. The default is 20.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1865

},

1866

"bgpPeers": [ # BGP information that must be configured into the routing stack to establish BGP peering. This information must specify the peer ASN and either the interface name, IP address, or peer IP address. Please refer to RFC4273.

1867

{

1868

"advertiseMode": "A String", # User-specified flag to indicate which mode to use for advertisement.

1869

"advertisedGroups": [ # User-specified list of prefix groups to advertise in custom mode, which can take one of the following options:

1870

# - ALL_SUBNETS: Advertises all available subnets, including peer VPC subnets.

1871

# - ALL_VPC_SUBNETS: Advertises the router's own VPC subnets.

1872

# - ALL_PEER_VPC_SUBNETS: Advertises peer subnets of the router's VPC network. Note that this field can only be populated if advertise_mode is CUSTOM and overrides the list defined for the router (in the "bgp" message). These groups are advertised in addition to any specified prefixes. Leave this field blank to advertise no custom groups.

1873

"A String",

1874

],

1875

"advertisedIpRanges": [ # User-specified list of individual IP ranges to advertise in custom mode. This field can only be populated if advertise_mode is CUSTOM and overrides the list defined for the router (in the "bgp" message). These IP ranges are advertised in addition to any specified groups. Leave this field blank to advertise no custom IP ranges.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1876

{ # Description-tagged IP ranges for the router to advertise.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1877

"description": "A String", # User-specified description for the IP range.

1878

"range": "A String", # The IP range to advertise. The value must be a CIDR-formatted string.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

1879

},

1880

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1881

"advertisedRoutePriority": 42, # The priority of routes advertised to this BGP peer. Where there is more than one matching route of maximum length, the routes with the lowest priority value win.

1882

"bfd": { # BFD configuration for the BGP peering.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1883

# Not currently available publicly.

1884

"minReceiveInterval": 42, # The minimum interval, in milliseconds, between BFD control packets received from the peer router. The actual value is negotiated between the two routers and is equal to the greater of this value and the transmit interval of the other router.

1885

# Not currently available publicly.

1886

# If set, this value must be between 100 and 30000.

1887

# The default is 300.

1888

"minTransmitInterval": 42, # The minimum interval, in milliseconds, between BFD control packets transmitted to the peer router. The actual value is negotiated between the two routers and is equal to the greater of this value and the corresponding receive interval of the other router.

1889

# Not currently available publicly.

1890

# If set, this value must be between 100 and 30000.

1891

# The default is 300.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1892

"mode": "A String", # The BFD session initialization mode for this BGP peer. If set to ACTIVE, the Cloud Router will initiate the BFD session for this BGP peer. If set to PASSIVE, the Cloud Router will wait for the peer router to initiate the BFD session for this BGP peer. If set to DISABLED, BFD is disabled for this BGP peer. The default is PASSIVE.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1893

"multiplier": 42, # The number of consecutive BFD packets that must be missed before BFD declares that a peer is unavailable.

1894

# Not currently available publicly.

1895

# If set, the value must be a value between 2 and 16.

1896

# The default is 3.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1897

"packetMode": "A String", # The BFD packet mode for this BGP peer. If set to CONTROL_AND_ECHO, BFD echo mode is enabled for this BGP peer. In this mode, if the peer router also has BFD echo mode enabled, BFD echo packets will be sent to the other router. If the peer router does not have BFD echo mode enabled, only control packets will be sent. If set to CONTROL_ONLY, BFD echo mode is disabled for this BGP peer. If this router and the peer router have a multihop connection, this should be set to CONTROL_ONLY as BFD echo mode is only supported on singlehop connections. The default is CONTROL_AND_ECHO.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1898

"sessionInitializationMode": "A String", # The BFD session initialization mode for this BGP peer.

1899

# Not currently available publicly.

1900

# If set to ACTIVE, the Cloud Router will initiate the BFD session for this BGP peer. If set to PASSIVE, the Cloud Router will wait for the peer router to initiate the BFD session for this BGP peer. If set to DISABLED, BFD is disabled for this BGP peer. The default is PASSIVE.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1901

"slowTimerInterval": 42, # The minimum interval, in milliseconds, between BFD control packets transmitted to and received from the peer router when BFD echo mode is enabled on both routers. The actual transmit and receive intervals are negotiated between the two routers and are equal to the greater of this value and the corresponding interval on the other router. If set, this value must be between 1000 and 30000. The default is 5000.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1902

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1903

"enable": "A String", # The status of the BGP peer connection.

1904

# Not currently available publicly.

1905

# If set to FALSE, any active session with the peer is terminated and all associated routing information is removed. If set to TRUE, the peer connection can be established with routing information. The default is TRUE.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1906

"interfaceName": "A String", # Name of the interface the BGP peer is associated with.

1907

"ipAddress": "A String", # IP address of the interface inside Google Cloud Platform. Only IPv4 is supported.

1908

"managementType": "A String", # [Output Only] The resource that configures and manages this BGP peer.

1909

# - MANAGED_BY_USER is the default value and can be managed by you or other users

1910

# - MANAGED_BY_ATTACHMENT is a BGP peer that is configured and managed by Cloud Interconnect, specifically by an InterconnectAttachment of type PARTNER. Google automatically creates, updates, and deletes this type of BGP peer when the PARTNER InterconnectAttachment is created, updated, or deleted.

1911

"name": "A String", # Name of this BGP peer. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

1912

"peerAsn": 42, # Peer BGP Autonomous System Number (ASN). Each BGP interface may use a different value.

1913

"peerIpAddress": "A String", # IP address of the BGP interface outside Google Cloud Platform. Only IPv4 is supported.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1914

"routerApplianceInstance": "A String", # URI of the VM instance that is used as third-party router appliances such as Next Gen Firewalls, Virtual Routers, or Router Appliances. The VM instance must be located in zones contained in the same region as this Cloud Router. The VM instance is the peer side of the BGP session.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1915

},

1916

],

1917

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

1918

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1919

"encryptedInterconnectRouter": True or False, # Field to indicate if a router is dedicated to use with encrypted Interconnect Attachment (Encrypted Interconnect feature).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1920

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

1921

"interfaces": [ # Router interfaces. Each interface requires either one linked resource, (for example, linkedVpnTunnel), or IP address and IP address range (for example, ipRange), or both.

1922

{

1923

"ipRange": "A String", # IP address and range of the interface. The IP range must be in the RFC3927 link-local IP address space. The value must be a CIDR-formatted string, for example: 169.254.0.1/30. NOTE: Do not truncate the address as it represents the IP address of the interface.

1924

"linkedInterconnectAttachment": "A String", # URI of the linked Interconnect attachment. It must be in the same region as the router. Each interface can have one linked resource, which can be a VPN tunnel, an Interconnect attachment, or a virtual machine instance.

1925

"linkedVpnTunnel": "A String", # URI of the linked VPN tunnel, which must be in the same region as the router. Each interface can have one linked resource, which can be a VPN tunnel, an Interconnect attachment, or a virtual machine instance.

1926

"managementType": "A String", # [Output Only] The resource that configures and manages this interface.

1927

# - MANAGED_BY_USER is the default value and can be managed directly by users.

1928

# - MANAGED_BY_ATTACHMENT is an interface that is configured and managed by Cloud Interconnect, specifically, by an InterconnectAttachment of type PARTNER. Google automatically creates, updates, and deletes this type of interface when the PARTNER InterconnectAttachment is created, updated, or deleted.

1929

"name": "A String", # Name of this interface entry. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1930

"privateIpAddress": "A String", # The regional private internal IP address that is used to establish BGP sessions to a VM instance acting as a third-party Router Appliance, such as a Next Gen Firewall, a Virtual Router, or an SD-WAN VM.

1931

"redundantInterface": "A String", # Name of the interface that will be redundant with the current interface you are creating. The redundantInterface must belong to the same Cloud Router as the interface here. To establish the BGP session to a Router Appliance VM, you must create two BGP peers. The two BGP peers must be attached to two separate interfaces that are redundant with each other. The redundant_interface must be 1-63 characters long, and comply with RFC1035. Specifically, the redundant_interface must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

1932

"subnetwork": "A String", # The URL of the subnetwork resource that this interface belongs to, which must be in the same region as the Cloud Router. When you establish a BGP session to a VM instance using this interface, the VM instance must belong to the same subnetwork as the subnetwork specified here.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1933

},

1934

],

1935

"kind": "compute#router", # [Output Only] Type of resource. Always compute#router for routers.

1936

"name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

1937

"nats": [ # A list of NAT services created in this router.

1938

{ # Represents a Nat resource. It enables the VMs within the specified subnetworks to access Internet without external IP addresses. It specifies a list of subnetworks (and the ranges within) that want to use NAT. Customers can also provide the external IPs that would be used for NAT. GCP would auto-allocate ephemeral IPs if no external IPs are provided.

1939

"drainNatIps": [ # A list of URLs of the IP resources to be drained. These IPs must be valid static external IPs that have been assigned to the NAT. These IPs should be used for updating/patching a NAT only.

1940

"A String",

1941

],

1942

"enableEndpointIndependentMapping": True or False,

1943

"icmpIdleTimeoutSec": 42, # Timeout (in seconds) for ICMP connections. Defaults to 30s if not set.

1944

"logConfig": { # Configuration of logging on a NAT. # Configure logging on this NAT.

1945

"enable": True or False, # Indicates whether or not to export logs. This is false by default.

1946

"filter": "A String", # Specify the desired filtering of logs on this NAT. If unspecified, logs are exported for all connections handled by this NAT. This option can take one of the following values:

1947

# - ERRORS_ONLY: Export logs only for connection failures.

1948

# - TRANSLATIONS_ONLY: Export logs only for successful connections.

1949

# - ALL: Export logs for all connections, successful and unsuccessful.

1950

},

1951

"minPortsPerVm": 42, # Minimum number of ports allocated to a VM from this NAT config. If not set, a default number of ports is allocated to a VM. This is rounded up to the nearest power of 2. For example, if the value of this field is 50, at least 64 ports are allocated to a VM.

1952

"name": "A String", # Unique name of this Nat service. The name must be 1-63 characters long and comply with RFC1035.

1953

"natIpAllocateOption": "A String", # Specify the NatIpAllocateOption, which can take one of the following values:

1954

# - MANUAL_ONLY: Uses only Nat IP addresses provided by customers. When there are not enough specified Nat IPs, the Nat service fails for new VMs.

1955

# - AUTO_ONLY: Nat IPs are allocated by Google Cloud Platform; customers can't specify any Nat IPs. When choosing AUTO_ONLY, then nat_ip should be empty.

1956

"natIps": [ # A list of URLs of the IP resources used for this Nat service. These IP addresses must be valid static external IP addresses assigned to the project.

1957

"A String",

1958

],

1959

"rules": [ # A list of rules associated with this NAT.

1960

{

1961

"action": { # The action to be enforced for traffic that matches this rule.

1962

"sourceNatActiveIps": [ # A list of URLs of the IP resources used for this NAT rule. These IP addresses must be valid static external IP addresses assigned to the project.

1963

"A String",

1964

],

1965

"sourceNatDrainIps": [ # A list of URLs of the IP resources to be drained. These IPs must be valid static external IPs that have been assigned to the NAT. These IPs should be used for updating/patching a NAT rule only.

"A String",

],

},

"description": "A String", # An optional description of this rule.

1970

"match": "A String", # CEL expression that specifies the match condition that egress traffic from a VM is evaluated against. If it evaluates to true, the corresponding ?action? is enforced.

1971

#

1972

# The following examples are valid match expressions:

1973

#

1974

# "inIpRange(destination.ip, '1.1.0.0/16') || inIpRange(destination.ip, '2.2.0.0/16')"

1975

#

1976

# "destination.ip == '1.1.0.1' || destination.ip == '8.8.8.8'"

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1977

"ruleNumber": 42, # An integer uniquely identifying a rule in the list. The rule number must be a positive value between 0 and 65000, and must be unique among rules within a NAT.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1978

},

1979

],

1980

"sourceSubnetworkIpRangesToNat": "A String", # Specify the Nat option, which can take one of the following values:

1981

# - ALL_SUBNETWORKS_ALL_IP_RANGES: All of the IP ranges in every Subnetwork are allowed to Nat.

1982

# - ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES: All of the primary IP ranges in every Subnetwork are allowed to Nat.

1983

# - LIST_OF_SUBNETWORKS: A list of Subnetworks are allowed to Nat (specified in the field subnetwork below) The default is SUBNETWORK_IP_RANGE_TO_NAT_OPTION_UNSPECIFIED. Note that if this field contains ALL_SUBNETWORKS_ALL_IP_RANGES or ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES, then there should not be any other Router.Nat section in any Router for this network in this region.

1984

"subnetworks": [ # A list of Subnetwork resources whose traffic should be translated by NAT Gateway. It is used only when LIST_OF_SUBNETWORKS is selected for the SubnetworkIpRangeToNatOption above.

1985

{ # Defines the IP ranges that want to use NAT for a subnetwork.

1986

"name": "A String", # URL for the subnetwork resource that will use NAT.

1987

"secondaryIpRangeNames": [ # A list of the secondary ranges of the Subnetwork that are allowed to use NAT. This can be populated only if "LIST_OF_SECONDARY_IP_RANGES" is one of the values in source_ip_ranges_to_nat.

1988

"A String",

1989

],

1990

"sourceIpRangesToNat": [ # Specify the options for NAT ranges in the Subnetwork. All options of a single value are valid except NAT_IP_RANGE_OPTION_UNSPECIFIED. The only valid option with multiple values is: ["PRIMARY_IP_RANGE", "LIST_OF_SECONDARY_IP_RANGES"] Default: [ALL_IP_RANGES]

"A String",

],

},

],

"tcpEstablishedIdleTimeoutSec": 42, # Timeout (in seconds) for TCP established connections. Defaults to 1200s if not set.

1996

"tcpTimeWaitTimeoutSec": 42, # Timeout (in seconds) for TCP connections that are in TIME_WAIT state. Defaults to 120s if not set.

1997

"tcpTransitoryIdleTimeoutSec": 42, # Timeout (in seconds) for TCP transitory connections. Defaults to 30s if not set.

1998

"udpIdleTimeoutSec": 42, # Timeout (in seconds) for UDP connections. Defaults to 30s if not set.

1999

},

2000

],

2001

"network": "A String", # URI of the network to which this router belongs.

2002

"region": "A String", # [Output Only] URI of the region where the router resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

2003

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

2004

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

2005

}

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

Returns:

An object of the form:

2010

2011

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2012

"resource": { # Represents a Cloud Router resource. # Preview of given router.

2013

#

2014

# For more information about Cloud Router, read the Cloud Router overview.

2015

"bgp": { # BGP information specific to this router.

2016

"advertiseMode": "A String", # User-specified flag to indicate which mode to use for advertisement. The options are DEFAULT or CUSTOM.

2017

"advertisedGroups": [ # User-specified list of prefix groups to advertise in custom mode. This field can only be populated if advertise_mode is CUSTOM and is advertised to all peers of the router. These groups will be advertised in addition to any specified prefixes. Leave this field blank to advertise no custom groups.

2018

"A String",

2019

],

2020

"advertisedIpRanges": [ # User-specified list of individual IP ranges to advertise in custom mode. This field can only be populated if advertise_mode is CUSTOM and is advertised to all peers of the router. These IP ranges will be advertised in addition to any specified groups. Leave this field blank to advertise no custom IP ranges.

2021

{ # Description-tagged IP ranges for the router to advertise.

2022

"description": "A String", # User-specified description for the IP range.

2023

"range": "A String", # The IP range to advertise. The value must be a CIDR-formatted string.

2024

},

2025

],

2026

"asn": 42, # Local BGP Autonomous System Number (ASN). Must be an RFC6996 private ASN, either 16-bit or 32-bit. The value will be fixed for this router resource. All VPN tunnels that link to this router will have the same local ASN.

2027

"keepaliveInterval": 42, # The interval in seconds between BGP keepalive messages that are sent to the peer.

2028

# Not currently available publicly.

2029

# Hold time is three times the interval at which keepalive messages are sent, and the hold time is the maximum number of seconds allowed to elapse between successive keepalive messages that BGP receives from a peer.

2030

# BGP will use the smaller of either the local hold time value or the peer's hold time value as the hold time for the BGP connection between the two peers.

2031

# If set, this value must be between 1 and 120. The default is 20.

2032

},

2033

"bgpPeers": [ # BGP information that must be configured into the routing stack to establish BGP peering. This information must specify the peer ASN and either the interface name, IP address, or peer IP address. Please refer to RFC4273.

2034

{

2035

"advertiseMode": "A String", # User-specified flag to indicate which mode to use for advertisement.

2036

"advertisedGroups": [ # User-specified list of prefix groups to advertise in custom mode, which can take one of the following options:

2037

# - ALL_SUBNETS: Advertises all available subnets, including peer VPC subnets.

2038

# - ALL_VPC_SUBNETS: Advertises the router's own VPC subnets.

2039

# - ALL_PEER_VPC_SUBNETS: Advertises peer subnets of the router's VPC network. Note that this field can only be populated if advertise_mode is CUSTOM and overrides the list defined for the router (in the "bgp" message). These groups are advertised in addition to any specified prefixes. Leave this field blank to advertise no custom groups.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2040

"A String",

2041

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2042

"advertisedIpRanges": [ # User-specified list of individual IP ranges to advertise in custom mode. This field can only be populated if advertise_mode is CUSTOM and overrides the list defined for the router (in the "bgp" message). These IP ranges are advertised in addition to any specified groups. Leave this field blank to advertise no custom IP ranges.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2043

{ # Description-tagged IP ranges for the router to advertise.

2044

"description": "A String", # User-specified description for the IP range.

2045

"range": "A String", # The IP range to advertise. The value must be a CIDR-formatted string.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2046

},

2047

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2048

"advertisedRoutePriority": 42, # The priority of routes advertised to this BGP peer. Where there is more than one matching route of maximum length, the routes with the lowest priority value win.

2049

"bfd": { # BFD configuration for the BGP peering.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2050

# Not currently available publicly.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2051

"minReceiveInterval": 42, # The minimum interval, in milliseconds, between BFD control packets received from the peer router. The actual value is negotiated between the two routers and is equal to the greater of this value and the transmit interval of the other router.

2052

# Not currently available publicly.

2053

# If set, this value must be between 100 and 30000.

2054

# The default is 300.

2055

"minTransmitInterval": 42, # The minimum interval, in milliseconds, between BFD control packets transmitted to the peer router. The actual value is negotiated between the two routers and is equal to the greater of this value and the corresponding receive interval of the other router.

2056

# Not currently available publicly.

2057

# If set, this value must be between 100 and 30000.

2058

# The default is 300.

2059

"mode": "A String", # The BFD session initialization mode for this BGP peer. If set to ACTIVE, the Cloud Router will initiate the BFD session for this BGP peer. If set to PASSIVE, the Cloud Router will wait for the peer router to initiate the BFD session for this BGP peer. If set to DISABLED, BFD is disabled for this BGP peer. The default is PASSIVE.

2060

"multiplier": 42, # The number of consecutive BFD packets that must be missed before BFD declares that a peer is unavailable.

2061

# Not currently available publicly.

2062

# If set, the value must be a value between 2 and 16.

2063

# The default is 3.

2064

"packetMode": "A String", # The BFD packet mode for this BGP peer. If set to CONTROL_AND_ECHO, BFD echo mode is enabled for this BGP peer. In this mode, if the peer router also has BFD echo mode enabled, BFD echo packets will be sent to the other router. If the peer router does not have BFD echo mode enabled, only control packets will be sent. If set to CONTROL_ONLY, BFD echo mode is disabled for this BGP peer. If this router and the peer router have a multihop connection, this should be set to CONTROL_ONLY as BFD echo mode is only supported on singlehop connections. The default is CONTROL_AND_ECHO.

2065

"sessionInitializationMode": "A String", # The BFD session initialization mode for this BGP peer.

2066

# Not currently available publicly.

2067

# If set to ACTIVE, the Cloud Router will initiate the BFD session for this BGP peer. If set to PASSIVE, the Cloud Router will wait for the peer router to initiate the BFD session for this BGP peer. If set to DISABLED, BFD is disabled for this BGP peer. The default is PASSIVE.

2068

"slowTimerInterval": 42, # The minimum interval, in milliseconds, between BFD control packets transmitted to and received from the peer router when BFD echo mode is enabled on both routers. The actual transmit and receive intervals are negotiated between the two routers and are equal to the greater of this value and the corresponding interval on the other router. If set, this value must be between 1000 and 30000. The default is 5000.

2069

},

2070

"enable": "A String", # The status of the BGP peer connection.

2071

# Not currently available publicly.

2072

# If set to FALSE, any active session with the peer is terminated and all associated routing information is removed. If set to TRUE, the peer connection can be established with routing information. The default is TRUE.

2073

"interfaceName": "A String", # Name of the interface the BGP peer is associated with.

2074

"ipAddress": "A String", # IP address of the interface inside Google Cloud Platform. Only IPv4 is supported.

2075

"managementType": "A String", # [Output Only] The resource that configures and manages this BGP peer.

2076

# - MANAGED_BY_USER is the default value and can be managed by you or other users

2077

# - MANAGED_BY_ATTACHMENT is a BGP peer that is configured and managed by Cloud Interconnect, specifically by an InterconnectAttachment of type PARTNER. Google automatically creates, updates, and deletes this type of BGP peer when the PARTNER InterconnectAttachment is created, updated, or deleted.

2078

"name": "A String", # Name of this BGP peer. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

2079

"peerAsn": 42, # Peer BGP Autonomous System Number (ASN). Each BGP interface may use a different value.

2080

"peerIpAddress": "A String", # IP address of the BGP interface outside Google Cloud Platform. Only IPv4 is supported.

2081

"routerApplianceInstance": "A String", # URI of the VM instance that is used as third-party router appliances such as Next Gen Firewalls, Virtual Routers, or Router Appliances. The VM instance must be located in zones contained in the same region as this Cloud Router. The VM instance is the peer side of the BGP session.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2082

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2083

],

2084

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

2085

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

2086

"encryptedInterconnectRouter": True or False, # Field to indicate if a router is dedicated to use with encrypted Interconnect Attachment (Encrypted Interconnect feature).

2087

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

2088

"interfaces": [ # Router interfaces. Each interface requires either one linked resource, (for example, linkedVpnTunnel), or IP address and IP address range (for example, ipRange), or both.

2089

{

2090

"ipRange": "A String", # IP address and range of the interface. The IP range must be in the RFC3927 link-local IP address space. The value must be a CIDR-formatted string, for example: 169.254.0.1/30. NOTE: Do not truncate the address as it represents the IP address of the interface.

2091

"linkedInterconnectAttachment": "A String", # URI of the linked Interconnect attachment. It must be in the same region as the router. Each interface can have one linked resource, which can be a VPN tunnel, an Interconnect attachment, or a virtual machine instance.

2092

"linkedVpnTunnel": "A String", # URI of the linked VPN tunnel, which must be in the same region as the router. Each interface can have one linked resource, which can be a VPN tunnel, an Interconnect attachment, or a virtual machine instance.

2093

"managementType": "A String", # [Output Only] The resource that configures and manages this interface.

2094

# - MANAGED_BY_USER is the default value and can be managed directly by users.

2095

# - MANAGED_BY_ATTACHMENT is an interface that is configured and managed by Cloud Interconnect, specifically, by an InterconnectAttachment of type PARTNER. Google automatically creates, updates, and deletes this type of interface when the PARTNER InterconnectAttachment is created, updated, or deleted.

2096

"name": "A String", # Name of this interface entry. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

2097

"privateIpAddress": "A String", # The regional private internal IP address that is used to establish BGP sessions to a VM instance acting as a third-party Router Appliance, such as a Next Gen Firewall, a Virtual Router, or an SD-WAN VM.

2098

"redundantInterface": "A String", # Name of the interface that will be redundant with the current interface you are creating. The redundantInterface must belong to the same Cloud Router as the interface here. To establish the BGP session to a Router Appliance VM, you must create two BGP peers. The two BGP peers must be attached to two separate interfaces that are redundant with each other. The redundant_interface must be 1-63 characters long, and comply with RFC1035. Specifically, the redundant_interface must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

2099

"subnetwork": "A String", # The URL of the subnetwork resource that this interface belongs to, which must be in the same region as the Cloud Router. When you establish a BGP session to a VM instance using this interface, the VM instance must belong to the same subnetwork as the subnetwork specified here.

2100

},

2101

],

2102

"kind": "compute#router", # [Output Only] Type of resource. Always compute#router for routers.

2103

"name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

2104

"nats": [ # A list of NAT services created in this router.

2105

{ # Represents a Nat resource. It enables the VMs within the specified subnetworks to access Internet without external IP addresses. It specifies a list of subnetworks (and the ranges within) that want to use NAT. Customers can also provide the external IPs that would be used for NAT. GCP would auto-allocate ephemeral IPs if no external IPs are provided.

2106

"drainNatIps": [ # A list of URLs of the IP resources to be drained. These IPs must be valid static external IPs that have been assigned to the NAT. These IPs should be used for updating/patching a NAT only.

2107

"A String",

2108

],

2109

"enableEndpointIndependentMapping": True or False,

2110

"icmpIdleTimeoutSec": 42, # Timeout (in seconds) for ICMP connections. Defaults to 30s if not set.

2111

"logConfig": { # Configuration of logging on a NAT. # Configure logging on this NAT.

2112

"enable": True or False, # Indicates whether or not to export logs. This is false by default.

2113

"filter": "A String", # Specify the desired filtering of logs on this NAT. If unspecified, logs are exported for all connections handled by this NAT. This option can take one of the following values:

2114

# - ERRORS_ONLY: Export logs only for connection failures.

2115

# - TRANSLATIONS_ONLY: Export logs only for successful connections.

2116

# - ALL: Export logs for all connections, successful and unsuccessful.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2117

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2118

"minPortsPerVm": 42, # Minimum number of ports allocated to a VM from this NAT config. If not set, a default number of ports is allocated to a VM. This is rounded up to the nearest power of 2. For example, if the value of this field is 50, at least 64 ports are allocated to a VM.

2119

"name": "A String", # Unique name of this Nat service. The name must be 1-63 characters long and comply with RFC1035.

2120

"natIpAllocateOption": "A String", # Specify the NatIpAllocateOption, which can take one of the following values:

2121

# - MANUAL_ONLY: Uses only Nat IP addresses provided by customers. When there are not enough specified Nat IPs, the Nat service fails for new VMs.

2122

# - AUTO_ONLY: Nat IPs are allocated by Google Cloud Platform; customers can't specify any Nat IPs. When choosing AUTO_ONLY, then nat_ip should be empty.

2123

"natIps": [ # A list of URLs of the IP resources used for this Nat service. These IP addresses must be valid static external IP addresses assigned to the project.

2124

"A String",

2125

],

2126

"rules": [ # A list of rules associated with this NAT.

2127

{

2128

"action": { # The action to be enforced for traffic that matches this rule.

2129

"sourceNatActiveIps": [ # A list of URLs of the IP resources used for this NAT rule. These IP addresses must be valid static external IP addresses assigned to the project.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2130

"A String",

2131

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2132

"sourceNatDrainIps": [ # A list of URLs of the IP resources to be drained. These IPs must be valid static external IPs that have been assigned to the NAT. These IPs should be used for updating/patching a NAT rule only.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2133

"A String",

2134

],

2135

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2136

"description": "A String", # An optional description of this rule.

2137

"match": "A String", # CEL expression that specifies the match condition that egress traffic from a VM is evaluated against. If it evaluates to true, the corresponding ?action? is enforced.

2138

#

2139

# The following examples are valid match expressions:

2140

#

2141

# "inIpRange(destination.ip, '1.1.0.0/16') || inIpRange(destination.ip, '2.2.0.0/16')"

2142

#

2143

# "destination.ip == '1.1.0.1' || destination.ip == '8.8.8.8'"

2144

"ruleNumber": 42, # An integer uniquely identifying a rule in the list. The rule number must be a positive value between 0 and 65000, and must be unique among rules within a NAT.

2145

},

2146

],

2147

"sourceSubnetworkIpRangesToNat": "A String", # Specify the Nat option, which can take one of the following values:

2148

# - ALL_SUBNETWORKS_ALL_IP_RANGES: All of the IP ranges in every Subnetwork are allowed to Nat.

2149

# - ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES: All of the primary IP ranges in every Subnetwork are allowed to Nat.

2150

# - LIST_OF_SUBNETWORKS: A list of Subnetworks are allowed to Nat (specified in the field subnetwork below) The default is SUBNETWORK_IP_RANGE_TO_NAT_OPTION_UNSPECIFIED. Note that if this field contains ALL_SUBNETWORKS_ALL_IP_RANGES or ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES, then there should not be any other Router.Nat section in any Router for this network in this region.

2151

"subnetworks": [ # A list of Subnetwork resources whose traffic should be translated by NAT Gateway. It is used only when LIST_OF_SUBNETWORKS is selected for the SubnetworkIpRangeToNatOption above.

2152

{ # Defines the IP ranges that want to use NAT for a subnetwork.

2153

"name": "A String", # URL for the subnetwork resource that will use NAT.

2154

"secondaryIpRangeNames": [ # A list of the secondary ranges of the Subnetwork that are allowed to use NAT. This can be populated only if "LIST_OF_SECONDARY_IP_RANGES" is one of the values in source_ip_ranges_to_nat.

2155

"A String",

2156

],

2157

"sourceIpRangesToNat": [ # Specify the options for NAT ranges in the Subnetwork. All options of a single value are valid except NAT_IP_RANGE_OPTION_UNSPECIFIED. The only valid option with multiple values is: ["PRIMARY_IP_RANGE", "LIST_OF_SECONDARY_IP_RANGES"] Default: [ALL_IP_RANGES]

"A String",

],

},

],

"tcpEstablishedIdleTimeoutSec": 42, # Timeout (in seconds) for TCP established connections. Defaults to 1200s if not set.

2163

"tcpTimeWaitTimeoutSec": 42, # Timeout (in seconds) for TCP connections that are in TIME_WAIT state. Defaults to 120s if not set.

2164

"tcpTransitoryIdleTimeoutSec": 42, # Timeout (in seconds) for TCP transitory connections. Defaults to 30s if not set.

2165

"udpIdleTimeoutSec": 42, # Timeout (in seconds) for UDP connections. Defaults to 30s if not set.

2166

},

2167

],

2168

"network": "A String", # URI of the network to which this router belongs.

2169

"region": "A String", # [Output Only] URI of the region where the router resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

2170

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

2171

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

2172

},

2173

}</pre>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2177

<code class="details" id="testIamPermissions">testIamPermissions(project, region, resource, body=None)</code>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2178

<pre>Returns permissions that a caller has on the specified resource.

2179

2180

Args:

2181

project: string, Project ID for this request. (required)

2182

region: string, The name of the region for this request. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2183

resource: string, Name or id of the resource for this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2184

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2185

The object takes the form of:

2186

2187

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2188

"permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.

2189

"A String",

2190

],

2191

}

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

Returns:

An object of the form:

2196

2197

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2198

"permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.

2199

"A String",

2200

],

2201

}</pre>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2205

<code class="details" id="update">update(project, region, router, body=None, requestId=None)</code>

2206

<pre>Updates the specified Router resource with the data included in the request. This method conforms to PUT semantics, which requests that the state of the target resource be created or replaced with the state defined by the representation enclosed in the request message payload.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2207

2208

Args:

2209

project: string, Project ID for this request. (required)

2210

region: string, Name of the region for this request. (required)

2211

router: string, Name of the Router resource to update. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2212

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2213

The object takes the form of:

2214

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2215

{ # Represents a Cloud Router resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2216

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2217

# For more information about Cloud Router, read the Cloud Router overview.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2218

"bgp": { # BGP information specific to this router.

2219

"advertiseMode": "A String", # User-specified flag to indicate which mode to use for advertisement. The options are DEFAULT or CUSTOM.

2220

"advertisedGroups": [ # User-specified list of prefix groups to advertise in custom mode. This field can only be populated if advertise_mode is CUSTOM and is advertised to all peers of the router. These groups will be advertised in addition to any specified prefixes. Leave this field blank to advertise no custom groups.

2221

"A String",

2222

],

2223

"advertisedIpRanges": [ # User-specified list of individual IP ranges to advertise in custom mode. This field can only be populated if advertise_mode is CUSTOM and is advertised to all peers of the router. These IP ranges will be advertised in addition to any specified groups. Leave this field blank to advertise no custom IP ranges.

2224

{ # Description-tagged IP ranges for the router to advertise.

2225

"description": "A String", # User-specified description for the IP range.

2226

"range": "A String", # The IP range to advertise. The value must be a CIDR-formatted string.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2227

},

2228

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2229

"asn": 42, # Local BGP Autonomous System Number (ASN). Must be an RFC6996 private ASN, either 16-bit or 32-bit. The value will be fixed for this router resource. All VPN tunnels that link to this router will have the same local ASN.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2230

"keepaliveInterval": 42, # The interval in seconds between BGP keepalive messages that are sent to the peer.

2231

# Not currently available publicly.

2232

# Hold time is three times the interval at which keepalive messages are sent, and the hold time is the maximum number of seconds allowed to elapse between successive keepalive messages that BGP receives from a peer.

2233

# BGP will use the smaller of either the local hold time value or the peer's hold time value as the hold time for the BGP connection between the two peers.

2234

# If set, this value must be between 1 and 120. The default is 20.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2235

},

2236

"bgpPeers": [ # BGP information that must be configured into the routing stack to establish BGP peering. This information must specify the peer ASN and either the interface name, IP address, or peer IP address. Please refer to RFC4273.

2237

{

2238

"advertiseMode": "A String", # User-specified flag to indicate which mode to use for advertisement.

2239

"advertisedGroups": [ # User-specified list of prefix groups to advertise in custom mode, which can take one of the following options:

2240

# - ALL_SUBNETS: Advertises all available subnets, including peer VPC subnets.

2241

# - ALL_VPC_SUBNETS: Advertises the router's own VPC subnets.

2242

# - ALL_PEER_VPC_SUBNETS: Advertises peer subnets of the router's VPC network. Note that this field can only be populated if advertise_mode is CUSTOM and overrides the list defined for the router (in the "bgp" message). These groups are advertised in addition to any specified prefixes. Leave this field blank to advertise no custom groups.

2243

"A String",

2244

],

2245

"advertisedIpRanges": [ # User-specified list of individual IP ranges to advertise in custom mode. This field can only be populated if advertise_mode is CUSTOM and overrides the list defined for the router (in the "bgp" message). These IP ranges are advertised in addition to any specified groups. Leave this field blank to advertise no custom IP ranges.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2246

{ # Description-tagged IP ranges for the router to advertise.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2247

"description": "A String", # User-specified description for the IP range.

2248

"range": "A String", # The IP range to advertise. The value must be a CIDR-formatted string.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

2249

},

2250

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2251

"advertisedRoutePriority": 42, # The priority of routes advertised to this BGP peer. Where there is more than one matching route of maximum length, the routes with the lowest priority value win.

2252

"bfd": { # BFD configuration for the BGP peering.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2253

# Not currently available publicly.

2254

"minReceiveInterval": 42, # The minimum interval, in milliseconds, between BFD control packets received from the peer router. The actual value is negotiated between the two routers and is equal to the greater of this value and the transmit interval of the other router.

2255

# Not currently available publicly.

2256

# If set, this value must be between 100 and 30000.

2257

# The default is 300.

2258

"minTransmitInterval": 42, # The minimum interval, in milliseconds, between BFD control packets transmitted to the peer router. The actual value is negotiated between the two routers and is equal to the greater of this value and the corresponding receive interval of the other router.

2259

# Not currently available publicly.

2260

# If set, this value must be between 100 and 30000.

2261

# The default is 300.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2262

"mode": "A String", # The BFD session initialization mode for this BGP peer. If set to ACTIVE, the Cloud Router will initiate the BFD session for this BGP peer. If set to PASSIVE, the Cloud Router will wait for the peer router to initiate the BFD session for this BGP peer. If set to DISABLED, BFD is disabled for this BGP peer. The default is PASSIVE.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2263

"multiplier": 42, # The number of consecutive BFD packets that must be missed before BFD declares that a peer is unavailable.

2264

# Not currently available publicly.

2265

# If set, the value must be a value between 2 and 16.

2266

# The default is 3.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2267

"packetMode": "A String", # The BFD packet mode for this BGP peer. If set to CONTROL_AND_ECHO, BFD echo mode is enabled for this BGP peer. In this mode, if the peer router also has BFD echo mode enabled, BFD echo packets will be sent to the other router. If the peer router does not have BFD echo mode enabled, only control packets will be sent. If set to CONTROL_ONLY, BFD echo mode is disabled for this BGP peer. If this router and the peer router have a multihop connection, this should be set to CONTROL_ONLY as BFD echo mode is only supported on singlehop connections. The default is CONTROL_AND_ECHO.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2268

"sessionInitializationMode": "A String", # The BFD session initialization mode for this BGP peer.

2269

# Not currently available publicly.

2270

# If set to ACTIVE, the Cloud Router will initiate the BFD session for this BGP peer. If set to PASSIVE, the Cloud Router will wait for the peer router to initiate the BFD session for this BGP peer. If set to DISABLED, BFD is disabled for this BGP peer. The default is PASSIVE.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2271

"slowTimerInterval": 42, # The minimum interval, in milliseconds, between BFD control packets transmitted to and received from the peer router when BFD echo mode is enabled on both routers. The actual transmit and receive intervals are negotiated between the two routers and are equal to the greater of this value and the corresponding interval on the other router. If set, this value must be between 1000 and 30000. The default is 5000.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2272

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2273

"enable": "A String", # The status of the BGP peer connection.

2274

# Not currently available publicly.

2275

# If set to FALSE, any active session with the peer is terminated and all associated routing information is removed. If set to TRUE, the peer connection can be established with routing information. The default is TRUE.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2276

"interfaceName": "A String", # Name of the interface the BGP peer is associated with.

2277

"ipAddress": "A String", # IP address of the interface inside Google Cloud Platform. Only IPv4 is supported.

2278

"managementType": "A String", # [Output Only] The resource that configures and manages this BGP peer.

2279

# - MANAGED_BY_USER is the default value and can be managed by you or other users

2280

# - MANAGED_BY_ATTACHMENT is a BGP peer that is configured and managed by Cloud Interconnect, specifically by an InterconnectAttachment of type PARTNER. Google automatically creates, updates, and deletes this type of BGP peer when the PARTNER InterconnectAttachment is created, updated, or deleted.

2281

"name": "A String", # Name of this BGP peer. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

2282

"peerAsn": 42, # Peer BGP Autonomous System Number (ASN). Each BGP interface may use a different value.

2283

"peerIpAddress": "A String", # IP address of the BGP interface outside Google Cloud Platform. Only IPv4 is supported.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2284

"routerApplianceInstance": "A String", # URI of the VM instance that is used as third-party router appliances such as Next Gen Firewalls, Virtual Routers, or Router Appliances. The VM instance must be located in zones contained in the same region as this Cloud Router. The VM instance is the peer side of the BGP session.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2285

},

2286

],

2287

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

2288

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2289

"encryptedInterconnectRouter": True or False, # Field to indicate if a router is dedicated to use with encrypted Interconnect Attachment (Encrypted Interconnect feature).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2290

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

2291

"interfaces": [ # Router interfaces. Each interface requires either one linked resource, (for example, linkedVpnTunnel), or IP address and IP address range (for example, ipRange), or both.

2292

{

2293

"ipRange": "A String", # IP address and range of the interface. The IP range must be in the RFC3927 link-local IP address space. The value must be a CIDR-formatted string, for example: 169.254.0.1/30. NOTE: Do not truncate the address as it represents the IP address of the interface.

2294

"linkedInterconnectAttachment": "A String", # URI of the linked Interconnect attachment. It must be in the same region as the router. Each interface can have one linked resource, which can be a VPN tunnel, an Interconnect attachment, or a virtual machine instance.

2295

"linkedVpnTunnel": "A String", # URI of the linked VPN tunnel, which must be in the same region as the router. Each interface can have one linked resource, which can be a VPN tunnel, an Interconnect attachment, or a virtual machine instance.

2296

"managementType": "A String", # [Output Only] The resource that configures and manages this interface.

2297

# - MANAGED_BY_USER is the default value and can be managed directly by users.

2298

# - MANAGED_BY_ATTACHMENT is an interface that is configured and managed by Cloud Interconnect, specifically, by an InterconnectAttachment of type PARTNER. Google automatically creates, updates, and deletes this type of interface when the PARTNER InterconnectAttachment is created, updated, or deleted.

2299

"name": "A String", # Name of this interface entry. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2300

"privateIpAddress": "A String", # The regional private internal IP address that is used to establish BGP sessions to a VM instance acting as a third-party Router Appliance, such as a Next Gen Firewall, a Virtual Router, or an SD-WAN VM.

2301

"redundantInterface": "A String", # Name of the interface that will be redundant with the current interface you are creating. The redundantInterface must belong to the same Cloud Router as the interface here. To establish the BGP session to a Router Appliance VM, you must create two BGP peers. The two BGP peers must be attached to two separate interfaces that are redundant with each other. The redundant_interface must be 1-63 characters long, and comply with RFC1035. Specifically, the redundant_interface must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

2302

"subnetwork": "A String", # The URL of the subnetwork resource that this interface belongs to, which must be in the same region as the Cloud Router. When you establish a BGP session to a VM instance using this interface, the VM instance must belong to the same subnetwork as the subnetwork specified here.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2303

},

2304

],

2305

"kind": "compute#router", # [Output Only] Type of resource. Always compute#router for routers.

2306

"name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

2307

"nats": [ # A list of NAT services created in this router.

2308

{ # Represents a Nat resource. It enables the VMs within the specified subnetworks to access Internet without external IP addresses. It specifies a list of subnetworks (and the ranges within) that want to use NAT. Customers can also provide the external IPs that would be used for NAT. GCP would auto-allocate ephemeral IPs if no external IPs are provided.

2309

"drainNatIps": [ # A list of URLs of the IP resources to be drained. These IPs must be valid static external IPs that have been assigned to the NAT. These IPs should be used for updating/patching a NAT only.

2310

"A String",

2311

],

2312

"enableEndpointIndependentMapping": True or False,

2313

"icmpIdleTimeoutSec": 42, # Timeout (in seconds) for ICMP connections. Defaults to 30s if not set.

2314

"logConfig": { # Configuration of logging on a NAT. # Configure logging on this NAT.

2315

"enable": True or False, # Indicates whether or not to export logs. This is false by default.

2316

"filter": "A String", # Specify the desired filtering of logs on this NAT. If unspecified, logs are exported for all connections handled by this NAT. This option can take one of the following values:

2317

# - ERRORS_ONLY: Export logs only for connection failures.

2318

# - TRANSLATIONS_ONLY: Export logs only for successful connections.

2319

# - ALL: Export logs for all connections, successful and unsuccessful.

2320

},

2321

"minPortsPerVm": 42, # Minimum number of ports allocated to a VM from this NAT config. If not set, a default number of ports is allocated to a VM. This is rounded up to the nearest power of 2. For example, if the value of this field is 50, at least 64 ports are allocated to a VM.

2322

"name": "A String", # Unique name of this Nat service. The name must be 1-63 characters long and comply with RFC1035.

2323

"natIpAllocateOption": "A String", # Specify the NatIpAllocateOption, which can take one of the following values:

2324

# - MANUAL_ONLY: Uses only Nat IP addresses provided by customers. When there are not enough specified Nat IPs, the Nat service fails for new VMs.

2325

# - AUTO_ONLY: Nat IPs are allocated by Google Cloud Platform; customers can't specify any Nat IPs. When choosing AUTO_ONLY, then nat_ip should be empty.

2326

"natIps": [ # A list of URLs of the IP resources used for this Nat service. These IP addresses must be valid static external IP addresses assigned to the project.

2327

"A String",

2328

],

2329

"rules": [ # A list of rules associated with this NAT.

2330

{

2331

"action": { # The action to be enforced for traffic that matches this rule.

2332

"sourceNatActiveIps": [ # A list of URLs of the IP resources used for this NAT rule. These IP addresses must be valid static external IP addresses assigned to the project.

2333

"A String",

2334

],

2335

"sourceNatDrainIps": [ # A list of URLs of the IP resources to be drained. These IPs must be valid static external IPs that have been assigned to the NAT. These IPs should be used for updating/patching a NAT rule only.

"A String",

],

},

"description": "A String", # An optional description of this rule.

2340

"match": "A String", # CEL expression that specifies the match condition that egress traffic from a VM is evaluated against. If it evaluates to true, the corresponding ?action? is enforced.

2341

#

2342

# The following examples are valid match expressions:

2343

#

2344

# "inIpRange(destination.ip, '1.1.0.0/16') || inIpRange(destination.ip, '2.2.0.0/16')"

2345

#

2346

# "destination.ip == '1.1.0.1' || destination.ip == '8.8.8.8'"

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2347

"ruleNumber": 42, # An integer uniquely identifying a rule in the list. The rule number must be a positive value between 0 and 65000, and must be unique among rules within a NAT.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2348

},

2349

],

2350

"sourceSubnetworkIpRangesToNat": "A String", # Specify the Nat option, which can take one of the following values:

2351

# - ALL_SUBNETWORKS_ALL_IP_RANGES: All of the IP ranges in every Subnetwork are allowed to Nat.

2352

# - ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES: All of the primary IP ranges in every Subnetwork are allowed to Nat.

2353

# - LIST_OF_SUBNETWORKS: A list of Subnetworks are allowed to Nat (specified in the field subnetwork below) The default is SUBNETWORK_IP_RANGE_TO_NAT_OPTION_UNSPECIFIED. Note that if this field contains ALL_SUBNETWORKS_ALL_IP_RANGES or ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES, then there should not be any other Router.Nat section in any Router for this network in this region.

2354

"subnetworks": [ # A list of Subnetwork resources whose traffic should be translated by NAT Gateway. It is used only when LIST_OF_SUBNETWORKS is selected for the SubnetworkIpRangeToNatOption above.

2355

{ # Defines the IP ranges that want to use NAT for a subnetwork.

2356

"name": "A String", # URL for the subnetwork resource that will use NAT.

2357

"secondaryIpRangeNames": [ # A list of the secondary ranges of the Subnetwork that are allowed to use NAT. This can be populated only if "LIST_OF_SECONDARY_IP_RANGES" is one of the values in source_ip_ranges_to_nat.

2358

"A String",

2359

],

2360

"sourceIpRangesToNat": [ # Specify the options for NAT ranges in the Subnetwork. All options of a single value are valid except NAT_IP_RANGE_OPTION_UNSPECIFIED. The only valid option with multiple values is: ["PRIMARY_IP_RANGE", "LIST_OF_SECONDARY_IP_RANGES"] Default: [ALL_IP_RANGES]

"A String",

],

},

],

"tcpEstablishedIdleTimeoutSec": 42, # Timeout (in seconds) for TCP established connections. Defaults to 1200s if not set.

2366

"tcpTimeWaitTimeoutSec": 42, # Timeout (in seconds) for TCP connections that are in TIME_WAIT state. Defaults to 120s if not set.

2367

"tcpTransitoryIdleTimeoutSec": 42, # Timeout (in seconds) for TCP transitory connections. Defaults to 30s if not set.

2368

"udpIdleTimeoutSec": 42, # Timeout (in seconds) for UDP connections. Defaults to 30s if not set.

2369

},

2370

],

2371

"network": "A String", # URI of the network to which this router belongs.

2372

"region": "A String", # [Output Only] URI of the region where the router resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

2373

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

2374

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

2375

}

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2376

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2377

requestId: string, 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.

2378

2379

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.

2380

2381

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2382

2383

Returns:

2384

An object of the form:

2385

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2386

{ # Represents an Operation resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2387

#

2388

# Google Compute Engine has three Operation resources:

2389

#

2390

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

2391

#

2392

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

2393

#

2394

# Operations can be global, regional or zonal.

2395

# - For global operations, use the `globalOperations` resource.

2396

# - For regional operations, use the `regionOperations` resource.

2397

# - For zonal operations, use the `zonalOperations` resource.

2398

#

2399

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

2400

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

2401

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

2402

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

2403

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

2404

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

2405

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2406

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2407

"code": "A String", # [Output Only] The error type identifier for this error.

2408

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

2409

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2410

},

2411

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2412

},

2413

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

2414

"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.

2415

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

2416

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

2417

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame^]

2418

"metadata": { # `Any` contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message. # [Output Only] Service-specific metadata attached to this operation.

2419

#

2420

# Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type.

2421

#

2422

# Example 1: Pack and unpack a message in C++.

2423

#

2424

# Foo foo = ...; Any any; any.PackFrom(foo); ... if (any.UnpackTo(&foo)) { ... }

2425

#

2426

# Example 2: Pack and unpack a message in Java.

2427

#

2428

# Foo foo = ...; Any any = Any.pack(foo); ... if (any.is(Foo.class)) { foo = any.unpack(Foo.class); }

2429

#

2430

# Example 3: Pack and unpack a message in Python.

2431

#

2432

# foo = Foo(...) any = Any() any.Pack(foo) ... if any.Is(Foo.DESCRIPTOR): any.Unpack(foo) ...

2433

#

2434

# Example 4: Pack and unpack a message in Go

2435

#

2436

# foo := &pb.Foo{...} any, err := anypb.New(foo) if err != nil { ... } ... foo := &pb.Foo{} if err := any.UnmarshalTo(foo); err != nil { ... }

2437

#

2438

# The pack methods provided by protobuf library will by default use 'type.googleapis.com/full.type.name' as the type URL and the unpack methods only use the fully qualified type name after the last '/' in the type URL, for example "foo.bar.com/x/y.z" will yield type name "y.z".

#

#

#

# JSON ==== The JSON representation of an `Any` value uses the regular representation of the deserialized, embedded message, with an additional field `@type` which contains the type URL. Example:

2443

#

2444

# package google.profile; message Person { string first_name = 1; string last_name = 2; }

2445

#

2446

# { "@type": "type.googleapis.com/google.profile.Person", "firstName": , "lastName": }

2447

#

2448

# If the embedded message type is well-known and has a custom JSON representation, that representation will be embedded adding a field `value` which holds the custom JSON in addition to the `@type` field. Example (for message [google.protobuf.Duration][]):

2449

#

2450

# { "@type": "type.googleapis.com/google.protobuf.Duration", "value": "1.212s" }

2451

"typeUrl": "A String", # A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in `path/google.protobuf.Duration`). The name should be in a canonical form (e.g., leading "." is not accepted).

2452

#

2453

# In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme `http`, `https`, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:

2454

#

2455

# * If no scheme is provided, `https` is assumed. * An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error. * Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)

2456

#

2457

# Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.

2458

#

2459

# Schemes other than `http`, `https` (or the empty scheme) might be used with implementation specific semantics.

2460

"value": "A String", # Must be a valid serialized protocol buffer of the above specified type.

2461

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2462

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame^]

2463

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot