Blame - docs/dyn/container_v1beta1.projects.locations.operations.html - platform/external/python/google-api-python-client

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

[diff] [blame]

79

<p class="firstline">Cancels the specified operation.</p>

80

Dmitry Frenkel

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

[diff] [blame]

81

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

82

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

83

Yoshi Automation Bot

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

[diff] [blame]

84

<code><a href="#get">get(name, operationId=None, projectId=None, x__xgafv=None, zone=None)</a></code></p>

Bu Sun Kim

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

[diff] [blame]

85

<p class="firstline">Gets the specified operation.</p>

86

Yoshi Automation Bot

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

[diff] [blame]

87

<code><a href="#list">list(parent, projectId=None, x__xgafv=None, zone=None)</a></code></p>

Bu Sun Kim

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

[diff] [blame]

88

<p class="firstline">Lists all operations in a project in the specified zone or all zones.</p>

89

<h3>Method Details</h3>

90

Dan O'Meara

dd49464

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

[diff] [blame]

91

<code class="details" id="cancel">cancel(name, body=None, x__xgafv=None)</code>

Bu Sun Kim

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

[diff] [blame]

92

<pre>Cancels the specified operation.

93

94

Args:

Dmitry Frenkel

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

[diff] [blame]

95

name: string, The name (project, location, operation id) of the operation to cancel. Specified in the format `projects/*/locations/*/operations/*`. (required)

Dan O'Meara

dd49464

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

[diff] [blame]

96

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

97

The object takes the form of:

98

99

{ # CancelOperationRequest cancels a single operation.

Yoshi Automation Bot

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

[diff] [blame]

100

"name": "A String", # The name (project, location, operation id) of the operation to cancel. Specified in the format `projects/*/locations/*/operations/*`.

101

"operationId": "A String", # Required. Deprecated. The server-assigned `name` of the operation. This field has been deprecated and replaced by the name field.

102

"projectId": "A String", # Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field.

103

"zone": "A String", # Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation resides. This field has been deprecated and replaced by the name field.

104

}

Bu Sun Kim

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

[diff] [blame]

105

106

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

113

Dmitry Frenkel

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

[diff] [blame]

114

{ # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.

Yoshi Automation Bot

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

[diff] [blame]

115

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

Dmitry Frenkel

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

[diff] [blame]

119

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

120

<pre>Close httplib2 connections.</pre>

</div>

Yoshi Automation Bot

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

[diff] [blame]

124

<code class="details" id="get">get(name, operationId=None, projectId=None, x__xgafv=None, zone=None)</code>

Bu Sun Kim

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

[diff] [blame]

125

<pre>Gets the specified operation.

126

127

Args:

Dmitry Frenkel

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

[diff] [blame]

128

name: string, The name (project, location, operation id) of the operation to get. Specified in the format `projects/*/locations/*/operations/*`. (required)

Bu Sun Kim

673ec5c

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

[diff] [blame]

129

operationId: string, Required. Deprecated. The server-assigned `name` of the operation. This field has been deprecated and replaced by the name field.

Yoshi Automation Bot

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

[diff] [blame]

130

projectId: string, Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field.

Bu Sun Kim

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

[diff] [blame]

131

x__xgafv: string, V1 error format.

132

Allowed values

133

1 - v1 error format

134

2 - v2 error format

Yoshi Automation Bot

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

[diff] [blame]

135

zone: string, Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.

Bu Sun Kim

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

[diff] [blame]

136

137

Returns:

138

An object of the form:

139

Dmitry Frenkel

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

[diff] [blame]

140

{ # This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.

Yoshi Automation Bot

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

[diff] [blame]

141

"clusterConditions": [ # Which conditions caused the current cluster state. Deprecated. Use field error instead.

142

{ # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

143

"canonicalCode": "A String", # Canonical code of the condition.

144

"code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.

145

"message": "A String", # Human-friendly representation of the condition

146

},

147

],

148

"detail": "A String", # Detailed operation progress, if available.

149

"endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

150

"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure.

151

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

152

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

153

{

154

"a_key": "", # Properties of the object. Contains field @type with type URL.

Yoshi Automation Bot

0d561ef

2020-11-25 07:50:41 -0800

[diff] [blame]

155

},

156

],

Yoshi Automation Bot

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

[diff] [blame]

157

"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

158

},

159

"location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.

160

"name": "A String", # The server-assigned ID for the operation.

161

"nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.

162

{ # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

163

"canonicalCode": "A String", # Canonical code of the condition.

164

"code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.

165

"message": "A String", # Human-friendly representation of the condition

Yoshi Automation Bot

b6971b0

2020-11-26 17:16:03 -0800

[diff] [blame]

166

},

