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

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

[diff] [blame]

80

81

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

82

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

83

Dmitry Frenkel

3e17f89

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

[diff] [blame]

84

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

85

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

86

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

87

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

Bu Sun Kim

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

[diff] [blame]

88

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

Sai Cheemalapati

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

[diff] [blame]

89

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

90

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

Sai Cheemalapati

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

[diff] [blame]

91

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

Sai Cheemalapati

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

[diff] [blame]

92

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

93

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

Sai Cheemalapati

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

[diff] [blame]

94

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

95

96

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

97

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

98

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

99

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

Sai Cheemalapati

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

[diff] [blame]

100

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

Bu Sun Kim

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

[diff] [blame]

101

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

102

<code><a href="#update">update(project, region, commitment, body=None, paths=None, requestId=None, updateMask=None, x__xgafv=None)</a></code></p>

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

103

<p class="firstline">Updates the specified commitment with the data included in the request. Update is performed only on selected fields included as part of update-mask. Only the following fields can be modified: auto_renew.</p>

104

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

105

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

Dan O'Meara

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

[diff] [blame]

106

<p class="firstline">Transfers GPUs or local SSDs between reservations within commitments.</p>

Sai Cheemalapati

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

[diff] [blame]

107

<h3>Method Details</h3>

108

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

109

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

yoshi-code-bot

04bafe1

2021-06-29 00:20:25 -0700

[diff] [blame]

110

<pre>Retrieves an aggregated list of commitments by region.

Sai Cheemalapati

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

[diff] [blame]

111

112

Args:

113

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

114

filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. 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. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ```

Dan O'Meara

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

[diff] [blame]

115

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

Bu Sun Kim

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

[diff] [blame]

116

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

117

orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. 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. Currently, only sorting by `name` or `creationTimestamp desc` is supported.

Bu Sun Kim

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

[diff] [blame]

118

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

yoshi-code-bot

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

[diff] [blame]

119

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

120

x__xgafv: string, V1 error format.

121

Allowed values

122

1 - v1 error format

123

2 - v2 error format

Sai Cheemalapati

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

[diff] [blame]

124

125

Returns:

126

An object of the form:

127

128

{

Yoshi Automation Bot

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

[diff] [blame]

129

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

130

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

131

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

132

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

133

{ # Represents a regional Commitment resource. 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.

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

134

"autoRenew": True or False, # Specifies whether to enable automatic renewal for the commitment. The default value is false if not specified. The field can be updated until the day of the commitment expiration at 12:00am PST. If the field is set to true, the commitment will be automatically renewed for either one or three years according to the terms of the existing commitment.

Yoshi Automation Bot

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

[diff] [blame]

135

"category": "A String", # The category of the commitment. Category MACHINE specifies commitments composed of machine resources such as VCPU or MEMORY, listed in resources. Category LICENSE specifies commitments composed of software licenses, listed in licenseResources. Note that only MACHINE commitments should have a Type specified.

136

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

137

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

138

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

139

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

140

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

141

"licenseResource": { # Commitment for a particular license resource. # The license specification required as part of a license commitment.

142

"amount": "A String", # The number of licenses purchased.

143

"coresPerLicense": "A String", # Specifies the core range of the instance for which this license applies.

144

"license": "A String", # Any applicable license URI.

Bu Sun Kim

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

[diff] [blame]

145

},

Yoshi Automation Bot

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

[diff] [blame]

146

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

147

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

148

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

149

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

150

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

Yoshi Automation Bot

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

[diff] [blame]

151

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

152

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

153

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

154

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

155

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

156

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

yoshi-code-bot

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

[diff] [blame]

157

"satisfiesPzs": True or False, # [Output Only] Reserved for future use.

Yoshi Automation Bot

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

[diff] [blame]

158

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

159

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

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

160

"shareSettings": { # The share setting for reservations and sole tenancy node groups. # Share-settings for shared-reservation

yoshi-code-bot

2021-08-24 00:22:31 -0700

[diff] [blame]

161

"folderMap": { # A map of folder id and folder config to specify consumer projects for this shared-reservation. This is only valid when share_type's value is DIRECT_PROJECTS_UNDER_SPECIFIC_FOLDERS.

162

"a_key": { # Config for each folder in the share settings.

163

"folderId": "A String", # The folder ID, should be same as the key of this folder config in the parent map.

164

},

165

},

yoshi-code-bot

2021-09-21 00:22:28 -0700

[diff] [blame]

166

"projectMap": { # A map of project id and project config. Using map format to ease add-to/remove-from the Project list in PATCH command. In future we will deprecate (And later remove) the array one.

167

"a_key": { # Config for each project in the share settings.

168

"projectId": "A String", # The project ID, should be same as the key of this project config in the parent map.

169

},

170

},

yoshi-code-bot

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

[diff] [blame]

171

"projects": [ # A List of Project names to specify consumer projects for this shared-reservation. This is only valid when share_type's value is SPECIFIC_PROJECTS.

172

"A String",

173

],

Yoshi Automation Bot

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

[diff] [blame]

174

"shareType": "A String", # Type of sharing for this shared-reservation

175

},

yoshi-code-bot

2021-08-31 00:28:27 -0700

[diff] [blame]

176

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

Yoshi Automation Bot

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

[diff] [blame]

177

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

178

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

179

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

180

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

181

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

182

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

183

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

184

},

185

],

186

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

187

{

188

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

189

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

190

},

191

],

192

"locationHint": "A String", # An opaque location hint used to place the allocation close to other resources. This field is for use by internal tools that use the public API.

193

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

194

"maintenanceFreezeDurationHours": 42, # Specifies the number of hours after reservation creation where instances using the reservation won't be scheduled for maintenance.

yoshi-code-bot

2021-04-29 03:48:05 -0700

[diff] [blame]

195

"maintenanceInterval": "A String", # For more information about maintenance intervals, see Setting maintenance intervals.

Yoshi Automation Bot

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

[diff] [blame]

196

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

197

},

198

},

199

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

200

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

201

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

Sai Cheemalapati

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

[diff] [blame]

202

},

203

],

Yoshi Automation Bot

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

[diff] [blame]

204

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

205

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

206

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

207

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

208

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

209

},

210

],

211

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

212

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

213

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

214

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

215

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

216

"type": "A String", # The type of commitment, which affects the discount rate and the eligible resources. Type MEMORY_OPTIMIZED specifies a commitment that will only apply to memory optimized machines. Type ACCELERATOR_OPTIMIZED specifies a commitment that will only apply to accelerator optimized machines.

Bu Sun Kim

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

[diff] [blame]

217

},

218

],

Yoshi Automation Bot

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

[diff] [blame]

219

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

220

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

221

"data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

Yoshi Automation Bot

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

[diff] [blame]

222

{

223

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

224

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

225

},

226

],

227

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

228

},

Bu Sun Kim

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

[diff] [blame]

229

},

Yoshi Automation Bot

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

[diff] [blame]

230

},

231

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

232

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

233

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

234

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

235

"A String",

236

],

237

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

238

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

239

"data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

Yoshi Automation Bot

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

[diff] [blame]

240

{

241

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

242

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

243

},

244

],

245

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

246

},

247

}</pre>

Sai Cheemalapati

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

[diff] [blame]

</div>

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

252

<pre>Retrieves the next page of results.

253

254

Args:

255

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

256

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

257

258

Returns:

Bu Sun Kim

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

[diff] [blame]

259

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

Sai Cheemalapati

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

[diff] [blame]

260

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]

265

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

266

<pre>Close httplib2 connections.</pre>

</div>

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

270

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

Bu Sun Kim

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

[diff] [blame]

271

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

Sai Cheemalapati

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

[diff] [blame]

272

273

Args:

274

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

275

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

276

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

277

x__xgafv: string, V1 error format.

278

Allowed values

279

1 - v1 error format

280

2 - v2 error format

Sai Cheemalapati

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

[diff] [blame]

281

282

Returns:

283

An object of the form:

284

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

285

{ # Represents a regional Commitment resource. 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.

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

286

"autoRenew": True or False, # Specifies whether to enable automatic renewal for the commitment. The default value is false if not specified. The field can be updated until the day of the commitment expiration at 12:00am PST. If the field is set to true, the commitment will be automatically renewed for either one or three years according to the terms of the existing commitment.

Yoshi Automation Bot

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

[diff] [blame]

287

"category": "A String", # The category of the commitment. Category MACHINE specifies commitments composed of machine resources such as VCPU or MEMORY, listed in resources. Category LICENSE specifies commitments composed of software licenses, listed in licenseResources. Note that only MACHINE commitments should have a Type specified.

288

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

289

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

290

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

291

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

292

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

293

"licenseResource": { # Commitment for a particular license resource. # The license specification required as part of a license commitment.

294

"amount": "A String", # The number of licenses purchased.

295

"coresPerLicense": "A String", # Specifies the core range of the instance for which this license applies.

296

"license": "A String", # Any applicable license URI.

297

},

298

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

299

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

300

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

301

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

302

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

Yoshi Automation Bot

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

[diff] [blame]

303

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

304

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

305

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

306

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

307

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

308

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

yoshi-code-bot

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

[diff] [blame]

309

"satisfiesPzs": True or False, # [Output Only] Reserved for future use.

Yoshi Automation Bot

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

[diff] [blame]

310

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

311

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

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

312

"shareSettings": { # The share setting for reservations and sole tenancy node groups. # Share-settings for shared-reservation

yoshi-code-bot

2021-08-24 00:22:31 -0700

[diff] [blame]

313

"folderMap": { # A map of folder id and folder config to specify consumer projects for this shared-reservation. This is only valid when share_type's value is DIRECT_PROJECTS_UNDER_SPECIFIC_FOLDERS.

314

"a_key": { # Config for each folder in the share settings.

315

"folderId": "A String", # The folder ID, should be same as the key of this folder config in the parent map.

316

},

317

},

yoshi-code-bot

2021-09-21 00:22:28 -0700

[diff] [blame]

318

"projectMap": { # A map of project id and project config. Using map format to ease add-to/remove-from the Project list in PATCH command. In future we will deprecate (And later remove) the array one.

319

"a_key": { # Config for each project in the share settings.

320

"projectId": "A String", # The project ID, should be same as the key of this project config in the parent map.

321

},

322

},

yoshi-code-bot

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

[diff] [blame]

323

"projects": [ # A List of Project names to specify consumer projects for this shared-reservation. This is only valid when share_type's value is SPECIFIC_PROJECTS.

324

"A String",

325

],

Yoshi Automation Bot

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

[diff] [blame]

326

"shareType": "A String", # Type of sharing for this shared-reservation

327

},

yoshi-code-bot

2021-08-31 00:28:27 -0700

[diff] [blame]

328

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

Yoshi Automation Bot

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

[diff] [blame]

329

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

330

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

331

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

332

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

333

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

334

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

335

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

336

},

337

],

338

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

339

{

340

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

341

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

342

},

343

],

344

"locationHint": "A String", # An opaque location hint used to place the allocation close to other resources. This field is for use by internal tools that use the public API.

345

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

346

"maintenanceFreezeDurationHours": 42, # Specifies the number of hours after reservation creation where instances using the reservation won't be scheduled for maintenance.

yoshi-code-bot

2021-04-29 03:48:05 -0700

[diff] [blame]

347

"maintenanceInterval": "A String", # For more information about maintenance intervals, see Setting maintenance intervals.

Yoshi Automation Bot

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

[diff] [blame]

348

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

349

},

350

},

351

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

352

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

353

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

Bu Sun Kim

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

[diff] [blame]

354

},

Yoshi Automation Bot

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

[diff] [blame]

355

],

356

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

357

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

358

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

359

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

360

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

361

},

362

],

363

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

364

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

365

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

366

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

367

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

368

"type": "A String", # The type of commitment, which affects the discount rate and the eligible resources. Type MEMORY_OPTIMIZED specifies a commitment that will only apply to memory optimized machines. Type ACCELERATOR_OPTIMIZED specifies a commitment that will only apply to accelerator optimized machines.

369

}</pre>

Sai Cheemalapati

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

[diff] [blame]

</div>

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

373

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

Sai Cheemalapati

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

[diff] [blame]

374

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

Sai Cheemalapati

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

[diff] [blame]

375

376

Args:

377

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

378

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

Dan O'Meara

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

[diff] [blame]

379

body: object, The request body.

Sai Cheemalapati

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

[diff] [blame]

380

The object takes the form of:

381

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

382

{ # Represents a regional Commitment resource. 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.

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

383

"autoRenew": True or False, # Specifies whether to enable automatic renewal for the commitment. The default value is false if not specified. The field can be updated until the day of the commitment expiration at 12:00am PST. If the field is set to true, the commitment will be automatically renewed for either one or three years according to the terms of the existing commitment.

Bu Sun Kim

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

[diff] [blame]

384

"category": "A String", # The category of the commitment. Category MACHINE specifies commitments composed of machine resources such as VCPU or MEMORY, listed in resources. Category LICENSE specifies commitments composed of software licenses, listed in licenseResources. Note that only MACHINE commitments should have a Type specified.

385

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

386

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

387

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

388

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

389

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

390

"licenseResource": { # Commitment for a particular license resource. # The license specification required as part of a license commitment.

391

"amount": "A String", # The number of licenses purchased.

392

"coresPerLicense": "A String", # Specifies the core range of the instance for which this license applies.

393

"license": "A String", # Any applicable license URI.

394

},

395

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

396

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

397

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

398

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

399

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

Bu Sun Kim

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

[diff] [blame]

400

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

401

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

402

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

403

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

404

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

405

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

yoshi-code-bot

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

[diff] [blame]

406

"satisfiesPzs": True or False, # [Output Only] Reserved for future use.

Bu Sun Kim

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

[diff] [blame]

407

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

408

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

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

409

"shareSettings": { # The share setting for reservations and sole tenancy node groups. # Share-settings for shared-reservation

yoshi-code-bot

2021-08-24 00:22:31 -0700

[diff] [blame]

410

"folderMap": { # A map of folder id and folder config to specify consumer projects for this shared-reservation. This is only valid when share_type's value is DIRECT_PROJECTS_UNDER_SPECIFIC_FOLDERS.

411

"a_key": { # Config for each folder in the share settings.

412

"folderId": "A String", # The folder ID, should be same as the key of this folder config in the parent map.

413

},

414

},

yoshi-code-bot

2021-09-21 00:22:28 -0700

[diff] [blame]

415

"projectMap": { # A map of project id and project config. Using map format to ease add-to/remove-from the Project list in PATCH command. In future we will deprecate (And later remove) the array one.

416

"a_key": { # Config for each project in the share settings.

417

"projectId": "A String", # The project ID, should be same as the key of this project config in the parent map.

418

},

419

},

yoshi-code-bot

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

[diff] [blame]

420

"projects": [ # A List of Project names to specify consumer projects for this shared-reservation. This is only valid when share_type's value is SPECIFIC_PROJECTS.

421

"A String",

422

],

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame]

423

"shareType": "A String", # Type of sharing for this shared-reservation

424

},

yoshi-code-bot

2021-08-31 00:28:27 -0700

[diff] [blame]

425

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

Bu Sun Kim

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

[diff] [blame]

426

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

427

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

Bu Sun Kim

d059ad8

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

[diff] [blame]

428

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

429

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

430

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

431

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

432

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

433

},

434

],

435

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

436

{

437

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

438

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

439

},

440

],

441

"locationHint": "A String", # An opaque location hint used to place the allocation close to other resources. This field is for use by internal tools that use the public API.

Bu Sun Kim

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

[diff] [blame]

442

"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

d059ad8

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

[diff] [blame]

443

"maintenanceFreezeDurationHours": 42, # Specifies the number of hours after reservation creation where instances using the reservation won't be scheduled for maintenance.

yoshi-code-bot

2021-04-29 03:48:05 -0700

[diff] [blame]

444

"maintenanceInterval": "A String", # For more information about maintenance intervals, see Setting maintenance intervals.

Bu Sun Kim

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

[diff] [blame]

445

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

Bu Sun Kim

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

[diff] [blame]

446

},

Bu Sun Kim

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

[diff] [blame]

447

},

Bu Sun Kim

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

[diff] [blame]

448

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

449

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

450

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

Dan O'Meara

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

[diff] [blame]

451

},

Bu Sun Kim

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

[diff] [blame]

452

],

453

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

454

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

455

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

456

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

457

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

458

},

459

],

460

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

461

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

462

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

463

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

464

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

Dmitry Frenkel

3e17f89

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

[diff] [blame]

465

"type": "A String", # The type of commitment, which affects the discount rate and the eligible resources. Type MEMORY_OPTIMIZED specifies a commitment that will only apply to memory optimized machines. Type ACCELERATOR_OPTIMIZED specifies a commitment that will only apply to accelerator optimized machines.

Bu Sun Kim

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

[diff] [blame]

466

}

Sai Cheemalapati

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

[diff] [blame]

467

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

468

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. 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. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).

469

x__xgafv: string, V1 error format.

470

Allowed values

471

1 - v1 error format

472

2 - v2 error format

Sai Cheemalapati

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

[diff] [blame]

473

474

Returns:

475

An object of the form:

476

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

477

{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources.

Yoshi Automation Bot

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

[diff] [blame]

478

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

479

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

480

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

481

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

482

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

483

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

Bu Sun Kim

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

[diff] [blame]

484

{

Yoshi Automation Bot

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

[diff] [blame]

485

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

486

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

487

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

Bu Sun Kim

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

[diff] [blame]

488

},

489

],

Yoshi Automation Bot

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

[diff] [blame]

490

},

491

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

492

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

493

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

494

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

495

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

496

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

yoshi-code-bot

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

[diff] [blame]

497

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot

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

[diff] [blame]

498

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

499

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

500

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

501

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

502

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

503

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

504

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

505

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

506

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

507

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

508

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

509

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

510

{

511

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

512

"data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

Yoshi Automation Bot

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

[diff] [blame]

513

{

514

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

515

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

516

},

517

],

518

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

519

},

520

],

521

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

522

}</pre>

Sai Cheemalapati

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

[diff] [blame]

</div>

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

526

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

Sai Cheemalapati

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

[diff] [blame]

527

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

528

529

Args:

530

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

531

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

532

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 `<`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. 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. 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) ```

