Recommendations AI (Beta) . projects . locations . catalogs

close()

Close httplib2 connections.

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

Lists all the catalog configurations associated with the project.

Args:
  parent: string, Required. The account resource name with an associated location. (required)
  pageSize: integer, Optional. Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.
  pageToken: string, Optional. A page token, received from a previous `ListCatalogs` call. Provide this to retrieve the subsequent page.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response for ListCatalogs method.
  "catalogs": [ # Output only. All the customer's catalogs.
    { # The catalog configuration. Next ID: 5.
      "catalogItemLevelConfig": { # Configures the catalog level that users send events to, and the level at which predictions are made. # Required. The catalog item level configuration.
        "eventItemLevel": "A String", # Optional. Level of the catalog at which events are uploaded. See https://cloud.google.com/recommendations-ai/docs/catalog#catalog-levels for more details.
        "predictItemLevel": "A String", # Optional. Level of the catalog at which predictions are made. See https://cloud.google.com/recommendations-ai/docs/catalog#catalog-levels for more details.
      },
      "defaultEventStoreId": "A String", # Required. The ID of the default event store.
      "displayName": "A String", # Required. The catalog display name.
      "name": "A String", # The fully qualified resource name of the catalog.
    },
  ],
  "nextPageToken": "A String", # Pagination token, if not returned indicates the last page.
}

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.
    

patch(name, body=None, updateMask=None, x__xgafv=None)

Updates the catalog configuration.

Args:
  name: string, The fully qualified resource name of the catalog. (required)
  body: object, The request body.
    The object takes the form of:

{ # The catalog configuration. Next ID: 5.
  "catalogItemLevelConfig": { # Configures the catalog level that users send events to, and the level at which predictions are made. # Required. The catalog item level configuration.
    "eventItemLevel": "A String", # Optional. Level of the catalog at which events are uploaded. See https://cloud.google.com/recommendations-ai/docs/catalog#catalog-levels for more details.
    "predictItemLevel": "A String", # Optional. Level of the catalog at which predictions are made. See https://cloud.google.com/recommendations-ai/docs/catalog#catalog-levels for more details.
  },
  "defaultEventStoreId": "A String", # Required. The ID of the default event store.
  "displayName": "A String", # Required. The catalog display name.
  "name": "A String", # The fully qualified resource name of the catalog.
}

  updateMask: string, Optional. Indicates which fields in the provided 'catalog' to update. If not set, will only update the catalog_item_level_config field. Currently only fields that can be updated are catalog_item_level_config.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The catalog configuration. Next ID: 5.
  "catalogItemLevelConfig": { # Configures the catalog level that users send events to, and the level at which predictions are made. # Required. The catalog item level configuration.
    "eventItemLevel": "A String", # Optional. Level of the catalog at which events are uploaded. See https://cloud.google.com/recommendations-ai/docs/catalog#catalog-levels for more details.
    "predictItemLevel": "A String", # Optional. Level of the catalog at which predictions are made. See https://cloud.google.com/recommendations-ai/docs/catalog#catalog-levels for more details.
  },
  "defaultEventStoreId": "A String", # Required. The ID of the default event store.
  "displayName": "A String", # Required. The catalog display name.
  "name": "A String", # The fully qualified resource name of the catalog.
}