Discovery Engine API (discoveryengine:v1alpha)

2024-10-17

5 new methods | 2 updated methods

Additions

    Methods
  • discoveryengine.projects.locations.updateCmekConfig

      Path : v1alpha/{+name}

      Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/cmekConfig

      HTTP Method : PATCH

      Parameters :

        name

          Description : Required. Name of the CmekConfig, of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`.

          Pattern : ^projects/[^/]+/locations/[^/]+/cmekConfig$

          Location : path

          Required : Yes

          Type : string

        setDefault

          Description : Set the following CmekConfig as the default to be used for child resources if one is not specified.

          Location : query

          Type : boolean

      Parameter Order : name

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

      Description : Provisions a CMEK key for use in a location of a customer's project. This method will also conduct location validation on the provided cmekConfig to make sure the key is valid and can be used in the selected location.

  • discoveryengine.projects.locations.getCmekConfig

      Path : v1alpha/{+name}

      Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/cmekConfig

      HTTP Method : GET

      Parameters :

        name

          Description : Required. Resource name of CmekConfig, such as `projects/*/locations/*/cmekConfig` or `projects/*/locations/*/cmekConfigs/*`. If the caller does not have permission to access the CmekConfig, regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

          Pattern : ^projects/[^/]+/locations/[^/]+/cmekConfig$

          Location : path

          Required : Yes

          Type : string

      Parameter Order : name

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

      Description : Gets the CmekConfig.

  • discoveryengine.projects.locations.cmekConfigs.patch

      Path : v1alpha/{+name}

      Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/cmekConfigs/{cmekConfigsId}

      HTTP Method : PATCH

      Parameters :

        name

          Description : Required. Name of the CmekConfig, of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`.

          Pattern : ^projects/[^/]+/locations/[^/]+/cmekConfigs/[^/]+$

          Location : path

          Required : Yes

          Type : string

        setDefault

          Description : Set the following CmekConfig as the default to be used for child resources if one is not specified.

          Location : query

          Type : boolean

      Parameter Order : name

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

      Description : Provisions a CMEK key for use in a location of a customer's project. This method will also conduct location validation on the provided cmekConfig to make sure the key is valid and can be used in the selected location.

  • discoveryengine.projects.locations.cmekConfigs.get

      Path : v1alpha/{+name}

      Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/cmekConfigs/{cmekConfigsId}

      HTTP Method : GET

      Parameters :

        name

          Description : Required. Resource name of CmekConfig, such as `projects/*/locations/*/cmekConfig` or `projects/*/locations/*/cmekConfigs/*`. If the caller does not have permission to access the CmekConfig, regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

          Pattern : ^projects/[^/]+/locations/[^/]+/cmekConfigs/[^/]+$

          Location : path

          Required : Yes

          Type : string

      Parameter Order : name

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

      Description : Gets the CmekConfig.

  • discoveryengine.projects.locations.cmekConfigs.list

      Path : v1alpha/{+parent}/cmekConfigs

      Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/cmekConfigs

      HTTP Method : GET

      Parameters :

        parent

          Description : Required. The parent location resource name, such as `projects/{project}/locations/{location}`. If the caller does not have permission to list CmekConfigs under this location, regardless of whether or not a CmekConfig exists, a PERMISSION_DENIED error is returned.

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

          Location : path

          Required : Yes

          Type : string

      Parameter Order : parent

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

      Description : Lists all the CmekConfigs with the project.

Updates

    Methods
  • discoveryengine.projects.locations.collections.dataStores.create

      Parameters :

        cmekConfigName

          Description : Resource name of the CmekConfig to use for protecting this DataStore.

          Location : query

          Type : string

        disableCmek

          Description : DataStore without CMEK protections. If a default CmekConfig is set for the project, setting this field will override the default CmekConfig as well.

          Location : query

          Type : boolean

  • discoveryengine.projects.locations.dataStores.create

      Parameters :

        cmekConfigName

          Description : Resource name of the CmekConfig to use for protecting this DataStore.

          Location : query

          Type : string

        disableCmek

          Description : DataStore without CMEK protections. If a default CmekConfig is set for the project, setting this field will override the default CmekConfig as well.

          Location : query

          Type : boolean