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

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

[diff] [blame]

79

<p class="firstline">Retrieves an aggregated list of VPN gateways.</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

84

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

85

<p class="firstline">Deletes the specified VPN gateway.</p>

86

87

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

88

<p class="firstline">Returns the specified VPN gateway. Gets a list of available VPN gateways by making a list() request.</p>

89

90

<code><a href="#getStatus">getStatus(project, region, vpnGateway)</a></code></p>

91

<p class="firstline">Returns the status for the specified VPN gateway.</p>

92

Dan O'Meara

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

[diff] [blame]

93

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

Bu Sun Kim

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

[diff] [blame]

94

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

95

Bu Sun Kim

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

[diff] [blame]

96

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

Bu Sun Kim

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

[diff] [blame]

97

<p class="firstline">Retrieves a list of VPN gateways available to the specified project and region.</p>

98

99

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

100

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

101

Dan O'Meara

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

[diff] [blame]

102

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

Bu Sun Kim

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

[diff] [blame]

103

<p class="firstline">Sets the labels on a VpnGateway. To learn more about labels, read the Labeling Resources documentation.</p>

104

Dan O'Meara

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

[diff] [blame]

105

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

Bu Sun Kim

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

[diff] [blame]

106

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

107

<h3>Method Details</h3>

108

Bu Sun Kim

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

[diff] [blame]

109

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

Bu Sun Kim

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

[diff] [blame]

110

<pre>Retrieves an aggregated list of VPN gateways.

111

112

Args:

113

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

Dan O'Meara

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

[diff] [blame]

114

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]

115

Dan O'Meara

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

[diff] [blame]

116

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]

117

Dan O'Meara

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

[diff] [blame]

118

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]

119

Bu Sun Kim

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

[diff] [blame]

120

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]

121

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]

