docs/dyn/cloudprivatecatalogproducer_v1beta1.catalogs.associations.html - platform/external/python/google-api-python-client - Git at Google

 <html><body>
 <style>

 body, h1, h2, h3, div, span, p, pre, a {
   margin: 0;
   padding: 0;
   border: 0;
   font-weight: inherit;
   font-style: inherit;
   font-size: 100%;
   font-family: inherit;
   vertical-align: baseline;
 }

 body {
   font-size: 13px;
   padding: 1em;
 }

 h1 {
   font-size: 26px;
   margin-bottom: 1em;
 }

 h2 {
   font-size: 24px;
   margin-bottom: 1em;
 }

 h3 {
   font-size: 20px;
   margin-bottom: 1em;
   margin-top: 1em;
 }

 pre, code {
   line-height: 1.5;
   font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
 }

 pre {
   margin-top: 0.5em;
 }

 h1, h2, h3, p {
   font-family: Arial, sans serif;
 }

 h1, h2, h3 {
   border-bottom: solid #CCC 1px;
 }

 .toc_element {
   margin-top: 0.5em;
 }

 .firstline {
   margin-left: 2 em;
 }

 .method  {
   margin-top: 1em;
   border: solid 1px #CCC;
   padding: 1em;
   background: #EEE;
 }

 .details {
   font-weight: bold;
   font-size: 14px;
 }

 </style>

 <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>
 <h2>Instance Methods</h2>
 <p class="toc_element">
   <code><a href="#create">create(parent, body, x__xgafv=None)</a></code></p>
 <p class="firstline">Creates an Association instance under a given Catalog.</p>
 <p class="toc_element">
   <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
 <p class="firstline">Deletes the given Association.</p>
 <p class="toc_element">
   <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
 <p class="firstline">Returns the requested Association resource.</p>
 <p class="toc_element">
   <code><a href="#list">list(parent, pageToken=None, x__xgafv=None, pageSize=None)</a></code></p>
 <p class="firstline">Lists all Association resources under a catalog.</p>
 <p class="toc_element">
   <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
 <p class="firstline">Retrieves the next page of results.</p>
 <h3>Method Details</h3>
 <div class="method">
     <code class="details" id="create">create(parent, body, x__xgafv=None)</code>
   <pre>Creates an Association instance under a given Catalog.

 Args:
   parent: string, The `Catalog` resource's name. (required)
   body: object, The request body. (required)
     The object takes the form of:

 {
     "association": { # An association tuple that pairs a `Catalog` to a resource # The user-supplied `Association` that is going to be created.
         #
         # If the `resource` field is set, the
         # `privatecatalogproducer.catalogTargets.associate` permission is checked on
         # the target resource.
         # that can use the `Catalog`. After association, a
         # google.cloud.privatecatalog.v1beta1.Catalog becomes available to
         # consumers under specified Association.resource and all of its child
         # nodes.
         # Users who have the `cloudprivatecatalog.targets.get` permission on any of
         # the resource nodes can access the catalog and child products under the node.
         #
         # For example, suppose the cloud resource hierarchy is as follows:
         #
         # * organizations/example.com
         #   * folders/team
         #     * projects/test
         #
         # After creating an association with `organizations/example.com`, the catalog
         # `catalogs/1`  is accessible from the following paths:
         #
         # * organizations/example.com
         # * folders/team
         # * projects/test
         #
         # Users can access them by
         # google.cloud.v1beta1.PrivateCatalog.SearchCatalogs action.
       "resource": "A String", # Required. The user-supplied fully qualified name of the `Resource`
           # associated to the `Catalog`. It supports `Organization`, `Folder`,
           # and `Project`. Values are of the form
           #
           # * `//cloudresourcemanager.googleapis.com/projects/{product_number}`
           # * `//cloudresourcemanager.googleapis.com/folders/{folder_id}`
           # * `//cloudresourcemanager.googleapis.com/organizations/{organization_id}`
       "createTime": "A String", # The creation time of the association.
       "name": "A String", # Output only. The resource name of the catalog association, in the format
           # `catalogs/{catalog_id}/associations/{association_id}'.
           #
           # A unique identifier for the catalog association, which is
           # generated by catalog service.
     },
   }

   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
       2 - v2 error format

 Returns:
   An object of the form:

     { # An association tuple that pairs a `Catalog` to a resource
       # that can use the `Catalog`. After association, a
       # google.cloud.privatecatalog.v1beta1.Catalog becomes available to
       # consumers under specified Association.resource and all of its child
       # nodes.
       # Users who have the `cloudprivatecatalog.targets.get` permission on any of
       # the resource nodes can access the catalog and child products under the node.
       #
       # For example, suppose the cloud resource hierarchy is as follows:
       #
       # * organizations/example.com
       #   * folders/team
       #     * projects/test
       #
       # After creating an association with `organizations/example.com`, the catalog
       # `catalogs/1`  is accessible from the following paths:
       #
       # * organizations/example.com
       # * folders/team
       # * projects/test
       #
       # Users can access them by
       # google.cloud.v1beta1.PrivateCatalog.SearchCatalogs action.
     "resource": "A String", # Required. The user-supplied fully qualified name of the `Resource`
         # associated to the `Catalog`. It supports `Organization`, `Folder`,
         # and `Project`. Values are of the form
         #
         # * `//cloudresourcemanager.googleapis.com/projects/{product_number}`
         # * `//cloudresourcemanager.googleapis.com/folders/{folder_id}`
         # * `//cloudresourcemanager.googleapis.com/organizations/{organization_id}`
     "createTime": "A String", # The creation time of the association.
     "name": "A String", # Output only. The resource name of the catalog association, in the format
         # `catalogs/{catalog_id}/associations/{association_id}'.
         #
         # A unique identifier for the catalog association, which is
         # generated by catalog service.
   }</pre>
 </div>

 <div class="method">
     <code class="details" id="delete">delete(name, x__xgafv=None)</code>
   <pre>Deletes the given Association.

 Args:
   name: string, The resource name of the `Association` to delete. (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
       2 - v2 error format

 Returns:
   An object of the form:

     { # A generic empty message that you can re-use to avoid defining duplicated
       # empty messages in your APIs. A typical example is to use it as the request
       # or the response type of an API method. For instance:
       #
       #     service Foo {
       #       rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
       #     }
       #
       # The JSON representation for `Empty` is empty JSON object `{}`.
   }</pre>
 </div>

 <div class="method">
     <code class="details" id="get">get(name, x__xgafv=None)</code>
   <pre>Returns the requested Association resource.

 Args:
   name: string, The resource name of the `Association` to retrieve. (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
       2 - v2 error format

 Returns:
   An object of the form:

     { # An association tuple that pairs a `Catalog` to a resource
       # that can use the `Catalog`. After association, a
       # google.cloud.privatecatalog.v1beta1.Catalog becomes available to
       # consumers under specified Association.resource and all of its child
       # nodes.
       # Users who have the `cloudprivatecatalog.targets.get` permission on any of
       # the resource nodes can access the catalog and child products under the node.
       #
       # For example, suppose the cloud resource hierarchy is as follows:
       #
       # * organizations/example.com
       #   * folders/team
       #     * projects/test
       #
       # After creating an association with `organizations/example.com`, the catalog
       # `catalogs/1`  is accessible from the following paths:
       #
       # * organizations/example.com
       # * folders/team
       # * projects/test
       #
       # Users can access them by
       # google.cloud.v1beta1.PrivateCatalog.SearchCatalogs action.
     "resource": "A String", # Required. The user-supplied fully qualified name of the `Resource`
         # associated to the `Catalog`. It supports `Organization`, `Folder`,
         # and `Project`. Values are of the form
         #
         # * `//cloudresourcemanager.googleapis.com/projects/{product_number}`
         # * `//cloudresourcemanager.googleapis.com/folders/{folder_id}`
         # * `//cloudresourcemanager.googleapis.com/organizations/{organization_id}`
     "createTime": "A String", # The creation time of the association.
     "name": "A String", # Output only. The resource name of the catalog association, in the format
         # `catalogs/{catalog_id}/associations/{association_id}'.
         #
         # A unique identifier for the catalog association, which is
         # generated by catalog service.
   }</pre>
 </div>

 <div class="method">
     <code class="details" id="list">list(parent, pageToken=None, x__xgafv=None, pageSize=None)</code>
   <pre>Lists all Association resources under a catalog.

 Args:
   parent: string, The resource name of the `Catalog` whose `Associations` are
 being retrieved. In the format `catalogs/<catalog>`. (required)
   pageToken: string, A pagination token returned from the previous call to
 `ListAssociations`.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
       2 - v2 error format
   pageSize: integer, The maximum number of catalog associations to return.

 Returns:
   An object of the form:

     {
     "nextPageToken": "A String", # A pagination token returned from a previous call to
         # `ListAssociations` that indicates where the listing should continue from.
         # This field is optional.
     "associations": [ # The returned `Association` resources from the list call.
       { # An association tuple that pairs a `Catalog` to a resource
           # that can use the `Catalog`. After association, a
           # google.cloud.privatecatalog.v1beta1.Catalog becomes available to
           # consumers under specified Association.resource and all of its child
           # nodes.
           # Users who have the `cloudprivatecatalog.targets.get` permission on any of
           # the resource nodes can access the catalog and child products under the node.
           #
           # For example, suppose the cloud resource hierarchy is as follows:
           #
           # * organizations/example.com
           #   * folders/team
           #     * projects/test
           #
           # After creating an association with `organizations/example.com`, the catalog
           # `catalogs/1`  is accessible from the following paths:
           #
           # * organizations/example.com
           # * folders/team
           # * projects/test
           #
           # Users can access them by
           # google.cloud.v1beta1.PrivateCatalog.SearchCatalogs action.
         "resource": "A String", # Required. The user-supplied fully qualified name of the `Resource`
             # associated to the `Catalog`. It supports `Organization`, `Folder`,
             # and `Project`. Values are of the form
             #
             # * `//cloudresourcemanager.googleapis.com/projects/{product_number}`
             # * `//cloudresourcemanager.googleapis.com/folders/{folder_id}`
             # * `//cloudresourcemanager.googleapis.com/organizations/{organization_id}`
         "createTime": "A String", # The creation time of the association.
         "name": "A String", # Output only. The resource name of the catalog association, in the format
             # `catalogs/{catalog_id}/associations/{association_id}'.
             #
             # A unique identifier for the catalog association, which is
             # generated by catalog service.
       },
     ],
   }</pre>
 </div>

 <div class="method">
     <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
   <pre>Retrieves the next page of results.

 Args:
   previous_request: The request for the previous page. (required)
   previous_response: The response from the request for the previous page. (required)

 Returns:
   A request object that you can call 'execute()' on to request the next
   page. Returns None if there are no more items in the collection.
     </pre>
 </div>

 </body></html>
	<html><body>
	<style>

	body, h1, h2, h3, div, span, p, pre, a {
	margin: 0;
	padding: 0;
	border: 0;
	font-weight: inherit;
	font-style: inherit;
	font-size: 100%;
	font-family: inherit;
	vertical-align: baseline;
	}

	body {
	font-size: 13px;
	padding: 1em;
	}

	h1 {
	font-size: 26px;
	margin-bottom: 1em;
	}

	h2 {
	font-size: 24px;
	margin-bottom: 1em;
	}

	h3 {
	font-size: 20px;
	margin-bottom: 1em;
	margin-top: 1em;
	}

	pre, code {
	line-height: 1.5;
	font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
	}

	pre {
	margin-top: 0.5em;
	}

	h1, h2, h3, p {
	font-family: Arial, sans serif;
	}

	h1, h2, h3 {
	border-bottom: solid #CCC 1px;
	}

	.toc_element {
	margin-top: 0.5em;
	}

	.firstline {
	margin-left: 2 em;
	}

	.method {
	margin-top: 1em;
	border: solid 1px #CCC;
	padding: 1em;
	background: #EEE;
	}

	.details {
	font-weight: bold;
	font-size: 14px;
	}

	</style>

	<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>
	<h2>Instance Methods</h2>
	<p class="toc_element">
	<code><a href="#create">create(parent, body, x__xgafv=None)</a></code></p>
	<p class="firstline">Creates an Association instance under a given Catalog.</p>
	<p class="toc_element">
	<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
	<p class="firstline">Deletes the given Association.</p>
	<p class="toc_element">
	<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
	<p class="firstline">Returns the requested Association resource.</p>
	<p class="toc_element">
	<code><a href="#list">list(parent, pageToken=None, x__xgafv=None, pageSize=None)</a></code></p>
	<p class="firstline">Lists all Association resources under a catalog.</p>
	<p class="toc_element">
	<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
	<p class="firstline">Retrieves the next page of results.</p>
	<h3>Method Details</h3>
	<div class="method">
	<code class="details" id="create">create(parent, body, x__xgafv=None)</code>
	<pre>Creates an Association instance under a given Catalog.

	Args:
	parent: string, The `Catalog` resource's name. (required)
	body: object, The request body. (required)
	The object takes the form of:

	{
	"association": { # An association tuple that pairs a `Catalog` to a resource # The user-supplied `Association` that is going to be created.
	#
	# If the `resource` field is set, the
	# `privatecatalogproducer.catalogTargets.associate` permission is checked on
	# the target resource.
	# that can use the `Catalog`. After association, a
	# google.cloud.privatecatalog.v1beta1.Catalog becomes available to
	# consumers under specified Association.resource and all of its child
	# nodes.
	# Users who have the `cloudprivatecatalog.targets.get` permission on any of
	# the resource nodes can access the catalog and child products under the node.
	#
	# For example, suppose the cloud resource hierarchy is as follows:
	#
	# * organizations/example.com
	# * folders/team
	# * projects/test
	#
	# After creating an association with `organizations/example.com`, the catalog
	# `catalogs/1` is accessible from the following paths:
	#
	# * organizations/example.com
	# * folders/team
	# * projects/test
	#
	# Users can access them by
	# google.cloud.v1beta1.PrivateCatalog.SearchCatalogs action.
	"resource": "A String", # Required. The user-supplied fully qualified name of the `Resource`
	# associated to the `Catalog`. It supports `Organization`, `Folder`,
	# and `Project`. Values are of the form
	#
	# * `//cloudresourcemanager.googleapis.com/projects/{product_number}`
	# * `//cloudresourcemanager.googleapis.com/folders/{folder_id}`
	# * `//cloudresourcemanager.googleapis.com/organizations/{organization_id}`
	"createTime": "A String", # The creation time of the association.
	"name": "A String", # Output only. The resource name of the catalog association, in the format
	# `catalogs/{catalog_id}/associations/{association_id}'.
	#
	# A unique identifier for the catalog association, which is
	# generated by catalog service.
	},
	}

	x__xgafv: string, V1 error format.
	Allowed values
	1 - v1 error format
	2 - v2 error format

	Returns:
	An object of the form:

	{ # An association tuple that pairs a `Catalog` to a resource
	# that can use the `Catalog`. After association, a
	# google.cloud.privatecatalog.v1beta1.Catalog becomes available to
	# consumers under specified Association.resource and all of its child
	# nodes.
	# Users who have the `cloudprivatecatalog.targets.get` permission on any of
	# the resource nodes can access the catalog and child products under the node.
	#
	# For example, suppose the cloud resource hierarchy is as follows:
	#
	# * organizations/example.com
	# * folders/team
	# * projects/test
	#
	# After creating an association with `organizations/example.com`, the catalog
	# `catalogs/1` is accessible from the following paths:
	#
	# * organizations/example.com
	# * folders/team
	# * projects/test
	#
	# Users can access them by
	# google.cloud.v1beta1.PrivateCatalog.SearchCatalogs action.
	"resource": "A String", # Required. The user-supplied fully qualified name of the `Resource`
	# associated to the `Catalog`. It supports `Organization`, `Folder`,
	# and `Project`. Values are of the form
	#
	# * `//cloudresourcemanager.googleapis.com/projects/{product_number}`
	# * `//cloudresourcemanager.googleapis.com/folders/{folder_id}`
	# * `//cloudresourcemanager.googleapis.com/organizations/{organization_id}`
	"createTime": "A String", # The creation time of the association.
	"name": "A String", # Output only. The resource name of the catalog association, in the format
	# `catalogs/{catalog_id}/associations/{association_id}'.
	#
	# A unique identifier for the catalog association, which is
	# generated by catalog service.
	}</pre>
	</div>

	<div class="method">
	<code class="details" id="delete">delete(name, x__xgafv=None)</code>
	<pre>Deletes the given Association.

	Args:
	name: string, The resource name of the `Association` to delete. (required)
	x__xgafv: string, V1 error format.
	Allowed values
	1 - v1 error format
	2 - v2 error format

	Returns:
	An object of the form:

	{ # A generic empty message that you can re-use to avoid defining duplicated
	# empty messages in your APIs. A typical example is to use it as the request
	# or the response type of an API method. For instance:
	#
	# service Foo {
	# rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
	# }
	#
	# The JSON representation for `Empty` is empty JSON object `{}`.
	}</pre>
	</div>

	<div class="method">
	<code class="details" id="get">get(name, x__xgafv=None)</code>
	<pre>Returns the requested Association resource.

	Args:
	name: string, The resource name of the `Association` to retrieve. (required)
	x__xgafv: string, V1 error format.
	Allowed values
	1 - v1 error format
	2 - v2 error format

	Returns:
	An object of the form:

	{ # An association tuple that pairs a `Catalog` to a resource
	# that can use the `Catalog`. After association, a
	# google.cloud.privatecatalog.v1beta1.Catalog becomes available to
	# consumers under specified Association.resource and all of its child
	# nodes.
	# Users who have the `cloudprivatecatalog.targets.get` permission on any of
	# the resource nodes can access the catalog and child products under the node.
	#
	# For example, suppose the cloud resource hierarchy is as follows:
	#
	# * organizations/example.com
	# * folders/team
	# * projects/test
	#
	# After creating an association with `organizations/example.com`, the catalog
	# `catalogs/1` is accessible from the following paths:
	#
	# * organizations/example.com
	# * folders/team
	# * projects/test
	#
	# Users can access them by
	# google.cloud.v1beta1.PrivateCatalog.SearchCatalogs action.
	"resource": "A String", # Required. The user-supplied fully qualified name of the `Resource`
	# associated to the `Catalog`. It supports `Organization`, `Folder`,
	# and `Project`. Values are of the form
	#
	# * `//cloudresourcemanager.googleapis.com/projects/{product_number}`
	# * `//cloudresourcemanager.googleapis.com/folders/{folder_id}`
	# * `//cloudresourcemanager.googleapis.com/organizations/{organization_id}`
	"createTime": "A String", # The creation time of the association.
	"name": "A String", # Output only. The resource name of the catalog association, in the format
	# `catalogs/{catalog_id}/associations/{association_id}'.
	#
	# A unique identifier for the catalog association, which is
	# generated by catalog service.
	}</pre>
	</div>

	<div class="method">
	<code class="details" id="list">list(parent, pageToken=None, x__xgafv=None, pageSize=None)</code>
	<pre>Lists all Association resources under a catalog.

	Args:
	parent: string, The resource name of the `Catalog` whose `Associations` are
	being retrieved. In the format `catalogs/<catalog>`. (required)
	pageToken: string, A pagination token returned from the previous call to
	`ListAssociations`.
	x__xgafv: string, V1 error format.
	Allowed values
	1 - v1 error format
	2 - v2 error format
	pageSize: integer, The maximum number of catalog associations to return.

	Returns:
	An object of the form:

	{
	"nextPageToken": "A String", # A pagination token returned from a previous call to
	# `ListAssociations` that indicates where the listing should continue from.
	# This field is optional.
	"associations": [ # The returned `Association` resources from the list call.
	{ # An association tuple that pairs a `Catalog` to a resource
	# that can use the `Catalog`. After association, a
	# google.cloud.privatecatalog.v1beta1.Catalog becomes available to
	# consumers under specified Association.resource and all of its child
	# nodes.
	# Users who have the `cloudprivatecatalog.targets.get` permission on any of
	# the resource nodes can access the catalog and child products under the node.
	#
	# For example, suppose the cloud resource hierarchy is as follows:
	#
	# * organizations/example.com
	# * folders/team
	# * projects/test
	#
	# After creating an association with `organizations/example.com`, the catalog
	# `catalogs/1` is accessible from the following paths:
	#
	# * organizations/example.com
	# * folders/team
	# * projects/test
	#
	# Users can access them by
	# google.cloud.v1beta1.PrivateCatalog.SearchCatalogs action.
	"resource": "A String", # Required. The user-supplied fully qualified name of the `Resource`
	# associated to the `Catalog`. It supports `Organization`, `Folder`,
	# and `Project`. Values are of the form
	#
	# * `//cloudresourcemanager.googleapis.com/projects/{product_number}`
	# * `//cloudresourcemanager.googleapis.com/folders/{folder_id}`
	# * `//cloudresourcemanager.googleapis.com/organizations/{organization_id}`
	"createTime": "A String", # The creation time of the association.
	"name": "A String", # Output only. The resource name of the catalog association, in the format
	# `catalogs/{catalog_id}/associations/{association_id}'.
	#
	# A unique identifier for the catalog association, which is
	# generated by catalog service.
	},
	],
	}</pre>
	</div>

	<div class="method">
	<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
	<pre>Retrieves the next page of results.

	Args:
	previous_request: The request for the previous page. (required)
	previous_response: The response from the request for the previous page. (required)

	Returns:
	A request object that you can call 'execute()' on to request the next
	page. Returns None if there are no more items in the collection.
	</pre>
	</div>

	</body></html>