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

2020-10-06 16:46:05 -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

Bu Sun Kim

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

[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

Dmitry Frenkel

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

[diff] [blame]

99

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

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

Dmitry Frenkel

2020-10-06 16:46:05 -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

{

Bu Sun Kim

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

[diff] [blame]

132

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

Sai Cheemalapati

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

[diff] [blame]

133

{

Bu Sun Kim

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

[diff] [blame]

134

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

Sai Cheemalapati

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

[diff] [blame]

},

],

}

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.

149

#

Dan O'Meara

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

[diff] [blame]

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

#

Bu Sun Kim

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

[diff] [blame]

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.

Dan O'Meara

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

[diff] [blame]

157

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

158

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

159

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

Bu Sun Kim

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

[diff] [blame]

160

#

Dan O'Meara

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

[diff] [blame]

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

Bu Sun Kim

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

[diff] [blame]

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.

Sai Cheemalapati

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

[diff] [blame]

168

{

Bu Sun Kim

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

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

Sai Cheemalapati

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

[diff] [blame]

172

},

173

],

174

},

Bu Sun Kim

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

[diff] [blame]

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.

180

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

181

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

182

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

183

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

184

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

185

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

186

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

187

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

188

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

189

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

190

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

191

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

192

{

193

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

194

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

195

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

196

{

197

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

198

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

199

},

200

],

201

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

202

},

203

],

204

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

Sai Cheemalapati

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

[diff] [blame]

}</pre>

</div>

Dmitry Frenkel

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

[diff] [blame]

209

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

210

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

211

212

Args:

213

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

Dan O'Meara

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

[diff] [blame]

214

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]

215

Dan O'Meara

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

[diff] [blame]

216

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]

217

Dan O'Meara

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

[diff] [blame]

218

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]

219

Bu Sun Kim

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

[diff] [blame]

220

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]

221

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]

222

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

223

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

224

225

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.

226

227

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

228

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

Dmitry Frenkel

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

[diff] [blame]

229

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

Sai Cheemalapati

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

[diff] [blame]

230

231

Returns:

232

An object of the form:

233

234

{

Bu Sun Kim

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

[diff] [blame]

235

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

236

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

237

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

238

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

239

{ # Represents an Instance Group resource.

240

#

241

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

242

#

243

# Instance groups can either be managed or unmanaged.

244

#

245

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

246

#

247

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

248

#

249

# For more information, read Instance groups.

250

#

251

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

252

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

253

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

254

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

255

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

256

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

257

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

258

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

259

#

260

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

261

#

262

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

263

{ # The named port. For example: .

264

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

265

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

266

},

267

],

268

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

269

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

270

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

271

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

272

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

273

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

274

},

275

],

276

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

277

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

278

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

279

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

Sai Cheemalapati

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

[diff] [blame]

280

{

Bu Sun Kim

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

[diff] [blame]

281

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

282

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

Sai Cheemalapati

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

[diff] [blame]

283

},

284

],

Bu Sun Kim

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

[diff] [blame]

285

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

Sai Cheemalapati

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

[diff] [blame]

286

},

Sai Cheemalapati

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

[diff] [blame]

287

},

288

},

Bu Sun Kim

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

[diff] [blame]

289

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

290

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

291

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

Dmitry Frenkel

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

[diff] [blame]

292

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

293

"A String",

294

],

Bu Sun Kim

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

[diff] [blame]

295

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

296

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

297

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

298

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

Bu Sun Kim

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

[diff] [blame]

299

{

Bu Sun Kim

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

[diff] [blame]

300

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

301

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

Bu Sun Kim

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

[diff] [blame]

302

},

303

],

Bu Sun Kim

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

[diff] [blame]

304

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

Bu Sun Kim

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

[diff] [blame]

305

},

Sai Cheemalapati

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

[diff] [blame]

}</pre>

</div>

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

311

<pre>Retrieves the next page of results.

312

313

Args:

314

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

315

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

316

317

Returns:

Bu Sun Kim

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

[diff] [blame]

318

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

Sai Cheemalapati

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

[diff] [blame]

319

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]

324

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

325

<pre>Close httplib2 connections.</pre>

</div>

Bu Sun Kim

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

[diff] [blame]

329

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

Sai Cheemalapati

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

[diff] [blame]

330

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

331

332