Bu Sun Kim

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

[diff] [blame]

533

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

534

orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. 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. Currently, only sorting by `name` or `creationTimestamp desc` is supported.

Bu Sun Kim

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

[diff] [blame]

535

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

yoshi-code-bot

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

[diff] [blame]

536

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

537

x__xgafv: string, V1 error format.

538

Allowed values

539

1 - v1 error format

540

2 - v2 error format

Sai Cheemalapati

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

[diff] [blame]

541

542

Returns:

543

An object of the form:

544

545

{ # Contains a list of Commitment resources.

Yoshi Automation Bot

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

[diff] [blame]

546

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

547

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

548

{ # Represents a regional Commitment resource. 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.

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

549

"autoRenew": True or False, # Specifies whether to enable automatic renewal for the commitment. The default value is false if not specified. The field can be updated until the day of the commitment expiration at 12:00am PST. If the field is set to true, the commitment will be automatically renewed for either one or three years according to the terms of the existing commitment.

Yoshi Automation Bot

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

[diff] [blame]

550

"category": "A String", # The category of the commitment. Category MACHINE specifies commitments composed of machine resources such as VCPU or MEMORY, listed in resources. Category LICENSE specifies commitments composed of software licenses, listed in licenseResources. Note that only MACHINE commitments should have a Type specified.

551

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

552

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

553

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

554

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

555

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

556

"licenseResource": { # Commitment for a particular license resource. # The license specification required as part of a license commitment.

557

"amount": "A String", # The number of licenses purchased.

558

"coresPerLicense": "A String", # Specifies the core range of the instance for which this license applies.

559

"license": "A String", # Any applicable license URI.

Bu Sun Kim

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

[diff] [blame]

560

},

Yoshi Automation Bot

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

[diff] [blame]

561

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

562

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

563

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

564

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

565

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

Yoshi Automation Bot

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

[diff] [blame]

566

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

567

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

568

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

569

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

570

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

571

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

yoshi-code-bot

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

[diff] [blame]

572

"satisfiesPzs": True or False, # [Output Only] Reserved for future use.

Yoshi Automation Bot

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

[diff] [blame]

573

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

574

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

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

575

"shareSettings": { # The share setting for reservations and sole tenancy node groups. # Share-settings for shared-reservation

yoshi-code-bot

2021-08-24 00:22:31 -0700

[diff] [blame]

576

"folderMap": { # A map of folder id and folder config to specify consumer projects for this shared-reservation. This is only valid when share_type's value is DIRECT_PROJECTS_UNDER_SPECIFIC_FOLDERS.

577

"a_key": { # Config for each folder in the share settings.

578

"folderId": "A String", # The folder ID, should be same as the key of this folder config in the parent map.

579

},

580

},

yoshi-code-bot

2021-09-21 00:22:28 -0700

[diff] [blame]

581

"projectMap": { # A map of project id and project config. Using map format to ease add-to/remove-from the Project list in PATCH command. In future we will deprecate (And later remove) the array one.

582

"a_key": { # Config for each project in the share settings.

583

"projectId": "A String", # The project ID, should be same as the key of this project config in the parent map.

584

},

585

},

yoshi-code-bot

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

[diff] [blame]

586

"projects": [ # A List of Project names to specify consumer projects for this shared-reservation. This is only valid when share_type's value is SPECIFIC_PROJECTS.

587

"A String",

588

],

Yoshi Automation Bot

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

[diff] [blame]

589

"shareType": "A String", # Type of sharing for this shared-reservation

590

},

yoshi-code-bot

2021-08-31 00:28:27 -0700

[diff] [blame]

591

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

Yoshi Automation Bot

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

[diff] [blame]

592

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

593

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

594

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

595

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

596

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

597

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

598

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

599

},

600

],