122

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`)

123

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

124

125

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.

126

127

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

128

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.

129

returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false and the logic is the same as today.

Bu Sun Kim

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

[diff] [blame]

130

131

Returns:

132

An object of the form:

133

134

{

Bu Sun Kim

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

[diff] [blame]

135

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

136

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

137

"a_key": { # [Output Only] Name of the scope containing this set of VPN gateways.

138

"vpnGateways": [ # [Output Only] A list of VPN gateways contained in this scope.

139

{ # Represents a HA VPN gateway.

140

#

141

# HA VPN is a high-availability (HA) Cloud VPN solution that lets you securely connect your on-premises network to your Google Cloud Virtual Private Cloud network through an IPsec VPN connection in a single region. For more information about Cloud HA VPN solutions, see Cloud VPN topologies . (== resource_for {$api_version}.vpnGateways ==)

142

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

143

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

144

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

145

"kind": "compute#vpnGateway", # [Output Only] Type of resource. Always compute#vpnGateway for VPN gateways.

146

"labelFingerprint": "A String", # A fingerprint for the labels being applied to this VpnGateway, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet.

147

#

148

# To see the latest fingerprint, make a get() request to retrieve an VpnGateway.

149

"labels": { # Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.

150

"a_key": "A String",

151

},

152

"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.

153

"network": "A String", # URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created.

154

"region": "A String", # [Output Only] URL of the region where the VPN gateway resides.

155

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

156

"vpnInterfaces": [ # A list of interfaces on this VPN gateway.

157

{ # A VPN gateway interface.

158

"id": 42, # The numeric ID of this VPN gateway interface.

159

"ipAddress": "A String", # [Output Only] The external IP address for this VPN gateway interface.

},

],

},

],

"warning": { # [Output Only] Informational warning which replaces the list of addresses when the list is empty.

165

"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.

166

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

167

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

Bu Sun Kim

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

[diff] [blame]

168

{

Bu Sun Kim

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

[diff] [blame]

169

"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).

170

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

Bu Sun Kim

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

[diff] [blame]

171

},

172

],

Bu Sun Kim

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

[diff] [blame]

173

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

Bu Sun Kim

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

[diff] [blame]

174

},

Bu Sun Kim

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

[diff] [blame]

175

},

176

},

Bu Sun Kim

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

[diff] [blame]

177

"kind": "compute#vpnGatewayAggregatedList", # [Output Only] Type of resource. Always compute#vpnGateway for VPN gateways.

178

"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.

179

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

180

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

181

"A String",

182

],

183

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

184

"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.

185

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

186

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

Bu Sun Kim

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

[diff] [blame]

187

{

Bu Sun Kim

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

[diff] [blame]

188

"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).

189

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

Bu Sun Kim

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

[diff] [blame]

190

},

191

],

Bu Sun Kim

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

[diff] [blame]

192

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

Bu Sun Kim

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

[diff] [blame]

193

},

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

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

199

<pre>Retrieves the next page of results.

200

201

Args:

202

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

203

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

204

205

Returns:

Bu Sun Kim

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

[diff] [blame]

206

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]

207

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

</pre>

</div>

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

213

<pre>Deletes the specified VPN gateway.

214

215

Args:

216

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

217

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

218

vpnGateway: string, Name of the VPN gateway to delete. (required)

219

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.

220

221

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.

222

223

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

224

225

Returns:

226

An object of the form:

227

228

{ # Represents an Operation resource.

229

#

Dan O'Meara

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

[diff] [blame]

230

# Google Compute Engine has three Operation resources:

231

#

232

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

233

#

Bu Sun Kim

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

[diff] [blame]

234

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

235

#

236

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

237

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

238

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

239

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

Bu Sun Kim

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

[diff] [blame]

240

#

Dan O'Meara

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

[diff] [blame]

241

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

Bu Sun Kim

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

[diff] [blame]

242

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

243

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

244

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

245

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

246

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

247

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

Bu Sun Kim

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

[diff] [blame]

248

{

Bu Sun Kim

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

[diff] [blame]

249

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

250

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

251

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

Bu Sun Kim

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

[diff] [blame]

252

},

253

],

254

},

Bu Sun Kim

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

[diff] [blame]

255

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

256

"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.

257

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

258

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

259

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

260

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

261

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

262

"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.

263

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

264

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

265

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

266

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

267

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

268

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

269

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

270

"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.

271

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

272

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

273

{

274

"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.

275

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

276

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

277

{

278

"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).

279

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

280

},

281

],

282

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

283

},

284

],

285

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

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

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

291

<pre>Returns the specified VPN gateway. Gets a list of available VPN gateways by making a list() request.

292

293

Args:

294

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

295

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

296

vpnGateway: string, Name of the VPN gateway to return. (required)

297

298

Returns:

299

An object of the form:

300

Bu Sun Kim

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

[diff] [blame]

301

{ # Represents a HA VPN gateway.

302

#

303

# HA VPN is a high-availability (HA) Cloud VPN solution that lets you securely connect your on-premises network to your Google Cloud Virtual Private Cloud network through an IPsec VPN connection in a single region. For more information about Cloud HA VPN solutions, see Cloud VPN topologies . (== resource_for {$api_version}.vpnGateways ==)

304

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

305

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

306

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

307

"kind": "compute#vpnGateway", # [Output Only] Type of resource. Always compute#vpnGateway for VPN gateways.

308

"labelFingerprint": "A String", # A fingerprint for the labels being applied to this VpnGateway, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet.

309

#

310

# To see the latest fingerprint, make a get() request to retrieve an VpnGateway.

311

"labels": { # Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.

312

"a_key": "A String",

313

},

314

"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.

315

"network": "A String", # URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created.

316

"region": "A String", # [Output Only] URL of the region where the VPN gateway resides.

317

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

318

"vpnInterfaces": [ # A list of interfaces on this VPN gateway.

319

{ # A VPN gateway interface.

320

"id": 42, # The numeric ID of this VPN gateway interface.

321

"ipAddress": "A String", # [Output Only] The external IP address for this VPN gateway interface.

Bu Sun Kim

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

[diff] [blame]

322

},

Bu Sun Kim

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

[diff] [blame]

323

],

324

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

<code class="details" id="getStatus">getStatus(project, region, vpnGateway)</code>

329

<pre>Returns the status for the specified VPN gateway.

330

331

Args:

332

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

333

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

334

vpnGateway: string, Name of the VPN gateway to return. (required)

335

336

Returns:

337

An object of the form:

338

339

{

Bu Sun Kim

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

[diff] [blame]

340

"result": {

341

"vpnConnections": [ # List of VPN connection for this VpnGateway.

Bu Sun Kim

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

[diff] [blame]

342

{ # A VPN connection contains all VPN tunnels connected from this VpnGateway to the same peer gateway. The peer gateway could either be a external VPN gateway or GCP VPN gateway.

Bu Sun Kim

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

[diff] [blame]

343

"peerExternalGateway": "A String", # URL reference to the peer external VPN gateways to which the VPN tunnels in this VPN connection are connected. This field is mutually exclusive with peer_gcp_gateway.

344

"peerGcpGateway": "A String", # URL reference to the peer side VPN gateways to which the VPN tunnels in this VPN connection are connected. This field is mutually exclusive with peer_gcp_gateway.

345

"state": { # Describes the high availability requirement state for the VPN connection between this Cloud VPN gateway and a peer gateway. # HighAvailabilityRequirementState for the VPN connection.

346

"state": "A String", # Indicates the high availability requirement state for the VPN connection. Valid values are CONNECTION_REDUNDANCY_MET, CONNECTION_REDUNDANCY_NOT_MET.

347

"unsatisfiedReason": "A String", # Indicates the reason why the VPN connection does not meet the high availability redundancy criteria/requirement. Valid values is INCOMPLETE_TUNNELS_COVERAGE.

348

},

349

"tunnels": [ # List of VPN tunnels that are in this VPN connection.

Bu Sun Kim

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

[diff] [blame]

350

{ # Contains some information about a VPN tunnel.

Bu Sun Kim

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

[diff] [blame]

351

"localGatewayInterface": 42, # The VPN gateway interface this VPN tunnel is associated with.

352

"peerGatewayInterface": 42, # The peer gateway interface this VPN tunnel is connected to, the peer gateway could either be an external VPN gateway or GCP VPN gateway.

353

"tunnelUrl": "A String", # URL reference to the VPN tunnel.

Bu Sun Kim

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

[diff] [blame]

354

},

355

],

Bu Sun Kim

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

[diff] [blame]

},

],

},

}</pre>

</div>

Dan O'Meara

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

[diff] [blame]

363

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

Bu Sun Kim

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

[diff] [blame]

364

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

365

366

Args:

367

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

368

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

Dan O'Meara

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

[diff] [blame]

369

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

370

The object takes the form of:

371

Bu Sun Kim

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

[diff] [blame]

372

{ # Represents a HA VPN gateway.

373

#

374

# HA VPN is a high-availability (HA) Cloud VPN solution that lets you securely connect your on-premises network to your Google Cloud Virtual Private Cloud network through an IPsec VPN connection in a single region. For more information about Cloud HA VPN solutions, see Cloud VPN topologies . (== resource_for {$api_version}.vpnGateways ==)

375

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

376

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

377

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

378

"kind": "compute#vpnGateway", # [Output Only] Type of resource. Always compute#vpnGateway for VPN gateways.

379

"labelFingerprint": "A String", # A fingerprint for the labels being applied to this VpnGateway, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet.

380

#

381

# To see the latest fingerprint, make a get() request to retrieve an VpnGateway.

382

"labels": { # Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.

383

"a_key": "A String",

384

},

385

"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.

386

"network": "A String", # URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created.

387

"region": "A String", # [Output Only] URL of the region where the VPN gateway resides.

388

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

389

"vpnInterfaces": [ # A list of interfaces on this VPN gateway.

390

{ # A VPN gateway interface.

391

"id": 42, # The numeric ID of this VPN gateway interface.

392

"ipAddress": "A String", # [Output Only] The external IP address for this VPN gateway interface.

Bu Sun Kim

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

[diff] [blame]

393

},

Bu Sun Kim

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

[diff] [blame]

394

],

395

}

Bu Sun Kim

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

[diff] [blame]

396

397

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.

398

399

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.

400

401

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

402

403

Returns:

404

An object of the form:

405

406

{ # Represents an Operation resource.

407

#

Dan O'Meara

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

[diff] [blame]

408

# Google Compute Engine has three Operation resources:

409

#

410

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

411

#

Bu Sun Kim

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

[diff] [blame]

412

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

413

#

414

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

415

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

416

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

417

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

Bu Sun Kim

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

[diff] [blame]

418

#

Dan O'Meara

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

[diff] [blame]

419

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

Bu Sun Kim

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

[diff] [blame]

420

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

421

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

422

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

423

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

424

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

425

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

Bu Sun Kim

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

[diff] [blame]

426

{

Bu Sun Kim

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

[diff] [blame]

427

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

428

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

429

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

Bu Sun Kim

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

[diff] [blame]

430

},

431

],

432

},

Bu Sun Kim

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

[diff] [blame]

433

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

434

"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.

435

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

436

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

437

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

438

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

439

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

440

"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.

441

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

442

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

443

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

444

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

445

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

446

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

447

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

448

"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.

449

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

450

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

451

{

452

"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.

453

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

454

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

455

{

456

"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).

457

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

458

},

459

],

460

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

461

},

462

],

463

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

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

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

[diff] [blame]

468

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

Bu Sun Kim

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

[diff] [blame]

469

<pre>Retrieves a list of VPN gateways available to the specified project and region.

470

471

Args:

472

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

473

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

Dan O'Meara

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

[diff] [blame]

474

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]

475

Dan O'Meara

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

[diff] [blame]

476

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]

477

Dan O'Meara

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

[diff] [blame]

478

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]

479

Bu Sun Kim

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

[diff] [blame]

480

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) ```

