Recommender API (recommender:v1)

Additions

Methods


• ▼ ▲ recommender.organizations.locations.recommenders.getConfig

  Path : v1/{+name}

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

  HTTP Method : GET

  Parameter Order : name

  Parameters :

  name

  Required : Yes

  Type : string

  Location : path

  Pattern : ^organizations/[^/]+/locations/[^/]+/recommenders/[^/]+/config$

  Description : 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`

  Scopes : https://www.googleapis.com/auth/cloud-platform

  Flat Path : v1/organizations/{organizationsId}/locations/{locationsId}/recommenders/{recommendersId}/config

• ▼ ▲ recommender.organizations.locations.recommenders.updateConfig

  Path : v1/{+name}

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

  Scopes : https://www.googleapis.com/auth/cloud-platform

  Parameters :

  validateOnly

  Type : boolean

  Location : query

  Description : If true, validate the request and preview the change, but do not actually update it.

  name

  Pattern : ^organizations/[^/]+/locations/[^/]+/recommenders/[^/]+/config$

  Required : Yes

  Type : string

  Location : path

  Description : Name of recommender config. Eg, projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/config

  updateMask

  Description : The list of fields to be updated.

  Format : google-fieldmask

  Type : string

  Location : query

  HTTP Method : PATCH

  Parameter Order : name

  Flat Path : v1/organizations/{organizationsId}/locations/{locationsId}/recommenders/{recommendersId}/config

• ▼ ▲ recommender.organizations.locations.insightTypes.updateConfig

  HTTP Method : PATCH

  Parameters :

  name

  Required : Yes

  Pattern : ^organizations/[^/]+/locations/[^/]+/insightTypes/[^/]+/config$

  Description : Name of insight type config. Eg, projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]/config

  Location : path

  Type : string

  updateMask

  Format : google-fieldmask

  Description : The list of fields to be updated.

  Type : string

  Location : query

  validateOnly

  Type : boolean

  Description : If true, validate the request and preview the change, but do not actually update it.

  Location : query

  Parameter Order : name

  Path : v1/{+name}

  Flat Path : v1/organizations/{organizationsId}/locations/{locationsId}/insightTypes/{insightTypesId}/config

  Scopes : https://www.googleapis.com/auth/cloud-platform

  Description : Updates an InsightTypeConfig change. This will create a new revision of the config.

• ▼ ▲ recommender.organizations.locations.insightTypes.getConfig

  Flat Path : v1/organizations/{organizationsId}/locations/{locationsId}/insightTypes/{insightTypesId}/config

  HTTP Method : GET

  Path : v1/{+name}

  Parameter Order : name

  Description : Gets the requested InsightTypeConfig. There is only one instance of the config for each InsightType.

  Parameters :

  name

  Description : Required. Name of the InsightTypeConfig to get. Acceptable formats: * `projects/[PROJECT_NUMBER]/locations/global/recommenders/[INSIGHT_TYPE_ID]/config` * `projects/[PROJECT_ID]/locations/global/recommenders/[INSIGHT_TYPE_ID]/config` * `organizations/[ORGANIZATION_ID]/locations/global/recommenders/[INSIGHT_TYPE_ID]/config`

  Location : path

  Required : Yes

  Type : string

  Pattern : ^organizations/[^/]+/locations/[^/]+/insightTypes/[^/]+/config$

  Scopes : https://www.googleapis.com/auth/cloud-platform

• ▼ ▲ recommender.projects.locations.insightTypes.getConfig

  Flat Path : v1/projects/{projectsId}/locations/{locationsId}/insightTypes/{insightTypesId}/config

  Description : Gets the requested InsightTypeConfig. There is only one instance of the config for each InsightType.

  Path : v1/{+name}

  Parameter Order : name

  Scopes : https://www.googleapis.com/auth/cloud-platform

  HTTP Method : GET

  Parameters :

  name

  Pattern : ^projects/[^/]+/locations/[^/]+/insightTypes/[^/]+/config$

  Description : Required. Name of the InsightTypeConfig to get. Acceptable formats: * `projects/[PROJECT_NUMBER]/locations/global/recommenders/[INSIGHT_TYPE_ID]/config` * `projects/[PROJECT_ID]/locations/global/recommenders/[INSIGHT_TYPE_ID]/config` * `organizations/[ORGANIZATION_ID]/locations/global/recommenders/[INSIGHT_TYPE_ID]/config`

  Required : Yes

  Location : path

  Type : string

• ▼ ▲ recommender.projects.locations.insightTypes.updateConfig

  Parameter Order : name

  HTTP Method : PATCH

  Scopes : https://www.googleapis.com/auth/cloud-platform

  Parameters :

  name

  Location : path

  Pattern : ^projects/[^/]+/locations/[^/]+/insightTypes/[^/]+/config$

  Required : Yes

  Description : Name of insight type config. Eg, projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]/config

  Type : string

  updateMask

  Type : string

  Format : google-fieldmask

  Location : query

  Description : The list of fields to be updated.

  validateOnly

  Description : If true, validate the request and preview the change, but do not actually update it.

  Location : query

  Type : boolean

  Description : Updates an InsightTypeConfig change. This will create a new revision of the config.

  Flat Path : v1/projects/{projectsId}/locations/{locationsId}/insightTypes/{insightTypesId}/config

  Path : v1/{+name}

• ▼ ▲ recommender.projects.locations.recommenders.getConfig

  Parameters :

  name

  Type : string

  Required : Yes

  Pattern : ^projects/[^/]+/locations/[^/]+/recommenders/[^/]+/config$

  Description : 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`

  Location : path

  Parameter Order : name

  Path : v1/{+name}

  Flat Path : v1/projects/{projectsId}/locations/{locationsId}/recommenders/{recommendersId}/config

  HTTP Method : GET

  Scopes : https://www.googleapis.com/auth/cloud-platform

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

• ▼ ▲ recommender.projects.locations.recommenders.updateConfig

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

  Scopes : https://www.googleapis.com/auth/cloud-platform

  Parameter Order : name

  Flat Path : v1/projects/{projectsId}/locations/{locationsId}/recommenders/{recommendersId}/config

  Parameters :

  validateOnly

  Description : If true, validate the request and preview the change, but do not actually update it.

  Location : query

  Type : boolean

  updateMask

  Description : The list of fields to be updated.

  Type : string

  Format : google-fieldmask

  Location : query

  name

  Description : Name of recommender config. Eg, projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/config

  Required : Yes

  Type : string

  Location : path

  Pattern : ^projects/[^/]+/locations/[^/]+/recommenders/[^/]+/config$

  HTTP Method : PATCH

  Path : v1/{+name}