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

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

[diff] [blame]

81

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

Sai Cheemalapati

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

[diff] [blame]

82

<p class="firstline">Retrieves the list of instance groups and sorts them by zone.</p>

83

84

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

85

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

86

Dmitry Frenkel

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

[diff] [blame]

87

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

88

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

89

Sai Cheemalapati

c30d2b5

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

[diff] [blame]

90

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

Sai Cheemalapati

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

[diff] [blame]

91

<p class="firstline">Deletes the specified instance group. The instances in the group are not deleted. Note that instance group must not belong to a backend service. Read Deleting an instance group for more information.</p>

92

93

<code><a href="#get">get(project, zone, instanceGroup)</a></code></p>

Dmitry Frenkel

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

[diff] [blame]

94

<p class="firstline">Returns the specified zonal instance group. Get a list of available zonal instance groups by making a list() request.</p>

Sai Cheemalapati

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

[diff] [blame]

95

Dan O'Meara

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

[diff] [blame]

96

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

Sai Cheemalapati

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

[diff] [blame]

97

<p class="firstline">Creates an instance group in the specified project using the parameters that are included in the request.</p>

98

Bu Sun Kim

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

[diff] [blame]

99

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

Dmitry Frenkel

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

[diff] [blame]

100

<p class="firstline">Retrieves the list of zonal instance group resources contained within the specified zone.</p>

Sai Cheemalapati

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

[diff] [blame]

101

Bu Sun Kim

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

[diff] [blame]

102

<code><a href="#listInstances">listInstances(project, zone, instanceGroup, body=None, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</a></code></p>

Bu Sun Kim

d059ad8

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

[diff] [blame]

103

<p class="firstline">Lists the instances in the specified instance group. The orderBy query parameter is not supported.</p>

Sai Cheemalapati

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

[diff] [blame]

104

105

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

106

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

107

108

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

109

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

110

Dan O'Meara

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

[diff] [blame]

111

<code><a href="#removeInstances">removeInstances(project, zone, instanceGroup, body=None, requestId=None)</a></code></p>

Sai Cheemalapati

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

[diff] [blame]

112

<p class="firstline">Removes one or more instances from the specified instance group, but does not delete those instances.</p>

113

Dan O'Meara

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

[diff] [blame]

114

<code><a href="#setNamedPorts">setNamedPorts(project, zone, instanceGroup, body=None, requestId=None)</a></code></p>

Sai Cheemalapati

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

[diff] [blame]

115

<p class="firstline">Sets the named ports for the specified instance group.</p>

116

Dan O'Meara

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

[diff] [blame]

117

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

Sai Cheemalapati

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

[diff] [blame]

118

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

119

<h3>Method Details</h3>

120

Dan O'Meara

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

[diff] [blame]

121

<code class="details" id="addInstances">addInstances(project, zone, instanceGroup, body=None, requestId=None)</code>

Sai Cheemalapati

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

[diff] [blame]

122

<pre>Adds a list of instances to the specified instance group. All of the instances in the instance group must be in the same network/subnetwork. Read Adding instances for more information.

123

124

Args:

125

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

126

zone: string, The name of the zone where the instance group is located. (required)

127

instanceGroup: string, The name of the instance group where you are adding instances. (required)

Dan O'Meara

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

[diff] [blame]

128

body: object, The request body.

Sai Cheemalapati

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

[diff] [blame]

129

The object takes the form of:

130

131

{

Yoshi Automation Bot

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

[diff] [blame]

132

"instances": [ # The list of instances to add to the instance group.

133

{

134

"instance": "A String", # The URL for a specific instance.

135

},

136

],

137

}

Sai Cheemalapati

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

[diff] [blame]

138

Bu Sun Kim

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

[diff] [blame]

139

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.

140

141

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.

142

143

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]

144

145

Returns:

146

An object of the form:

147

Bu Sun Kim

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

[diff] [blame]

148

{ # Represents an Operation resource.

Yoshi Automation Bot

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

[diff] [blame]

149

#

150

# Google Compute Engine has three Operation resources:

151

#

152

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

153

#

154

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

155

#

156

# Operations can be global, regional or zonal.

157

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

158

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

159

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

160

#

161

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

162

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

163

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

164

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

165

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

166

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

167

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

Bu Sun Kim

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

[diff] [blame]

168

{

Yoshi Automation Bot

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

[diff] [blame]

169

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

170

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

171

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

Bu Sun Kim

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

[diff] [blame]

172

},

173

],

