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

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

[diff] [blame]

79

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

Sai Cheemalapati

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

[diff] [blame]

87

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

Sai Cheemalapati

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

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

Sai Cheemalapati

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

[diff] [blame]

95

Bu Sun Kim

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

[diff] [blame]

96

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

Sai Cheemalapati

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

[diff] [blame]

97

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

98

99

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

100

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

101

Dan O'Meara

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

[diff] [blame]

102

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

Bu Sun Kim

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

[diff] [blame]

103

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

Sai Cheemalapati

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

[diff] [blame]

104

Dan O'Meara

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

[diff] [blame]

105

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

Sai Cheemalapati

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

[diff] [blame]

106

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

107

<h3>Method Details</h3>

108

Bu Sun Kim

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

[diff] [blame]

109

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

Sai Cheemalapati

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

[diff] [blame]

110

<pre>Retrieves an aggregated list of addresses.

111

112

Args:

113

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

Dan O'Meara

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

[diff] [blame]

114

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

Sai Cheemalapati

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

[diff] [blame]

115

Dan O'Meara

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

[diff] [blame]

116

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

Sai Cheemalapati

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

[diff] [blame]

117

Dan O'Meara

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

[diff] [blame]

118

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

Sai Cheemalapati

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

[diff] [blame]

119

Bu Sun Kim

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

[diff] [blame]

120

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

Dan O'Meara

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

[diff] [blame]

121

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

Bu Sun Kim

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

[diff] [blame]

122

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

123

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

124

125

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

126

127

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

128

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

yoshi-code-bot

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

[diff] [blame]

129

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

Sai Cheemalapati

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

[diff] [blame]

130

131

Returns:

132

An object of the form:

133

134

{

Yoshi Automation Bot

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

[diff] [blame]

135

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

136

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

137

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

138

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

139

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

140

#

141

# Use global internal addresses for reserved peering network range.

142

#

143

# Use regional external addresses for the following resources:

144

#

145

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

146

#

147

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

148

#

149

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

150

#

151

# For more information, read reserved IP address.

152

#

153

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

154

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

155

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

156

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

157

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

158

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

159

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

160

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

161

"labelFingerprint": "A String", # A fingerprint for the labels being applied to this Address, 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]

162

#

Yoshi Automation Bot

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

[diff] [blame]

163

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

164

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

165

"a_key": "A String",

Bu Sun Kim

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

[diff] [blame]

166

},

Yoshi Automation Bot

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

[diff] [blame]

167

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

168

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

169

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

170

#

171

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

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame^]

172

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

Yoshi Automation Bot

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

[diff] [blame]

173

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

174

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

175

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

176

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

177

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

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame^]

178

# - `IPSEC_INTERCONNECT` for addresses created from a private IP range that are reserved for a VLAN attachment in an IPsec-encrypted Cloud Interconnect configuration. These addresses are regional resources.

yoshi-code-bot

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

[diff] [blame]

179

"region": "A String", # [Output Only] The URL of the region where a regional address resides. For regional addresses, you must specify the region as a path parameter in the HTTP request URL. This field is not applicable to global addresses.

Yoshi Automation Bot

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

[diff] [blame]

180

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

181

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

182

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

183

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

184

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

185

"A String",

Sai Cheemalapati

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

[diff] [blame]

186

],

Bu Sun Kim

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

[diff] [blame]

187

},

188

],

Yoshi Automation Bot

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

[diff] [blame]

189

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

190

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

191

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

192

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

193

{

194

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

195

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

196

},

197

],

198

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

199

},

Bu Sun Kim

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

[diff] [blame]

200

},

Yoshi Automation Bot

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

[diff] [blame]

201

},

202

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

203

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

204

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

205

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

206

"A String",

207

],

208

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

209

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

210

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

211

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

212

{

213

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

214

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

215

},

216

],

217

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

218

},

219

}</pre>

Sai Cheemalapati

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

[diff] [blame]

</div>

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

224

<pre>Retrieves the next page of results.

225

226

Args:

227

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

228

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

229

230

Returns:

Bu Sun Kim

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

[diff] [blame]

231

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

Sai Cheemalapati

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

[diff] [blame]

232

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]

237

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

238

<pre>Close httplib2 connections.</pre>

</div>

Sai Cheemalapati

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

