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

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

[diff] [blame]

79

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

80

81

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

82

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

83

84

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

85

<p class="firstline">Returns the specified commitment resource. Gets a list of available commitments by making a list() request.</p>

86

Dan O'Meara

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

[diff] [blame]

87

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

Bu Sun Kim

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

[diff] [blame]

88

<p class="firstline">Creates a commitment in the specified project using the data included in the request.</p>

89

Bu Sun Kim

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

[diff] [blame]

90

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

Bu Sun Kim

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

[diff] [blame]

91

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

92

93

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

94

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

95

<h3>Method Details</h3>

96

Bu Sun Kim

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

[diff] [blame]

97

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

Bu Sun Kim

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

[diff] [blame]

98

<pre>Retrieves an aggregated list of commitments.

99

100

Args:

101

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

Dan O'Meara

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

[diff] [blame]

102

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

Bu Sun Kim

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

[diff] [blame]

103

Dan O'Meara

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

[diff] [blame]

104

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

Bu Sun Kim

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

[diff] [blame]

105

Dan O'Meara

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

[diff] [blame]

106

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.

Bu Sun Kim

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

[diff] [blame]

107

Bu Sun Kim

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

[diff] [blame]

108

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]

109

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]

110

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

111

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

112

113

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.

114

115

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

116

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.

Bu Sun Kim

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

[diff] [blame]

117

118

Returns:

119

An object of the form:

120

121

{

Bu Sun Kim

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

[diff] [blame]

122

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

123

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

124

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

125

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

126

{ # Represents a regional Commitment resource.

127

#

128

# Creating a commitment resource means that you are purchasing a committed use contract with an explicit start and end time. You can create commitments based on vCPUs and memory usage and receive discounted rates. For full details, read Signing Up for Committed Use Discounts. (== resource_for {$api_version}.regionCommitments ==)

129

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

130

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

131

"endTimestamp": "A String", # [Output Only] Commitment end time in RFC3339 text format.

132

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

133

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

134

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

135

"plan": "A String", # The plan for this commitment, which determines duration and discount rate. The currently supported plans are TWELVE_MONTH (1 year), and THIRTY_SIX_MONTH (3 years).

136

"region": "A String", # [Output Only] URL of the region where this commitment may be used.

137

"reservations": [ # List of reservations in this commitment.

138

{ # Represents a reservation resource. A reservation ensures that capacity is held in a specific zone even if the reserved VMs are not running. For more information, read Reserving zonal resources. (== resource_for {$api_version}.reservations ==)

139

"commitment": "A String", # [Output Only] Full or partial URL to a parent commitment. This field displays for reservations that are tied to a commitment.

140

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

141

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

142

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

143

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

144

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

145

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

146

"specificReservation": { # This reservation type allows to pre allocate specific instance configuration. # Reservation for instances with specific machine shapes.

147

"count": "A String", # Specifies the number of resources that are allocated.

148

"inUseCount": "A String", # [Output Only] Indicates how many instances are in use.

Bu Sun Kim

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

[diff] [blame^]

149

"instanceProperties": { # Properties of the SKU instances being reserved. Next ID: 9 # The instance properties for the reservation.

Bu Sun Kim

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

[diff] [blame]

150

"guestAccelerators": [ # Specifies accelerator type and count.

151

{ # A specification of the type and number of accelerator cards attached to the instance.

152

"acceleratorCount": 42, # The number of the guest accelerator cards exposed to this instance.

153

"acceleratorType": "A String", # Full or partial URL of the accelerator type resource to attach to this instance. For example: projects/my-project/zones/us-central1-c/acceleratorTypes/nvidia-tesla-p100 If you are creating an instance template, specify only the accelerator name. See GPUs on Compute Engine for a full list of accelerator types.

154

},

155

],

156

"localSsds": [ # Specifies amount of local ssd to reserve with each instance. The type of disk is local-ssd.

157

{

158

"diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB.

159

"interface": "A String", # Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance.

160

},

161

],

162

"machineType": "A String", # Specifies type of machine (name only) which has fixed number of vCPUs and fixed amount of memory. This also includes specifying custom machine type following custom-NUMBER_OF_CPUS-AMOUNT_OF_MEMORY pattern.

Bu Sun Kim

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

[diff] [blame^]

163

"maintenanceInterval": "A String", # Specifies whether this VM may be a stable fleet VM. Setting this to "Periodic" designates this VM as a Stable Fleet VM.

164

#

165

# See go/stable-fleet-ug for more details.

Bu Sun Kim

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

[diff] [blame]

166

"minCpuPlatform": "A String", # Minimum cpu platform the reservation.

167

},

168

},

169

"specificReservationRequired": True or False, # Indicates whether the reservation can be consumed by VMs with affinity for "any" reservation. If the field is set, then only VMs that target the reservation by name can consume from this reservation.

170

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

171

"zone": "A String", # Zone in which the reservation resides. A zone must be provided if the reservation is created within a commitment.

172

},

173

],

174

"resources": [ # A list of commitment amounts for particular resources. Note that VCPU and MEMORY resource commitments must occur together.

175

{ # Commitment for a particular resource (a Commitment is composed of one or more of these).

176

"acceleratorType": "A String", # Name of the accelerator type resource. Applicable only when the type is ACCELERATOR.

177

"amount": "A String", # The amount of the resource purchased (in a type-dependent unit, such as bytes). For vCPUs, this can just be an integer. For memory, this must be provided in MB. Memory must be a multiple of 256 MB, with up to 6.5GB of memory per every vCPU.

178

"type": "A String", # Type of resource for which this commitment applies. Possible values are VCPU and MEMORY

179

},

180

],

181

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

182

"startTimestamp": "A String", # [Output Only] Commitment start time in RFC3339 text format.

183

"status": "A String", # [Output Only] Status of the commitment with regards to eventual expiration (each commitment has an end date defined). One of the following values: NOT_YET_ACTIVE, ACTIVE, EXPIRED.

184

"statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status.

185

},

186

],