Yoshi Automation Bot

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

[diff] [blame]

174

},

175

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

176

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

177

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

178

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

179

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

180

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

181

#

182

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

183

#

184

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

185

#

186

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

187

#

188

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

189

#

190

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

191

#

192

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

193

#

194

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

195

#

196

# Example 4: Pack and unpack a message in Go

197

#

198

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

199

#

200

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

205

#

206

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

207

#

208

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

209

#

210

# 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][]):

211

#

212

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

213

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

214

#

215

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

216

#

217

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

218

#

219

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

220

#

221

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

222

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

223

},

Yoshi Automation Bot

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

[diff] [blame]

224

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

yoshi-code-bot

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

[diff] [blame^]

225

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

226

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

227

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

228

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

229

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

230

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

231

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

232

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

233

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

234

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

235

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

236

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

237

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

238

{

239

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

240

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

241

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

242

{

243

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

244

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

245

},

246

],

247

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

248

},

249

],

250

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

251

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

255

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

256

<pre>Retrieves the list of instance groups and sorts them by zone.

257

258

Args:

259

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

Dan O'Meara

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

[diff] [blame]

260

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]

261

Dan O'Meara

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

[diff] [blame]

262

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]

263

Dan O'Meara

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

[diff] [blame]

264

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]

265

Bu Sun Kim

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

[diff] [blame]

266

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]

267

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]

268

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

269

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

270

271

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.

272

273

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

274

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

275

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]

276

277

Returns:

278

An object of the form:

279

280

{

Yoshi Automation Bot

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

[diff] [blame]

281

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

282

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

283

"a_key": { # The name of the scope that contains this set of instance groups.

284

"instanceGroups": [ # [Output Only] The list of instance groups that are contained in this scope.

285

{ # Represents an Instance Group resource.

286

#

287

# Instance Groups can be used to configure a target for load balancing.

288

#

289

# Instance groups can either be managed or unmanaged.

290

#

291

# To create managed instance groups, use the instanceGroupManager or regionInstanceGroupManager resource instead.

292

#

293

# Use zonal unmanaged instance groups if you need to apply load balancing to groups of heterogeneous instances or if you need to manage the instances yourself. You cannot create regional unmanaged instance groups.

294

#

295

# For more information, read Instance groups.

296

#

297

# (== resource_for {$api_version}.instanceGroups ==) (== resource_for {$api_version}.regionInstanceGroups ==)

298

"creationTimestamp": "A String", # [Output Only] The creation timestamp for this instance group in RFC3339 text format.

299

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

300

"fingerprint": "A String", # [Output Only] The fingerprint of the named ports. The system uses this fingerprint to detect conflicts when multiple users change the named ports concurrently.

301

"id": "A String", # [Output Only] A unique identifier for this instance group, generated by the server.

302

"kind": "compute#instanceGroup", # [Output Only] The resource type, which is always compute#instanceGroup for instance groups.

303

"name": "A String", # The name of the instance group. The name must be 1-63 characters long, and comply with RFC1035.

304

"namedPorts": [ # Assigns a name to a port number. For example: {name: "http", port: 80}

Bu Sun Kim

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

[diff] [blame]

305

#

Yoshi Automation Bot

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

[diff] [blame]

306

# This allows the system to reference ports by the assigned name instead of a port number. Named ports can also contain multiple ports. For example: [{name: "http", port: 80},{name: "http", port: 8080}]

Bu Sun Kim

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

[diff] [blame]

307

#

Yoshi Automation Bot

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

[diff] [blame]

308

# Named ports apply to all instances in this instance group.

309

{ # The named port. For example: .

310

"name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.

311

"port": 42, # The port number, which can be a value between 1 and 65535.

Sai Cheemalapati

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

[diff] [blame]

312

},

313

],

Yoshi Automation Bot

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

[diff] [blame]

314

"network": "A String", # [Output Only] The URL of the network to which all instances in the instance group belong. If your instance has multiple network interfaces, then the network and subnetwork fields only refer to the network and subnet used by your primary interface (nic0).

315

"region": "A String", # [Output Only] The URL of the region where the instance group is located (for regional resources).

316

"selfLink": "A String", # [Output Only] The URL for this instance group. The server generates this URL.

317

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

318

"size": 42, # [Output Only] The total number of instances in the instance group.

319

"subnetwork": "A String", # [Output Only] The URL of the subnetwork to which all instances in the instance group belong. If your instance has multiple network interfaces, then the network and subnetwork fields only refer to the network and subnet used by your primary interface (nic0).

320

"zone": "A String", # [Output Only] The URL of the zone where the instance group is located (for zonal resources).

Bu Sun Kim

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

[diff] [blame]

321

},

322

],

Yoshi Automation Bot

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

[diff] [blame]

323

"warning": { # [Output Only] An informational warning that replaces the list of instance groups when the list is empty.

324

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

325

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

326

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

327

{

328

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

329

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

330

},

331

],

332

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

333

},

Bu Sun Kim

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

[diff] [blame]

334

},

