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> . <a href="cloudprivatecatalogproducer_v1beta1.catalogs.associations.html">associations</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">Creates an Association instance under a given Catalog.</p>
80<p class="toc_element">
81  <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
82<p class="firstline">Deletes the given Association.</p>
83<p class="toc_element">
84  <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
85<p class="firstline">Returns the requested Association 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">Lists all Association resources under a catalog.</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<h3>Method Details</h3>
93<div class="method">
94    <code class="details" id="create">create(parent, body, x__xgafv=None)</code>
95  <pre>Creates an Association instance under a given Catalog.
96
97Args:
98  parent: string, The `Catalog` resource's name. (required)
99  body: object, The request body. (required)
100    The object takes the form of:
101
102{
103    "association": { # An association tuple that pairs a `Catalog` to a resource # The user-supplied `Association` that is going to be created.
104        #
105        # If the `resource` field is set, the
106        # `privatecatalogproducer.catalogTargets.associate` permission is checked on
107        # the target resource.
108        # that can use the `Catalog`. After association, a
109        # google.cloud.privatecatalog.v1beta1.Catalog becomes available to
110        # consumers under specified Association.resource and all of its child
111        # nodes.
112        # Users who have the `cloudprivatecatalog.targets.get` permission on any of
113        # the resource nodes can access the catalog and child products under the node.
114        #
115        # For example, suppose the cloud resource hierarchy is as follows:
116        #
117        # * organizations/example.com
118        #   * folders/team
119        #     * projects/test
120        #
121        # After creating an association with `organizations/example.com`, the catalog
122        # `catalogs/1`  is accessible from the following paths:
123        #
124        # * organizations/example.com
125        # * folders/team
126        # * projects/test
127        #
128        # Users can access them by
129        # google.cloud.v1beta1.PrivateCatalog.SearchCatalogs action.
130      "resource": "A String", # Required. The user-supplied fully qualified name of the `Resource`
131          # associated to the `Catalog`. It supports `Organization`, `Folder`,
132          # and `Project`. Values are of the form
133          #
134          # * `//cloudresourcemanager.googleapis.com/projects/{product_number}`
135          # * `//cloudresourcemanager.googleapis.com/folders/{folder_id}`
136          # * `//cloudresourcemanager.googleapis.com/organizations/{organization_id}`
137      "createTime": "A String", # The creation time of the association.
138      "name": "A String", # Output only. The resource name of the catalog association, in the format
139          # `catalogs/{catalog_id}/associations/{association_id}'.
140          #
141          # A unique identifier for the catalog association, which is
142          # generated by catalog service.
143    },
144  }
145
146  x__xgafv: string, V1 error format.
147    Allowed values
148      1 - v1 error format
149      2 - v2 error format
150
151Returns:
152  An object of the form:
153
154    { # An association tuple that pairs a `Catalog` to a resource
155      # that can use the `Catalog`. After association, a
156      # google.cloud.privatecatalog.v1beta1.Catalog becomes available to
157      # consumers under specified Association.resource and all of its child
158      # nodes.
159      # Users who have the `cloudprivatecatalog.targets.get` permission on any of
160      # the resource nodes can access the catalog and child products under the node.
161      #
162      # For example, suppose the cloud resource hierarchy is as follows:
163      #
164      # * organizations/example.com
165      #   * folders/team
166      #     * projects/test
167      #
168      # After creating an association with `organizations/example.com`, the catalog
169      # `catalogs/1`  is accessible from the following paths:
170      #
171      # * organizations/example.com
172      # * folders/team
173      # * projects/test
174      #
175      # Users can access them by
176      # google.cloud.v1beta1.PrivateCatalog.SearchCatalogs action.
177    "resource": "A String", # Required. The user-supplied fully qualified name of the `Resource`
178        # associated to the `Catalog`. It supports `Organization`, `Folder`,
179        # and `Project`. Values are of the form
180        #
181        # * `//cloudresourcemanager.googleapis.com/projects/{product_number}`
182        # * `//cloudresourcemanager.googleapis.com/folders/{folder_id}`
183        # * `//cloudresourcemanager.googleapis.com/organizations/{organization_id}`
184    "createTime": "A String", # The creation time of the association.
185    "name": "A String", # Output only. The resource name of the catalog association, in the format
186        # `catalogs/{catalog_id}/associations/{association_id}'.
187        #
188        # A unique identifier for the catalog association, which is
189        # generated by catalog service.
190  }</pre>
191</div>
192
193<div class="method">
194    <code class="details" id="delete">delete(name, x__xgafv=None)</code>
195  <pre>Deletes the given Association.
196
197Args:
198  name: string, The resource name of the `Association` to delete. (required)
199  x__xgafv: string, V1 error format.
200    Allowed values
201      1 - v1 error format
202      2 - v2 error format
203
204Returns:
205  An object of the form:
206
207    { # A generic empty message that you can re-use to avoid defining duplicated
208      # empty messages in your APIs. A typical example is to use it as the request
209      # or the response type of an API method. For instance:
210      #
211      #     service Foo {
212      #       rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
213      #     }
214      #
215      # The JSON representation for `Empty` is empty JSON object `{}`.
216  }</pre>
217</div>
218
219<div class="method">
220    <code class="details" id="get">get(name, x__xgafv=None)</code>
221  <pre>Returns the requested Association resource.
222
223Args:
224  name: string, The resource name of the `Association` to retrieve. (required)
225  x__xgafv: string, V1 error format.
226    Allowed values
227      1 - v1 error format
228      2 - v2 error format
229
230Returns:
231  An object of the form:
232
233    { # An association tuple that pairs a `Catalog` to a resource
234      # that can use the `Catalog`. After association, a
235      # google.cloud.privatecatalog.v1beta1.Catalog becomes available to
236      # consumers under specified Association.resource and all of its child
237      # nodes.
238      # Users who have the `cloudprivatecatalog.targets.get` permission on any of
239      # the resource nodes can access the catalog and child products under the node.
240      #
241      # For example, suppose the cloud resource hierarchy is as follows:
242      #
243      # * organizations/example.com
244      #   * folders/team
245      #     * projects/test
246      #
247      # After creating an association with `organizations/example.com`, the catalog
248      # `catalogs/1`  is accessible from the following paths:
249      #
250      # * organizations/example.com
251      # * folders/team
252      # * projects/test
253      #
254      # Users can access them by
255      # google.cloud.v1beta1.PrivateCatalog.SearchCatalogs action.
256    "resource": "A String", # Required. The user-supplied fully qualified name of the `Resource`
257        # associated to the `Catalog`. It supports `Organization`, `Folder`,
258        # and `Project`. Values are of the form
259        #
260        # * `//cloudresourcemanager.googleapis.com/projects/{product_number}`
261        # * `//cloudresourcemanager.googleapis.com/folders/{folder_id}`
262        # * `//cloudresourcemanager.googleapis.com/organizations/{organization_id}`
263    "createTime": "A String", # The creation time of the association.
264    "name": "A String", # Output only. The resource name of the catalog association, in the format
265        # `catalogs/{catalog_id}/associations/{association_id}'.
266        #
267        # A unique identifier for the catalog association, which is
268        # generated by catalog service.
269  }</pre>
270</div>
271
272<div class="method">
273    <code class="details" id="list">list(parent, pageToken=None, x__xgafv=None, pageSize=None)</code>
274  <pre>Lists all Association resources under a catalog.
275
276Args:
277  parent: string, The resource name of the `Catalog` whose `Associations` are
278being retrieved. In the format `catalogs/<catalog>`. (required)
279  pageToken: string, A pagination token returned from the previous call to
280`ListAssociations`.
281  x__xgafv: string, V1 error format.
282    Allowed values
283      1 - v1 error format
284      2 - v2 error format
285  pageSize: integer, The maximum number of catalog associations to return.
286
287Returns:
288  An object of the form:
289
290    {
291    "nextPageToken": "A String", # A pagination token returned from a previous call to
292        # `ListAssociations` that indicates where the listing should continue from.
293        # This field is optional.
294    "associations": [ # The returned `Association` resources from the list call.
295      { # An association tuple that pairs a `Catalog` to a resource
296          # that can use the `Catalog`. After association, a
297          # google.cloud.privatecatalog.v1beta1.Catalog becomes available to
298          # consumers under specified Association.resource and all of its child
299          # nodes.
300          # Users who have the `cloudprivatecatalog.targets.get` permission on any of
301          # the resource nodes can access the catalog and child products under the node.
302          #
303          # For example, suppose the cloud resource hierarchy is as follows:
304          #
305          # * organizations/example.com
306          #   * folders/team
307          #     * projects/test
308          #
309          # After creating an association with `organizations/example.com`, the catalog
310          # `catalogs/1`  is accessible from the following paths:
311          #
312          # * organizations/example.com
313          # * folders/team
314          # * projects/test
315          #
316          # Users can access them by
317          # google.cloud.v1beta1.PrivateCatalog.SearchCatalogs action.
318        "resource": "A String", # Required. The user-supplied fully qualified name of the `Resource`
319            # associated to the `Catalog`. It supports `Organization`, `Folder`,
320            # and `Project`. Values are of the form
321            #
322            # * `//cloudresourcemanager.googleapis.com/projects/{product_number}`
323            # * `//cloudresourcemanager.googleapis.com/folders/{folder_id}`
324            # * `//cloudresourcemanager.googleapis.com/organizations/{organization_id}`
325        "createTime": "A String", # The creation time of the association.
326        "name": "A String", # Output only. The resource name of the catalog association, in the format
327            # `catalogs/{catalog_id}/associations/{association_id}'.
328            #
329            # A unique identifier for the catalog association, which is
330            # generated by catalog service.
331      },
332    ],
333  }</pre>
334</div>
335
336<div class="method">
337    <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
338  <pre>Retrieves the next page of results.
339
340Args:
341  previous_request: The request for the previous page. (required)
342  previous_response: The response from the request for the previous page. (required)
343
344Returns:
345  A request object that you can call 'execute()' on to request the next
346  page. Returns None if there are no more items in the collection.
347    </pre>
348</div>
349
350</body></html>