187

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

188

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

189

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

190

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

Bu Sun Kim

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

[diff] [blame]

191

{

Bu Sun Kim

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

[diff] [blame]

192

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

193

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

194

},

195

],

Bu Sun Kim

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

[diff] [blame]

196

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

197

},

Bu Sun Kim

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

[diff] [blame]

198

},

199

},

Bu Sun Kim

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

[diff] [blame]

200

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

201

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

202

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

203

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

204

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

205

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

206

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

Bu Sun Kim

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

[diff] [blame]

207

{

Bu Sun Kim

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

[diff] [blame]

208

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

209

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

210

},

211

],

Bu Sun Kim

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

[diff] [blame]

212

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

213

},

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

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

219

<pre>Retrieves the next page of results.

220

221

Args:

222

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

223

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

224

225

Returns:

Bu Sun Kim

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

[diff] [blame]

226

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

Bu Sun Kim

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

[diff] [blame]

227

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

</pre>

</div>

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

233

<pre>Returns the specified commitment resource. Gets a list of available commitments by making a list() request.

234

235

Args:

236

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

237

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

238

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

239

240

Returns:

241

An object of the form:

242

243

{ # Represents a regional Commitment resource.

Bu Sun Kim

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

[diff] [blame]

244

#

245

# Creating a commitment resource means that you are purchasing a committed use contract with an explicit start and end time. You can create commitments based on vCPUs and memory usage and receive discounted rates. For full details, read Signing Up for Committed Use Discounts. (== resource_for {$api_version}.regionCommitments ==)

246

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

247

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

248

"endTimestamp": "A String", # [Output Only] Commitment end time in RFC3339 text format.

249

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

250

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

251

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

252

"plan": "A String", # The plan for this commitment, which determines duration and discount rate. The currently supported plans are TWELVE_MONTH (1 year), and THIRTY_SIX_MONTH (3 years).

253

"region": "A String", # [Output Only] URL of the region where this commitment may be used.

254

"reservations": [ # List of reservations in this commitment.

255

{ # Represents a reservation resource. A reservation ensures that capacity is held in a specific zone even if the reserved VMs are not running. For more information, read Reserving zonal resources. (== resource_for {$api_version}.reservations ==)

256

"commitment": "A String", # [Output Only] Full or partial URL to a parent commitment. This field displays for reservations that are tied to a commitment.

257

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

258

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

259

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

260

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

261

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

262

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

263

"specificReservation": { # This reservation type allows to pre allocate specific instance configuration. # Reservation for instances with specific machine shapes.

264

"count": "A String", # Specifies the number of resources that are allocated.

265

"inUseCount": "A String", # [Output Only] Indicates how many instances are in use.

Bu Sun Kim

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

[diff] [blame^]

266

"instanceProperties": { # Properties of the SKU instances being reserved. Next ID: 9 # The instance properties for the reservation.

Bu Sun Kim

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

[diff] [blame]

267

"guestAccelerators": [ # Specifies accelerator type and count.

268

{ # A specification of the type and number of accelerator cards attached to the instance.

269

"acceleratorCount": 42, # The number of the guest accelerator cards exposed to this instance.

270

"acceleratorType": "A String", # Full or partial URL of the accelerator type resource to attach to this instance. For example: projects/my-project/zones/us-central1-c/acceleratorTypes/nvidia-tesla-p100 If you are creating an instance template, specify only the accelerator name. See GPUs on Compute Engine for a full list of accelerator types.

271

},

272

],

273

"localSsds": [ # Specifies amount of local ssd to reserve with each instance. The type of disk is local-ssd.

274

{

275

"diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB.

276

"interface": "A String", # Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance.

277

},

278

],

279

"machineType": "A String", # Specifies type of machine (name only) which has fixed number of vCPUs and fixed amount of memory. This also includes specifying custom machine type following custom-NUMBER_OF_CPUS-AMOUNT_OF_MEMORY pattern.

Bu Sun Kim

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

[diff] [blame^]

280

"maintenanceInterval": "A String", # Specifies whether this VM may be a stable fleet VM. Setting this to "Periodic" designates this VM as a Stable Fleet VM.

281

#

282

# See go/stable-fleet-ug for more details.

Bu Sun Kim

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

[diff] [blame]

283

"minCpuPlatform": "A String", # Minimum cpu platform the reservation.

Dan O'Meara

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

[diff] [blame]

284

},

Dan O'Meara

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

[diff] [blame]

285

},

Bu Sun Kim

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

[diff] [blame]

286

"specificReservationRequired": True or False, # Indicates whether the reservation can be consumed by VMs with affinity for "any" reservation. If the field is set, then only VMs that target the reservation by name can consume from this reservation.

287

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

288

"zone": "A String", # Zone in which the reservation resides. A zone must be provided if the reservation is created within a commitment.

289

},

290

],

291

"resources": [ # A list of commitment amounts for particular resources. Note that VCPU and MEMORY resource commitments must occur together.

292

{ # Commitment for a particular resource (a Commitment is composed of one or more of these).

293

"acceleratorType": "A String", # Name of the accelerator type resource. Applicable only when the type is ACCELERATOR.

294

"amount": "A String", # The amount of the resource purchased (in a type-dependent unit, such as bytes). For vCPUs, this can just be an integer. For memory, this must be provided in MB. Memory must be a multiple of 256 MB, with up to 6.5GB of memory per every vCPU.

295

"type": "A String", # Type of resource for which this commitment applies. Possible values are VCPU and MEMORY

296

},

297

],

298

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

299

"startTimestamp": "A String", # [Output Only] Commitment start time in RFC3339 text format.

300

"status": "A String", # [Output Only] Status of the commitment with regards to eventual expiration (each commitment has an end date defined). One of the following values: NOT_YET_ACTIVE, ACTIVE, EXPIRED.

301

"statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status.

302

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

Dan O'Meara

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

[diff] [blame]

306

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

Bu Sun Kim

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

[diff] [blame]

307

<pre>Creates a commitment in the specified project using the data included in the request.

308

309

Args:

310

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

311

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

Dan O'Meara

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

[diff] [blame]

312

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

313

The object takes the form of:

314

315

{ # Represents a regional Commitment resource.

Bu Sun Kim

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

[diff] [blame]

316

#

317

# Creating a commitment resource means that you are purchasing a committed use contract with an explicit start and end time. You can create commitments based on vCPUs and memory usage and receive discounted rates. For full details, read Signing Up for Committed Use Discounts. (== resource_for {$api_version}.regionCommitments ==)

318

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

319

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

320

"endTimestamp": "A String", # [Output Only] Commitment end time in RFC3339 text format.

321

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

322

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

323

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

324

"plan": "A String", # The plan for this commitment, which determines duration and discount rate. The currently supported plans are TWELVE_MONTH (1 year), and THIRTY_SIX_MONTH (3 years).

325

"region": "A String", # [Output Only] URL of the region where this commitment may be used.

326

"reservations": [ # List of reservations in this commitment.

327

{ # Represents a reservation resource. A reservation ensures that capacity is held in a specific zone even if the reserved VMs are not running. For more information, read Reserving zonal resources. (== resource_for {$api_version}.reservations ==)

328

"commitment": "A String", # [Output Only] Full or partial URL to a parent commitment. This field displays for reservations that are tied to a commitment.

329

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

330

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

331

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

332

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

333

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

334

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

335

"specificReservation": { # This reservation type allows to pre allocate specific instance configuration. # Reservation for instances with specific machine shapes.

336

"count": "A String", # Specifies the number of resources that are allocated.

337

"inUseCount": "A String", # [Output Only] Indicates how many instances are in use.

Bu Sun Kim

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

[diff] [blame^]

338

"instanceProperties": { # Properties of the SKU instances being reserved. Next ID: 9 # The instance properties for the reservation.

Bu Sun Kim

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

[diff] [blame]

339

"guestAccelerators": [ # Specifies accelerator type and count.

340

{ # A specification of the type and number of accelerator cards attached to the instance.

341

"acceleratorCount": 42, # The number of the guest accelerator cards exposed to this instance.

342

"acceleratorType": "A String", # Full or partial URL of the accelerator type resource to attach to this instance. For example: projects/my-project/zones/us-central1-c/acceleratorTypes/nvidia-tesla-p100 If you are creating an instance template, specify only the accelerator name. See GPUs on Compute Engine for a full list of accelerator types.

343

},

344

],

345

"localSsds": [ # Specifies amount of local ssd to reserve with each instance. The type of disk is local-ssd.

346

{

347

"diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB.

348

"interface": "A String", # Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance.

349

},

350

],

351

"machineType": "A String", # Specifies type of machine (name only) which has fixed number of vCPUs and fixed amount of memory. This also includes specifying custom machine type following custom-NUMBER_OF_CPUS-AMOUNT_OF_MEMORY pattern.

Bu Sun Kim

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

[diff] [blame^]

352

"maintenanceInterval": "A String", # Specifies whether this VM may be a stable fleet VM. Setting this to "Periodic" designates this VM as a Stable Fleet VM.

353

#

354

# See go/stable-fleet-ug for more details.

Bu Sun Kim

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

[diff] [blame]

355

"minCpuPlatform": "A String", # Minimum cpu platform the reservation.

Dan O'Meara

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

[diff] [blame]

356

},

Dan O'Meara

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

[diff] [blame]

357

},

Bu Sun Kim

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

[diff] [blame]

358

"specificReservationRequired": True or False, # Indicates whether the reservation can be consumed by VMs with affinity for "any" reservation. If the field is set, then only VMs that target the reservation by name can consume from this reservation.

359

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

360

"zone": "A String", # Zone in which the reservation resides. A zone must be provided if the reservation is created within a commitment.

361

},

362

],

363

"resources": [ # A list of commitment amounts for particular resources. Note that VCPU and MEMORY resource commitments must occur together.

364

{ # Commitment for a particular resource (a Commitment is composed of one or more of these).

365

"acceleratorType": "A String", # Name of the accelerator type resource. Applicable only when the type is ACCELERATOR.

366

"amount": "A String", # The amount of the resource purchased (in a type-dependent unit, such as bytes). For vCPUs, this can just be an integer. For memory, this must be provided in MB. Memory must be a multiple of 256 MB, with up to 6.5GB of memory per every vCPU.

367

"type": "A String", # Type of resource for which this commitment applies. Possible values are VCPU and MEMORY

368

},

369

],

370

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

371

"startTimestamp": "A String", # [Output Only] Commitment start time in RFC3339 text format.

372

"status": "A String", # [Output Only] Status of the commitment with regards to eventual expiration (each commitment has an end date defined). One of the following values: NOT_YET_ACTIVE, ACTIVE, EXPIRED.

373

"statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status.

374

}

Bu Sun Kim

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

[diff] [blame]

375

376

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.

377

378

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.

379

380

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

381

382

Returns:

383

An object of the form:

384

385

{ # Represents an Operation resource.

386

#

Dan O'Meara

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

[diff] [blame]

387

# Google Compute Engine has three Operation resources:

388

#

389

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

390

#

Bu Sun Kim

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

[diff] [blame]

391

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

392

#

393

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

394

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

395

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

396

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

Bu Sun Kim

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

[diff] [blame]

397

#

Dan O'Meara

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

[diff] [blame]

398

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

399

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

400

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

401

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

402

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

403

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

404

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

Bu Sun Kim

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

[diff] [blame]

405

{

Bu Sun Kim

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

[diff] [blame]

406

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

407

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

408

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

Bu Sun Kim

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

[diff] [blame]

409

},

410

],

411

},