601

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

602

{

603

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

604

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

605

},

606

],

607

"locationHint": "A String", # An opaque location hint used to place the allocation close to other resources. This field is for use by internal tools that use the public API.

608

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

609

"maintenanceFreezeDurationHours": 42, # Specifies the number of hours after reservation creation where instances using the reservation won't be scheduled for maintenance.

yoshi-code-bot

2021-04-29 03:48:05 -0700

[diff] [blame]

610

"maintenanceInterval": "A String", # For more information about maintenance intervals, see Setting maintenance intervals.

Yoshi Automation Bot

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

[diff] [blame]

611

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

612

},

613

},

614

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

615

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

616

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

Bu Sun Kim

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

[diff] [blame]

617

},

618

],

Yoshi Automation Bot

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

[diff] [blame]

619

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

620

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

621

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

622

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

623

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

624

},

625

],

626

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

627

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

628

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

629

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

630

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

631

"type": "A String", # The type of commitment, which affects the discount rate and the eligible resources. Type MEMORY_OPTIMIZED specifies a commitment that will only apply to memory optimized machines. Type ACCELERATOR_OPTIMIZED specifies a commitment that will only apply to accelerator optimized machines.

Bu Sun Kim

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

[diff] [blame]

632

},

Yoshi Automation Bot

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

