create(parent, body=None, x__xgafv=None)

Register an API key for use with predict method.

Args:
  parent: string, Required. The parent resource path. `projects/*/locations/global/catalogs/default_catalog/eventStores/default_event_store`. (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for the `CreatePredictionApiKeyRegistration` method.
  "predictionApiKeyRegistration": { # Registered Api Key. # Required. The prediction API key registration.
    "apiKey": "A String", # The API key.
  },
}

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

Returns:
  An object of the form:

    { # Registered Api Key.
  "apiKey": "A String", # The API key.
}

delete(name, x__xgafv=None)

Unregister an apiKey from using for predict method.

Args:
  name: string, Required. The API key to unregister including full resource path. `projects/*/locations/global/catalogs/default_catalog/eventStores/default_event_store/predictionApiKeyRegistrations/` (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); }
}

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

List the registered apiKeys for use with predict method.

Args:
  parent: string, Required. The parent placement resource name such as `projects/1234/locations/global/catalogs/default_catalog/eventStores/default_event_store` (required)
  pageSize: integer, Optional. Maximum number of results to return per page. If unset, the service will choose a reasonable default.
  pageToken: string, Optional. The previous `ListPredictionApiKeyRegistration.nextPageToken`.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for the `ListPredictionApiKeyRegistrations`.
  "nextPageToken": "A String", # If empty, the list is complete. If nonempty, pass the token to the next request's `ListPredictionApiKeysRegistrationsRequest.pageToken`.
  "predictionApiKeyRegistrations": [ # The list of registered API keys.
    { # Registered Api Key.
      "apiKey": "A String", # The API key.
    },
  ],
}

list_next()

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.

Recommendations AI (Beta) . projects . locations . catalogs . eventStores . predictionApiKeyRegistrations

Instance Methods

Method Details