Yoshi Automation Bot

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

[diff] [blame]

335

},

336

"kind": "compute#instanceGroupAggregatedList", # [Output Only] The resource type, which is always compute#instanceGroupAggregatedList for aggregated lists of instance groups.

337

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

338

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

339

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

340

"A String",

341

],

342

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

343

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

344

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

345

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

346

{

347

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

348

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

349

},

350

],

351

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

352

},

353

}</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>

358

<pre>Retrieves the next page of results.

359

360

Args:

361

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

362

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

363

364

Returns:

Bu Sun Kim

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

[diff] [blame]

365

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

Sai Cheemalapati

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

[diff] [blame]

366

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]

371

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

372

<pre>Close httplib2 connections.</pre>

</div>

Sai Cheemalapati

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

[diff] [blame]

376

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

Sai Cheemalapati

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

[diff] [blame]

377

<pre>Deletes the specified instance group. The instances in the group are not deleted. Note that instance group must not belong to a backend service. Read Deleting an instance group for more information.

378

379

Args:

380

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

381

zone: string, The name of the zone where the instance group is located. (required)

382

instanceGroup: string, The name of the instance group to delete. (required)

Bu Sun Kim

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

[diff] [blame]

383

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.

384

385

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.

386

387

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]

388

389

Returns:

390

An object of the form:

391

Bu Sun Kim

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

[diff] [blame]

392

{ # Represents an Operation resource.

Yoshi Automation Bot

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

[diff] [blame]

393

#

394

# Google Compute Engine has three Operation resources:

395

#

396

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

397

#

398

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

399

#

400

# Operations can be global, regional or zonal.

401

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

402

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

403

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

404

#

405

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

406

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

407

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

408

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

409

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

410

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

411

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

Bu Sun Kim

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

[diff] [blame]

412

{

Yoshi Automation Bot

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

[diff] [blame]

413

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

414

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

415

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

Bu Sun Kim

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

[diff] [blame]

416

},

417

],

Yoshi Automation Bot

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

[diff] [blame]

418

},

419

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

420

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

421

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

422

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

423

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

424

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

425

#

426

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

427

#

428

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

429

#

430

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

431

#

432

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

433

#

434

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

435

#

436

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

437

#

438

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

439

#

440

# Example 4: Pack and unpack a message in Go

441

#

442

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

443

#

444

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

449

#

450

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

451

#

452

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

453

#

454

# 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][]):

455

#

456

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

457

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

458

#

459

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

460

#

461

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

462

#

463

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

464

#

465

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

466

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

467

},

Yoshi Automation Bot

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

[diff] [blame]

468

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

yoshi-code-bot

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

[diff] [blame^]

469

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

470

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

471

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

472

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

473

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

474

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

475

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

476

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

477

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

478

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

479

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

480

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

481

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

482

{

483

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

484

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

485

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

486

{

487

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

488

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

489

},

490

],

491

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

492

},

493

],

494

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

495

}</pre>

Sai Cheemalapati

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

[diff] [blame]

</div>

<code class="details" id="get">get(project, zone, instanceGroup)</code>

Dmitry Frenkel

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

[diff] [blame]

500

<pre>Returns the specified zonal instance group. Get a list of available zonal instance groups by making a list() request.

501

502

For managed instance groups, use the instanceGroupManagers or regionInstanceGroupManagers methods instead.