Bu Sun Kim

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

[diff] [blame]

412

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

413

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

414

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

415

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

416

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

417

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

418

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

419

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

420

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

421

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

422

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

423

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

424

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

425

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

426

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

427

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

428

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

429

{

430

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

431

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

432

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

433

{

434

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

435

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

436

},

437

],

438

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

439

},

440

],

441

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

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

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

[diff] [blame]

446

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

Bu Sun Kim

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

[diff] [blame]

447

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

448

449

Args:

450

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

451

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

Dan O'Meara

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

[diff] [blame]

452

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

Bu Sun Kim

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

[diff] [blame]

453

Dan O'Meara

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

[diff] [blame]

454

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

Bu Sun Kim

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

[diff] [blame]

455

Dan O'Meara

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

[diff] [blame]

456

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.

Bu Sun Kim

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

[diff] [blame]

457

Bu Sun Kim

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

[diff] [blame]

458

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

459

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

460

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

461

462

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.

463

464

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

465

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.

Bu Sun Kim

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

[diff] [blame]

466

467

Returns:

468

An object of the form:

469

470

{ # Contains a list of Commitment resources.

Bu Sun Kim

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

[diff] [blame]

471

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

472

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

Bu Sun Kim

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

[diff] [blame]

473

{ # Represents a regional Commitment resource.

Bu Sun Kim

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

[diff] [blame]

474

#

475

# Creating a commitment resource means that you are purchasing a committed use contract with an explicit start and end time. You can create commitments based on vCPUs and memory usage and receive discounted rates. For full details, read Signing Up for Committed Use Discounts. (== resource_for {$api_version}.regionCommitments ==)

476

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

477

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

478

"endTimestamp": "A String", # [Output Only] Commitment end time in RFC3339 text format.

479

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

480

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

481

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

482

"plan": "A String", # The plan for this commitment, which determines duration and discount rate. The currently supported plans are TWELVE_MONTH (1 year), and THIRTY_SIX_MONTH (3 years).

483

"region": "A String", # [Output Only] URL of the region where this commitment may be used.

484

"reservations": [ # List of reservations in this commitment.

485

{ # Represents a reservation resource. A reservation ensures that capacity is held in a specific zone even if the reserved VMs are not running. For more information, read Reserving zonal resources. (== resource_for {$api_version}.reservations ==)

486

"commitment": "A String", # [Output Only] Full or partial URL to a parent commitment. This field displays for reservations that are tied to a commitment.

487

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

488

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

489

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

490

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

491

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

492

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

493

"specificReservation": { # This reservation type allows to pre allocate specific instance configuration. # Reservation for instances with specific machine shapes.

494

"count": "A String", # Specifies the number of resources that are allocated.

495

"inUseCount": "A String", # [Output Only] Indicates how many instances are in use.

Bu Sun Kim

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

[diff] [blame^]

496

"instanceProperties": { # Properties of the SKU instances being reserved. Next ID: 9 # The instance properties for the reservation.

Bu Sun Kim

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

[diff] [blame]

497

"guestAccelerators": [ # Specifies accelerator type and count.

498

{ # A specification of the type and number of accelerator cards attached to the instance.

499

"acceleratorCount": 42, # The number of the guest accelerator cards exposed to this instance.

500

"acceleratorType": "A String", # Full or partial URL of the accelerator type resource to attach to this instance. For example: projects/my-project/zones/us-central1-c/acceleratorTypes/nvidia-tesla-p100 If you are creating an instance template, specify only the accelerator name. See GPUs on Compute Engine for a full list of accelerator types.

501

},

502

],

503

"localSsds": [ # Specifies amount of local ssd to reserve with each instance. The type of disk is local-ssd.

504

{

505

"diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB.

506

"interface": "A String", # Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance.

507

},

508

],

509

"machineType": "A String", # Specifies type of machine (name only) which has fixed number of vCPUs and fixed amount of memory. This also includes specifying custom machine type following custom-NUMBER_OF_CPUS-AMOUNT_OF_MEMORY pattern.

Bu Sun Kim

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

[diff] [blame^]

510

"maintenanceInterval": "A String", # Specifies whether this VM may be a stable fleet VM. Setting this to "Periodic" designates this VM as a Stable Fleet VM.

511

#

512

# See go/stable-fleet-ug for more details.

Bu Sun Kim

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

[diff] [blame]

513

"minCpuPlatform": "A String", # Minimum cpu platform the reservation.

Dan O'Meara

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

[diff] [blame]

514

},

Dan O'Meara

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

[diff] [blame]

515

},

Bu Sun Kim

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

[diff] [blame]

516

"specificReservationRequired": True or False, # Indicates whether the reservation can be consumed by VMs with affinity for "any" reservation. If the field is set, then only VMs that target the reservation by name can consume from this reservation.

517

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

518

"zone": "A String", # Zone in which the reservation resides. A zone must be provided if the reservation is created within a commitment.

519

},

520

],

521

"resources": [ # A list of commitment amounts for particular resources. Note that VCPU and MEMORY resource commitments must occur together.

522

{ # Commitment for a particular resource (a Commitment is composed of one or more of these).

523

"acceleratorType": "A String", # Name of the accelerator type resource. Applicable only when the type is ACCELERATOR.

524

"amount": "A String", # The amount of the resource purchased (in a type-dependent unit, such as bytes). For vCPUs, this can just be an integer. For memory, this must be provided in MB. Memory must be a multiple of 256 MB, with up to 6.5GB of memory per every vCPU.

525

"type": "A String", # Type of resource for which this commitment applies. Possible values are VCPU and MEMORY

526

},

527

],

528

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

529

"startTimestamp": "A String", # [Output Only] Commitment start time in RFC3339 text format.

530

"status": "A String", # [Output Only] Status of the commitment with regards to eventual expiration (each commitment has an end date defined). One of the following values: NOT_YET_ACTIVE, ACTIVE, EXPIRED.

531

"statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status.

532

},

Bu Sun Kim

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

[diff] [blame]

533

],

Bu Sun Kim

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

[diff] [blame]

534

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

535

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

536

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

537

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

538

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

539

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

540

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

Bu Sun Kim

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

[diff] [blame]

541

{

Bu Sun Kim

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

[diff] [blame]

542

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

543

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

544

},

545

],

Bu Sun Kim