[diff] [blame]

633

],

634

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

635

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

636

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

637

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

638

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

639

"data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

Yoshi Automation Bot

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

[diff] [blame]

640

{

641

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

642

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

643

},

644

],

645

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

646

},

647

}</pre>

Sai Cheemalapati

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

[diff] [blame]

</div>

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

652

<pre>Retrieves the next page of results.

653

654

Args:

655

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

656

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

657

658

Returns:

Bu Sun Kim

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

[diff] [blame]

659

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

Sai Cheemalapati

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

[diff] [blame]

660

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

</pre>

</div>

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

665

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

Sai Cheemalapati

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

[diff] [blame]

666

<pre>Returns permissions that a caller has on the specified resource.

667

668

Args:

669

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

670

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

Bu Sun Kim

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

[diff] [blame]

671

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

Dan O'Meara

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

[diff] [blame]

672

body: object, The request body.

Sai Cheemalapati

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

[diff] [blame]

673

The object takes the form of:

674

675

{

Yoshi Automation Bot

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

[diff] [blame]

676

"permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.

677

"A String",

678

],

679

}

Sai Cheemalapati

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

[diff] [blame]

680

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

681

x__xgafv: string, V1 error format.

682

Allowed values

683

1 - v1 error format

684

2 - v2 error format

