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="cloudprivatecatalogproducer_v1beta1.html">Cloud Private Catalog Producer API</a> . <a href="cloudprivatecatalogproducer_v1beta1.catalogs.html">catalogs</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78  <code><a href="cloudprivatecatalogproducer_v1beta1.catalogs.associations.html">associations()</a></code>
79</p>
80<p class="firstline">Returns the associations Resource.</p>
81
82<p class="toc_element">
83  <code><a href="cloudprivatecatalogproducer_v1beta1.catalogs.products.html">products()</a></code>
84</p>
85<p class="firstline">Returns the products Resource.</p>
86
87<p class="toc_element">
88  <code><a href="#create">create(body, x__xgafv=None)</a></code></p>
89<p class="firstline">Creates a new Catalog resource.</p>
90<p class="toc_element">
91  <code><a href="#delete">delete(name, force=None, x__xgafv=None)</a></code></p>
92<p class="firstline">Soft deletes an existing Catalog and all resources under it.</p>
93<p class="toc_element">
94  <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
95<p class="firstline">Returns the requested Catalog resource.</p>
96<p class="toc_element">
97  <code><a href="#getIamPolicy">getIamPolicy(resource, x__xgafv=None)</a></code></p>
98<p class="firstline">Gets IAM policy for the specified Catalog.</p>
99<p class="toc_element">
100  <code><a href="#list">list(parent=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
101<p class="firstline">Lists Catalog resources that the producer has access to, within the</p>
102<p class="toc_element">
103  <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
104<p class="firstline">Retrieves the next page of results.</p>
105<p class="toc_element">
106  <code><a href="#patch">patch(name, body, updateMask=None, x__xgafv=None)</a></code></p>
107<p class="firstline">Updates a specific Catalog resource.</p>
108<p class="toc_element">
109  <code><a href="#setIamPolicy">setIamPolicy(resource, body, x__xgafv=None)</a></code></p>
110<p class="firstline">Sets the IAM policy for the specified Catalog.</p>
111<p class="toc_element">
112  <code><a href="#testIamPermissions">testIamPermissions(resource, body, x__xgafv=None)</a></code></p>
113<p class="firstline">Tests the IAM permissions for the specified Catalog.</p>
114<p class="toc_element">
115  <code><a href="#undelete">undelete(name, body=None, x__xgafv=None)</a></code></p>
116<p class="firstline">Undeletes a deleted Catalog and all resources under it.</p>
117<h3>Method Details</h3>
118<div class="method">
119    <code class="details" id="create">create(body, x__xgafv=None)</code>
120  <pre>Creates a new Catalog resource.
121
122Args:
123  body: object, The request body. (required)
124    The object takes the form of:
125
126{ # The producer representation of a catalog which is a curated collection of
127    # solutions that can be managed, controlled, and shared by cloud admins.
128  "updateTime": "A String", # Output only. The time when the catalog was last updated.
129  "displayName": "A String", # Required. The user-supplied descriptive name of the catalog as it appears
130      # in UIs. Maximum 256 characters in length.
131  "name": "A String", # Output only. The resource name of the catalog, in the format
132      # `catalogs/{catalog_id}'.
133      #
134      # A unique identifier for the catalog, which is generated
135      # by catalog service.
136  "parent": "A String", # Required. The parent resource name of the catalog, which can't be changed
137      # after a catalog is created. It can only be an organization. Values are of
138      # the form `//cloudresourcemanager.googleapis.com/organizations/<id>`.
139      # Maximum 256 characters in length.
140  "createTime": "A String", # Output only. The time when the catalog was created.
141  "description": "A String", # Required. The user-supplied description of the catalog. Maximum of 512
142      # characters.
143}
144
145  x__xgafv: string, V1 error format.
146    Allowed values
147      1 - v1 error format
148      2 - v2 error format
149
150Returns:
151  An object of the form:
152
153    { # This resource represents a long-running operation that is the result of a
154      # network API call.
155    "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.
156        # different programming environments, including REST APIs and RPC APIs. It is
157        # used by [gRPC](https://github.com/grpc). Each `Status` message contains
158        # three pieces of data: error code, error message, and error details.
159        #
160        # You can find out more about this error model and how to work with it in the
161        # [API Design Guide](https://cloud.google.com/apis/design/errors).
162      "message": "A String", # A developer-facing error message, which should be in English. Any
163          # user-facing error message should be localized and sent in the
164          # google.rpc.Status.details field, or localized by the client.
165      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
166      "details": [ # A list of messages that carry the error details.  There is a common set of
167          # message types for APIs to use.
168        {
169          "a_key": "", # Properties of the object. Contains field @type with type URL.
170        },
171      ],
172    },
173    "done": True or False, # If the value is `false`, it means the operation is still in progress.
174        # If `true`, the operation is completed, and either `error` or `response` is
175        # available.
176    "response": { # The normal response of the operation in case of success.  If the original
177        # method returns no data on success, such as `Delete`, the response is
178        # `google.protobuf.Empty`.  If the original method is standard
179        # `Get`/`Create`/`Update`, the response should be the resource.  For other
180        # methods, the response should have the type `XxxResponse`, where `Xxx`
181        # is the original method name.  For example, if the original method name
182        # is `TakeSnapshot()`, the inferred response type is
183        # `TakeSnapshotResponse`.
184      "a_key": "", # Properties of the object. Contains field @type with type URL.
185    },
186    "name": "A String", # The server-assigned name, which is only unique within the same service that
187        # originally returns it. If you use the default HTTP mapping, the
188        # `name` should be a resource name ending with `operations/{unique_id}`.
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  }</pre>
196</div>
197
198<div class="method">
199    <code class="details" id="delete">delete(name, force=None, x__xgafv=None)</code>
200  <pre>Soft deletes an existing Catalog and all resources under it.
201The catalog can only be deleted if there is no associations under it or
202DeleteCatalogRequest.force is true. The delete operation
203can be recovered by the PrivateCatalogProducer.UndeleteCatalog
204method.
205
206Args:
207  name: string, The resource name of the catalog. (required)
208  force: boolean, Forces deletion of the `Catalog` and its `Association` resources.
209If the `Catalog` is still associated with other resources and
210force is not set to true, then the operation fails.
211  x__xgafv: string, V1 error format.
212    Allowed values
213      1 - v1 error format
214      2 - v2 error format
215
216Returns:
217  An object of the form:
218
219    { # The producer representation of a catalog which is a curated collection of
220      # solutions that can be managed, controlled, and shared by cloud admins.
221    "updateTime": "A String", # Output only. The time when the catalog was last updated.
222    "displayName": "A String", # Required. The user-supplied descriptive name of the catalog as it appears
223        # in UIs. Maximum 256 characters in length.
224    "name": "A String", # Output only. The resource name of the catalog, in the format
225        # `catalogs/{catalog_id}'.
226        #
227        # A unique identifier for the catalog, which is generated
228        # by catalog service.
229    "parent": "A String", # Required. The parent resource name of the catalog, which can't be changed
230        # after a catalog is created. It can only be an organization. Values are of
231        # the form `//cloudresourcemanager.googleapis.com/organizations/<id>`.
232        # Maximum 256 characters in length.
233    "createTime": "A String", # Output only. The time when the catalog was created.
234    "description": "A String", # Required. The user-supplied description of the catalog. Maximum of 512
235        # characters.
236  }</pre>
237</div>
238
239<div class="method">
240    <code class="details" id="get">get(name, x__xgafv=None)</code>
241  <pre>Returns the requested Catalog resource.
242
243Args:
244  name: string, The resource name of the catalog. (required)
245  x__xgafv: string, V1 error format.
246    Allowed values
247      1 - v1 error format
248      2 - v2 error format
249
250Returns:
251  An object of the form:
252
253    { # The producer representation of a catalog which is a curated collection of
254      # solutions that can be managed, controlled, and shared by cloud admins.
255    "updateTime": "A String", # Output only. The time when the catalog was last updated.
256    "displayName": "A String", # Required. The user-supplied descriptive name of the catalog as it appears
257        # in UIs. Maximum 256 characters in length.
258    "name": "A String", # Output only. The resource name of the catalog, in the format
259        # `catalogs/{catalog_id}'.
260        #
261        # A unique identifier for the catalog, which is generated
262        # by catalog service.
263    "parent": "A String", # Required. The parent resource name of the catalog, which can't be changed
264        # after a catalog is created. It can only be an organization. Values are of
265        # the form `//cloudresourcemanager.googleapis.com/organizations/<id>`.
266        # Maximum 256 characters in length.
267    "createTime": "A String", # Output only. The time when the catalog was created.
268    "description": "A String", # Required. The user-supplied description of the catalog. Maximum of 512
269        # characters.
270  }</pre>
271</div>
272
273<div class="method">
274    <code class="details" id="getIamPolicy">getIamPolicy(resource, x__xgafv=None)</code>
275  <pre>Gets IAM policy for the specified Catalog.
276
277Args:
278  resource: string, REQUIRED: The resource for which the policy is being requested.
279See the operation documentation for the appropriate value for this field. (required)
280  x__xgafv: string, V1 error format.
281    Allowed values
282      1 - v1 error format
283      2 - v2 error format
284
285Returns:
286  An object of the form:
287
288    { # Defines an Identity and Access Management (IAM) policy. It is used to
289      # specify access control policies for Cloud Platform resources.
290      #
291      #
292      # A `Policy` consists of a list of `bindings`. A `binding` binds a list of
293      # `members` to a `role`, where the members can be user accounts, Google groups,
294      # Google domains, and service accounts. A `role` is a named list of permissions
295      # defined by IAM.
296      #
297      # **JSON Example**
298      #
299      #     {
300      #       "bindings": [
301      #         {
302      #           "role": "roles/owner",
303      #           "members": [
304      #             "user:mike@example.com",
305      #             "group:admins@example.com",
306      #             "domain:google.com",
307      #             "serviceAccount:my-other-app@appspot.gserviceaccount.com"
308      #           ]
309      #         },
310      #         {
311      #           "role": "roles/viewer",
312      #           "members": ["user:sean@example.com"]
313      #         }
314      #       ]
315      #     }
316      #
317      # **YAML Example**
318      #
319      #     bindings:
320      #     - members:
321      #       - user:mike@example.com
322      #       - group:admins@example.com
323      #       - domain:google.com
324      #       - serviceAccount:my-other-app@appspot.gserviceaccount.com
325      #       role: roles/owner
326      #     - members:
327      #       - user:sean@example.com
328      #       role: roles/viewer
329      #
330      #
331      # For a description of IAM and its features, see the
332      # [IAM developer's guide](https://cloud.google.com/iam/docs).
333    "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
334      { # Specifies the audit configuration for a service.
335          # The configuration determines which permission types are logged, and what
336          # identities, if any, are exempted from logging.
337          # An AuditConfig must have one or more AuditLogConfigs.
338          #
339          # If there are AuditConfigs for both `allServices` and a specific service,
340          # the union of the two AuditConfigs is used for that service: the log_types
341          # specified in each AuditConfig are enabled, and the exempted_members in each
342          # AuditLogConfig are exempted.
343          #
344          # Example Policy with multiple AuditConfigs:
345          #
346          #     {
347          #       "audit_configs": [
348          #         {
349          #           "service": "allServices"
350          #           "audit_log_configs": [
351          #             {
352          #               "log_type": "DATA_READ",
353          #               "exempted_members": [
354          #                 "user:foo@gmail.com"
355          #               ]
356          #             },
357          #             {
358          #               "log_type": "DATA_WRITE",
359          #             },
360          #             {
361          #               "log_type": "ADMIN_READ",
362          #             }
363          #           ]
364          #         },
365          #         {
366          #           "service": "fooservice.googleapis.com"
367          #           "audit_log_configs": [
368          #             {
369          #               "log_type": "DATA_READ",
370          #             },
371          #             {
372          #               "log_type": "DATA_WRITE",
373          #               "exempted_members": [
374          #                 "user:bar@gmail.com"
375          #               ]
376          #             }
377          #           ]
378          #         }
379          #       ]
380          #     }
381          #
382          # For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
383          # logging. It also exempts foo@gmail.com from DATA_READ logging, and
384          # bar@gmail.com from DATA_WRITE logging.
385        "auditLogConfigs": [ # The configuration for logging of each type of permission.
386          { # Provides the configuration for logging a type of permissions.
387              # Example:
388              #
389              #     {
390              #       "audit_log_configs": [
391              #         {
392              #           "log_type": "DATA_READ",
393              #           "exempted_members": [
394              #             "user:foo@gmail.com"
395              #           ]
396              #         },
397              #         {
398              #           "log_type": "DATA_WRITE",
399              #         }
400              #       ]
401              #     }
402              #
403              # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting
404              # foo@gmail.com from DATA_READ logging.
405            "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of
406                # permission.
407                # Follows the same format of Binding.members.
408              "A String",
409            ],
410            "logType": "A String", # The log type that this config enables.
411          },
412        ],
413        "service": "A String", # Specifies a service that will be enabled for audit logging.
414            # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
415            # `allServices` is a special value that covers all services.
416      },
417    ],
418    "version": 42, # Deprecated.
419    "bindings": [ # Associates a list of `members` to a `role`.
420        # `bindings` with no members will result in an error.
421      { # Associates `members` with a `role`.
422        "role": "A String", # Role that is assigned to `members`.
423            # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
424        "members": [ # Specifies the identities requesting access for a Cloud Platform resource.
425            # `members` can have the following values:
426            #
427            # * `allUsers`: A special identifier that represents anyone who is
428            #    on the internet; with or without a Google account.
429            #
430            # * `allAuthenticatedUsers`: A special identifier that represents anyone
431            #    who is authenticated with a Google account or a service account.
432            #
433            # * `user:{emailid}`: An email address that represents a specific Google
434            #    account. For example, `alice@gmail.com` .
435            #
436            #
437            # * `serviceAccount:{emailid}`: An email address that represents a service
438            #    account. For example, `my-other-app@appspot.gserviceaccount.com`.
439            #
440            # * `group:{emailid}`: An email address that represents a Google group.
441            #    For example, `admins@example.com`.
442            #
443            #
444            # * `domain:{domain}`: The G Suite domain (primary) that represents all the
445            #    users of that domain. For example, `google.com` or `example.com`.
446            #
447          "A String",
448        ],
449        "condition": { # Represents an expression text. Example: # The condition that is associated with this binding.
450            # NOTE: An unsatisfied condition will not allow user access via current
451            # binding. Different bindings, including their conditions, are examined
452            # independently.
453            #
454            #     title: "User account presence"
455            #     description: "Determines whether the request has a user account"
456            #     expression: "size(request.user) > 0"
457          "location": "A String", # An optional string indicating the location of the expression for error
458              # reporting, e.g. a file name and a position in the file.
459          "expression": "A String", # Textual representation of an expression in
460              # Common Expression Language syntax.
461              #
462              # The application context of the containing message determines which
463              # well-known feature set of CEL is supported.
464          "description": "A String", # An optional description of the expression. This is a longer text which
465              # describes the expression, e.g. when hovered over it in a UI.
466          "title": "A String", # An optional title for the expression, i.e. a short string describing
467              # its purpose. This can be used e.g. in UIs which allow to enter the
468              # expression.
469        },
470      },
471    ],
472    "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
473        # prevent simultaneous updates of a policy from overwriting each other.
474        # It is strongly suggested that systems make use of the `etag` in the
475        # read-modify-write cycle to perform policy updates in order to avoid race
476        # conditions: An `etag` is returned in the response to `getIamPolicy`, and
477        # systems are expected to put that etag in the request to `setIamPolicy` to
478        # ensure that their change will be applied to the same version of the policy.
479        #
480        # If no `etag` is provided in the call to `setIamPolicy`, then the existing
481        # policy is overwritten blindly.
482  }</pre>
483</div>
484
485<div class="method">
486    <code class="details" id="list">list(parent=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
487  <pre>Lists Catalog resources that the producer has access to, within the
488scope of the parent resource.
489
490Args:
491  parent: string, The resource name of the parent resource.
492  pageSize: integer, The maximum number of catalogs to return.
493  pageToken: string, A pagination token returned from a previous call to ListCatalogs
494that indicates where this listing should continue from.
495This field is optional.
496  x__xgafv: string, V1 error format.
497    Allowed values
498      1 - v1 error format
499      2 - v2 error format
500
501Returns:
502  An object of the form:
503
504    {
505    "nextPageToken": "A String", # A pagination token returned from a previous call to ListCatalogs
506        # that indicates where the listing should continue from.
507        # This field is optional.
508    "catalogs": [ # The `Catalogs` returned from the list call.
509      { # The producer representation of a catalog which is a curated collection of
510          # solutions that can be managed, controlled, and shared by cloud admins.
511        "updateTime": "A String", # Output only. The time when the catalog was last updated.
512        "displayName": "A String", # Required. The user-supplied descriptive name of the catalog as it appears
513            # in UIs. Maximum 256 characters in length.
514        "name": "A String", # Output only. The resource name of the catalog, in the format
515            # `catalogs/{catalog_id}'.
516            #
517            # A unique identifier for the catalog, which is generated
518            # by catalog service.
519        "parent": "A String", # Required. The parent resource name of the catalog, which can't be changed
520            # after a catalog is created. It can only be an organization. Values are of
521            # the form `//cloudresourcemanager.googleapis.com/organizations/<id>`.
522            # Maximum 256 characters in length.
523        "createTime": "A String", # Output only. The time when the catalog was created.
524        "description": "A String", # Required. The user-supplied description of the catalog. Maximum of 512
525            # characters.
526      },
527    ],
528  }</pre>
529</div>
530
531<div class="method">
532    <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
533  <pre>Retrieves the next page of results.
534
535Args:
536  previous_request: The request for the previous page. (required)
537  previous_response: The response from the request for the previous page. (required)
538
539Returns:
540  A request object that you can call 'execute()' on to request the next
541  page. Returns None if there are no more items in the collection.
542    </pre>
543</div>
544
545<div class="method">
546    <code class="details" id="patch">patch(name, body, updateMask=None, x__xgafv=None)</code>
547  <pre>Updates a specific Catalog resource.
548
549Args:
550  name: string, Output only. The resource name of the catalog, in the format
551`catalogs/{catalog_id}'.
552
553A unique identifier for the catalog, which is generated
554by catalog service. (required)
555  body: object, The request body. (required)
556    The object takes the form of:
557
558{ # The producer representation of a catalog which is a curated collection of
559    # solutions that can be managed, controlled, and shared by cloud admins.
560  "updateTime": "A String", # Output only. The time when the catalog was last updated.
561  "displayName": "A String", # Required. The user-supplied descriptive name of the catalog as it appears
562      # in UIs. Maximum 256 characters in length.
563  "name": "A String", # Output only. The resource name of the catalog, in the format
564      # `catalogs/{catalog_id}'.
565      #
566      # A unique identifier for the catalog, which is generated
567      # by catalog service.
568  "parent": "A String", # Required. The parent resource name of the catalog, which can't be changed
569      # after a catalog is created. It can only be an organization. Values are of
570      # the form `//cloudresourcemanager.googleapis.com/organizations/<id>`.
571      # Maximum 256 characters in length.
572  "createTime": "A String", # Output only. The time when the catalog was created.
573  "description": "A String", # Required. The user-supplied description of the catalog. Maximum of 512
574      # characters.
575}
576
577  updateMask: string, Field mask that controls which fields of the catalog should be updated.
578  x__xgafv: string, V1 error format.
579    Allowed values
580      1 - v1 error format
581      2 - v2 error format
582
583Returns:
584  An object of the form:
585
586    { # The producer representation of a catalog which is a curated collection of
587      # solutions that can be managed, controlled, and shared by cloud admins.
588    "updateTime": "A String", # Output only. The time when the catalog was last updated.
589    "displayName": "A String", # Required. The user-supplied descriptive name of the catalog as it appears
590        # in UIs. Maximum 256 characters in length.
591    "name": "A String", # Output only. The resource name of the catalog, in the format
592        # `catalogs/{catalog_id}'.
593        #
594        # A unique identifier for the catalog, which is generated
595        # by catalog service.
596    "parent": "A String", # Required. The parent resource name of the catalog, which can't be changed
597        # after a catalog is created. It can only be an organization. Values are of
598        # the form `//cloudresourcemanager.googleapis.com/organizations/<id>`.
599        # Maximum 256 characters in length.
600    "createTime": "A String", # Output only. The time when the catalog was created.
601    "description": "A String", # Required. The user-supplied description of the catalog. Maximum of 512
602        # characters.
603  }</pre>
604</div>
605
606<div class="method">
607    <code class="details" id="setIamPolicy">setIamPolicy(resource, body, x__xgafv=None)</code>
608  <pre>Sets the IAM policy for the specified Catalog.
609
610Args:
611  resource: string, REQUIRED: The resource for which the policy is being specified.
612See the operation documentation for the appropriate value for this field. (required)
613  body: object, The request body. (required)
614    The object takes the form of:
615
616{ # Request message for `SetIamPolicy` method.
617    "policy": { # Defines an Identity and Access Management (IAM) policy. It is used to # REQUIRED: The complete policy to be applied to the `resource`. The size of
618        # the policy is limited to a few 10s of KB. An empty policy is a
619        # valid policy but certain Cloud Platform services (such as Projects)
620        # might reject them.
621        # specify access control policies for Cloud Platform resources.
622        #
623        #
624        # A `Policy` consists of a list of `bindings`. A `binding` binds a list of
625        # `members` to a `role`, where the members can be user accounts, Google groups,
626        # Google domains, and service accounts. A `role` is a named list of permissions
627        # defined by IAM.
628        #
629        # **JSON Example**
630        #
631        #     {
632        #       "bindings": [
633        #         {
634        #           "role": "roles/owner",
635        #           "members": [
636        #             "user:mike@example.com",
637        #             "group:admins@example.com",
638        #             "domain:google.com",
639        #             "serviceAccount:my-other-app@appspot.gserviceaccount.com"
640        #           ]
641        #         },
642        #         {
643        #           "role": "roles/viewer",
644        #           "members": ["user:sean@example.com"]
645        #         }
646        #       ]
647        #     }
648        #
649        # **YAML Example**
650        #
651        #     bindings:
652        #     - members:
653        #       - user:mike@example.com
654        #       - group:admins@example.com
655        #       - domain:google.com
656        #       - serviceAccount:my-other-app@appspot.gserviceaccount.com
657        #       role: roles/owner
658        #     - members:
659        #       - user:sean@example.com
660        #       role: roles/viewer
661        #
662        #
663        # For a description of IAM and its features, see the
664        # [IAM developer's guide](https://cloud.google.com/iam/docs).
665      "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
666        { # Specifies the audit configuration for a service.
667            # The configuration determines which permission types are logged, and what
668            # identities, if any, are exempted from logging.
669            # An AuditConfig must have one or more AuditLogConfigs.
670            #
671            # If there are AuditConfigs for both `allServices` and a specific service,
672            # the union of the two AuditConfigs is used for that service: the log_types
673            # specified in each AuditConfig are enabled, and the exempted_members in each
674            # AuditLogConfig are exempted.
675            #
676            # Example Policy with multiple AuditConfigs:
677            #
678            #     {
679            #       "audit_configs": [
680            #         {
681            #           "service": "allServices"
682            #           "audit_log_configs": [
683            #             {
684            #               "log_type": "DATA_READ",
685            #               "exempted_members": [
686            #                 "user:foo@gmail.com"
687            #               ]
688            #             },
689            #             {
690            #               "log_type": "DATA_WRITE",
691            #             },
692            #             {
693            #               "log_type": "ADMIN_READ",
694            #             }
695            #           ]
696            #         },
697            #         {
698            #           "service": "fooservice.googleapis.com"
699            #           "audit_log_configs": [
700            #             {
701            #               "log_type": "DATA_READ",
702            #             },
703            #             {
704            #               "log_type": "DATA_WRITE",
705            #               "exempted_members": [
706            #                 "user:bar@gmail.com"
707            #               ]
708            #             }
709            #           ]
710            #         }
711            #       ]
712            #     }
713            #
714            # For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
715            # logging. It also exempts foo@gmail.com from DATA_READ logging, and
716            # bar@gmail.com from DATA_WRITE logging.
717          "auditLogConfigs": [ # The configuration for logging of each type of permission.
718            { # Provides the configuration for logging a type of permissions.
719                # Example:
720                #
721                #     {
722                #       "audit_log_configs": [
723                #         {
724                #           "log_type": "DATA_READ",
725                #           "exempted_members": [
726                #             "user:foo@gmail.com"
727                #           ]
728                #         },
729                #         {
730                #           "log_type": "DATA_WRITE",
731                #         }
732                #       ]
733                #     }
734                #
735                # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting
736                # foo@gmail.com from DATA_READ logging.
737              "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of
738                  # permission.
739                  # Follows the same format of Binding.members.
740                "A String",
741              ],
742              "logType": "A String", # The log type that this config enables.
743            },
744          ],
745          "service": "A String", # Specifies a service that will be enabled for audit logging.
746              # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
747              # `allServices` is a special value that covers all services.
748        },
749      ],
750      "version": 42, # Deprecated.
751      "bindings": [ # Associates a list of `members` to a `role`.
752          # `bindings` with no members will result in an error.
753        { # Associates `members` with a `role`.
754          "role": "A String", # Role that is assigned to `members`.
755              # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
756          "members": [ # Specifies the identities requesting access for a Cloud Platform resource.
757              # `members` can have the following values:
758              #
759              # * `allUsers`: A special identifier that represents anyone who is
760              #    on the internet; with or without a Google account.
761              #
762              # * `allAuthenticatedUsers`: A special identifier that represents anyone
763              #    who is authenticated with a Google account or a service account.
764              #
765              # * `user:{emailid}`: An email address that represents a specific Google
766              #    account. For example, `alice@gmail.com` .
767              #
768              #
769              # * `serviceAccount:{emailid}`: An email address that represents a service
770              #    account. For example, `my-other-app@appspot.gserviceaccount.com`.
771              #
772              # * `group:{emailid}`: An email address that represents a Google group.
773              #    For example, `admins@example.com`.
774              #
775              #
776              # * `domain:{domain}`: The G Suite domain (primary) that represents all the
777              #    users of that domain. For example, `google.com` or `example.com`.
778              #
779            "A String",
780          ],
781          "condition": { # Represents an expression text. Example: # The condition that is associated with this binding.
782              # NOTE: An unsatisfied condition will not allow user access via current
783              # binding. Different bindings, including their conditions, are examined
784              # independently.
785              #
786              #     title: "User account presence"
787              #     description: "Determines whether the request has a user account"
788              #     expression: "size(request.user) > 0"
789            "location": "A String", # An optional string indicating the location of the expression for error
790                # reporting, e.g. a file name and a position in the file.
791            "expression": "A String", # Textual representation of an expression in
792                # Common Expression Language syntax.
793                #
794                # The application context of the containing message determines which
795                # well-known feature set of CEL is supported.
796            "description": "A String", # An optional description of the expression. This is a longer text which
797                # describes the expression, e.g. when hovered over it in a UI.
798            "title": "A String", # An optional title for the expression, i.e. a short string describing
799                # its purpose. This can be used e.g. in UIs which allow to enter the
800                # expression.
801          },
802        },
803      ],
804      "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
805          # prevent simultaneous updates of a policy from overwriting each other.
806          # It is strongly suggested that systems make use of the `etag` in the
807          # read-modify-write cycle to perform policy updates in order to avoid race
808          # conditions: An `etag` is returned in the response to `getIamPolicy`, and
809          # systems are expected to put that etag in the request to `setIamPolicy` to
810          # ensure that their change will be applied to the same version of the policy.
811          #
812          # If no `etag` is provided in the call to `setIamPolicy`, then the existing
813          # policy is overwritten blindly.
814    },
815    "updateMask": "A String", # OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only
816        # the fields in the mask will be modified. If no mask is provided, the
817        # following default mask is used:
818        # paths: "bindings, etag"
819        # This field is only used by Cloud IAM.
820  }
821
822  x__xgafv: string, V1 error format.
823    Allowed values
824      1 - v1 error format
825      2 - v2 error format
826
827Returns:
828  An object of the form:
829
830    { # Defines an Identity and Access Management (IAM) policy. It is used to
831      # specify access control policies for Cloud Platform resources.
832      #
833      #
834      # A `Policy` consists of a list of `bindings`. A `binding` binds a list of
835      # `members` to a `role`, where the members can be user accounts, Google groups,
836      # Google domains, and service accounts. A `role` is a named list of permissions
837      # defined by IAM.
838      #
839      # **JSON Example**
840      #
841      #     {
842      #       "bindings": [
843      #         {
844      #           "role": "roles/owner",
845      #           "members": [
846      #             "user:mike@example.com",
847      #             "group:admins@example.com",
848      #             "domain:google.com",
849      #             "serviceAccount:my-other-app@appspot.gserviceaccount.com"
850      #           ]
851      #         },
852      #         {
853      #           "role": "roles/viewer",
854      #           "members": ["user:sean@example.com"]
855      #         }
856      #       ]
857      #     }
858      #
859      # **YAML Example**
860      #
861      #     bindings:
862      #     - members:
863      #       - user:mike@example.com
864      #       - group:admins@example.com
865      #       - domain:google.com
866      #       - serviceAccount:my-other-app@appspot.gserviceaccount.com
867      #       role: roles/owner
868      #     - members:
869      #       - user:sean@example.com
870      #       role: roles/viewer
871      #
872      #
873      # For a description of IAM and its features, see the
874      # [IAM developer's guide](https://cloud.google.com/iam/docs).
875    "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
876      { # Specifies the audit configuration for a service.
877          # The configuration determines which permission types are logged, and what
878          # identities, if any, are exempted from logging.
879          # An AuditConfig must have one or more AuditLogConfigs.
880          #
881          # If there are AuditConfigs for both `allServices` and a specific service,
882          # the union of the two AuditConfigs is used for that service: the log_types
883          # specified in each AuditConfig are enabled, and the exempted_members in each
884          # AuditLogConfig are exempted.
885          #
886          # Example Policy with multiple AuditConfigs:
887          #
888          #     {
889          #       "audit_configs": [
890          #         {
891          #           "service": "allServices"
892          #           "audit_log_configs": [
893          #             {
894          #               "log_type": "DATA_READ",
895          #               "exempted_members": [
896          #                 "user:foo@gmail.com"
897          #               ]
898          #             },
899          #             {
900          #               "log_type": "DATA_WRITE",
901          #             },
902          #             {
903          #               "log_type": "ADMIN_READ",
904          #             }
905          #           ]
906          #         },
907          #         {
908          #           "service": "fooservice.googleapis.com"
909          #           "audit_log_configs": [
910          #             {
911          #               "log_type": "DATA_READ",
912          #             },
913          #             {
914          #               "log_type": "DATA_WRITE",
915          #               "exempted_members": [
916          #                 "user:bar@gmail.com"
917          #               ]
918          #             }
919          #           ]
920          #         }
921          #       ]
922          #     }
923          #
924          # For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
925          # logging. It also exempts foo@gmail.com from DATA_READ logging, and
926          # bar@gmail.com from DATA_WRITE logging.
927        "auditLogConfigs": [ # The configuration for logging of each type of permission.
928          { # Provides the configuration for logging a type of permissions.
929              # Example:
930              #
931              #     {
932              #       "audit_log_configs": [
933              #         {
934              #           "log_type": "DATA_READ",
935              #           "exempted_members": [
936              #             "user:foo@gmail.com"
937              #           ]
938              #         },
939              #         {
940              #           "log_type": "DATA_WRITE",
941              #         }
942              #       ]
943              #     }
944              #
945              # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting
946              # foo@gmail.com from DATA_READ logging.
947            "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of
948                # permission.
949                # Follows the same format of Binding.members.
950              "A String",
951            ],
952            "logType": "A String", # The log type that this config enables.
953          },
954        ],
955        "service": "A String", # Specifies a service that will be enabled for audit logging.
956            # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
957            # `allServices` is a special value that covers all services.
958      },
959    ],
960    "version": 42, # Deprecated.
961    "bindings": [ # Associates a list of `members` to a `role`.
962        # `bindings` with no members will result in an error.
963      { # Associates `members` with a `role`.
964        "role": "A String", # Role that is assigned to `members`.
965            # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
966        "members": [ # Specifies the identities requesting access for a Cloud Platform resource.
967            # `members` can have the following values:
968            #
969            # * `allUsers`: A special identifier that represents anyone who is
970            #    on the internet; with or without a Google account.
971            #
972            # * `allAuthenticatedUsers`: A special identifier that represents anyone
973            #    who is authenticated with a Google account or a service account.
974            #
975            # * `user:{emailid}`: An email address that represents a specific Google
976            #    account. For example, `alice@gmail.com` .
977            #
978            #
979            # * `serviceAccount:{emailid}`: An email address that represents a service
980            #    account. For example, `my-other-app@appspot.gserviceaccount.com`.
981            #
982            # * `group:{emailid}`: An email address that represents a Google group.
983            #    For example, `admins@example.com`.
984            #
985            #
986            # * `domain:{domain}`: The G Suite domain (primary) that represents all the
987            #    users of that domain. For example, `google.com` or `example.com`.
988            #
989          "A String",
990        ],
991        "condition": { # Represents an expression text. Example: # The condition that is associated with this binding.
992            # NOTE: An unsatisfied condition will not allow user access via current
993            # binding. Different bindings, including their conditions, are examined
994            # independently.
995            #
996            #     title: "User account presence"
997            #     description: "Determines whether the request has a user account"
998            #     expression: "size(request.user) > 0"
999          "location": "A String", # An optional string indicating the location of the expression for error
1000              # reporting, e.g. a file name and a position in the file.
1001          "expression": "A String", # Textual representation of an expression in
1002              # Common Expression Language syntax.
1003              #
1004              # The application context of the containing message determines which
1005              # well-known feature set of CEL is supported.
1006          "description": "A String", # An optional description of the expression. This is a longer text which
1007              # describes the expression, e.g. when hovered over it in a UI.
1008          "title": "A String", # An optional title for the expression, i.e. a short string describing
1009              # its purpose. This can be used e.g. in UIs which allow to enter the
1010              # expression.
1011        },
1012      },
1013    ],
1014    "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
1015        # prevent simultaneous updates of a policy from overwriting each other.
1016        # It is strongly suggested that systems make use of the `etag` in the
1017        # read-modify-write cycle to perform policy updates in order to avoid race
1018        # conditions: An `etag` is returned in the response to `getIamPolicy`, and
1019        # systems are expected to put that etag in the request to `setIamPolicy` to
1020        # ensure that their change will be applied to the same version of the policy.
1021        #
1022        # If no `etag` is provided in the call to `setIamPolicy`, then the existing
1023        # policy is overwritten blindly.
1024  }</pre>
1025</div>
1026
1027<div class="method">
1028    <code class="details" id="testIamPermissions">testIamPermissions(resource, body, x__xgafv=None)</code>
1029  <pre>Tests the IAM permissions for the specified Catalog.
1030
1031Args:
1032  resource: string, REQUIRED: The resource for which the policy detail is being requested.
1033See the operation documentation for the appropriate value for this field. (required)
1034  body: object, The request body. (required)
1035    The object takes the form of:
1036
1037{ # Request message for `TestIamPermissions` method.
1038    "permissions": [ # The set of permissions to check for the `resource`. Permissions with
1039        # wildcards (such as '*' or 'storage.*') are not allowed. For more
1040        # information see
1041        # [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
1042      "A String",
1043    ],
1044  }
1045
1046  x__xgafv: string, V1 error format.
1047    Allowed values
1048      1 - v1 error format
1049      2 - v2 error format
1050
1051Returns:
1052  An object of the form:
1053
1054    { # Response message for `TestIamPermissions` method.
1055    "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is
1056        # allowed.
1057      "A String",
1058    ],
1059  }</pre>
1060</div>
1061
1062<div class="method">
1063    <code class="details" id="undelete">undelete(name, body=None, x__xgafv=None)</code>
1064  <pre>Undeletes a deleted Catalog and all resources under it.
1065
1066Args:
1067  name: string, The resource name of the catalog. (required)
1068  body: object, The request body.
1069    The object takes the form of:
1070
1071{
1072  }
1073
1074  x__xgafv: string, V1 error format.
1075    Allowed values
1076      1 - v1 error format
1077      2 - v2 error format
1078
1079Returns:
1080  An object of the form:
1081
1082    { # The producer representation of a catalog which is a curated collection of
1083      # solutions that can be managed, controlled, and shared by cloud admins.
1084    "updateTime": "A String", # Output only. The time when the catalog was last updated.
1085    "displayName": "A String", # Required. The user-supplied descriptive name of the catalog as it appears
1086        # in UIs. Maximum 256 characters in length.
1087    "name": "A String", # Output only. The resource name of the catalog, in the format
1088        # `catalogs/{catalog_id}'.
1089        #
1090        # A unique identifier for the catalog, which is generated
1091        # by catalog service.
1092    "parent": "A String", # Required. The parent resource name of the catalog, which can't be changed
1093        # after a catalog is created. It can only be an organization. Values are of
1094        # the form `//cloudresourcemanager.googleapis.com/organizations/<id>`.
1095        # Maximum 256 characters in length.
1096    "createTime": "A String", # Output only. The time when the catalog was created.
1097    "description": "A String", # Required. The user-supplied description of the catalog. Maximum of 512
1098        # characters.
1099  }</pre>
1100</div>
1101
1102</body></html>