Sai Cheemalapati

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

[diff] [blame]

503

504

Args:

505

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

506

zone: string, The name of the zone where the instance group is located. (required)

507

instanceGroup: string, The name of the instance group. (required)

508

509

Returns:

510

An object of the form:

511

Dan O'Meara

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

[diff] [blame]

512

{ # Represents an Instance Group resource.

Yoshi Automation Bot

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

[diff] [blame]

513

#

514

# Instance Groups can be used to configure a target for load balancing.

515

#

516

# Instance groups can either be managed or unmanaged.

517

#

518

# To create managed instance groups, use the instanceGroupManager or regionInstanceGroupManager resource instead.

519

#

520

# Use zonal unmanaged instance groups if you need to apply load balancing to groups of heterogeneous instances or if you need to manage the instances yourself. You cannot create regional unmanaged instance groups.

521

#

522

# For more information, read Instance groups.

523

#

524

# (== resource_for {$api_version}.instanceGroups ==) (== resource_for {$api_version}.regionInstanceGroups ==)

525

"creationTimestamp": "A String", # [Output Only] The creation timestamp for this instance group in RFC3339 text format.

526

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

527

"fingerprint": "A String", # [Output Only] The fingerprint of the named ports. The system uses this fingerprint to detect conflicts when multiple users change the named ports concurrently.

528

"id": "A String", # [Output Only] A unique identifier for this instance group, generated by the server.

529

"kind": "compute#instanceGroup", # [Output Only] The resource type, which is always compute#instanceGroup for instance groups.

530

"name": "A String", # The name of the instance group. The name must be 1-63 characters long, and comply with RFC1035.

531

"namedPorts": [ # Assigns a name to a port number. For example: {name: "http", port: 80}

Bu Sun Kim

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

[diff] [blame]

532

#

Yoshi Automation Bot

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

[diff] [blame]

533

# This allows the system to reference ports by the assigned name instead of a port number. Named ports can also contain multiple ports. For example: [{name: "http", port: 80},{name: "http", port: 8080}]

Bu Sun Kim

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

[diff] [blame]

534

#

Yoshi Automation Bot

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

[diff] [blame]

535

# Named ports apply to all instances in this instance group.

536

{ # The named port. For example: .

537

"name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.

538

"port": 42, # The port number, which can be a value between 1 and 65535.

539

},

540

],

541

"network": "A String", # [Output Only] The URL of the network to which all instances in the instance group belong. If your instance has multiple network interfaces, then the network and subnetwork fields only refer to the network and subnet used by your primary interface (nic0).

542

"region": "A String", # [Output Only] The URL of the region where the instance group is located (for regional resources).

543

"selfLink": "A String", # [Output Only] The URL for this instance group. The server generates this URL.

544

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

545

"size": 42, # [Output Only] The total number of instances in the instance group.

546

"subnetwork": "A String", # [Output Only] The URL of the subnetwork to which all instances in the instance group belong. If your instance has multiple network interfaces, then the network and subnetwork fields only refer to the network and subnet used by your primary interface (nic0).

547

"zone": "A String", # [Output Only] The URL of the zone where the instance group is located (for zonal resources).

548

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

552

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

Sai Cheemalapati

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

[diff] [blame]

553

<pre>Creates an instance group in the specified project using the parameters that are included in the request.

554

555

Args:

556

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

557

zone: string, The name of the zone where you want to create the instance group. (required)

Dan O'Meara

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

[diff] [blame]

558

body: object, The request body.

Sai Cheemalapati

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

[diff] [blame]

559

The object takes the form of:

560

Dan O'Meara

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

[diff] [blame]

561

{ # Represents an Instance Group resource.

Bu Sun Kim

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

[diff] [blame]

562

#

563

# Instance Groups can be used to configure a target for load balancing.

564

#

565

# Instance groups can either be managed or unmanaged.

566

#

567

# To create managed instance groups, use the instanceGroupManager or regionInstanceGroupManager resource instead.

568

#

569

# Use zonal unmanaged instance groups if you need to apply load balancing to groups of heterogeneous instances or if you need to manage the instances yourself. You cannot create regional unmanaged instance groups.

570

#

571

# For more information, read Instance groups.

572

#

573

# (== resource_for {$api_version}.instanceGroups ==) (== resource_for {$api_version}.regionInstanceGroups ==)

574

"creationTimestamp": "A String", # [Output Only] The creation timestamp for this instance group in RFC3339 text format.

575

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

576

"fingerprint": "A String", # [Output Only] The fingerprint of the named ports. The system uses this fingerprint to detect conflicts when multiple users change the named ports concurrently.

577

"id": "A String", # [Output Only] A unique identifier for this instance group, generated by the server.

578

"kind": "compute#instanceGroup", # [Output Only] The resource type, which is always compute#instanceGroup for instance groups.

579

"name": "A String", # The name of the instance group. The name must be 1-63 characters long, and comply with RFC1035.

580

"namedPorts": [ # Assigns a name to a port number. For example: {name: "http", port: 80}

Bu Sun Kim

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

[diff] [blame]

581

#

Bu Sun Kim

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

[diff] [blame]

582

# This allows the system to reference ports by the assigned name instead of a port number. Named ports can also contain multiple ports. For example: [{name: "http", port: 80},{name: "http", port: 8080}]

Bu Sun Kim

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

[diff] [blame]

583

#

Bu Sun Kim

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

[diff] [blame]

584

# Named ports apply to all instances in this instance group.

585

{ # The named port. For example: .

586

"name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.

587

"port": 42, # The port number, which can be a value between 1 and 65535.

588

},

589

],

590

"network": "A String", # [Output Only] The URL of the network to which all instances in the instance group belong. If your instance has multiple network interfaces, then the network and subnetwork fields only refer to the network and subnet used by your primary interface (nic0).

591

"region": "A String", # [Output Only] The URL of the region where the instance group is located (for regional resources).

592

"selfLink": "A String", # [Output Only] The URL for this instance group. The server generates this URL.

593

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

594

"size": 42, # [Output Only] The total number of instances in the instance group.

595

"subnetwork": "A String", # [Output Only] The URL of the subnetwork to which all instances in the instance group belong. If your instance has multiple network interfaces, then the network and subnetwork fields only refer to the network and subnet used by your primary interface (nic0).

596

"zone": "A String", # [Output Only] The URL of the zone where the instance group is located (for zonal resources).

597

}

Sai Cheemalapati

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

[diff] [blame]

598

Bu Sun Kim

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

[diff] [blame]

599

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.

600

601

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.

602

603

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]

