Cloud Private Catalog Producer API . catalogs . associations

Instance Methods

create(parent, body, x__xgafv=None)

Creates an Association instance under a given Catalog.

delete(name, x__xgafv=None)

Deletes the given Association.

get(name, x__xgafv=None)

Returns the requested Association resource.

list(parent, pageToken=None, x__xgafv=None, pageSize=None)

Lists all Association resources under a catalog.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

create(parent, body, x__xgafv=None)
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.
  }
delete(name, x__xgafv=None)
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 `{}`.
  }
get(name, x__xgafv=None)
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.
  }
list(parent, pageToken=None, x__xgafv=None, pageSize=None)
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/`. (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.
      },
    ],
  }
list_next(previous_request, previous_response)
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.