Skip to main content

recommenders_config

Creates, updates, deletes, gets or lists a recommenders_config resource.

Overview

Namerecommenders_config
TypeResource
Idgoogle.recommender.recommenders_config

Fields

NameDatatypeDescription
namestringIdentifier. Name of recommender config. Eg, projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/config
annotationsobjectAllows 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.
displayNamestringA user-settable field to provide a human-readable name to be used in user interfaces.
etagstringFingerprint of the RecommenderConfig. Provides optimistic locking when updating.
recommenderGenerationConfigobjectA Configuration to customize the generation of recommendations. Eg, customizing the lookback period considered when generating a recommendation.
revisionIdstringOutput 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.
updateTimestringLast time when the config was updated.

Methods

NameAccessible byRequired ParamsDescription
billing_accounts_locations_recommenders_get_configSELECTbillingAccountsId, locationsId, recommendersIdGets the requested Recommender Config. There is only one instance of the config for each Recommender.
organizations_locations_recommenders_get_configSELECTlocationsId, organizationsId, recommendersIdGets the requested Recommender Config. There is only one instance of the config for each Recommender.
projects_locations_recommenders_get_configSELECTlocationsId, projectsId, recommendersIdGets the requested Recommender Config. There is only one instance of the config for each Recommender.
billing_accounts_locations_recommenders_update_configUPDATEbillingAccountsId, locationsId, recommendersIdUpdates a Recommender Config. This will create a new revision of the config.
organizations_locations_recommenders_update_configUPDATElocationsId, organizationsId, recommendersIdUpdates a Recommender Config. This will create a new revision of the config.
projects_locations_recommenders_update_configUPDATElocationsId, projectsId, recommendersIdUpdates a Recommender Config. This will create a new revision of the config.

SELECT examples

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

SELECT
name,
annotations,
displayName,
etag,
recommenderGenerationConfig,
revisionId,
updateTime
FROM google.recommender.recommenders_config
WHERE locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}'
AND recommendersId = '{{ recommendersId }}';

UPDATE example

Updates a recommenders_config resource.

/*+ update */
UPDATE google.recommender.recommenders_config
SET
displayName = '{{ displayName }}',
name = '{{ name }}',
etag = '{{ etag }}',
recommenderGenerationConfig = '{{ recommenderGenerationConfig }}',
annotations = '{{ annotations }}'
WHERE
locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}'
AND recommendersId = '{{ recommendersId }}';