Yoshi Automation Bot

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

[diff] [blame]

167

],

168

"operationType": "A String", # The operation type.

169

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

170

"metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}]

171

{ # Progress metric is (string, int|float|string) pair.

172

"doubleValue": 3.14, # For metrics with floating point value.

173

"intValue": "A String", # For metrics with integer value.

174

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

175

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

Yoshi Automation Bot

0bf565c

2020-12-09 08:56:03 -0800

[diff] [blame]

176

},

177

],

Yoshi Automation Bot

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

[diff] [blame]

178

"name": "A String", # A non-parameterized string describing an operation stage. Unset for single-stage operations.

179

"stages": [ # Substages of an operation or a stage.

180

# Object with schema name: OperationProgress

181

],

182

"status": "A String", # Status of an operation stage. Unset for single-stage operations.

183

},

184

"selfLink": "A String", # Server-defined URL for the resource.

185

"startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

186

"status": "A String", # The current status of the operation.

187

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead.

188

"targetLink": "A String", # Server-defined URL for the target of the operation.

189

"zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.

190

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

Yoshi Automation Bot

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

[diff] [blame]

194

<code class="details" id="list">list(parent, projectId=None, x__xgafv=None, zone=None)</code>

Bu Sun Kim

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

[diff] [blame]

195

<pre>Lists all operations in a project in the specified zone or all zones.

196

197

Args:

Dmitry Frenkel

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

[diff] [blame]

198

parent: string, The parent (project and location) where the operations will be listed. Specified in the format `projects/*/locations/*`. Location "-" matches all zones and all regions. (required)

Yoshi Automation Bot

0bf565c

2020-12-09 08:56:03 -0800

[diff] [blame]

199

projectId: string, Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the parent field.

Bu Sun Kim

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

[diff] [blame]

200

x__xgafv: string, V1 error format.

201

Allowed values

202

1 - v1 error format

203

2 - v2 error format

Yoshi Automation Bot

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

[diff] [blame]

204

zone: string, Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) to return operations for, or `-` for all zones. This field has been deprecated and replaced by the parent field.

Bu Sun Kim

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

[diff] [blame]

205

206

Returns:

207

An object of the form:

208

209

{ # ListOperationsResponse is the result of ListOperationsRequest.

Yoshi Automation Bot

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

[diff] [blame]

210

"missingZones": [ # If any zones are listed here, the list of operations returned may be missing the operations from those zones.

211

"A String",

212

],

213

"operations": [ # A list of operations in the project in the specified zone.

214

{ # This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.

215

"clusterConditions": [ # Which conditions caused the current cluster state. Deprecated. Use field error instead.

216

{ # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

217

"canonicalCode": "A String", # Canonical code of the condition.

218

"code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.

219

"message": "A String", # Human-friendly representation of the condition

220

},

221

],

222

"detail": "A String", # Detailed operation progress, if available.

223

"endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

224

"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure.

225

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

226

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

227

{

228

"a_key": "", # Properties of the object. Contains field @type with type URL.

Yoshi Automation Bot

0d561ef

2020-11-25 07:50:41 -0800

[diff] [blame]

229

},

230

],

Yoshi Automation Bot

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

[diff] [blame]

231

"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

Bu Sun Kim

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

[diff] [blame]

232

},

Yoshi Automation Bot

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

[diff] [blame]

233

"location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.

234

"name": "A String", # The server-assigned ID for the operation.

235

"nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.

236

{ # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).

237

"canonicalCode": "A String", # Canonical code of the condition.

238

"code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.

239

"message": "A String", # Human-friendly representation of the condition

240

},

241

],

242

"operationType": "A String", # The operation type.

243

"progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.

244

"metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}]

245

{ # Progress metric is (string, int|float|string) pair.

246

"doubleValue": 3.14, # For metrics with floating point value.

247

"intValue": "A String", # For metrics with integer value.

248

"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".

249

"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).

250

},

251

],

252

"name": "A String", # A non-parameterized string describing an operation stage. Unset for single-stage operations.

253

"stages": [ # Substages of an operation or a stage.

254

# Object with schema name: OperationProgress

255

],

256

"status": "A String", # Status of an operation stage. Unset for single-stage operations.

257

},

258

"selfLink": "A String", # Server-defined URL for the resource.

259

"startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.

260

"status": "A String", # The current status of the operation.

261

"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead.

262

"targetLink": "A String", # Server-defined URL for the target of the operation.

263

"zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.

264

},

265

],

266

}</pre>

Bu Sun Kim