604

605

Returns:

606

An object of the form:

607

Bu Sun Kim

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

[diff] [blame]

608

{ # Represents an Operation resource.

Yoshi Automation Bot

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

[diff] [blame]

609

#

610

# Google Compute Engine has three Operation resources:

611

#

612

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

613

#

614

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

615

#

616

# Operations can be global, regional or zonal.

617

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

618

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

619

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

620

#

621

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

622

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

623

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

624

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

625

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

626

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

627

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

Bu Sun Kim

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

[diff] [blame]

628

{

Yoshi Automation Bot

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

[diff] [blame]

629

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

630

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

631

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

Bu Sun Kim

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

[diff] [blame]

632

},

633

],

Yoshi Automation Bot

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

[diff] [blame]

634

},

635

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

636

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

637

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

638

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

639

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

640

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

641

#

642

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

643

#

644

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

645

#

646

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

647

#

648

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

649

#

650

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

651

#

652

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

653

#

654

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

655

#

656

# Example 4: Pack and unpack a message in Go

657

#

658

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

659

#

660

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

665

#

666

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

667

#

668

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

669

#

670

# 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][]):

671

#

672

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

673

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

674

#

675

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

676

#

677

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

678

#

679

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

680

#

681

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

682

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

683

},

Yoshi Automation Bot

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

[diff] [blame]

684

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

yoshi-code-bot

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

[diff] [blame^]

685

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

686

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

687

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

688

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

689

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

690

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

691

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

692

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

693

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

694

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

695

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

696

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

697

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

698

{

699

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

700

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

701

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

702

{

703

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

704

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

705

},

706

],

707

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

708

},

709

],

710

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

711

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

715

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

Dmitry Frenkel

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

[diff] [blame]

716

<pre>Retrieves the list of zonal instance group resources contained within the specified zone.

717

718

For managed instance groups, use the instanceGroupManagers or regionInstanceGroupManagers methods instead.

Sai Cheemalapati

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

[diff] [blame]

719

