1<html><body> 2<style> 3 4body, h1, h2, h3, div, span, p, pre, a { 5 margin: 0; 6 padding: 0; 7 border: 0; 8 font-weight: inherit; 9 font-style: inherit; 10 font-size: 100%; 11 font-family: inherit; 12 vertical-align: baseline; 13} 14 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51} 52 53.toc_element { 54 margin-top: 0.5em; 55} 56 57.firstline { 58 margin-left: 2 em; 59} 60 61.method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66} 67 68.details { 69 font-weight: bold; 70 font-size: 14px; 71} 72 73</style> 74 75<h1><a href="servicemanagement_v1.html">Service Management API</a> . <a href="servicemanagement_v1.operations.html">operations</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#get">get(name, x__xgafv=None)</a></code></p> 79<p class="firstline">Gets the latest state of a long-running operation. Clients can use this</p> 80<p class="toc_element"> 81 <code><a href="#list">list(name=None, pageToken=None, x__xgafv=None, pageSize=None, filter=None)</a></code></p> 82<p class="firstline">Lists service operations that match the specified filter in the request.</p> 83<p class="toc_element"> 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<div class="method"> 88 <code class="details" id="get">get(name, x__xgafv=None)</code> 89 <pre>Gets the latest state of a long-running operation. Clients can use this 90method to poll the operation result at intervals as recommended by the API 91service. 92 93Args: 94 name: string, The name of the operation resource. (required) 95 x__xgafv: string, V1 error format. 96 Allowed values 97 1 - v1 error format 98 2 - v2 error format 99 100Returns: 101 An object of the form: 102 103 { # This resource represents a long-running operation that is the result of a 104 # network API call. 105 "response": { # The normal response of the operation in case of success. If the original 106 # method returns no data on success, such as `Delete`, the response is 107 # `google.protobuf.Empty`. If the original method is standard 108 # `Get`/`Create`/`Update`, the response should be the resource. For other 109 # methods, the response should have the type `XxxResponse`, where `Xxx` 110 # is the original method name. For example, if the original method name 111 # is `TakeSnapshot()`, the inferred response type is 112 # `TakeSnapshotResponse`. 113 "a_key": "", # Properties of the object. Contains field @type with type URL. 114 }, 115 "metadata": { # Service-specific metadata associated with the operation. It typically 116 # contains progress information and common metadata such as create time. 117 # Some services might not provide such metadata. Any method that returns a 118 # long-running operation should document the metadata type, if any. 119 "a_key": "", # Properties of the object. Contains field @type with type URL. 120 }, 121 "done": True or False, # If the value is `false`, it means the operation is still in progress. 122 # If `true`, the operation is completed, and either `error` or `response` is 123 # available. 124 "name": "A String", # The server-assigned name, which is only unique within the same service that 125 # originally returns it. If you use the default HTTP mapping, the 126 # `name` should be a resource name ending with `operations/{unique_id}`. 127 "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation. 128 # different programming environments, including REST APIs and RPC APIs. It is 129 # used by [gRPC](https://github.com/grpc). Each `Status` message contains 130 # three pieces of data: error code, error message, and error details. 131 # 132 # You can find out more about this error model and how to work with it in the 133 # [API Design Guide](https://cloud.google.com/apis/design/errors). 134 "message": "A String", # A developer-facing error message, which should be in English. Any 135 # user-facing error message should be localized and sent in the 136 # google.rpc.Status.details field, or localized by the client. 137 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 138 "details": [ # A list of messages that carry the error details. There is a common set of 139 # message types for APIs to use. 140 { 141 "a_key": "", # Properties of the object. Contains field @type with type URL. 142 }, 143 ], 144 }, 145 }</pre> 146</div> 147 148<div class="method"> 149 <code class="details" id="list">list(name=None, pageToken=None, x__xgafv=None, pageSize=None, filter=None)</code> 150 <pre>Lists service operations that match the specified filter in the request. 151 152Args: 153 name: string, Not used. 154 pageToken: string, The standard list page token. 155 x__xgafv: string, V1 error format. 156 Allowed values 157 1 - v1 error format 158 2 - v2 error format 159 pageSize: integer, The maximum number of operations to return. If unspecified, defaults to 16050. The maximum value is 100. 161 filter: string, A string for filtering Operations. 162 The following filter fields are supported: 163 164 * serviceName: Required. Only `=` operator is allowed. 165 * startTime: The time this job was started, in ISO 8601 format. 166 Allowed operators are `>=`, `>`, `<=`, and `<`. 167 * status: Can be `done`, `in_progress`, or `failed`. Allowed 168 operators are `=`, and `!=`. 169 170 Filter expression supports conjunction (AND) and disjunction (OR) 171 logical operators. However, the serviceName restriction must be at the 172 top-level and can only be combined with other restrictions via the AND 173 logical operator. 174 175 Examples: 176 177 * `serviceName={some-service}.googleapis.com` 178 * `serviceName={some-service}.googleapis.com AND startTime>="2017-02-01"` 179 * `serviceName={some-service}.googleapis.com AND status=done` 180 * `serviceName={some-service}.googleapis.com AND (status=done OR startTime>="2017-02-01")` 181 182Returns: 183 An object of the form: 184 185 { # The response message for Operations.ListOperations. 186 "nextPageToken": "A String", # The standard List next-page token. 187 "operations": [ # A list of operations that matches the specified filter in the request. 188 { # This resource represents a long-running operation that is the result of a 189 # network API call. 190 "response": { # The normal response of the operation in case of success. If the original 191 # method returns no data on success, such as `Delete`, the response is 192 # `google.protobuf.Empty`. If the original method is standard 193 # `Get`/`Create`/`Update`, the response should be the resource. For other 194 # methods, the response should have the type `XxxResponse`, where `Xxx` 195 # is the original method name. For example, if the original method name 196 # is `TakeSnapshot()`, the inferred response type is 197 # `TakeSnapshotResponse`. 198 "a_key": "", # Properties of the object. Contains field @type with type URL. 199 }, 200 "metadata": { # Service-specific metadata associated with the operation. It typically 201 # contains progress information and common metadata such as create time. 202 # Some services might not provide such metadata. Any method that returns a 203 # long-running operation should document the metadata type, if any. 204 "a_key": "", # Properties of the object. Contains field @type with type URL. 205 }, 206 "done": True or False, # If the value is `false`, it means the operation is still in progress. 207 # If `true`, the operation is completed, and either `error` or `response` is 208 # available. 209 "name": "A String", # The server-assigned name, which is only unique within the same service that 210 # originally returns it. If you use the default HTTP mapping, the 211 # `name` should be a resource name ending with `operations/{unique_id}`. 212 "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation. 213 # different programming environments, including REST APIs and RPC APIs. It is 214 # used by [gRPC](https://github.com/grpc). Each `Status` message contains 215 # three pieces of data: error code, error message, and error details. 216 # 217 # You can find out more about this error model and how to work with it in the 218 # [API Design Guide](https://cloud.google.com/apis/design/errors). 219 "message": "A String", # A developer-facing error message, which should be in English. Any 220 # user-facing error message should be localized and sent in the 221 # google.rpc.Status.details field, or localized by the client. 222 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 223 "details": [ # A list of messages that carry the error details. There is a common set of 224 # message types for APIs to use. 225 { 226 "a_key": "", # Properties of the object. Contains field @type with type URL. 227 }, 228 ], 229 }, 230 }, 231 ], 232 }</pre> 233</div> 234 235<div class="method"> 236 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 237 <pre>Retrieves the next page of results. 238 239Args: 240 previous_request: The request for the previous page. (required) 241 previous_response: The response from the request for the previous page. (required) 242 243Returns: 244 A request object that you can call 'execute()' on to request the next 245 page. Returns None if there are no more items in the collection. 246 </pre> 247</div> 248 249</body></html>