[diff] [blame]

242

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

Sai Cheemalapati

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

[diff] [blame]

243

<pre>Deletes the specified address resource.

244

245

Args:

246

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

247

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

248

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

Bu Sun Kim

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

[diff] [blame]

249

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.

250

251

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.

252

253

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

Sai Cheemalapati

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

[diff] [blame]

254

255

Returns:

256

An object of the form:

257

Bu Sun Kim

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

[diff] [blame]

258

{ # Represents an Operation resource.

Yoshi Automation Bot

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

[diff] [blame]

259

#

260

# Google Compute Engine has three Operation resources:

261

#

262

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

263

#

264

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

265

#

266

# Operations can be global, regional or zonal.

267

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

268

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

269

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

270

#

271

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

272

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

273

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

274

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

275

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

276

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

277

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

Bu Sun Kim

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

[diff] [blame]

278

{

Yoshi Automation Bot

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

[diff] [blame]

279

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

280

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

281

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

Bu Sun Kim

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

[diff] [blame]

282

},

283

],

Yoshi Automation Bot

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

[diff] [blame]

284

},

285

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

286

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

287

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

288

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

289

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

yoshi-code-bot

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

[diff] [blame]

290

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

291

#

292

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

293

#

294

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

295

#

296

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

297

#

298

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

299

#

300

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

301

#

302

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

303

#

304

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

305

#

306

# Example 4: Pack and unpack a message in Go

307

#

308

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

309

#

310

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

#

#

#

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

315

#

316

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

317

#

318

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

319

#

320

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

321

#

322

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

323

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

324

#

325

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

326

#

327

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

328

#

329

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

330

#

331

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

332

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

333

},

Yoshi Automation Bot

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

[diff] [blame]

334

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

yoshi-code-bot

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

[diff] [blame]

335

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

336

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

337

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

338

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

339

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

340

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

341

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

342

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

343

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

344

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

345

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

346

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

347

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

348

{

349

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

350

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

351

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

352

{

353

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

354

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

355

},

356

],

357

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

358

},

359

],

360

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

361

}</pre>

Sai Cheemalapati

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

[diff] [blame]

</div>

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

366

<pre>Returns the specified address resource.

367

368

Args:

369

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

370

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

371

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

372

373

Returns:

374

An object of the form:

375

Dan O'Meara

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

[diff] [blame]

376

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

Yoshi Automation Bot

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

[diff] [blame]

377

#

378

# Use global internal addresses for reserved peering network range.

379

#

380

# Use regional external addresses for the following resources:

381

#

382

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

383

#

384

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

385

#

386

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

387

#

388

# For more information, read reserved IP address.

389

#

390

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

391

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

392

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

393

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

394

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

395

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

396

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

397

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

398

"labelFingerprint": "A String", # A fingerprint for the labels being applied to this Address, 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]

399

#

Yoshi Automation Bot

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

[diff] [blame]

400

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

401

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

402

"a_key": "A String",

403

},

404

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

405

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

406

"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

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

[diff] [blame]

407

#

Yoshi Automation Bot

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

[diff] [blame]

408

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

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame^]

409

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

Yoshi Automation Bot

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

[diff] [blame]

410

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

411

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

412

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

413

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

414

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

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame^]

415

# - `IPSEC_INTERCONNECT` for addresses created from a private IP range that are reserved for a VLAN attachment in an IPsec-encrypted Cloud Interconnect configuration. These addresses are regional resources.

yoshi-code-bot

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

[diff] [blame]

416

"region": "A String", # [Output Only] The URL of the region where a regional address resides. For regional addresses, you must specify the region as a path parameter in the HTTP request URL. This field is not applicable to global addresses.

Yoshi Automation Bot

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

[diff] [blame]

417

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

418

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

419

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

420

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

421

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

422

"A String",

423

],

424

}</pre>

Sai Cheemalapati

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

[diff] [blame]

</div>

Dan O'Meara

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

[diff] [blame]

428

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

429

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

Sai Cheemalapati

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

[diff] [blame]

430

431

Args:

432

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

433

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

Dan O'Meara

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

[diff] [blame]

434

body: object, The request body.

Sai Cheemalapati

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

[diff] [blame]

435

The object takes the form of:

436

Dan O'Meara

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

