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

2016-02-19 16:02:29 -0800

[diff] [blame]

79

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

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

80

81

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

82

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

83

Dmitry Frenkel

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

[diff] [blame^]

84

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

85

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

86

Bu Sun Kim

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

[diff] [blame]

87

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

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

88

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

89

90

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

91

<p class="firstline">Returns the specified address resource.</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 an address resource in the specified project by using the data included in the request.</p>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

95

Dmitry Frenkel

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

[diff] [blame^]

96

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

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

97

<p class="firstline">Retrieves a list of addresses contained within the specified region.</p>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

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

<h3>Method Details</h3>

102

Dmitry Frenkel

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

[diff] [blame^]

103

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

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

104

<pre>Retrieves an aggregated list of addresses.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

105

106

Args:

Nathaniel Manista

2015-03-10 23:29:22 +0000

[diff] [blame]

107

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

Dan O'Meara

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

[diff] [blame]

108

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

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

109

Dan O'Meara

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

[diff] [blame]

110

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

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

111

Dan O'Meara

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

[diff] [blame]

112

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.

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

113

Bu Sun Kim

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

[diff] [blame]

114

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]

115

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]

116

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

117

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

118

119

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.

120

121

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

122

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.

Dmitry Frenkel

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

[diff] [blame^]

123

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.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

124

125

Returns:

126

An object of the form:

127

128