Args:

333

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

334

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

335

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

Bu Sun Kim

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

[diff] [blame]

336

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.

337

338

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.

339

340

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]

341

342

Returns:

343

An object of the form:

344

Bu Sun Kim

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

[diff] [blame]

345

{ # Represents an Operation resource.

346

#

Dan O'Meara

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

[diff] [blame]

347

# Google Compute Engine has three Operation resources:

348

#

349

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

350

#

Bu Sun Kim

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

[diff] [blame]

351

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

352

#

353

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

354

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

355

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

356

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

Bu Sun Kim

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

[diff] [blame]

357

#

Dan O'Meara

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

[diff] [blame]

358

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

Bu Sun Kim

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

[diff] [blame]

359

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

360

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

361

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

362

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

363

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

364

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

Sai Cheemalapati

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

[diff] [blame]

365

{

Bu Sun Kim

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

[diff] [blame]

366

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

367

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

368

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

Sai Cheemalapati

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

[diff] [blame]

369

},

370

],

371

},

Bu Sun Kim

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

[diff] [blame]

372

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

373

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

374

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

375

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

376

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

377

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

378

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

379

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

380

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

381

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

382

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

383

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

384

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

385

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

386

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

387

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

388

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

389

{

390

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

391

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

392

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

393

{

394

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

395

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

396

},

397

],

398

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

399

},

400

],

401

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

Sai Cheemalapati

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

[diff] [blame]

}</pre>

</div>

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

Dmitry Frenkel

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

[diff] [blame]

407

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

408

409

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

Sai Cheemalapati

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

[diff] [blame]

410

411

Args:

412

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

413

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

414

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

415

416

Returns:

417

An object of the form:

418

Dan O'Meara

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

[diff] [blame]

419

{ # Represents an Instance Group resource.

Bu Sun Kim

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

[diff] [blame]

420

#

421

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

422

#

423

# Instance groups can either be managed or unmanaged.

424

#

425

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

426

#

427

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

428

#

429

# For more information, read Instance groups.

430

#

431

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

432

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

433

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

434

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

435

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

436

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

437

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

438

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

439

#

Bu Sun Kim

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

[diff] [blame]

440

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

441

#

Bu Sun Kim

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

[diff] [blame]

442

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

443

{ # The named port. For example: .

444

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

445

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

446

},

447

],

448

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

449

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

450

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

451

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

452

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

453

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

454

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

458

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

Sai Cheemalapati

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

[diff] [blame]

459

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

460

461

Args:

462

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

463

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]

464

body: object, The request body.

Sai Cheemalapati

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

[diff] [blame]

465

The object takes the form of:

466

Dan O'Meara

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

[diff] [blame]

467

{ # Represents an Instance Group resource.

Bu Sun Kim

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

[diff] [blame]

468

#

469

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

470

#

471

# Instance groups can either be managed or unmanaged.

472

#

473

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

474

#

475

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

476

#

477

# For more information, read Instance groups.

478

#

479

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

480

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

481

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

482

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

483

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

484

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

485

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

486

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

487

#

Bu Sun Kim

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

[diff] [blame]

488

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

489

#

Bu Sun Kim

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

[diff] [blame]

490

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

491

{ # The named port. For example: .

492

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

493

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

494

},

495

],

496

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

497

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

498

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

499

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

500

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

501

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

502

}

Sai Cheemalapati

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

[diff] [blame]

503

Bu Sun Kim

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

[diff] [blame]

504

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.

505

506

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.

507

508

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]

509

510

Returns:

511

An object of the form:

512

Bu Sun Kim

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

[diff] [blame]

513

{ # Represents an Operation resource.

514

#

Dan O'Meara

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

[diff] [blame]

515

# Google Compute Engine has three Operation resources:

516

#

517

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

518

#

Bu Sun Kim

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

[diff] [blame]

519

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

520

#

521

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

522

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

523

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

524

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

Bu Sun Kim

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

[diff] [blame]

525

#

Dan O'Meara

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

[diff] [blame]

526

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

Bu Sun Kim

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

[diff] [blame]

527

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

528

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

529

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

530

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

531

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

532

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

Sai Cheemalapati

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

[diff] [blame]

533

{

Bu Sun Kim

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

[diff] [blame]

534

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

535

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

536

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

Sai Cheemalapati

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

[diff] [blame]

537

},

538

],