[diff] [blame]

437

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

438

#

439

# Use global internal addresses for reserved peering network range.

440

#

441

# Use regional external addresses for the following resources:

442

#

443

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

444

#

445

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

446

#

447

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

448

#

449

# For more information, read reserved IP address.

450

#

451

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

452

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

453

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

454

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

455

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

456

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

457

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

458

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

459

"labelFingerprint": "A String", # A fingerprint for the labels being applied to this Address, 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

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

[diff] [blame]

460

#

Bu Sun Kim

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

[diff] [blame]

461

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

462

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

463

"a_key": "A String",

464

},

465

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

466

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

467

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

468

#

Bu Sun Kim

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

[diff] [blame]

469

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

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame^]

470

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

Bu Sun Kim

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

[diff] [blame]

471

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

472

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

473

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

474

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

475

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

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame^]

476

# - `IPSEC_INTERCONNECT` for addresses created from a private IP range that are reserved for a VLAN attachment in an IPsec-encrypted Cloud Interconnect configuration. These addresses are regional resources.

yoshi-code-bot

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

[diff] [blame]

477

"region": "A String", # [Output Only] The URL of the region where a regional address resides. For regional addresses, you must specify the region as a path parameter in the HTTP request URL. This field is not applicable to global addresses.

Bu Sun Kim

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

[diff] [blame]

478

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

479

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

480

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

481

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

482

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

483

"A String",

484

],

485

}

Sai Cheemalapati

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

[diff] [blame]

486

Bu Sun Kim

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

[diff] [blame]

487

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.

488

489

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.

490

491

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

Sai Cheemalapati

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

[diff] [blame]

492

493

Returns:

494

An object of the form:

495

Bu Sun Kim

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

[diff] [blame]

496

{ # Represents an Operation resource.

Yoshi Automation Bot

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

[diff] [blame]

497

#

498

# Google Compute Engine has three Operation resources:

499

#

500

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

501

#

502

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

503

#

504

# Operations can be global, regional or zonal.

505

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

506

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

507

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

508

#

509

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

510

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

511

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

512

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

513

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

514

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

515

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

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

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

518

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

519

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

Bu Sun Kim

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

[diff] [blame]

520

},

521

],

Yoshi Automation Bot

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

[diff] [blame]

522

},

523

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

524

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

525

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

526

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

527

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

yoshi-code-bot

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

[diff] [blame]

528

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

529

#

530

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

531

#

532

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

533

#

534

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

535

#

536

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

537

#

538

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

539

#

540

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

541

#

542

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

543

#

544

# Example 4: Pack and unpack a message in Go

545

#

546

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

547

#

548

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

#

#

#

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

553

#

554

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

555

#

556

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

557

#

558

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

559

#

560

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

561

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

562

#

563

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

564

#

565

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

566

#

567

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

568

#

569

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

570

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

571

},

Yoshi Automation Bot

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

[diff] [blame]

572

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

yoshi-code-bot

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

[diff] [blame]

573

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

574

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

575

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

576

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

577

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

578

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

579

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

580

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

581

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

582

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

583

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

584

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

585

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

586

{

587

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

588

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

589

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

590

{

591

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

592

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

593

},

594

],

595

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

596

},

597

],

598

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

599

}</pre>

Sai Cheemalapati

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

[diff] [blame]

</div>

Bu Sun Kim

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

[diff] [blame]

603

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

Sai Cheemalapati

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

[diff] [blame]

604

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

605

606

Args:

607

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

608

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

Dan O'Meara

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

[diff] [blame]

609

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

Sai Cheemalapati

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

[diff] [blame]

610

Dan O'Meara

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

[diff] [blame]

611

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

Sai Cheemalapati

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

[diff] [blame]

612

Dan O'Meara

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

[diff] [blame]

613

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

Sai Cheemalapati

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

[diff] [blame]

614

Bu Sun Kim

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

[diff] [blame]

615

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

616

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

617

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

618

619

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.

620

621

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

622

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]

623

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

Sai Cheemalapati

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

[diff] [blame]

624

625

Returns:

626

An object of the form:

627

628