Sai Cheemalapati

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

[diff] [blame]

685

686

Returns:

687

An object of the form:

688

689

{

Yoshi Automation Bot

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

[diff] [blame]

690

"permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.

691

"A String",

692

],

693

}</pre>

Sai Cheemalapati

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

[diff] [blame]

694

</div>

695

Bu Sun Kim

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

[diff] [blame]

696

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

697

<code class="details" id="update">update(project, region, commitment, body=None, paths=None, requestId=None, updateMask=None, x__xgafv=None)</code>

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

698

<pre>Updates the specified commitment with the data included in the request. Update is performed only on selected fields included as part of update-mask. Only the following fields can be modified: auto_renew.

699

700

Args:

701

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

702

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

703

commitment: string, Name of the commitment for which auto renew is being updated. (required)

704

body: object, The request body.

705

The object takes the form of:

706

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

707

{ # Represents a regional Commitment resource. 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.

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

708

"autoRenew": True or False, # Specifies whether to enable automatic renewal for the commitment. The default value is false if not specified. The field can be updated until the day of the commitment expiration at 12:00am PST. If the field is set to true, the commitment will be automatically renewed for either one or three years according to the terms of the existing commitment.

709

"category": "A String", # The category of the commitment. Category MACHINE specifies commitments composed of machine resources such as VCPU or MEMORY, listed in resources. Category LICENSE specifies commitments composed of software licenses, listed in licenseResources. Note that only MACHINE commitments should have a Type specified.

710

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

711

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

712

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

713

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

714

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

715

"licenseResource": { # Commitment for a particular license resource. # The license specification required as part of a license commitment.

716

"amount": "A String", # The number of licenses purchased.

717

"coresPerLicense": "A String", # Specifies the core range of the instance for which this license applies.

718

"license": "A String", # Any applicable license URI.

719

},

720

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

721

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

722

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

723

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

724

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

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

725

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

726

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

727

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

728

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

729

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

730

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

731

"satisfiesPzs": True or False, # [Output Only] Reserved for future use.

732

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

733

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

734

"shareSettings": { # The share setting for reservations and sole tenancy node groups. # Share-settings for shared-reservation

yoshi-code-bot

2021-08-24 00:22:31 -0700

[diff] [blame]

735

"folderMap": { # A map of folder id and folder config to specify consumer projects for this shared-reservation. This is only valid when share_type's value is DIRECT_PROJECTS_UNDER_SPECIFIC_FOLDERS.

736

"a_key": { # Config for each folder in the share settings.

737

"folderId": "A String", # The folder ID, should be same as the key of this folder config in the parent map.

738

},

739

},

yoshi-code-bot

2021-09-21 00:22:28 -0700

[diff] [blame]

740

"projectMap": { # A map of project id and project config. Using map format to ease add-to/remove-from the Project list in PATCH command. In future we will deprecate (And later remove) the array one.

741

"a_key": { # Config for each project in the share settings.

742

"projectId": "A String", # The project ID, should be same as the key of this project config in the parent map.

743

},

744

},

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

745

"projects": [ # A List of Project names to specify consumer projects for this shared-reservation. This is only valid when share_type's value is SPECIFIC_PROJECTS.

746

"A String",

747

],

748

"shareType": "A String", # Type of sharing for this shared-reservation

749

},

yoshi-code-bot

2021-08-31 00:28:27 -0700

[diff] [blame]

750

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

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

751

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

752

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

753

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

754

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

755

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

756

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

757

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

758

},

