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

2020-05-20 12:08:20 -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

Dmitry Frenkel

3e17f89

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

Bu Sun Kim

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

[diff] [blame]

87

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

88

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

89

90

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

91

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

92

93

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

94

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

95

96

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

97

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

98

Dmitry Frenkel

3e17f89

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

[diff] [blame]

99

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

Bu Sun Kim

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

[diff] [blame]

100

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

101

102

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

103

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

104

105

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

106

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

107

108

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

109

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

110

<h3>Method Details</h3>

111

Dmitry Frenkel

3e17f89

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

[diff] [blame]

112

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

Bu Sun Kim

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

[diff] [blame]

113

<pre>Retrieves an aggregated list of VPN gateways.

114

115

Args:

116

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

117

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

118

119

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

120

121

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.

122

123

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

124

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.

125

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

126

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

127

128

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.

129

130

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

131

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]

132

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

Bu Sun Kim

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

[diff] [blame]

133

134

Returns:

135

An object of the form:

136

137

{

Yoshi Automation Bot

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

[diff] [blame]

138

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

139

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

140

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

141

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

142

{ # Represents a HA VPN gateway.

143

#

144

# 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 ==)

145

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

146

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

147

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

148

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

149

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

Bu Sun Kim

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

[diff] [blame]

150

#

Yoshi Automation Bot

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

[diff] [blame]

151

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

152

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

153

"a_key": "A String",

Bu Sun Kim

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

[diff] [blame]

154

},

Yoshi Automation Bot

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

[diff] [blame]

155

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

156

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

157

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

158

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

159

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

160

{ # A VPN gateway interface.

161

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

162

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

Bu Sun Kim

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

[diff] [blame]

163

},

164

],

Bu Sun Kim

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

[diff] [blame]

165

},

166

],

Yoshi Automation Bot

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

[diff] [blame]

167

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

168

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

169

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

170

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

171

{

172

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

173

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

174

},

175

],

176

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

177

},

Bu Sun Kim

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

[diff] [blame]

178

},

Yoshi Automation Bot

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

[diff] [blame]

179

},

180

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

181

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

182

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

183

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

184

"A String",

185

],

186

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

187

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

188

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

189

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

190

{

191

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

192

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

193

},

194

],

195

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

196

},

197

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

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

202

<pre>Retrieves the next page of results.

203

204

Args:

205

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

206

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

207

208

Returns:

209

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

210

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]

215

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

216

<pre>Close httplib2 connections.</pre>

</div>

Bu Sun Kim

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

[diff] [blame]

220

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

221

<pre>Deletes the specified VPN gateway.

222

223

Args:

224

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

225

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

226

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

227

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.

228

229

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.

230

231

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

232

233

Returns:

234

An object of the form:

235

236

{ # Represents an Operation resource.

Yoshi Automation Bot

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

[diff] [blame]

237

#

238

# Google Compute Engine has three Operation resources:

239

#

240

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

241

#

242

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

243

#

244

# Operations can be global, regional or zonal.

245

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

246

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

247

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

248

#

249

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

250

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

251

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

252

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

253

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

254

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

255

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

Bu Sun Kim

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

[diff] [blame]

256

{

Yoshi Automation Bot

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

[diff] [blame]

257

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

258

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

259

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

Bu Sun Kim

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

[diff] [blame]

260

},

261

],

Yoshi Automation Bot

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

[diff] [blame]

262

},

263

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

264

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

265

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

266

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

267

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

268

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

yoshi-code-bot

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

[diff] [blame]

269

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

270

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

271

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

272

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

273

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

274

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

275

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

276

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

277

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

278

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

279

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

280

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

281

{

282

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

283

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

284

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

285

{

286

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

287

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

288

},

289

],

290

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

291

},

292

],

293

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

294

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

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

299

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

300

301

Args:

302

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

303

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

304

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

305

306

Returns:

307

An object of the form:

308

309

{ # Represents a HA VPN gateway.

Yoshi Automation Bot

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

[diff] [blame]

310

#

311

# 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 ==)

312

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

313

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

314

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

315

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

316

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

Bu Sun Kim

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

[diff] [blame]

317

#

Yoshi Automation Bot

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

[diff] [blame]

318

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

319

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

320

"a_key": "A String",

321

},

322

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

323

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

324

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

325

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

326

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

327

{ # A VPN gateway interface.

328

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

329

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

Bu Sun Kim

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

[diff] [blame]

330

},

Yoshi Automation Bot

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

[diff] [blame]

331

],

332

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

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

337

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

338

339

Args:

340

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

341

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

342

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

343

344

Returns:

345

An object of the form:

346

347