720

Args:

721

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

722

zone: string, The name of the zone where the instance group is located. (required)

Dan O'Meara

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

[diff] [blame]

723

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]

724

Dan O'Meara

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

[diff] [blame]

725

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]

726

Dan O'Meara

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

[diff] [blame]

727

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]

728

Bu Sun Kim

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

[diff] [blame]

729

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

730

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

731

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

732

733

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.

734

735

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

736

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

737

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]

738

739

Returns:

740

An object of the form:

741

742

{ # A list of InstanceGroup resources.

Yoshi Automation Bot

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

[diff] [blame]

743

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

744

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

745

{ # Represents an Instance Group resource.

746

#

747

# Instance Groups can be used to configure a target for load balancing.

748

#

749

# Instance groups can either be managed or unmanaged.

750

#

751

# To create managed instance groups, use the instanceGroupManager or regionInstanceGroupManager resource instead.

752

#

753

# Use zonal unmanaged instance groups if you need to apply load balancing to groups of heterogeneous instances or if you need to manage the instances yourself. You cannot create regional unmanaged instance groups.

754

#

755

# For more information, read Instance groups.

756

#

757

# (== resource_for {$api_version}.instanceGroups ==) (== resource_for {$api_version}.regionInstanceGroups ==)

758

"creationTimestamp": "A String", # [Output Only] The creation timestamp for this instance group in RFC3339 text format.

759

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

760

"fingerprint": "A String", # [Output Only] The fingerprint of the named ports. The system uses this fingerprint to detect conflicts when multiple users change the named ports concurrently.

761

"id": "A String", # [Output Only] A unique identifier for this instance group, generated by the server.

762

"kind": "compute#instanceGroup", # [Output Only] The resource type, which is always compute#instanceGroup for instance groups.

763

"name": "A String", # The name of the instance group. The name must be 1-63 characters long, and comply with RFC1035.

764

"namedPorts": [ # Assigns a name to a port number. For example: {name: "http", port: 80}

Bu Sun Kim

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

[diff] [blame]

765

#

Yoshi Automation Bot

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

[diff] [blame]

766

# This allows the system to reference ports by the assigned name instead of a port number. Named ports can also contain multiple ports. For example: [{name: "http", port: 80},{name: "http", port: 8080}]

Bu Sun Kim

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

[diff] [blame]

767

#

Yoshi Automation Bot

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

[diff] [blame]

768

# Named ports apply to all instances in this instance group.

769

{ # The named port. For example: .

770

"name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.

771

"port": 42, # The port number, which can be a value between 1 and 65535.

Bu Sun Kim

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

[diff] [blame]

772

},

773

],

Yoshi Automation Bot

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

[diff] [blame]

774

"network": "A String", # [Output Only] The URL of the network to which all instances in the instance group belong. If your instance has multiple network interfaces, then the network and subnetwork fields only refer to the network and subnet used by your primary interface (nic0).

775

"region": "A String", # [Output Only] The URL of the region where the instance group is located (for regional resources).

776

"selfLink": "A String", # [Output Only] The URL for this instance group. The server generates this URL.

777

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

778

"size": 42, # [Output Only] The total number of instances in the instance group.

779

"subnetwork": "A String", # [Output Only] The URL of the subnetwork to which all instances in the instance group belong. If your instance has multiple network interfaces, then the network and subnetwork fields only refer to the network and subnet used by your primary interface (nic0).

780

"zone": "A String", # [Output Only] The URL of the zone where the instance group is located (for zonal resources).

Bu Sun Kim

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

[diff] [blame]

781

},

Yoshi Automation Bot

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

[diff] [blame]

782

],

783

"kind": "compute#instanceGroupList", # [Output Only] The resource type, which is always compute#instanceGroupList for instance group lists.

784

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

785

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

786

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

787

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

788

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

789

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

790

{

791

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

792

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

793

},

794

],

795

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

796

},

797

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

801