759

],

760

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

761

{

762

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

763

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

764

},

765

],

766

"locationHint": "A String", # An opaque location hint used to place the allocation close to other resources. This field is for use by internal tools that use the public API.

767

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

768

"maintenanceFreezeDurationHours": 42, # Specifies the number of hours after reservation creation where instances using the reservation won't be scheduled for maintenance.

769

"maintenanceInterval": "A String", # For more information about maintenance intervals, see Setting maintenance intervals.

770

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

771

},

772

},

773

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

774

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

775

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

776

},

777

],

778

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

779

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

780

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

781

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

782

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

783

},

784

],

785

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

786

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

787

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

788

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

789

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

790

"type": "A String", # The type of commitment, which affects the discount rate and the eligible resources. Type MEMORY_OPTIMIZED specifies a commitment that will only apply to memory optimized machines. Type ACCELERATOR_OPTIMIZED specifies a commitment that will only apply to accelerator optimized machines.

791

}

792

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

793

paths: string, A parameter (repeated)

794

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. 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. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).

795

updateMask: string, update_mask indicates fields to be updated as part of this request.

796

x__xgafv: string, V1 error format.

797

Allowed values

798

1 - v1 error format

799

2 - v2 error format

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

800

801

Returns:

802

An object of the form:

803

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

804

{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources.

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

805

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

806

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

807

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

808

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

809

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

810

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

811

{

812

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

813

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

814

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

},

],

},

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

819

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

820

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

821

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

822

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

823

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

824

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

825

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

826

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

827

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

828

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

829

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

830

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

831

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

832

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

833

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

834

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

835

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

836

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

837

{

838

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

839

"data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

840

{

841

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

842

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

843

},

844

],

845

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

846

},

847

],

848

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

}</pre>

</div>

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

