Recommender API . projects . locations . recommenders

close()

Close httplib2 connections.

getConfig(name, x__xgafv=None)

Gets the requested Recommender Config. There is only one instance of the config for each Recommender.

Args:
  name: string, Required. Name of the Recommendation Config to get. Acceptable formats: * `projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/config` * `projects/[PROJECT_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/config` * `organizations/[ORGANIZATION_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/config` (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Configuration for a Recommender.
  "annotations": { # Allows clients to store small amounts of arbitrary data. Annotations must follow the Kubernetes syntax. The total size of all keys and values combined is limited to 256k. Key can have 2 segments: prefix (optional) and name (required), separated by a slash (/). Prefix must be a DNS subdomain. Name must be 63 characters or less, begin and end with alphanumerics, with dashes (-), underscores (_), dots (.), and alphanumerics between.
    "a_key": "A String",
  },
  "displayName": "A String", # A user-settable field to provide a human-readable name to be used in user interfaces.
  "etag": "A String", # Fingerprint of the RecommenderConfig. Provides optimistic locking when updating.
  "name": "A String", # Name of recommender config. Eg, projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/config
  "recommenderGenerationConfig": { # A Configuration to customize the generation of recommendations. Eg, customizing the lookback period considered when generating a recommendation. # RecommenderGenerationConfig which configures the Generation of recommendations for this recommender.
    "params": { # Parameters for this RecommenderGenerationConfig. These configs can be used by or are applied to all subtypes.
      "a_key": "", # Properties of the object.
    },
  },
  "revisionId": "A String", # Output only. Immutable. The revision ID of the config. A new revision is committed whenever the config is changed in any way. The format is an 8-character hexadecimal string.
  "updateTime": "A String", # Last time when the config was updated.
}

updateConfig(name, body, updateMask=None, validateOnly=None, x__xgafv=None)

Updates a Recommender Config. This will create a new revision of the config.

Args:
  name: string, Name of recommender config. Eg, projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/config (required)
  body: object, The request body.
    The object takes the form of:

{ # Configuration for a Recommender.
  "annotations": { # Allows clients to store small amounts of arbitrary data. Annotations must follow the Kubernetes syntax. The total size of all keys and values combined is limited to 256k. Key can have 2 segments: prefix (optional) and name (required), separated by a slash (/). Prefix must be a DNS subdomain. Name must be 63 characters or less, begin and end with alphanumerics, with dashes (-), underscores (_), dots (.), and alphanumerics between.
    "a_key": "A String",
  },
  "displayName": "A String", # A user-settable field to provide a human-readable name to be used in user interfaces.
  "etag": "A String", # Fingerprint of the RecommenderConfig. Provides optimistic locking when updating.
  "name": "A String", # Name of recommender config. Eg, projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/config
  "recommenderGenerationConfig": { # A Configuration to customize the generation of recommendations. Eg, customizing the lookback period considered when generating a recommendation. # RecommenderGenerationConfig which configures the Generation of recommendations for this recommender.
    "params": { # Parameters for this RecommenderGenerationConfig. These configs can be used by or are applied to all subtypes.
      "a_key": "", # Properties of the object.
    },
  },
  "revisionId": "A String", # Output only. Immutable. The revision ID of the config. A new revision is committed whenever the config is changed in any way. The format is an 8-character hexadecimal string.
  "updateTime": "A String", # Last time when the config was updated.
}

  updateMask: string, The list of fields to be updated.
  validateOnly: boolean, If true, validate the request and preview the change, but do not actually update it.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Configuration for a Recommender.
  "annotations": { # Allows clients to store small amounts of arbitrary data. Annotations must follow the Kubernetes syntax. The total size of all keys and values combined is limited to 256k. Key can have 2 segments: prefix (optional) and name (required), separated by a slash (/). Prefix must be a DNS subdomain. Name must be 63 characters or less, begin and end with alphanumerics, with dashes (-), underscores (_), dots (.), and alphanumerics between.
    "a_key": "A String",
  },
  "displayName": "A String", # A user-settable field to provide a human-readable name to be used in user interfaces.
  "etag": "A String", # Fingerprint of the RecommenderConfig. Provides optimistic locking when updating.
  "name": "A String", # Name of recommender config. Eg, projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/config
  "recommenderGenerationConfig": { # A Configuration to customize the generation of recommendations. Eg, customizing the lookback period considered when generating a recommendation. # RecommenderGenerationConfig which configures the Generation of recommendations for this recommender.
    "params": { # Parameters for this RecommenderGenerationConfig. These configs can be used by or are applied to all subtypes.
      "a_key": "", # Properties of the object.
    },
  },
  "revisionId": "A String", # Output only. Immutable. The revision ID of the config. A new revision is committed whenever the config is changed in any way. The format is an 8-character hexadecimal string.
  "updateTime": "A String", # Last time when the config was updated.
}