539

},

Bu Sun Kim

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

[diff] [blame]

540

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

541

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

542

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

543

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

544

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

545

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

546

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

547

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

548

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

549

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

550

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

551

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

552

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

553

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

554

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

555

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

556

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

557

{

558

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

559

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

560

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

561

{

562

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

563

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

564

},

565

],

566

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

567

},

568

],

569

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

Sai Cheemalapati

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

[diff] [blame]

}</pre>

</div>

Dmitry Frenkel

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

[diff] [blame]

574

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

575

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

576

577

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

Sai Cheemalapati

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

[diff] [blame]

578

579

Args:

580

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

581

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]

582

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]

583

Dan O'Meara

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

[diff] [blame]

584

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]

585

Dan O'Meara

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

[diff] [blame]

586

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]

587

Bu Sun Kim

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

[diff] [blame]

588

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

589

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

590

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

591

592

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.

593

594

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

595

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

Dmitry Frenkel

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

[diff] [blame]

596

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

Sai Cheemalapati

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

[diff] [blame]

597

598

Returns:

599

An object of the form:

600

601

{ # A list of InstanceGroup resources.

Bu Sun Kim

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

[diff] [blame]

602

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

603

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

Dan O'Meara

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

[diff] [blame]

604

{ # Represents an Instance Group resource.

Bu Sun Kim

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

[diff] [blame]

605

#

606

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

607

#

608

# Instance groups can either be managed or unmanaged.

609

#

610

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

611

#

612

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

613

#

614

# For more information, read Instance groups.

615

#

616

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

617

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

618

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

619

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

620

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

621

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

622

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

623

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

624

#

Bu Sun Kim

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

[diff] [blame]

625

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

626

#

Bu Sun Kim

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

[diff] [blame]

627

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

628

{ # The named port. For example: .

629

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

630

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

631

},

632

],

633

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

634

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

635

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

636

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

637

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

638

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

639

},

Sai Cheemalapati

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

[diff] [blame]

640

],

Bu Sun Kim

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

[diff] [blame]

641

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

642

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

643

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

644

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

645

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

646

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

647

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

Bu Sun Kim

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

[diff] [blame]

648

{

Bu Sun Kim

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

[diff] [blame]

649

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

650

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

Bu Sun Kim

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

[diff] [blame]

651

},

652

],

Bu Sun Kim

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

[diff] [blame]

653

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

Bu Sun Kim

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

[diff] [blame]

654

},

Sai Cheemalapati

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

[diff] [blame]

}</pre>

</div>

Dmitry Frenkel

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

[diff] [blame]

659

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

660

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

661

662

Args:

663

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

664

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

665

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]

666

body: object, The request body.

Sai Cheemalapati

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

[diff] [blame]

667

The object takes the form of:

668

669

{

Bu Sun Kim

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

[diff] [blame]

670

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

Sai Cheemalapati

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

[diff] [blame]

671

}

672

Dan O'Meara

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

[diff] [blame]

673

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]

674

Dan O'Meara

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

[diff] [blame]

675

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]

676

Dan O'Meara

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

[diff] [blame]

677

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]

678

Bu Sun Kim

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

[diff] [blame]

679

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

680

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

681

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

682

683

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.

684

685

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

686

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

Dmitry Frenkel

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

[diff] [blame]

687

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

Sai Cheemalapati

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

[diff] [blame]

688

689

Returns:

690

An object of the form:

691

692

{

Bu Sun Kim

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

[diff] [blame]

693

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

694

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

Sai Cheemalapati

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

[diff] [blame]

695

{

Bu Sun Kim

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

[diff] [blame]

696

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

697

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

Sai Cheemalapati

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

[diff] [blame]

698

{ # The named port. For example: .

Bu Sun Kim

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

[diff] [blame]

699

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

700

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

701

},

702

],

Bu Sun Kim

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

[diff] [blame]

703

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

Sai Cheemalapati

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

[diff] [blame]

704

},

705

],

Bu Sun Kim

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

[diff] [blame]

706

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

707

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

708

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

709

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

710

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

711

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

712

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

Bu Sun Kim

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

[diff] [blame]

713

{

Bu Sun Kim

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

[diff] [blame]

714

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

715

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

Bu Sun Kim

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

[diff] [blame]

716

},