853

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

Dan O'Meara

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

[diff] [blame]

854

<pre>Transfers GPUs or local SSDs between reservations within commitments.

Bu Sun Kim

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

[diff] [blame]

855

856

Args:

857

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

858

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

Dan O'Meara

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

[diff] [blame]

859

commitment: string, Name of the commitment for which the reservation is being updated. (required)

860

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

861

The object takes the form of:

862

863

{

Yoshi Automation Bot

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

[diff] [blame]

864

"reservations": [ # A list of two reservations to transfer GPUs and local SSD between.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

865

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

Yoshi Automation Bot

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

[diff] [blame]

866

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

867

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

868

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

869

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

870

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

871

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

yoshi-code-bot

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

[diff] [blame]

872

"satisfiesPzs": True or False, # [Output Only] Reserved for future use.

Yoshi Automation Bot

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

[diff] [blame]

873

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

874

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

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

875

"shareSettings": { # The share setting for reservations and sole tenancy node groups. # Share-settings for shared-reservation

yoshi-code-bot

2021-08-24 00:22:31 -0700

[diff] [blame]

876

"folderMap": { # A map of folder id and folder config to specify consumer projects for this shared-reservation. This is only valid when share_type's value is DIRECT_PROJECTS_UNDER_SPECIFIC_FOLDERS.

877

"a_key": { # Config for each folder in the share settings.

878

"folderId": "A String", # The folder ID, should be same as the key of this folder config in the parent map.

879

},

880

},

yoshi-code-bot

2021-09-21 00:22:28 -0700

[diff] [blame]

881

"projectMap": { # A map of project id and project config. Using map format to ease add-to/remove-from the Project list in PATCH command. In future we will deprecate (And later remove) the array one.

882

"a_key": { # Config for each project in the share settings.

883

"projectId": "A String", # The project ID, should be same as the key of this project config in the parent map.

884

},

885

},

yoshi-code-bot

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

[diff] [blame]

886

"projects": [ # A List of Project names to specify consumer projects for this shared-reservation. This is only valid when share_type's value is SPECIFIC_PROJECTS.

887

"A String",

888

],

Yoshi Automation Bot

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

[diff] [blame]

889

"shareType": "A String", # Type of sharing for this shared-reservation

Bu Sun Kim

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

[diff] [blame]

890

},

yoshi-code-bot

2021-08-31 00:28:27 -0700

[diff] [blame]

891

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

Yoshi Automation Bot

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

[diff] [blame]

892

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

893

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

894

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

895

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

896

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

897

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

898

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

899

},

900

],

901

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

902

{

903

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

904

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

905

},

906

],

907

"locationHint": "A String", # An opaque location hint used to place the allocation close to other resources. This field is for use by internal tools that use the public API.

908

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

909

"maintenanceFreezeDurationHours": 42, # Specifies the number of hours after reservation creation where instances using the reservation won't be scheduled for maintenance.

yoshi-code-bot

2021-04-29 03:48:05 -0700

[diff] [blame]

910

"maintenanceInterval": "A String", # For more information about maintenance intervals, see Setting maintenance intervals.

Yoshi Automation Bot

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

[diff] [blame]

911

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

912

},

913

},

914

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

915

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

916

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

917

},

918

],

919

}

Bu Sun Kim

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

[diff] [blame]

920

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

921

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. 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. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).

922

x__xgafv: string, V1 error format.

923

Allowed values

924

1 - v1 error format

925

2 - v2 error format

Bu Sun Kim

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

[diff] [blame]

926

927

Returns:

928

An object of the form:

929

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

930

{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources.

Yoshi Automation Bot

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

[diff] [blame]

931

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

932

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

933

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

934

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

935

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

936

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

Bu Sun Kim

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

[diff] [blame]

937

{

Yoshi Automation Bot

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

[diff] [blame]

938

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

939

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

940

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

Bu Sun Kim

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

[diff] [blame]

941

},

942

],

Yoshi Automation Bot

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

[diff] [blame]

943

},

944

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

945

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

946

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

947

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

948

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

949

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

yoshi-code-bot

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

[diff] [blame]

950

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot

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

[diff] [blame]

951

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

952

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

953

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

954

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

955

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

956

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

957

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

958

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

959

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

960

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

961

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

962

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

963

{

964

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

965

"data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

Yoshi Automation Bot