Blame - docs/dyn/deploymentmanager_alpha.operations.html - platform/external/python/google-api-python-client

2020-05-27 12:20:54 -0700

[diff] [blame^]

81

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

Sai Cheemalapati

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

[diff] [blame]

82

<p class="firstline">Lists all operations for a project.</p>

83

84

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

85

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

86

<h3>Method Details</h3>

87

88

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

89

<pre>Gets information about a specific operation.

90

91

Args:

92

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

93

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

94

95

Returns:

96

An object of the form:

97

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

98

{ # Represents an Operation resource.

99

#

100

# Google Compute Engine has three Operation resources:

101

#

102

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

103

#

104

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

105

#

106

# Operations can be global, regional or zonal.

107

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

108

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

109

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

110

#

111

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

Bu Sun Kim

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

[diff] [blame]

112

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

113

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

114

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

115

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

116

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

117

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

Sai Cheemalapati

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

[diff] [blame]

118

{

Bu Sun Kim

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

[diff] [blame]

119

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

120

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

121

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

Sai Cheemalapati

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

[diff] [blame]

122

},

123

],

124

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

125

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

126

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

127

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

Bu Sun Kim

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

[diff] [blame]

128

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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

129

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

130

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

131

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

Bu Sun Kim

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

[diff] [blame]

132

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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

133

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

Bu Sun Kim

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

[diff] [blame]

134

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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

135

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

Bu Sun Kim

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

[diff] [blame]

136

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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

137

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

Bu Sun Kim

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

[diff] [blame]

138

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

139

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

140

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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

141

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

Bu Sun Kim

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

[diff] [blame]

142

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

143

{

144

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

145

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

146

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

147

{

148

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

149

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

150

},

151

],

152

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

153

},

154

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

155

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

Sai Cheemalapati

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

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

160

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

Sai Cheemalapati

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

[diff] [blame]

161

<pre>Lists all operations for a project.

162

163

Args:

164

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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

165

filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`.

Sai Cheemalapati

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

[diff] [blame]

166

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

167

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

Sai Cheemalapati

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

[diff] [blame]

168

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

169

You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

Sai Cheemalapati

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

[diff] [blame]

170

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

171

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

172

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

Bu Sun Kim

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

[diff] [blame]

173

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

174

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

175

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.

Bu Sun Kim

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

[diff] [blame]

176

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

177

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

178

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.

179

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

Sai Cheemalapati

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

[diff] [blame]

180

181

Returns:

182

An object of the form:

183

184

{ # A response containing a partial list of operations and a page token used to build the next request if the request has been truncated.

Bu Sun Kim

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

[diff] [blame]

185

"nextPageToken": "A String", # Output only. A token used to continue a truncated list request.

186

"operations": [ # Output only. Operations contained in this list response.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

187

{ # Represents an Operation resource.

188

#

189

# Google Compute Engine has three Operation resources:

190

#

191

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

192

#

193

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

194

#

195

# Operations can be global, regional or zonal.

196

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

197

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

198

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

199

#

200

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

Bu Sun Kim

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

[diff] [blame]

201

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

202

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

203

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

204

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

205

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

206

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

Sai Cheemalapati

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

[diff] [blame]

207

{

Bu Sun Kim

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

[diff] [blame]

208

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

209

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

210

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

Sai Cheemalapati

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

[diff] [blame]

211

},

212

],

213

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

214

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

215

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

216

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

Bu Sun Kim

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

[diff] [blame]

217

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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

218

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

219

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

220

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

Bu Sun Kim

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

[diff] [blame]

221

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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

222

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

Bu Sun Kim

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

[diff] [blame]

223

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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

224

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

Bu Sun Kim

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

[diff] [blame]

225

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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

226

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

Bu Sun Kim

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

[diff] [blame]

227

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

228

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

229

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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

230

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

Bu Sun Kim