Recommender API (recommender:v1)

2022-03-25

8 new methods

Additions

    Methods
  • recommender.projects.locations.insightTypes.getConfig

      Parameters :

        name

          Type : string

          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

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

          Required : Yes

      Parameter Order : name

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

      HTTP Method : GET

      Path : v1/{+name}

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

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

  • recommender.projects.locations.insightTypes.updateConfig

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

      HTTP Method : PATCH

      Path : v1/{+name}

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

      Parameters :

        validateOnly

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

          Type : boolean

          Location : query

        name

          Required : Yes

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

          Type : string

          Location : path

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

        updateMask

          Description : The list of fields to be updated.

          Format : google-fieldmask

          Location : query

          Type : string

      Parameter Order : name

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

  • recommender.projects.locations.recommenders.getConfig

      HTTP Method : GET

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

      Path : v1/{+name}

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

      Parameter Order : name

      Parameters :

        name

          Location : path

          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`

          Type : string

          Required : Yes

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

  • recommender.projects.locations.recommenders.updateConfig

      Parameters :

        validateOnly

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

          Location : query

          Type : boolean

        name

          Location : path

          Required : Yes

          Type : string

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

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

        updateMask

          Format : google-fieldmask

          Type : string

          Description : The list of fields to be updated.

          Location : query

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

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

      Path : v1/{+name}

      HTTP Method : PATCH

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

      Parameter Order : name

  • recommender.organizations.locations.insightTypes.getConfig

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

      Parameters :

        name

          Pattern : ^organizations/[^/]+/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

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

      Path : v1/{+name}

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

      HTTP Method : GET

      Parameter Order : name

  • recommender.organizations.locations.insightTypes.updateConfig

      HTTP Method : PATCH

      Parameter Order : name

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

      Parameters :

        validateOnly

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

          Location : query

          Type : boolean

        updateMask

          Format : google-fieldmask

          Description : The list of fields to be updated.

          Location : query

          Type : string

        name

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

          Type : string

          Location : path

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

          Required : Yes

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

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

      Path : v1/{+name}

  • recommender.organizations.locations.recommenders.updateConfig

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

      Path : v1/{+name}

      Parameters :

        updateMask

          Format : google-fieldmask

          Location : query

          Description : The list of fields to be updated.

          Type : string

        validateOnly

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

          Type : boolean

          Location : query

        name

          Required : Yes

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

          Type : string

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

          Location : path

      Parameter Order : name

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

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

      HTTP Method : PATCH

  • recommender.organizations.locations.recommenders.getConfig

      Parameters :

        name

          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`

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

          Type : string

          Required : Yes

          Location : path

      Parameter Order : name

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

      HTTP Method : GET

      Path : v1/{+name}

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

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