<code class="details" id="listInstances">listInstances(project, zone, instanceGroup, body=None, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</code>

Bu Sun Kim

d059ad8

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

[diff] [blame]

802

<pre>Lists the instances in the specified instance group. The orderBy query parameter is not supported.

Sai Cheemalapati

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

[diff] [blame]

803

804

Args:

805

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

806

zone: string, The name of the zone where the instance group is located. (required)

807

instanceGroup: string, The name of the instance group from which you want to generate a list of included instances. (required)

Dan O'Meara

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

[diff] [blame]

808

body: object, The request body.

Sai Cheemalapati

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

[diff] [blame]

809

The object takes the form of:

810

811

{

Yoshi Automation Bot

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

[diff] [blame]

812

"instanceState": "A String", # A filter for the state of the instances in the instance group. Valid options are ALL or RUNNING. If you do not specify this parameter the list includes all instances regardless of their state.

813

}

Sai Cheemalapati

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

[diff] [blame]

814

Dan O'Meara

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

[diff] [blame]

815

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]

816

Dan O'Meara

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

[diff] [blame]

817

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]

818

Dan O'Meara

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

[diff] [blame]

819

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]

820

Bu Sun Kim

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

[diff] [blame]

821

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

822

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

823

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

824

825

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.

826

827

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

828

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

829

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]

830

831

Returns:

832

An object of the form:

833

834

{

Yoshi Automation Bot

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

[diff] [blame]

835

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

836

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

837

{

838

"instance": "A String", # [Output Only] The URL of the instance.

839

"namedPorts": [ # [Output Only] The named ports that belong to this instance group.

840

{ # The named port. For example: .

841

"name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.

842

"port": 42, # The port number, which can be a value between 1 and 65535.

Bu Sun Kim

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

[diff] [blame]

843

},

844

],

Yoshi Automation Bot

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

[diff] [blame]

845

"status": "A String", # [Output Only] The status of the instance.

Bu Sun Kim

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

[diff] [blame]

846

},

Yoshi Automation Bot

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

[diff] [blame]

847

],

848

"kind": "compute#instanceGroupsListInstances", # [Output Only] The resource type, which is always compute#instanceGroupsListInstances for the list of instances in the specified instance group.

849

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

850

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

851

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

852

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

853

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

854

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

855

{

856

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

857

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

858

},

859

],

860

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

861

},

862

}</pre>

Sai Cheemalapati

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

[diff] [blame]

</div>

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

867

<pre>Retrieves the next page of results.

868

869

Args:

870

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

871

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

872

873

Returns:

Bu Sun Kim

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

[diff] [blame]

874

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

Sai Cheemalapati

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

[diff] [blame]

875

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

</pre>

</div>

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

881

<pre>Retrieves the next page of results.

882

883

Args:

884

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

885

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

886

887

Returns:

Bu Sun Kim

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

[diff] [blame]

888

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

Sai Cheemalapati

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

[diff] [blame]

889

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]

894

<code class="details" id="removeInstances">removeInstances(project, zone, instanceGroup, body=None, requestId=None)</code>

Sai Cheemalapati

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

[diff] [blame]

895

<pre>Removes one or more instances from the specified instance group, but does not delete those instances.

896

Sai Cheemalapati

4ba8c23

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

[diff] [blame]

897

If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration before the VM instance is removed or deleted.

898

Sai Cheemalapati

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

[diff] [blame]

899

Args:

900

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

901

zone: string, The name of the zone where the instance group is located. (required)

902

instanceGroup: string, The name of the instance group where the specified instances will be removed. (required)

Dan O'Meara

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

[diff] [blame]

903

body: object, The request body.

Sai Cheemalapati

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

[diff] [blame]

904

The object takes the form of:

905

906

{

Yoshi Automation Bot

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

[diff] [blame]

907

"instances": [ # The list of instances to remove from the instance group.

908

{

909

"instance": "A String", # The URL for a specific instance.

910

},

911

],

912

}

Sai Cheemalapati

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

[diff] [blame]

913

Bu Sun Kim

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

[diff] [blame]

914

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.

915

916

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.

917

918

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]

919

920

Returns:

921

An object of the form:

922

Bu Sun Kim

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

[diff] [blame]

923

{ # Represents an Operation resource.

Yoshi Automation Bot

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

[diff] [blame]

924

#

925

# Google Compute Engine has three Operation resources:

926

#

927

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

928

#

929

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

930

#

931

# Operations can be global, regional or zonal.

932

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

933

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

934

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

935

#

936

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

937

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

938

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

939

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

940

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

941

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

942

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

Bu Sun Kim

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

[diff] [blame]

943

{

Yoshi Automation Bot

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

[diff] [blame]

944

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

945

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

946

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

Bu Sun Kim

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

[diff] [blame]

947

},

948

],