{

Yoshi Automation Bot

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

[diff] [blame]

348

"result": {

349

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

350

{ # 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.

351

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

352

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

353

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

354

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

355

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

Bu Sun Kim

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

[diff] [blame]

356

},

Yoshi Automation Bot

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

[diff] [blame]

357

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

358

{ # Contains some information about a VPN tunnel.

359

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

360

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

361

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

},

],

},

],

},

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

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

372

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

373

374

Args:

375

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

376

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

377

body: object, The request body.

378

The object takes the form of:

379

380

{ # Represents a HA VPN gateway.

381

#

382

# 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 ==)

383

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

384

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

385

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

386

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

387

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

388

#

389

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

390

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

391

"a_key": "A String",

392

},

393

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

394

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

395

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

396

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

397

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

398

{ # A VPN gateway interface.

399

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

400

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

},

],

}

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.

406

407

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.

408

409

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

410

411

Returns:

412

An object of the form:

413

414

{ # Represents an Operation resource.

Yoshi Automation Bot

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

[diff] [blame]

415

#

416

# Google Compute Engine has three Operation resources:

417

#

418

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

419

#

420

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

421

#

422

# Operations can be global, regional or zonal.

423

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

424

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

425

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

426

#

427

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

428

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

429

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

430

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

431

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

432

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

433

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

Bu Sun Kim

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

[diff] [blame]

434

{

Yoshi Automation Bot

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

[diff] [blame]

435

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

436

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

437

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

Bu Sun Kim

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

[diff] [blame]

438

},

439

],

Yoshi Automation Bot

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

[diff] [blame]

440

},

441

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

442

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

443

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

444

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

445

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

446

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

yoshi-code-bot

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

[diff] [blame]

447

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

448

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

449

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

450

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

451

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

452

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

453

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

454

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

455

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

456

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

457

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

458

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

459

{

460

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

461

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

462

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

463

{

464

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

465

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

466

},

467

],

468

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

469

},

470

],

471

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

472

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

Dmitry Frenkel

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

[diff] [blame]

476

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

Bu Sun Kim

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

[diff] [blame]

477

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

478

479

Args:

480

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

481

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

482

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

483

484

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

485

486

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.

487

488

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

489

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

490

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

491

492

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.

493

494

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

495

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]

496

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

Bu Sun Kim

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

[diff] [blame]

497

498

Returns:

499

An object of the form:

500

501

{ # Contains a list of VpnGateway resources.

Yoshi Automation Bot

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

[diff] [blame]

502

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

503

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

504

{ # Represents a HA VPN gateway.

505

#

506

# 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 ==)

507

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

508

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

509

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

510

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

511

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

Bu Sun Kim

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

[diff] [blame]

512

#

Yoshi Automation Bot

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

[diff] [blame]

513

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

514

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

515

"a_key": "A String",

Bu Sun Kim

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

[diff] [blame]

516

},

Yoshi Automation Bot

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

[diff] [blame]

517

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

518

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

519

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

520

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

521

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

522

{ # A VPN gateway interface.

523

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

524

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

Bu Sun Kim

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

[diff] [blame]

525

},

526

],

Bu Sun Kim

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

[diff] [blame]

527

},

Yoshi Automation Bot

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

[diff] [blame]

528

],

529

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

530

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

531

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

532

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

533

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

534

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

535

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

536

{

537

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

538

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

539

},

540

],

541

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

542

},

543

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

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

548

<pre>Retrieves the next page of results.

549

550

Args:

551

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

552

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

553

554

Returns:

555

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

556

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

</pre>

</div>

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

562

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

563

564

Args:

565

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

566

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

567

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

568

body: object, The request body.

569

The object takes the form of:

570

571

{

Yoshi Automation Bot

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

[diff] [blame]

572

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

573

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

574

"a_key": "A String",

575

},

576

}

Bu Sun Kim

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

[diff] [blame]

577

578

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.

579

580

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.

581

582

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

583

584

Returns:

585

An object of the form:

586

587

{ # Represents an Operation resource.

Yoshi Automation Bot

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

[diff] [blame]

588

#

589

# Google Compute Engine has three Operation resources:

590

#

591

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

592

#

593

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

594

#

595

# Operations can be global, regional or zonal.

596

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

597

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

598

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

599

#

600

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

601

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

602

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

603

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

604

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

605

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

606

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

Bu Sun Kim

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

[diff] [blame]

607

{

Yoshi Automation Bot

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

[diff] [blame]

608

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

609

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

610

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

Bu Sun Kim

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

[diff] [blame]

611

},

612

],

Yoshi Automation Bot

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

[diff] [blame]

613

},

614

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

615

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

616

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

617

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

618

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

619

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

yoshi-code-bot

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

[diff] [blame]

620

"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