recommenders_config

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

Overview

Name	recommenders_config
Type	Resource
Id	google.recommender.recommenders_config

Fields

The following fields are returned by SELECT queries:

projects_locations_recommenders_get_config

Successful response

Name	Datatype	Description
name	string	Identifier. Name of recommender config. Eg, projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/config
annotations	object	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.
displayName	string	A user-settable field to provide a human-readable name to be used in user interfaces.
etag	string	Fingerprint of the RecommenderConfig. Provides optimistic locking when updating.
recommenderGenerationConfig	object	RecommenderGenerationConfig which configures the Generation of recommendations for this recommender. (id: GoogleCloudRecommenderV1RecommenderGenerationConfig)
revisionId	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	string (google-datetime)	Last time when the config was updated.

billing_accounts_locations_recommenders_get_config

Successful response

Name	Datatype	Description
name	string	Identifier. Name of recommender config. Eg, projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/config
annotations	object	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.
displayName	string	A user-settable field to provide a human-readable name to be used in user interfaces.
etag	string	Fingerprint of the RecommenderConfig. Provides optimistic locking when updating.
recommenderGenerationConfig	object	RecommenderGenerationConfig which configures the Generation of recommendations for this recommender. (id: GoogleCloudRecommenderV1RecommenderGenerationConfig)
revisionId	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	string (google-datetime)	Last time when the config was updated.

organizations_locations_recommenders_get_config

Successful response

Name	Datatype	Description
name	string	Identifier. Name of recommender config. Eg, projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/config
annotations	object	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.
displayName	string	A user-settable field to provide a human-readable name to be used in user interfaces.
etag	string	Fingerprint of the RecommenderConfig. Provides optimistic locking when updating.
recommenderGenerationConfig	object	RecommenderGenerationConfig which configures the Generation of recommendations for this recommender. (id: GoogleCloudRecommenderV1RecommenderGenerationConfig)
revisionId	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	string (google-datetime)	Last time when the config was updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
projects_locations_recommenders_get_config	select	projectsId, locationsId, recommendersId		Gets the requested Recommender Config. There is only one instance of the config for each Recommender.
billing_accounts_locations_recommenders_get_config	select	billingAccountsId, locationsId, recommendersId		Gets the requested Recommender Config. There is only one instance of the config for each Recommender.
organizations_locations_recommenders_get_config	select	organizationsId, locationsId, recommendersId		Gets the requested Recommender Config. There is only one instance of the config for each Recommender.
projects_locations_recommenders_update_config	update	projectsId, locationsId, recommendersId	updateMask, validateOnly	Updates a Recommender Config. This will create a new revision of the config.
billing_accounts_locations_recommenders_update_config	update	billingAccountsId, locationsId, recommendersId	updateMask, validateOnly	Updates a Recommender Config. This will create a new revision of the config.
organizations_locations_recommenders_update_config	update	organizationsId, locationsId, recommendersId	updateMask, validateOnly	Updates a Recommender Config. This will create a new revision of the config.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
billingAccountsId	string
locationsId	string
organizationsId	string
projectsId	string
recommendersId	string
updateMask	string (google-fieldmask)
validateOnly	boolean

SELECT examples

projects_locations_recommenders_get_config

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 projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND recommendersId = '{{ recommendersId }}' -- required;

billing_accounts_locations_recommenders_get_config

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 billingAccountsId = '{{ billingAccountsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND recommendersId = '{{ recommendersId }}' -- required;

organizations_locations_recommenders_get_config

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 organizationsId = '{{ organizationsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND recommendersId = '{{ recommendersId }}' -- required;

UPDATE examples

projects_locations_recommenders_update_config

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

UPDATE google.recommender.recommenders_config
SET 
data__name = '{{ name }}',
data__recommenderGenerationConfig = '{{ recommenderGenerationConfig }}',
data__etag = '{{ etag }}',
data__updateTime = '{{ updateTime }}',
data__annotations = '{{ annotations }}',
data__displayName = '{{ displayName }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND recommendersId = '{{ recommendersId }}' --required
AND updateMask = '{{ updateMask}}'
AND validateOnly = {{ validateOnly}}
RETURNING
name,
annotations,
displayName,
etag,
recommenderGenerationConfig,
revisionId,
updateTime;

billing_accounts_locations_recommenders_update_config

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

UPDATE google.recommender.recommenders_config
SET 
data__name = '{{ name }}',
data__recommenderGenerationConfig = '{{ recommenderGenerationConfig }}',
data__etag = '{{ etag }}',
data__updateTime = '{{ updateTime }}',
data__annotations = '{{ annotations }}',
data__displayName = '{{ displayName }}'
WHERE 
billingAccountsId = '{{ billingAccountsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND recommendersId = '{{ recommendersId }}' --required
AND updateMask = '{{ updateMask}}'
AND validateOnly = {{ validateOnly}}
RETURNING
name,
annotations,
displayName,
etag,
recommenderGenerationConfig,
revisionId,
updateTime;

organizations_locations_recommenders_update_config

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

UPDATE google.recommender.recommenders_config
SET 
data__name = '{{ name }}',
data__recommenderGenerationConfig = '{{ recommenderGenerationConfig }}',
data__etag = '{{ etag }}',
data__updateTime = '{{ updateTime }}',
data__annotations = '{{ annotations }}',
data__displayName = '{{ displayName }}'
WHERE 
organizationsId = '{{ organizationsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND recommendersId = '{{ recommendersId }}' --required
AND updateMask = '{{ updateMask}}'
AND validateOnly = {{ validateOnly}}
RETURNING
name,
annotations,
displayName,
etag,
recommenderGenerationConfig,
revisionId,
updateTime;