• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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="accesscontextmanager_v1beta.html">Access Context Manager API</a> . <a href="accesscontextmanager_v1beta.accessPolicies.html">accessPolicies</a> . <a href="accesscontextmanager_v1beta.accessPolicies.servicePerimeters.html">servicePerimeters</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78  <code><a href="#create">create(parent, body, x__xgafv=None)</a></code></p>
79<p class="firstline">Create an Service Perimeter. The</p>
80<p class="toc_element">
81  <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
82<p class="firstline">Delete an Service Perimeter by resource</p>
83<p class="toc_element">
84  <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
85<p class="firstline">Get an Service Perimeter by resource</p>
86<p class="toc_element">
87  <code><a href="#list">list(parent, pageToken=None, x__xgafv=None, pageSize=None)</a></code></p>
88<p class="firstline">List all Service Perimeters for an</p>
89<p class="toc_element">
90  <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
91<p class="firstline">Retrieves the next page of results.</p>
92<p class="toc_element">
93  <code><a href="#patch">patch(name, body, updateMask=None, x__xgafv=None)</a></code></p>
94<p class="firstline">Update an Service Perimeter. The</p>
95<h3>Method Details</h3>
96<div class="method">
97    <code class="details" id="create">create(parent, body, x__xgafv=None)</code>
98  <pre>Create an Service Perimeter. The
99longrunning operation from this RPC will have a successful status once the
100Service Perimeter has
101propagated to long-lasting storage. Service Perimeters containing
102errors will result in an error response for the first error encountered.
103
104Args:
105  parent: string, Required. Resource name for the access policy which owns this Service
106Perimeter.
107
108Format: `accessPolicies/{policy_id}` (required)
109  body: object, The request body. (required)
110    The object takes the form of:
111
112{ # `ServicePerimeter` describes a set of GCP resources which can freely import
113      # and export data amongst themselves, but not export outside of the
114      # `ServicePerimeter`. If a request with a source within this `ServicePerimeter`
115      # has a target outside of the `ServicePerimeter`, the request will be blocked.
116      # Otherwise the request is allowed. There are two types of Service Perimeter -
117      # Regular and Bridge. Regular Service Perimeters cannot overlap, a single GCP
118      # project can only belong to a single regular Service Perimeter. Service
119      # Perimeter Bridges can contain only GCP projects as members, a single GCP
120      # project may belong to multiple Service Perimeter Bridges.
121    "status": { # `ServicePerimeterConfig` specifies a set of GCP resources that describe # Current ServicePerimeter configuration. Specifies sets of resources,
122        # restricted/unrestricted services and access levels that determine perimeter
123        # content and boundaries.
124        # specific Service Perimeter configuration.
125      "restrictedServices": [ # GCP services that are subject to the Service Perimeter restrictions. Must
126          # contain a list of services. For example, if
127          # `storage.googleapis.com` is specified, access to the storage buckets
128          # inside the perimeter must meet the perimeter's access restrictions.
129        "A String",
130      ],
131      "unrestrictedServices": [ # GCP services that are not subject to the Service Perimeter
132          # restrictions. Deprecated. Must be set to a single wildcard "*".
133          #
134          # The wildcard means that unless explicitly specified by
135          # "restricted_services" list, any service is treated as unrestricted.
136        "A String",
137      ],
138      "resources": [ # A list of GCP resources that are inside of the service perimeter.
139          # Currently only projects are allowed. Format: `projects/{project_number}`
140        "A String",
141      ],
142      "accessLevels": [ # A list of `AccessLevel` resource names that allow resources within the
143          # `ServicePerimeter` to be accessed from the internet. `AccessLevels` listed
144          # must be in the same policy as this `ServicePerimeter`. Referencing a
145          # nonexistent `AccessLevel` is a syntax error. If no `AccessLevel` names are
146          # listed, resources within the perimeter can only be accessed via GCP calls
147          # with request origins within the perimeter. Example:
148          # `"accessPolicies/MY_POLICY/accessLevels/MY_LEVEL"`.
149          # For Service Perimeter Bridge, must be empty.
150        "A String",
151      ],
152    },
153    "updateTime": "A String", # Output only. Time the `ServicePerimeter` was updated in UTC.
154    "description": "A String", # Description of the `ServicePerimeter` and its use. Does not affect
155        # behavior.
156    "title": "A String", # Human readable title. Must be unique within the Policy.
157    "perimeterType": "A String", # Perimeter type indicator. A single project is
158        # allowed to be a member of single regular perimeter, but multiple service
159        # perimeter bridges. A project cannot be a included in a perimeter bridge
160        # without being included in regular perimeter. For perimeter bridges,
161        # restricted/unrestricted service lists as well as access lists must be
162        # empty.
163    "createTime": "A String", # Output only. Time the `ServicePerimeter` was created in UTC.
164    "name": "A String", # Required. Resource name for the ServicePerimeter.  The `short_name`
165        # component must begin with a letter and only include alphanumeric and '_'.
166        # Format: `accessPolicies/{policy_id}/servicePerimeters/{short_name}`
167  }
168
169  x__xgafv: string, V1 error format.
170    Allowed values
171      1 - v1 error format
172      2 - v2 error format
173
174Returns:
175  An object of the form:
176
177    { # This resource represents a long-running operation that is the result of a
178      # network API call.
179    "response": { # The normal response of the operation in case of success.  If the original
180        # method returns no data on success, such as `Delete`, the response is
181        # `google.protobuf.Empty`.  If the original method is standard
182        # `Get`/`Create`/`Update`, the response should be the resource.  For other
183        # methods, the response should have the type `XxxResponse`, where `Xxx`
184        # is the original method name.  For example, if the original method name
185        # is `TakeSnapshot()`, the inferred response type is
186        # `TakeSnapshotResponse`.
187      "a_key": "", # Properties of the object. Contains field @type with type URL.
188    },
189    "metadata": { # Service-specific metadata associated with the operation.  It typically
190        # contains progress information and common metadata such as create time.
191        # Some services might not provide such metadata.  Any method that returns a
192        # long-running operation should document the metadata type, if any.
193      "a_key": "", # Properties of the object. Contains field @type with type URL.
194    },
195    "done": True or False, # If the value is `false`, it means the operation is still in progress.
196        # If `true`, the operation is completed, and either `error` or `response` is
197        # available.
198    "name": "A String", # The server-assigned name, which is only unique within the same service that
199        # originally returns it. If you use the default HTTP mapping, the
200        # `name` should be a resource name ending with `operations/{unique_id}`.
201    "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.
202        # different programming environments, including REST APIs and RPC APIs. It is
203        # used by [gRPC](https://github.com/grpc). Each `Status` message contains
204        # three pieces of data: error code, error message, and error details.
205        #
206        # You can find out more about this error model and how to work with it in the
207        # [API Design Guide](https://cloud.google.com/apis/design/errors).
208      "message": "A String", # A developer-facing error message, which should be in English. Any
209          # user-facing error message should be localized and sent in the
210          # google.rpc.Status.details field, or localized by the client.
211      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
212      "details": [ # A list of messages that carry the error details.  There is a common set of
213          # message types for APIs to use.
214        {
215          "a_key": "", # Properties of the object. Contains field @type with type URL.
216        },
217      ],
218    },
219  }</pre>
220</div>
221
222<div class="method">
223    <code class="details" id="delete">delete(name, x__xgafv=None)</code>
224  <pre>Delete an Service Perimeter by resource
225name. The longrunning operation from this RPC will have a successful status
226once the Service Perimeter has been
227removed from long-lasting storage.
228
229Args:
230  name: string, Required. Resource name for the Service Perimeter.
231
232Format:
233`accessPolicies/{policy_id}/servicePerimeters/{service_perimeter_id}` (required)
234  x__xgafv: string, V1 error format.
235    Allowed values
236      1 - v1 error format
237      2 - v2 error format
238
239Returns:
240  An object of the form:
241
242    { # This resource represents a long-running operation that is the result of a
243      # network API call.
244    "response": { # The normal response of the operation in case of success.  If the original
245        # method returns no data on success, such as `Delete`, the response is
246        # `google.protobuf.Empty`.  If the original method is standard
247        # `Get`/`Create`/`Update`, the response should be the resource.  For other
248        # methods, the response should have the type `XxxResponse`, where `Xxx`
249        # is the original method name.  For example, if the original method name
250        # is `TakeSnapshot()`, the inferred response type is
251        # `TakeSnapshotResponse`.
252      "a_key": "", # Properties of the object. Contains field @type with type URL.
253    },
254    "metadata": { # Service-specific metadata associated with the operation.  It typically
255        # contains progress information and common metadata such as create time.
256        # Some services might not provide such metadata.  Any method that returns a
257        # long-running operation should document the metadata type, if any.
258      "a_key": "", # Properties of the object. Contains field @type with type URL.
259    },
260    "done": True or False, # If the value is `false`, it means the operation is still in progress.
261        # If `true`, the operation is completed, and either `error` or `response` is
262        # available.
263    "name": "A String", # The server-assigned name, which is only unique within the same service that
264        # originally returns it. If you use the default HTTP mapping, the
265        # `name` should be a resource name ending with `operations/{unique_id}`.
266    "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.
267        # different programming environments, including REST APIs and RPC APIs. It is
268        # used by [gRPC](https://github.com/grpc). Each `Status` message contains
269        # three pieces of data: error code, error message, and error details.
270        #
271        # You can find out more about this error model and how to work with it in the
272        # [API Design Guide](https://cloud.google.com/apis/design/errors).
273      "message": "A String", # A developer-facing error message, which should be in English. Any
274          # user-facing error message should be localized and sent in the
275          # google.rpc.Status.details field, or localized by the client.
276      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
277      "details": [ # A list of messages that carry the error details.  There is a common set of
278          # message types for APIs to use.
279        {
280          "a_key": "", # Properties of the object. Contains field @type with type URL.
281        },
282      ],
283    },
284  }</pre>
285</div>
286
287<div class="method">
288    <code class="details" id="get">get(name, x__xgafv=None)</code>
289  <pre>Get an Service Perimeter by resource
290name.
291
292Args:
293  name: string, Required. Resource name for the Service Perimeter.
294
295Format:
296`accessPolicies/{policy_id}/servicePerimeters/{service_perimeters_id}` (required)
297  x__xgafv: string, V1 error format.
298    Allowed values
299      1 - v1 error format
300      2 - v2 error format
301
302Returns:
303  An object of the form:
304
305    { # `ServicePerimeter` describes a set of GCP resources which can freely import
306        # and export data amongst themselves, but not export outside of the
307        # `ServicePerimeter`. If a request with a source within this `ServicePerimeter`
308        # has a target outside of the `ServicePerimeter`, the request will be blocked.
309        # Otherwise the request is allowed. There are two types of Service Perimeter -
310        # Regular and Bridge. Regular Service Perimeters cannot overlap, a single GCP
311        # project can only belong to a single regular Service Perimeter. Service
312        # Perimeter Bridges can contain only GCP projects as members, a single GCP
313        # project may belong to multiple Service Perimeter Bridges.
314      "status": { # `ServicePerimeterConfig` specifies a set of GCP resources that describe # Current ServicePerimeter configuration. Specifies sets of resources,
315          # restricted/unrestricted services and access levels that determine perimeter
316          # content and boundaries.
317          # specific Service Perimeter configuration.
318        "restrictedServices": [ # GCP services that are subject to the Service Perimeter restrictions. Must
319            # contain a list of services. For example, if
320            # `storage.googleapis.com` is specified, access to the storage buckets
321            # inside the perimeter must meet the perimeter's access restrictions.
322          "A String",
323        ],
324        "unrestrictedServices": [ # GCP services that are not subject to the Service Perimeter
325            # restrictions. Deprecated. Must be set to a single wildcard "*".
326            #
327            # The wildcard means that unless explicitly specified by
328            # "restricted_services" list, any service is treated as unrestricted.
329          "A String",
330        ],
331        "resources": [ # A list of GCP resources that are inside of the service perimeter.
332            # Currently only projects are allowed. Format: `projects/{project_number}`
333          "A String",
334        ],
335        "accessLevels": [ # A list of `AccessLevel` resource names that allow resources within the
336            # `ServicePerimeter` to be accessed from the internet. `AccessLevels` listed
337            # must be in the same policy as this `ServicePerimeter`. Referencing a
338            # nonexistent `AccessLevel` is a syntax error. If no `AccessLevel` names are
339            # listed, resources within the perimeter can only be accessed via GCP calls
340            # with request origins within the perimeter. Example:
341            # `"accessPolicies/MY_POLICY/accessLevels/MY_LEVEL"`.
342            # For Service Perimeter Bridge, must be empty.
343          "A String",
344        ],
345      },
346      "updateTime": "A String", # Output only. Time the `ServicePerimeter` was updated in UTC.
347      "description": "A String", # Description of the `ServicePerimeter` and its use. Does not affect
348          # behavior.
349      "title": "A String", # Human readable title. Must be unique within the Policy.
350      "perimeterType": "A String", # Perimeter type indicator. A single project is
351          # allowed to be a member of single regular perimeter, but multiple service
352          # perimeter bridges. A project cannot be a included in a perimeter bridge
353          # without being included in regular perimeter. For perimeter bridges,
354          # restricted/unrestricted service lists as well as access lists must be
355          # empty.
356      "createTime": "A String", # Output only. Time the `ServicePerimeter` was created in UTC.
357      "name": "A String", # Required. Resource name for the ServicePerimeter.  The `short_name`
358          # component must begin with a letter and only include alphanumeric and '_'.
359          # Format: `accessPolicies/{policy_id}/servicePerimeters/{short_name}`
360    }</pre>
361</div>
362
363<div class="method">
364    <code class="details" id="list">list(parent, pageToken=None, x__xgafv=None, pageSize=None)</code>
365  <pre>List all Service Perimeters for an
366access policy.
367
368Args:
369  parent: string, Required. Resource name for the access policy to list Service Perimeters from.
370
371Format:
372`accessPolicies/{policy_id}` (required)
373  pageToken: string, Next page token for the next batch of Service Perimeter instances.
374Defaults to the first page of results.
375  x__xgafv: string, V1 error format.
376    Allowed values
377      1 - v1 error format
378      2 - v2 error format
379  pageSize: integer, Number of Service Perimeters to include
380in the list. Default 100.
381
382Returns:
383  An object of the form:
384
385    { # A response to `ListServicePerimetersRequest`.
386    "nextPageToken": "A String", # The pagination token to retrieve the next page of results. If the value is
387        # empty, no further results remain.
388    "servicePerimeters": [ # List of the Service Perimeter instances.
389      { # `ServicePerimeter` describes a set of GCP resources which can freely import
390            # and export data amongst themselves, but not export outside of the
391            # `ServicePerimeter`. If a request with a source within this `ServicePerimeter`
392            # has a target outside of the `ServicePerimeter`, the request will be blocked.
393            # Otherwise the request is allowed. There are two types of Service Perimeter -
394            # Regular and Bridge. Regular Service Perimeters cannot overlap, a single GCP
395            # project can only belong to a single regular Service Perimeter. Service
396            # Perimeter Bridges can contain only GCP projects as members, a single GCP
397            # project may belong to multiple Service Perimeter Bridges.
398          "status": { # `ServicePerimeterConfig` specifies a set of GCP resources that describe # Current ServicePerimeter configuration. Specifies sets of resources,
399              # restricted/unrestricted services and access levels that determine perimeter
400              # content and boundaries.
401              # specific Service Perimeter configuration.
402            "restrictedServices": [ # GCP services that are subject to the Service Perimeter restrictions. Must
403                # contain a list of services. For example, if
404                # `storage.googleapis.com` is specified, access to the storage buckets
405                # inside the perimeter must meet the perimeter's access restrictions.
406              "A String",
407            ],
408            "unrestrictedServices": [ # GCP services that are not subject to the Service Perimeter
409                # restrictions. Deprecated. Must be set to a single wildcard "*".
410                #
411                # The wildcard means that unless explicitly specified by
412                # "restricted_services" list, any service is treated as unrestricted.
413              "A String",
414            ],
415            "resources": [ # A list of GCP resources that are inside of the service perimeter.
416                # Currently only projects are allowed. Format: `projects/{project_number}`
417              "A String",
418            ],
419            "accessLevels": [ # A list of `AccessLevel` resource names that allow resources within the
420                # `ServicePerimeter` to be accessed from the internet. `AccessLevels` listed
421                # must be in the same policy as this `ServicePerimeter`. Referencing a
422                # nonexistent `AccessLevel` is a syntax error. If no `AccessLevel` names are
423                # listed, resources within the perimeter can only be accessed via GCP calls
424                # with request origins within the perimeter. Example:
425                # `"accessPolicies/MY_POLICY/accessLevels/MY_LEVEL"`.
426                # For Service Perimeter Bridge, must be empty.
427              "A String",
428            ],
429          },
430          "updateTime": "A String", # Output only. Time the `ServicePerimeter` was updated in UTC.
431          "description": "A String", # Description of the `ServicePerimeter` and its use. Does not affect
432              # behavior.
433          "title": "A String", # Human readable title. Must be unique within the Policy.
434          "perimeterType": "A String", # Perimeter type indicator. A single project is
435              # allowed to be a member of single regular perimeter, but multiple service
436              # perimeter bridges. A project cannot be a included in a perimeter bridge
437              # without being included in regular perimeter. For perimeter bridges,
438              # restricted/unrestricted service lists as well as access lists must be
439              # empty.
440          "createTime": "A String", # Output only. Time the `ServicePerimeter` was created in UTC.
441          "name": "A String", # Required. Resource name for the ServicePerimeter.  The `short_name`
442              # component must begin with a letter and only include alphanumeric and '_'.
443              # Format: `accessPolicies/{policy_id}/servicePerimeters/{short_name}`
444        },
445    ],
446  }</pre>
447</div>
448
449<div class="method">
450    <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
451  <pre>Retrieves the next page of results.
452
453Args:
454  previous_request: The request for the previous page. (required)
455  previous_response: The response from the request for the previous page. (required)
456
457Returns:
458  A request object that you can call 'execute()' on to request the next
459  page. Returns None if there are no more items in the collection.
460    </pre>
461</div>
462
463<div class="method">
464    <code class="details" id="patch">patch(name, body, updateMask=None, x__xgafv=None)</code>
465  <pre>Update an Service Perimeter. The
466longrunning operation from this RPC will have a successful status once the
467changes to the Service Perimeter have
468propagated to long-lasting storage. Service Perimeter containing
469errors will result in an error response for the first error encountered.
470
471Args:
472  name: string, Required. Resource name for the ServicePerimeter.  The `short_name`
473component must begin with a letter and only include alphanumeric and '_'.
474Format: `accessPolicies/{policy_id}/servicePerimeters/{short_name}` (required)
475  body: object, The request body. (required)
476    The object takes the form of:
477
478{ # `ServicePerimeter` describes a set of GCP resources which can freely import
479      # and export data amongst themselves, but not export outside of the
480      # `ServicePerimeter`. If a request with a source within this `ServicePerimeter`
481      # has a target outside of the `ServicePerimeter`, the request will be blocked.
482      # Otherwise the request is allowed. There are two types of Service Perimeter -
483      # Regular and Bridge. Regular Service Perimeters cannot overlap, a single GCP
484      # project can only belong to a single regular Service Perimeter. Service
485      # Perimeter Bridges can contain only GCP projects as members, a single GCP
486      # project may belong to multiple Service Perimeter Bridges.
487    "status": { # `ServicePerimeterConfig` specifies a set of GCP resources that describe # Current ServicePerimeter configuration. Specifies sets of resources,
488        # restricted/unrestricted services and access levels that determine perimeter
489        # content and boundaries.
490        # specific Service Perimeter configuration.
491      "restrictedServices": [ # GCP services that are subject to the Service Perimeter restrictions. Must
492          # contain a list of services. For example, if
493          # `storage.googleapis.com` is specified, access to the storage buckets
494          # inside the perimeter must meet the perimeter's access restrictions.
495        "A String",
496      ],
497      "unrestrictedServices": [ # GCP services that are not subject to the Service Perimeter
498          # restrictions. Deprecated. Must be set to a single wildcard "*".
499          #
500          # The wildcard means that unless explicitly specified by
501          # "restricted_services" list, any service is treated as unrestricted.
502        "A String",
503      ],
504      "resources": [ # A list of GCP resources that are inside of the service perimeter.
505          # Currently only projects are allowed. Format: `projects/{project_number}`
506        "A String",
507      ],
508      "accessLevels": [ # A list of `AccessLevel` resource names that allow resources within the
509          # `ServicePerimeter` to be accessed from the internet. `AccessLevels` listed
510          # must be in the same policy as this `ServicePerimeter`. Referencing a
511          # nonexistent `AccessLevel` is a syntax error. If no `AccessLevel` names are
512          # listed, resources within the perimeter can only be accessed via GCP calls
513          # with request origins within the perimeter. Example:
514          # `"accessPolicies/MY_POLICY/accessLevels/MY_LEVEL"`.
515          # For Service Perimeter Bridge, must be empty.
516        "A String",
517      ],
518    },
519    "updateTime": "A String", # Output only. Time the `ServicePerimeter` was updated in UTC.
520    "description": "A String", # Description of the `ServicePerimeter` and its use. Does not affect
521        # behavior.
522    "title": "A String", # Human readable title. Must be unique within the Policy.
523    "perimeterType": "A String", # Perimeter type indicator. A single project is
524        # allowed to be a member of single regular perimeter, but multiple service
525        # perimeter bridges. A project cannot be a included in a perimeter bridge
526        # without being included in regular perimeter. For perimeter bridges,
527        # restricted/unrestricted service lists as well as access lists must be
528        # empty.
529    "createTime": "A String", # Output only. Time the `ServicePerimeter` was created in UTC.
530    "name": "A String", # Required. Resource name for the ServicePerimeter.  The `short_name`
531        # component must begin with a letter and only include alphanumeric and '_'.
532        # Format: `accessPolicies/{policy_id}/servicePerimeters/{short_name}`
533  }
534
535  updateMask: string, Required. Mask to control which fields get updated. Must be non-empty.
536  x__xgafv: string, V1 error format.
537    Allowed values
538      1 - v1 error format
539      2 - v2 error format
540
541Returns:
542  An object of the form:
543
544    { # This resource represents a long-running operation that is the result of a
545      # network API call.
546    "response": { # The normal response of the operation in case of success.  If the original
547        # method returns no data on success, such as `Delete`, the response is
548        # `google.protobuf.Empty`.  If the original method is standard
549        # `Get`/`Create`/`Update`, the response should be the resource.  For other
550        # methods, the response should have the type `XxxResponse`, where `Xxx`
551        # is the original method name.  For example, if the original method name
552        # is `TakeSnapshot()`, the inferred response type is
553        # `TakeSnapshotResponse`.
554      "a_key": "", # Properties of the object. Contains field @type with type URL.
555    },
556    "metadata": { # Service-specific metadata associated with the operation.  It typically
557        # contains progress information and common metadata such as create time.
558        # Some services might not provide such metadata.  Any method that returns a
559        # long-running operation should document the metadata type, if any.
560      "a_key": "", # Properties of the object. Contains field @type with type URL.
561    },
562    "done": True or False, # If the value is `false`, it means the operation is still in progress.
563        # If `true`, the operation is completed, and either `error` or `response` is
564        # available.
565    "name": "A String", # The server-assigned name, which is only unique within the same service that
566        # originally returns it. If you use the default HTTP mapping, the
567        # `name` should be a resource name ending with `operations/{unique_id}`.
568    "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.
569        # different programming environments, including REST APIs and RPC APIs. It is
570        # used by [gRPC](https://github.com/grpc). Each `Status` message contains
571        # three pieces of data: error code, error message, and error details.
572        #
573        # You can find out more about this error model and how to work with it in the
574        # [API Design Guide](https://cloud.google.com/apis/design/errors).
575      "message": "A String", # A developer-facing error message, which should be in English. Any
576          # user-facing error message should be localized and sent in the
577          # google.rpc.Status.details field, or localized by the client.
578      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
579      "details": [ # A list of messages that carry the error details.  There is a common set of
580          # message types for APIs to use.
581        {
582          "a_key": "", # Properties of the object. Contains field @type with type URL.
583        },
584      ],
585    },
586  }</pre>
587</div>
588
589</body></html>