Yoshi Automation Bot

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

[diff] [blame]

949

},

950

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

951

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

952

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

953

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

954

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

955

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

956

#

957

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

958

#

959

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

960

#

961

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

962

#

963

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

964

#

965

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

966

#

967

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

968

#

969

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

970

#

971

# Example 4: Pack and unpack a message in Go

972

#

973

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

974

#

975

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

980

#

981

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

982

#

983

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

984

#

985

# 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][]):

986

#

987

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

988

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

989

#

990

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

991

#

992

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

993

#

994

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

995

#

996

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

997

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

998

},

Yoshi Automation Bot

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

[diff] [blame]

999

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

yoshi-code-bot

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

[diff] [blame^]

1000

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

1001

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

1002

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

1003

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

1004

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

1005

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

1006

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

1007

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

1008

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

1009

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

1010

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

1011

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

1012

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

1013

{

1014

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

1015

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

1016

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

1017

{

1018

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

1019

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

1020

},

1021

],

1022

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

1023

},

1024

],

1025

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

1026

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

1030

<code class="details" id="setNamedPorts">setNamedPorts(project, zone, instanceGroup, body=None, requestId=None)</code>

Sai Cheemalapati

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

[diff] [blame]

1031

<pre>Sets the named ports for the specified instance group.

1032

1033

Args:

1034

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

1035

zone: string, The name of the zone where the instance group is located. (required)

1036

instanceGroup: string, The name of the instance group where the named ports are updated. (required)

Dan O'Meara

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

[diff] [blame]

1037

body: object, The request body.

Sai Cheemalapati

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

[diff] [blame]

1038

The object takes the form of:

1039

1040

{

Yoshi Automation Bot

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

[diff] [blame]

1041

"fingerprint": "A String", # The fingerprint of the named ports information for this instance group. Use this optional property to prevent conflicts when multiple users change the named ports settings concurrently. Obtain the fingerprint with the instanceGroups.get method. Then, include the fingerprint in your request to ensure that you do not overwrite changes that were applied from another concurrent request. A request with an incorrect fingerprint will fail with error 412 conditionNotMet.

1042

"namedPorts": [ # The list of named ports to set for this instance group.

1043

{ # The named port. For example: .

1044

"name": "A String", # The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.

1045

"port": 42, # The port number, which can be a value between 1 and 65535.

1046

},

1047

],

1048

}

Sai Cheemalapati

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

[diff] [blame]

1049

Bu Sun Kim

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

[diff] [blame]

1050

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.

1051

1052

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.

1053

1054

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]

1055

1056

Returns:

1057

An object of the form:

1058

Bu Sun Kim

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

[diff] [blame]

1059

{ # Represents an Operation resource.

Yoshi Automation Bot

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

[diff] [blame]

1060

#

1061

# Google Compute Engine has three Operation resources:

1062

#

1063

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

1064

#

1065

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

1066

#

1067

# Operations can be global, regional or zonal.

1068

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

1069

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

1070

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

1071

#

1072

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

1073

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

1074

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

1075

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

1076

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

1077

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

1078

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

Bu Sun Kim

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

[diff] [blame]

1079

{

Yoshi Automation Bot

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

[diff] [blame]

1080

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

1081

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

1082

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

Bu Sun Kim

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

[diff] [blame]

1083

},

1084

],

Yoshi Automation Bot

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

[diff] [blame]

1085

},

1086

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

1087

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

1088

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

1089

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

1090

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

1091

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

1092

#

1093

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

1094

#

1095

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

1096

#

1097

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

1098

#

1099

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

1100

#

1101

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

1102

#

1103

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

1104

#

1105

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

1106

#

1107

# Example 4: Pack and unpack a message in Go

1108

#

1109

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

1110

#

1111

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

1116

#

1117

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

1118

#

1119

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

1120

#

1121

# 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][]):

1122

#

1123

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

1124

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

1125

#

1126

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

1127

#

1128

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

1129

#

1130

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

1131

#

1132

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

1133

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

1134

},

Yoshi Automation Bot

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

[diff] [blame]

1135

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

yoshi-code-bot

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

[diff] [blame^]

1136

"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