717

],

Bu Sun Kim

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

[diff] [blame]

718

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

Bu Sun Kim

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

[diff] [blame]

719

},

Sai Cheemalapati

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

[diff] [blame]

}</pre>

</div>

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

725

<pre>Retrieves the next page of results.

726

727

Args:

728

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

729

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

730

731

Returns:

Bu Sun Kim

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

[diff] [blame]

732

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

Sai Cheemalapati

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

[diff] [blame]

733

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>

739

<pre>Retrieves the next page of results.

740

741

Args:

742

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

743

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

744

745

Returns:

Bu Sun Kim

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

[diff] [blame]

746

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

Sai Cheemalapati

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

[diff] [blame]

747

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]

752

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

753

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

754

Sai Cheemalapati

4ba8c23

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

[diff] [blame]

755

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.

756

Sai Cheemalapati

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

[diff] [blame]

757

Args:

758

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

759

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

760

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]

761

body: object, The request body.

Sai Cheemalapati

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

[diff] [blame]

762

The object takes the form of:

763

764

{

Bu Sun Kim

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

[diff] [blame]

765

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

Sai Cheemalapati

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

[diff] [blame]

766

{

Bu Sun Kim

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

[diff] [blame]

767

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

Sai Cheemalapati

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

[diff] [blame]

},

],

}

Bu Sun Kim

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

[diff] [blame]

772

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.

773

774

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.

775

776

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]

777

778

Returns:

779

An object of the form:

780

Bu Sun Kim

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

[diff] [blame]

781

{ # Represents an Operation resource.

782

#

Dan O'Meara

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

[diff] [blame]

783

# Google Compute Engine has three Operation resources:

784

#

785

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

786

#

Bu Sun Kim

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

[diff] [blame]

787

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

788

#

789

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

790

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

791

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

792

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

Bu Sun Kim

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

[diff] [blame]

793

#

Dan O'Meara

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

[diff] [blame]

794

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

Bu Sun Kim

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

[diff] [blame]

795

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

796

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

797

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

798

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

799

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

800

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

Sai Cheemalapati

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

[diff] [blame]

801

{

Bu Sun Kim

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

[diff] [blame]

802

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

803

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

804

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

Sai Cheemalapati

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

[diff] [blame]

805

},

806

],

807

},

Bu Sun Kim

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

[diff] [blame]

808

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

809

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

810

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

811

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

812

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

813

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

814

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

815

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

816

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

817

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

818

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

819

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

820

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

821

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

822

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

823

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

824

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

825

{

826

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

827

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

828

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

829

{

830

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

831

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

832

},

833

],

834

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

835

},

836

],

837

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

Sai Cheemalapati

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

[diff] [blame]

}</pre>

</div>

Dan O'Meara

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

[diff] [blame]

842

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

843

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

844

845

Args:

846

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

847

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

848

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]

849

body: object, The request body.

Sai Cheemalapati

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

[diff] [blame]

850

The object takes the form of:

851

852

{

Bu Sun Kim

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

[diff] [blame]

853

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

854

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

Sai Cheemalapati

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

[diff] [blame]

855

{ # The named port. For example: .

Bu Sun Kim

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

[diff] [blame]

856

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

857

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

858

},

859

],

Sai Cheemalapati

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

[diff] [blame]

860

}

861

Bu Sun Kim

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

[diff] [blame]

862

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.

863

864

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.

865

866

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]

867

868

Returns:

869

An object of the form:

870

Bu Sun Kim

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

[diff] [blame]

871

{ # Represents an Operation resource.

872

#

Dan O'Meara

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

[diff] [blame]

873

# Google Compute Engine has three Operation resources:

874

#

875

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

876

#

Bu Sun Kim

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

[diff] [blame]

877

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

878

#

879

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

880

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

881

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

882

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

Bu Sun Kim

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

[diff] [blame]

883

#

Dan O'Meara

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

[diff] [blame]

884

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

Bu Sun Kim

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

[diff] [blame]

885

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

886

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

887

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

888

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

889

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

890

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

Sai Cheemalapati

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

[diff] [blame]

891

{

Bu Sun Kim

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

[diff] [blame]

892

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

893

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

894

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

Sai Cheemalapati

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

[diff] [blame]

895

},

896

],

897

},

Bu Sun Kim