{

Bu Sun Kim

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

[diff] [blame]

129

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

130

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

131

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

132

"addresses": [ # [Output Only] A list of addresses contained in this scope.

133

{ # Use global external addresses for GFE-based external HTTP(S) load balancers in Premium Tier.

134

#

135

# Use global internal addresses for reserved peering network range.

136

#

137

# Use regional external addresses for the following resources:

138

#

139

# - External IP addresses for VM instances - Regional external forwarding rules - Cloud NAT external IP addresses - GFE based LBs in Standard Tier - Network LBs in Premium or Standard Tier - Cloud VPN gateways (both Classic and HA)

140

#

141

# Use regional internal IP addresses for subnet IP ranges (primary and secondary). This includes:

142

#

143

# - Internal IP addresses for VM instances - Alias IP ranges of VM instances (/32 only) - Regional internal forwarding rules - Internal TCP/UDP load balancer addresses - Internal HTTP(S) load balancer addresses - Cloud DNS inbound forwarding IP addresses

144

#

145

# For more information, read reserved IP address.

146

#

147

# (== resource_for {$api_version}.addresses ==) (== resource_for {$api_version}.globalAddresses ==)

148

"address": "A String", # The static IP address represented by this resource.

149

"addressType": "A String", # The type of address to reserve, either INTERNAL or EXTERNAL. If unspecified, defaults to EXTERNAL.

150

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

151

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

152

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

153

"ipVersion": "A String", # The IP version that will be used by this address. Valid options are IPV4 or IPV6. This can only be specified for a global address.

154

"kind": "compute#address", # [Output Only] Type of the resource. Always compute#address for addresses.

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])?`. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit.

156

"network": "A String", # The URL of the network in which to reserve the address. This field can only be used with INTERNAL type with the VPC_PEERING purpose.

157

"networkTier": "A String", # This signifies the networking tier used for configuring this address and can only take the following values: PREMIUM or STANDARD. Global forwarding rules can only be Premium Tier. Regional forwarding rules can be either Premium or Standard Tier. Standard Tier addresses applied to regional forwarding rules can be used with any external load balancer. Regional forwarding rules in Premium Tier can only be used with a network load balancer.

158

#

159

# If this field is not specified, it is assumed to be PREMIUM.

160

"prefixLength": 42, # The prefix length if the resource reprensents an IP range.

161

"purpose": "A String", # The purpose of this resource, which can be one of the following values:

162

# - `GCE_ENDPOINT` for addresses that are used by VM instances, alias IP ranges, internal load balancers, and similar resources.

163

# - `DNS_RESOLVER` for a DNS resolver address in a subnetwork

164

# - `VPC_PEERING` for addresses that are reserved for VPC peer networks.

165

# - `NAT_AUTO` for addresses that are external IP addresses automatically reserved for Cloud NAT.

166

"region": "A String", # [Output Only] The URL of the region where the regional address resides. This field is not applicable to global addresses. You must specify this field as part of the HTTP request URL.

167

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

168

"status": "A String", # [Output Only] The status of the address, which can be one of RESERVING, RESERVED, or IN_USE. An address that is RESERVING is currently in the process of being reserved. A RESERVED address is currently reserved and available to use. An IN_USE address is currently being used by another resource and is not available.

169

"subnetwork": "A String", # The URL of the subnetwork in which to reserve the address. If an IP address is specified, it must be within the subnetwork's IP range. This field can only be used with INTERNAL type with a GCE_ENDPOINT or DNS_RESOLVER purpose.

170

"users": [ # [Output Only] The URLs of the resources that are using this address.

"A String",

],

},

],

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

176

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

177

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

178

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

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

179

{

Bu Sun Kim

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

[diff] [blame]

180

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

181

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

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

182

},

183

],

Bu Sun Kim

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

[diff] [blame]

184

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

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

185

},

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

186

},

187

},

Bu Sun Kim

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

[diff] [blame]

188

"kind": "compute#addressAggregatedList", # [Output Only] Type of resource. Always compute#addressAggregatedList for aggregated lists of addresses.

189

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

190

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

Dmitry Frenkel

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

[diff] [blame^]

191

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

192

"A String",

193

],

Bu Sun Kim

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

[diff] [blame]

194

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

195

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

196

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

197

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

Bu Sun Kim

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

[diff] [blame]

198

{

Bu Sun Kim

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

[diff] [blame]

199

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

200

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

201

},

202

],

Bu Sun Kim

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

[diff] [blame]

203

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

204

},

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

}</pre>

</div>

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

210

<pre>Retrieves the next page of results.

211

212

Args:

213

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

214

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

215

216

Returns:

Bu Sun Kim

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

[diff] [blame]

217

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

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

218

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

223

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

224

<pre>Close httplib2 connections.</pre>

</div>

Bu Sun Kim

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

[diff] [blame]

228

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

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

229

<pre>Deletes the specified address resource.

230

231

Args:

Nathaniel Manista

2015-03-10 23:29:22 +0000

[diff] [blame]

232

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

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

233

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

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

234

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

Bu Sun Kim

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

[diff] [blame]

235

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.

236

237

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.

238

239

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

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

240

241

Returns:

242

An object of the form:

243

Bu Sun Kim

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

[diff] [blame]

244

{ # Represents an Operation resource.

245

#

Dan O'Meara

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

[diff] [blame]

246

# Google Compute Engine has three Operation resources:

247

#

248

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

249

#

Bu Sun Kim

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

[diff] [blame]

250

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

251

#

252

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

253

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

254

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

255

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

Bu Sun Kim

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

[diff] [blame]

256

#

Dan O'Meara

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

[diff] [blame]

257

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

258

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

259

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

260

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

261

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

262

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

263

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

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

264

{

Bu Sun Kim

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

[diff] [blame]

265

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

266

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

267

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

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

268

},

269

],

270

},

Bu Sun Kim

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

[diff] [blame]

271

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

272

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

273

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

274

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

275

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

276

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

277

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

278

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

279

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

280

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

281

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

282

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

283

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

284

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

285

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

286

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

287

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

288

{

289

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

290

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

291

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

292

{

293

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

294

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

295

},

296

],

297

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

298

},

299

],

300

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

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

}</pre>

</div>

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

306

<pre>Returns the specified address resource.

307

308

Args:

Nathaniel Manista

2015-03-10 23:29:22 +0000

[diff] [blame]

309

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

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

310

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

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

311

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

312

313

Returns:

314

An object of the form:

315

Dan O'Meara

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

[diff] [blame]

316

{ # Use global external addresses for GFE-based external HTTP(S) load balancers in Premium Tier.

Bu Sun Kim

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

[diff] [blame]

317

#

318

# Use global internal addresses for reserved peering network range.

319

#

320

# Use regional external addresses for the following resources:

321

#

322

# - External IP addresses for VM instances - Regional external forwarding rules - Cloud NAT external IP addresses - GFE based LBs in Standard Tier - Network LBs in Premium or Standard Tier - Cloud VPN gateways (both Classic and HA)

323

#

324

# Use regional internal IP addresses for subnet IP ranges (primary and secondary). This includes:

325

#

326

# - Internal IP addresses for VM instances - Alias IP ranges of VM instances (/32 only) - Regional internal forwarding rules - Internal TCP/UDP load balancer addresses - Internal HTTP(S) load balancer addresses - Cloud DNS inbound forwarding IP addresses

327

#

328

# For more information, read reserved IP address.

329

#

330

# (== resource_for {$api_version}.addresses ==) (== resource_for {$api_version}.globalAddresses ==)

331

"address": "A String", # The static IP address represented by this resource.

332

"addressType": "A String", # The type of address to reserve, either INTERNAL or EXTERNAL. If unspecified, defaults to EXTERNAL.

333

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

334

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

335

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

336

"ipVersion": "A String", # The IP version that will be used by this address. Valid options are IPV4 or IPV6. This can only be specified for a global address.

337

"kind": "compute#address", # [Output Only] Type of the resource. Always compute#address for addresses.

338

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

339

"network": "A String", # The URL of the network in which to reserve the address. This field can only be used with INTERNAL type with the VPC_PEERING purpose.

340

"networkTier": "A String", # This signifies the networking tier used for configuring this address and can only take the following values: PREMIUM or STANDARD. Global forwarding rules can only be Premium Tier. Regional forwarding rules can be either Premium or Standard Tier. Standard Tier addresses applied to regional forwarding rules can be used with any external load balancer. Regional forwarding rules in Premium Tier can only be used with a network load balancer.

Bu Sun Kim

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

[diff] [blame]

341

#

Bu Sun Kim

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

[diff] [blame]

342

# If this field is not specified, it is assumed to be PREMIUM.

343

"prefixLength": 42, # The prefix length if the resource reprensents an IP range.

344

"purpose": "A String", # The purpose of this resource, which can be one of the following values:

345

# - `GCE_ENDPOINT` for addresses that are used by VM instances, alias IP ranges, internal load balancers, and similar resources.

346

# - `DNS_RESOLVER` for a DNS resolver address in a subnetwork

347

# - `VPC_PEERING` for addresses that are reserved for VPC peer networks.

348

# - `NAT_AUTO` for addresses that are external IP addresses automatically reserved for Cloud NAT.

349

"region": "A String", # [Output Only] The URL of the region where the regional address resides. This field is not applicable to global addresses. You must specify this field as part of the HTTP request URL.

350

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

351

"status": "A String", # [Output Only] The status of the address, which can be one of RESERVING, RESERVED, or IN_USE. An address that is RESERVING is currently in the process of being reserved. A RESERVED address is currently reserved and available to use. An IN_USE address is currently being used by another resource and is not available.

352

"subnetwork": "A String", # The URL of the subnetwork in which to reserve the address. If an IP address is specified, it must be within the subnetwork's IP range. This field can only be used with INTERNAL type with a GCE_ENDPOINT or DNS_RESOLVER purpose.

353

"users": [ # [Output Only] The URLs of the resources that are using this address.

354

"A String",

355

],

356

}</pre>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

</div>

Dan O'Meara

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

[diff] [blame]

360

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

361

<pre>Creates an address resource in the specified project by using the data included in the request.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

362

363

Args:

Nathaniel Manista

2015-03-10 23:29:22 +0000

[diff] [blame]

364

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

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

365

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

Dan O'Meara

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

[diff] [blame]

366

body: object, The request body.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

367

The object takes the form of:

368

Dan O'Meara

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

[diff] [blame]

369

{ # Use global external addresses for GFE-based external HTTP(S) load balancers in Premium Tier.

Bu Sun Kim

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

[diff] [blame]

370

#

371

# Use global internal addresses for reserved peering network range.

372

#

373

# Use regional external addresses for the following resources:

374

#

375

# - External IP addresses for VM instances - Regional external forwarding rules - Cloud NAT external IP addresses - GFE based LBs in Standard Tier - Network LBs in Premium or Standard Tier - Cloud VPN gateways (both Classic and HA)

376

#

377

# Use regional internal IP addresses for subnet IP ranges (primary and secondary). This includes:

378

#

379

# - Internal IP addresses for VM instances - Alias IP ranges of VM instances (/32 only) - Regional internal forwarding rules - Internal TCP/UDP load balancer addresses - Internal HTTP(S) load balancer addresses - Cloud DNS inbound forwarding IP addresses

380

#

381

# For more information, read reserved IP address.

382

#

383

# (== resource_for {$api_version}.addresses ==) (== resource_for {$api_version}.globalAddresses ==)

384

"address": "A String", # The static IP address represented by this resource.

385

"addressType": "A String", # The type of address to reserve, either INTERNAL or EXTERNAL. If unspecified, defaults to EXTERNAL.

386

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

387

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

388

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

389

"ipVersion": "A String", # The IP version that will be used by this address. Valid options are IPV4 or IPV6. This can only be specified for a global address.

390

"kind": "compute#address", # [Output Only] Type of the resource. Always compute#address for addresses.

391

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

392

"network": "A String", # The URL of the network in which to reserve the address. This field can only be used with INTERNAL type with the VPC_PEERING purpose.

393

"networkTier": "A String", # This signifies the networking tier used for configuring this address and can only take the following values: PREMIUM or STANDARD. Global forwarding rules can only be Premium Tier. Regional forwarding rules can be either Premium or Standard Tier. Standard Tier addresses applied to regional forwarding rules can be used with any external load balancer. Regional forwarding rules in Premium Tier can only be used with a network load balancer.

Bu Sun Kim

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

[diff] [blame]

394

#

Bu Sun Kim

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

[diff] [blame]

395

# If this field is not specified, it is assumed to be PREMIUM.

396

"prefixLength": 42, # The prefix length if the resource reprensents an IP range.

397

"purpose": "A String", # The purpose of this resource, which can be one of the following values:

398

# - `GCE_ENDPOINT` for addresses that are used by VM instances, alias IP ranges, internal load balancers, and similar resources.

399

# - `DNS_RESOLVER` for a DNS resolver address in a subnetwork

400

# - `VPC_PEERING` for addresses that are reserved for VPC peer networks.

401

# - `NAT_AUTO` for addresses that are external IP addresses automatically reserved for Cloud NAT.

402

"region": "A String", # [Output Only] The URL of the region where the regional address resides. This field is not applicable to global addresses. You must specify this field as part of the HTTP request URL.

403

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

404

"status": "A String", # [Output Only] The status of the address, which can be one of RESERVING, RESERVED, or IN_USE. An address that is RESERVING is currently in the process of being reserved. A RESERVED address is currently reserved and available to use. An IN_USE address is currently being used by another resource and is not available.

405

"subnetwork": "A String", # The URL of the subnetwork in which to reserve the address. If an IP address is specified, it must be within the subnetwork's IP range. This field can only be used with INTERNAL type with a GCE_ENDPOINT or DNS_RESOLVER purpose.

406

"users": [ # [Output Only] The URLs of the resources that are using this address.

407

"A String",

408

],

409

}

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

410

Bu Sun Kim

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

[diff] [blame]

411

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.

412

413

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.

414

415

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

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

416

417

Returns:

418

An object of the form:

419

Bu Sun Kim

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

[diff] [blame]

420

{ # Represents an Operation resource.

421

#

Dan O'Meara

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

[diff] [blame]

422

# Google Compute Engine has three Operation resources:

423

#

424

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

425

#

Bu Sun Kim

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

[diff] [blame]

426

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

427

#

428

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

429

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

430

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

431

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

Bu Sun Kim

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

[diff] [blame]

432

#

Dan O'Meara

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

[diff] [blame]

433

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

434

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

435

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

436

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

437

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

438

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

439

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

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

440

{

Bu Sun Kim

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

[diff] [blame]

441

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

442

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

443

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

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

444

},

445

],

446

},

Bu Sun Kim

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

[diff] [blame]

447

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

448

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

449

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

450

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

451

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

452

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

453

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

454

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

455

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

456

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

457

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

458

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

459

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

460

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

461

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

462

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

463

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

464

{

465

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

466

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

467

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

468

{

469

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

470

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

471

},

472

],

473

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

474

},

475

],

476

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

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

}</pre>

</div>

Dmitry Frenkel

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

[diff] [blame^]

481

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

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

482

<pre>Retrieves a list of addresses contained within the specified region.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

483

484

Args:

Nathaniel Manista

2015-03-10 23:29:22 +0000

[diff] [blame]

485

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

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

486

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

Dan O'Meara

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

[diff] [blame]

487

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

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

488

Dan O'Meara

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

[diff] [blame]

489

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

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

490

Dan O'Meara

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

[diff] [blame]

491

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.

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

492

Bu Sun Kim

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

[diff] [blame]

493

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

494

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

495

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

496

497

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.

498

499

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

500

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.

Dmitry Frenkel

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

[diff] [blame^]

501

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.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

502

503

Returns:

504

An object of the form:

505

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

506

{ # Contains a list of addresses.

Bu Sun Kim

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

[diff] [blame]

507

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

508

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

Dan O'Meara

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

[diff] [blame]

509

{ # Use global external addresses for GFE-based external HTTP(S) load balancers in Premium Tier.

Bu Sun Kim

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

[diff] [blame]

510

#

511

# Use global internal addresses for reserved peering network range.

512

#

513

# Use regional external addresses for the following resources:

514

#

515

# - External IP addresses for VM instances - Regional external forwarding rules - Cloud NAT external IP addresses - GFE based LBs in Standard Tier - Network LBs in Premium or Standard Tier - Cloud VPN gateways (both Classic and HA)

516

#

517

# Use regional internal IP addresses for subnet IP ranges (primary and secondary). This includes:

518

#

519

# - Internal IP addresses for VM instances - Alias IP ranges of VM instances (/32 only) - Regional internal forwarding rules - Internal TCP/UDP load balancer addresses - Internal HTTP(S) load balancer addresses - Cloud DNS inbound forwarding IP addresses

520

#

521

# For more information, read reserved IP address.

522

#

523

# (== resource_for {$api_version}.addresses ==) (== resource_for {$api_version}.globalAddresses ==)

524

"address": "A String", # The static IP address represented by this resource.

525

"addressType": "A String", # The type of address to reserve, either INTERNAL or EXTERNAL. If unspecified, defaults to EXTERNAL.

526

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

527

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

528

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

529

"ipVersion": "A String", # The IP version that will be used by this address. Valid options are IPV4 or IPV6. This can only be specified for a global address.

530

"kind": "compute#address", # [Output Only] Type of the resource. Always compute#address for addresses.

531

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

532

"network": "A String", # The URL of the network in which to reserve the address. This field can only be used with INTERNAL type with the VPC_PEERING purpose.

533

"networkTier": "A String", # This signifies the networking tier used for configuring this address and can only take the following values: PREMIUM or STANDARD. Global forwarding rules can only be Premium Tier. Regional forwarding rules can be either Premium or Standard Tier. Standard Tier addresses applied to regional forwarding rules can be used with any external load balancer. Regional forwarding rules in Premium Tier can only be used with a network load balancer.

Bu Sun Kim

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

[diff] [blame]

534

#

Bu Sun Kim

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

[diff] [blame]

535

# If this field is not specified, it is assumed to be PREMIUM.

536

"prefixLength": 42, # The prefix length if the resource reprensents an IP range.

537

"purpose": "A String", # The purpose of this resource, which can be one of the following values:

538

# - `GCE_ENDPOINT` for addresses that are used by VM instances, alias IP ranges, internal load balancers, and similar resources.

539

# - `DNS_RESOLVER` for a DNS resolver address in a subnetwork

540

# - `VPC_PEERING` for addresses that are reserved for VPC peer networks.

541

# - `NAT_AUTO` for addresses that are external IP addresses automatically reserved for Cloud NAT.

542

"region": "A String", # [Output Only] The URL of the region where the regional address resides. This field is not applicable to global addresses. You must specify this field as part of the HTTP request URL.

543

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

544

"status": "A String", # [Output Only] The status of the address, which can be one of RESERVING, RESERVED, or IN_USE. An address that is RESERVING is currently in the process of being reserved. A RESERVED address is currently reserved and available to use. An IN_USE address is currently being used by another resource and is not available.

545

"subnetwork": "A String", # The URL of the subnetwork in which to reserve the address. If an IP address is specified, it must be within the subnetwork's IP range. This field can only be used with INTERNAL type with a GCE_ENDPOINT or DNS_RESOLVER purpose.

546

"users": [ # [Output Only] The URLs of the resources that are using this address.

547

"A String",

548

],

549

},

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

550

],

Bu Sun Kim

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

[diff] [blame]

551

"kind": "compute#addressList", # [Output Only] Type of resource. Always compute#addressList for lists of addresses.

552

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

553

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

554

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

555

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

556

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

557

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

Bu Sun Kim

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

[diff] [blame]

558

{

Bu Sun Kim

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

[diff] [blame]

559

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

560

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

561

},

562

],

Bu Sun Kim