481

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`)

482

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

483

484

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.

485

486

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

487

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.

488

returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false and the logic is the same as today.

Bu Sun Kim

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

[diff] [blame]

489

490

Returns:

491

An object of the form:

492

493

{ # Contains a list of VpnGateway resources.

Bu Sun Kim

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

[diff] [blame]

494

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

495

"items": [ # A list of VpnGateway resources.

496

{ # Represents a HA VPN gateway.

497

#

498

# HA VPN is a high-availability (HA) Cloud VPN solution that lets you securely connect your on-premises network to your Google Cloud Virtual Private Cloud network through an IPsec VPN connection in a single region. For more information about Cloud HA VPN solutions, see Cloud VPN topologies . (== resource_for {$api_version}.vpnGateways ==)

499

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

500

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

501

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

502

"kind": "compute#vpnGateway", # [Output Only] Type of resource. Always compute#vpnGateway for VPN gateways.

503

"labelFingerprint": "A String", # A fingerprint for the labels being applied to this VpnGateway, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet.

504

#

505

# To see the latest fingerprint, make a get() request to retrieve an VpnGateway.

506

"labels": { # Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.

507

"a_key": "A String",

Bu Sun Kim

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

[diff] [blame]

508

},

Bu Sun Kim

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

[diff] [blame]

509

"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.

510

"network": "A String", # URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created.

511

"region": "A String", # [Output Only] URL of the region where the VPN gateway resides.

512

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

513

"vpnInterfaces": [ # A list of interfaces on this VPN gateway.

514

{ # A VPN gateway interface.

515

"id": 42, # The numeric ID of this VPN gateway interface.

516

"ipAddress": "A String", # [Output Only] The external IP address for this VPN gateway interface.

517

},

518

],

519

},

Bu Sun Kim

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

[diff] [blame]

520

],

Bu Sun Kim

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

[diff] [blame]

521

"kind": "compute#vpnGatewayList", # [Output Only] Type of resource. Always compute#vpnGateway for VPN gateways.

522

"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.

523

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

524

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

525

"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.

526

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

527

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

Bu Sun Kim

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

[diff] [blame]

528

{

Bu Sun Kim

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

[diff] [blame]

529

"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).

530

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

Bu Sun Kim

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

[diff] [blame]

531

},

532

],

Bu Sun Kim

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

[diff] [blame]

533

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

Bu Sun Kim

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

[diff] [blame]

534

},

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

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

540

<pre>Retrieves the next page of results.

541

542

Args:

543

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

544

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

545

546

Returns:

Bu Sun Kim

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

[diff] [blame]

547

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]

548

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]

553

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

Bu Sun Kim

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

[diff] [blame]

554

<pre>Sets the labels on a VpnGateway. To learn more about labels, read the Labeling Resources documentation.

555

556

Args:

557

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

558

region: string, The region for this request. (required)

559

resource: string, Name or id of the resource for this request. (required)

Dan O'Meara

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

[diff] [blame]

560

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

561

The object takes the form of:

562

563

{

Bu Sun Kim

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

[diff] [blame]

564

"labelFingerprint": "A String", # The fingerprint of the previous set of labels for this resource, used to detect conflicts. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels. Make a get() request to the resource to get the latest fingerprint.

565

"labels": { # The labels to set for this resource.

566

"a_key": "A String",

Bu Sun Kim

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

[diff] [blame]

},

}

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.

571

572

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.

573

574

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

575

576

Returns:

577

An object of the form:

578

579

{ # Represents an Operation resource.

580

#

Dan O'Meara

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

[diff] [blame]

581

# Google Compute Engine has three Operation resources:

582

#

583

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

584

#

Bu Sun Kim

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

[diff] [blame]

585

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

586

#

587

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

588

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

589

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

590

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

Bu Sun Kim

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

[diff] [blame]

591

#

Dan O'Meara

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

[diff] [blame]

592

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

Bu Sun Kim

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

[diff] [blame]

593

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

594

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

595

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

596

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

597

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

598

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

Bu Sun Kim

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

[diff] [blame]

599

{

Bu Sun Kim

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

[diff] [blame]

600

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

601

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

602

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

Bu Sun Kim

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

[diff] [blame]

603

},

604

],

605

},

Bu Sun Kim