{ # Contains a list of addresses.

Yoshi Automation Bot

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

[diff] [blame]

629

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

630

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

631

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

632

#

633

# Use global internal addresses for reserved peering network range.

634

#

635

# Use regional external addresses for the following resources:

636

#

637

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

638

#

639

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

640

#

641

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

642

#

643

# For more information, read reserved IP address.

644

#

645

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

646

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

647

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

648

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

649

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

650

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

651

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

652

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

653

"labelFingerprint": "A String", # A fingerprint for the labels being applied to this Address, 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]

654

#

Yoshi Automation Bot

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

[diff] [blame]

655

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

656

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

657

"a_key": "A String",

658

},

659

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

660

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

661

"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

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

[diff] [blame]

662

#

Yoshi Automation Bot

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

[diff] [blame]

663

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

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame^]

664

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

Yoshi Automation Bot

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

[diff] [blame]

665

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

666

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

667

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

668

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

669

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

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame^]

670

# - `IPSEC_INTERCONNECT` for addresses created from a private IP range that are reserved for a VLAN attachment in an IPsec-encrypted Cloud Interconnect configuration. These addresses are regional resources.

yoshi-code-bot

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

[diff] [blame]

671

"region": "A String", # [Output Only] The URL of the region where a regional address resides. For regional addresses, you must specify the region as a path parameter in the HTTP request URL. This field is not applicable to global addresses.

Yoshi Automation Bot

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

[diff] [blame]

672

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

673

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

674

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

675

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

676

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

"A String",

],

},

],

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

682

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

683

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

684

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

685

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

686

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

687

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

688

{

689

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

690

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

Bu Sun Kim

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

[diff] [blame]

691

},

Sai Cheemalapati

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

[diff] [blame]

692

],

Yoshi Automation Bot

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

[diff] [blame]

693

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

694

},

695

}</pre>

Sai Cheemalapati

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

[diff] [blame]

</div>

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

700

<pre>Retrieves the next page of results.

701

702

Args:

703

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

704

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

705

706

Returns:

Bu Sun Kim

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

[diff] [blame]

707

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

Sai Cheemalapati

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

[diff] [blame]

708

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

</pre>

</div>

Dan O'Meara

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

[diff] [blame]

713

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

Bu Sun Kim

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

[diff] [blame]

714

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

Sai Cheemalapati

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

[diff] [blame]

715

716

Args:

717

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

718

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

Bu Sun Kim

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

[diff] [blame]

719

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

Dan O'Meara

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

[diff] [blame]

720

body: object, The request body.

Sai Cheemalapati

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

[diff] [blame]

721

The object takes the form of:

722

723

{

Yoshi Automation Bot

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

[diff] [blame]

724

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

725

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

726

"a_key": "A String",

727

},

728

}

Sai Cheemalapati

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

[diff] [blame]

729

Bu Sun Kim

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

[diff] [blame]

730

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.

731

732

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.

733

734

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

Sai Cheemalapati

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

[diff] [blame]

735

736

Returns:

737

An object of the form:

738

Bu Sun Kim

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

[diff] [blame]

739

{ # Represents an Operation resource.

Yoshi Automation Bot

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

[diff] [blame]

740

#

741

# Google Compute Engine has three Operation resources:

742

#

743

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

744

#

745

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

746

#

747

# Operations can be global, regional or zonal.

748

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

749

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

750

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

751

#

752

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

753

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

754

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

755

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

756

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

757

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

758

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

Bu Sun Kim

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

[diff] [blame]

759

{

Yoshi Automation Bot

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

[diff] [blame]

760

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

761

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

762

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

Bu Sun Kim

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

[diff] [blame]

763

},

764

],

Yoshi Automation Bot

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

[diff] [blame]

765

},

766

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

767

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

768

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

769

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

770

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

yoshi-code-bot

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

[diff] [blame]

771

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

772

#

773

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

774

#

775

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

776

#

777

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

778

#

779

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

780

#

781

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

782

#

783

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

784

#

785

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

786

#

787

# Example 4: Pack and unpack a message in Go

788

#

789

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

790

#

791

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

#

#

#

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

796

#

797

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

798

#

799

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

800

#

801

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

802

#

803

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

804

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

805

#

806

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

807

#

808

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

809

#

810

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

811

#

812

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

813

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

814

},

Yoshi Automation Bot

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

[diff] [blame]

815

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

yoshi-code-bot

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

[diff] [blame]

816

"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