Application Integration API (integrations:v1alpha)

2022-12-21

89 new methods | New API

Additions

    Methods
  • integrations.connectorPlatformRegions.enumerate

      Description : Enumerates the regions for which Connector Platform is provisioned.

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

      Path : v1alpha/connectorPlatformRegions:enumerate

      Flat Path : v1alpha/connectorPlatformRegions:enumerate

      HTTP Method : GET

  • integrations.projects.locations.appsScriptProjects.link

      Description : Links a existing Apps Script project.

      Parameters :

        parent

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

          Location : path

          Required : Yes

          Type : string

          Description : Required. The project that the executed integration belongs to.

      Path : v1alpha/{+parent}/appsScriptProjects:link

      HTTP Method : POST

      Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/appsScriptProjects:link

      Parameter Order : parent

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

  • integrations.projects.locations.appsScriptProjects.create

      Parameters :

        parent

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

          Description : Required. The project that the executed integration belongs to.

          Location : path

          Required : Yes

          Type : string

      Path : v1alpha/{+parent}/appsScriptProjects

      Parameter Order : parent

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

      Description : Creates an Apps Script project.

      HTTP Method : POST

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

  • integrations.projects.locations.sfdcInstances.sfdcChannels.patch

      Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/sfdcInstances/{sfdcInstancesId}/sfdcChannels/{sfdcChannelsId}

      Description : Updates an sfdc channel. Updates the sfdc channel in spanner. Returns the sfdc channel.

      Path : v1alpha/{+name}

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

      HTTP Method : PATCH

      Parameter Order : name

      Parameters :

        updateMask

          Location : query

          Description : Field mask specifying the fields in the above SfdcChannel that have been modified and need to be updated.

          Type : string

          Format : google-fieldmask

        name

          Type : string

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

          Required : Yes

          Location : path

          Description : Resource name of the SFDC channel projects/{project}/locations/{location}/sfdcInstances/{sfdc_instance}/sfdcChannels/{sfdc_channel}.

  • integrations.projects.locations.sfdcInstances.sfdcChannels.get

      Path : v1alpha/{+name}

      HTTP Method : GET

      Parameters :

        name

          Description : Required. The name that is associated with the SfdcChannel.

          Type : string

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

          Location : path

          Required : Yes

      Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/sfdcInstances/{sfdcInstancesId}/sfdcChannels/{sfdcChannelsId}

      Description : Gets an sfdc channel. If the channel doesn't exist, Code.NOT_FOUND exception will be thrown.

      Parameter Order : name

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

  • integrations.projects.locations.sfdcInstances.sfdcChannels.create

      Parameter Order : parent

      Description : Creates an sfdc channel record. Store the sfdc channel in Spanner. Returns the sfdc channel.

      Path : v1alpha/{+parent}/sfdcChannels

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

      Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/sfdcInstances/{sfdcInstancesId}/sfdcChannels

      Parameters :

        parent

          Description : Required. "projects/{project}/locations/{location}" format.

          Required : Yes

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

          Location : path

          Type : string

      HTTP Method : POST

  • integrations.projects.locations.sfdcInstances.sfdcChannels.delete

      Parameters :

        name

          Description : Required. The name that is associated with the SfdcChannel.

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

          Required : Yes

          Location : path

          Type : string

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

      Parameter Order : name

      Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/sfdcInstances/{sfdcInstancesId}/sfdcChannels/{sfdcChannelsId}

      Description : Deletes an sfdc channel.

      Path : v1alpha/{+name}

      HTTP Method : DELETE

  • integrations.projects.locations.sfdcInstances.sfdcChannels.list

      Parameter Order : parent

      HTTP Method : GET

      Description : Lists all sfdc channels that match the filter. Restrict to sfdc channels belonging to the current client only.

      Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/sfdcInstances/{sfdcInstancesId}/sfdcChannels

      Path : v1alpha/{+parent}/sfdcChannels

      Parameters :

        parent

          Location : path

          Type : string

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

          Description : Required. The client, which owns this collection of SfdcChannels.

          Required : Yes

        pageToken

          Type : string

          Location : query

          Description : The token returned in the previous response.

        pageSize

          Location : query

          Format : int32

          Description : The size of entries in the response. If unspecified, defaults to 100.

          Type : integer

        filter

          Location : query

          Description : Filtering as supported in https://developers.google.com/authorized-buyers/apis/guides/v2/list-filters.

          Type : string

        readMask

          Description : The mask which specifies fields that need to be returned in the SfdcChannel's response.

          Format : google-fieldmask

          Location : query

          Type : string

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

  • integrations.projects.locations.sfdcInstances.create

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

      Parameter Order : parent

      Description : Creates an sfdc instance record. Store the sfdc instance in Spanner. Returns the sfdc instance.

      Path : v1alpha/{+parent}/sfdcInstances

      Parameters :

        parent

          Description : Required. "projects/{project}/locations/{location}" format.

          Location : path

          Type : string

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

          Required : Yes

      HTTP Method : POST

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

  • integrations.projects.locations.sfdcInstances.list

      Parameter Order : parent

      Parameters :

        filter

          Type : string

          Description : Filtering as supported in https://developers.google.com/authorized-buyers/apis/guides/v2/list-filters.

          Location : query

        readMask

          Format : google-fieldmask

          Type : string

          Description : The mask which specifies fields that need to be returned in the SfdcInstance's response.

          Location : query

        pageToken

          Type : string

          Description : The token returned in the previous response.

          Location : query

        parent

          Description : Required. The client, which owns this collection of SfdcInstances.

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

          Type : string

          Location : path

          Required : Yes

        pageSize

          Description : The size of entries in the response. If unspecified, defaults to 100.

          Location : query

          Type : integer

          Format : int32

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

      Path : v1alpha/{+parent}/sfdcInstances

      HTTP Method : GET

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

      Description : Lists all sfdc instances that match the filter. Restrict to sfdc instances belonging to the current client only.

  • integrations.projects.locations.sfdcInstances.delete

      HTTP Method : DELETE

      Path : v1alpha/{+name}

      Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/sfdcInstances/{sfdcInstancesId}

      Parameters :

        name

          Type : string

          Required : Yes

          Location : path

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

          Description : Required. The name that is associated with the SfdcInstance.

      Parameter Order : name

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

      Description : Deletes an sfdc instance.

  • integrations.projects.locations.sfdcInstances.get

      Parameters :

        name

          Location : path

          Description : Required. The name that is associated with the SfdcInstance.

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

          Type : string

          Required : Yes

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

      Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/sfdcInstances/{sfdcInstancesId}

      Path : v1alpha/{+name}

      HTTP Method : GET

      Description : Gets an sfdc instance. If the instance doesn't exist, Code.NOT_FOUND exception will be thrown.

      Parameter Order : name

  • integrations.projects.locations.sfdcInstances.patch

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

      Parameter Order : name

      Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/sfdcInstances/{sfdcInstancesId}

      HTTP Method : PATCH

      Description : Updates an sfdc instance. Updates the sfdc instance in spanner. Returns the sfdc instance.

      Path : v1alpha/{+name}

      Parameters :

        name

          Location : path

          Type : string

          Required : Yes

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

          Description : Resource name of the SFDC instance projects/{project}/locations/{location}/sfdcInstances/{sfdcInstance}.

        updateMask

          Format : google-fieldmask

          Location : query

          Type : string

          Description : Field mask specifying the fields in the above SfdcInstance that have been modified and need to be updated.

  • integrations.projects.locations.connections.runtimeEntitySchemas.list

      Path : v1alpha/{+parent}/runtimeEntitySchemas

      Description : Lists the JSON schemas for the properties of runtime entities, filtered by entity name.

      Parameters :

        pageToken

          Description : Page token.

          Location : query

          Type : string

        parent

          Type : string

          Description : Required. Parent resource of RuntimeEntitySchema. Format: projects/{project}/locations/{location}/connections/{connection}

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

          Required : Yes

          Location : path

        pageSize

          Location : query

          Type : integer

          Format : int32

          Description : Page size.

        filter

          Description : Filter. Only the entity field with literal equality operator is supported.

          Type : string

          Location : query

      HTTP Method : GET

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

      Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/runtimeEntitySchemas

      Parameter Order : parent

  • integrations.projects.locations.connections.runtimeActionSchemas.list

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

      Parameters :

        parent

          Required : Yes

          Type : string

          Location : path

          Description : Required. Parent resource of RuntimeActionSchema. Format: projects/{project}/locations/{location}/connections/{connection}

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

        pageSize

          Description : Page size.

          Type : integer

          Format : int32

          Location : query

        pageToken

          Description : Page token.

          Location : query

          Type : string

        filter

          Description : Filter. Only the action field with literal equality operator is supported.

          Location : query

          Type : string

      Description : Lists the JSON schemas for the inputs and outputs of actions, filtered by action name.

      Path : v1alpha/{+parent}/runtimeActionSchemas

      Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/runtimeActionSchemas

      Parameter Order : parent

      HTTP Method : GET

  • integrations.projects.locations.connections.list

      Parameters :

        pageSize

          Format : int32

          Type : integer

          Location : query

          Description : Page size.

        pageToken

          Description : Page token.

          Type : string

          Location : query

        filter

          Description : Filter.

          Type : string

          Location : query

        orderBy

          Description : Order by parameters.

          Location : query

          Type : string

        parent

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

          Required : Yes

          Location : path

          Description : Required. Parent resource of the Connection, of the form: `projects/*/locations/*`

          Type : string

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

      Parameter Order : parent

      HTTP Method : GET

      Path : v1alpha/{+parent}/connections

      Description : Lists Connections in a given project and location.

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

  • integrations.projects.locations.connections.getConnectionSchemaMetadata

      Parameters :

        name

          Location : path

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

          Description : Required. ConnectionSchemaMetadata name. Format: projects/{project}/locations/{location}/connections/{connection}/connectionSchemaMetadata

          Type : string

          Required : Yes

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

      Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/connectionSchemaMetadata

      HTTP Method : GET

      Path : v1alpha/{+name}

      Parameter Order : name

      Description : Lists the available entities and actions associated with a Connection.

  • integrations.projects.locations.certificates.get

      Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/certificates/{certificatesId}

      Path : v1alpha/{+name}

      Parameter Order : name

      Parameters :

        name

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

          Location : path

          Description : Required. The certificate to retrieve. Format: projects/{project}/locations/{location}/certificates/{certificate}

          Required : Yes

          Type : string

      HTTP Method : GET

      Description : Get a certificates in the specified project.

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

  • integrations.projects.locations.products.listTaskEntities

      Parameter Order : parent

      Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}:listTaskEntities

      Description : This is a UI only method and will be moved away. Returns a list of common tasks.

      Path : v1alpha/{+parent}:listTaskEntities

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

      Parameters :

        parent

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

          Location : path

          Required : Yes

          Type : string

          Description : Required. The location resource of the request. This is not going to be used but preserve the field for future.

      HTTP Method : GET

  • integrations.projects.locations.products.createBundle

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

      Parameter Order : parent

      Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}:createBundle

      Description : PROTECT WITH A VISIBILITY LABEL. THIS METHOD WILL BE MOVED TO A SEPARATE SERVICE. Create a bundle.

      Path : v1alpha/{+parent}:createBundle

      Parameters :

        parent

          Type : string

          Description : Required. The location resource of the request.

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

          Required : Yes

          Location : path

      HTTP Method : POST

  • integrations.projects.locations.products.sfdcInstances.sfdcChannels.create

      Parameter Order : parent

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

      Parameters :

        parent

          Required : Yes

          Type : string

          Description : Required. "projects/{project}/locations/{location}" format.

          Location : path

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

      Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/sfdcInstances/{sfdcInstancesId}/sfdcChannels

      Path : v1alpha/{+parent}/sfdcChannels

      HTTP Method : POST

      Description : Creates an sfdc channel record. Store the sfdc channel in Spanner. Returns the sfdc channel.

  • integrations.projects.locations.products.sfdcInstances.sfdcChannels.patch

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

      Description : Updates an sfdc channel. Updates the sfdc channel in spanner. Returns the sfdc channel.

      Path : v1alpha/{+name}

      Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/sfdcInstances/{sfdcInstancesId}/sfdcChannels/{sfdcChannelsId}

      Parameters :

        name

          Required : Yes

          Location : path

          Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/sfdcInstances/[^/]+/sfdcChannels/[^/]+$

          Description : Resource name of the SFDC channel projects/{project}/locations/{location}/sfdcInstances/{sfdc_instance}/sfdcChannels/{sfdc_channel}.

          Type : string

        updateMask

          Format : google-fieldmask

          Description : Field mask specifying the fields in the above SfdcChannel that have been modified and need to be updated.

          Location : query

          Type : string

      Parameter Order : name

      HTTP Method : PATCH

  • integrations.projects.locations.products.sfdcInstances.sfdcChannels.get

      Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/sfdcInstances/{sfdcInstancesId}/sfdcChannels/{sfdcChannelsId}

      Path : v1alpha/{+name}

      Parameter Order : name

      HTTP Method : GET

      Parameters :

        name

          Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/sfdcInstances/[^/]+/sfdcChannels/[^/]+$

          Location : path

          Required : Yes

          Type : string

          Description : Required. The name that is associated with the SfdcChannel.

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

      Description : Gets an sfdc channel. If the channel doesn't exist, Code.NOT_FOUND exception will be thrown.

  • integrations.projects.locations.products.sfdcInstances.sfdcChannels.delete

      Parameters :

        name

          Type : string

          Required : Yes

          Description : Required. The name that is associated with the SfdcChannel.

          Location : path

          Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/sfdcInstances/[^/]+/sfdcChannels/[^/]+$

      Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/sfdcInstances/{sfdcInstancesId}/sfdcChannels/{sfdcChannelsId}

      Parameter Order : name

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

      HTTP Method : DELETE

      Description : Deletes an sfdc channel.

      Path : v1alpha/{+name}

  • integrations.projects.locations.products.sfdcInstances.sfdcChannels.list

      Path : v1alpha/{+parent}/sfdcChannels

      Description : Lists all sfdc channels that match the filter. Restrict to sfdc channels belonging to the current client only.

      HTTP Method : GET

      Parameter Order : parent

      Parameters :

        filter

          Type : string

          Location : query

          Description : Filtering as supported in https://developers.google.com/authorized-buyers/apis/guides/v2/list-filters.

        pageSize

          Type : integer

          Format : int32

          Location : query

          Description : The size of entries in the response. If unspecified, defaults to 100.

        pageToken

          Type : string

          Description : The token returned in the previous response.

          Location : query

        parent

          Description : Required. The client, which owns this collection of SfdcChannels.

          Location : path

          Required : Yes

          Type : string

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

        readMask

          Type : string

          Location : query

          Description : The mask which specifies fields that need to be returned in the SfdcChannel's response.

          Format : google-fieldmask

      Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/sfdcInstances/{sfdcInstancesId}/sfdcChannels

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

  • integrations.projects.locations.products.sfdcInstances.get

      Parameters :

        name

          Description : Required. The name that is associated with the SfdcInstance.

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

          Location : path

          Type : string

          Required : Yes

      Description : Gets an sfdc instance. If the instance doesn't exist, Code.NOT_FOUND exception will be thrown.

      Path : v1alpha/{+name}

      Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/sfdcInstances/{sfdcInstancesId}

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

      Parameter Order : name

      HTTP Method : GET

  • integrations.projects.locations.products.sfdcInstances.create

      Parameter Order : parent

      Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/sfdcInstances

      Parameters :

        parent

          Location : path

          Type : string

          Required : Yes

          Description : Required. "projects/{project}/locations/{location}" format.

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

      HTTP Method : POST

      Description : Creates an sfdc instance record. Store the sfdc instance in Spanner. Returns the sfdc instance.

      Path : v1alpha/{+parent}/sfdcInstances

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

  • integrations.projects.locations.products.sfdcInstances.delete

      Path : v1alpha/{+name}

      HTTP Method : DELETE

      Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/sfdcInstances/{sfdcInstancesId}

      Description : Deletes an sfdc instance.

      Parameter Order : name

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

      Parameters :

        name

          Required : Yes

          Location : path

          Type : string

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

          Description : Required. The name that is associated with the SfdcInstance.

  • integrations.projects.locations.products.sfdcInstances.list

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

      Description : Lists all sfdc instances that match the filter. Restrict to sfdc instances belonging to the current client only.

      Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/sfdcInstances

      Parameters :

        pageToken

          Location : query

          Description : The token returned in the previous response.

          Type : string

        parent

          Required : Yes

          Type : string

          Location : path

          Description : Required. The client, which owns this collection of SfdcInstances.

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

        pageSize

          Description : The size of entries in the response. If unspecified, defaults to 100.

          Type : integer

          Format : int32

          Location : query

        readMask

          Location : query

          Type : string

          Description : The mask which specifies fields that need to be returned in the SfdcInstance's response.

          Format : google-fieldmask

        filter

          Description : Filtering as supported in https://developers.google.com/authorized-buyers/apis/guides/v2/list-filters.

          Type : string

          Location : query

      HTTP Method : GET

      Parameter Order : parent

      Path : v1alpha/{+parent}/sfdcInstances

  • integrations.projects.locations.products.sfdcInstances.patch

      HTTP Method : PATCH

      Parameters :

        updateMask

          Description : Field mask specifying the fields in the above SfdcInstance that have been modified and need to be updated.

          Location : query

          Type : string

          Format : google-fieldmask

        name

          Description : Resource name of the SFDC instance projects/{project}/locations/{location}/sfdcInstances/{sfdcInstance}.

          Location : path

          Required : Yes

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

          Type : string

      Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/sfdcInstances/{sfdcInstancesId}

      Path : v1alpha/{+name}

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

      Description : Updates an sfdc instance. Updates the sfdc instance in spanner. Returns the sfdc instance.

      Parameter Order : name

  • integrations.projects.locations.products.integrations.versions.deactivate

      Description : Sets the status of the ACTIVE integration to SNAPSHOT with a new tag "PREVIOUSLY_PUBLISHED" after validating it. The "HEAD" and "PUBLISH_REQUESTED" tags do not change. This RPC throws an exception if the version being snapshot is not ACTIVE. Audit fields added include action, action_by, action_timestamp.

      Parameters :

        name

          Location : path

          Description : Required. The version to deactivate. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{version}

          Required : Yes

          Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+/versions/[^/]+$

          Type : string

      Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions/{versionsId}:deactivate

      Parameter Order : name

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

      Path : v1alpha/{+name}:deactivate

      HTTP Method : POST

  • integrations.projects.locations.products.integrations.versions.getBundle

      HTTP Method : GET

      Parameter Order : name

      Description : PROTECT WITH A VISIBILITY LABEL. THIS METHOD WILL BE MOVED TO A SEPARATE SERVICE. RPC to get details of the Bundle

      Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions/{versionsId}:getBundle

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

      Path : v1alpha/{+name}:getBundle

      Parameters :

        name

          Location : path

          Type : string

          Description : Required. The bundle name.

          Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+/versions/[^/]+$

          Required : Yes

  • integrations.projects.locations.products.integrations.versions.publish

      Path : v1alpha/{+name}:publish

      Description : This RPC throws an exception if the integration is in ARCHIVED or ACTIVE state. This RPC throws an exception if the version being published is DRAFT, and if the `locked_by` user is not the same as the user performing the Publish. Audit fields updated include last_published_timestamp, last_published_by, last_modified_timestamp, last_modified_by. Any existing lock is on this integration is released.

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

      Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions/{versionsId}:publish

      Parameters :

        name

          Location : path

          Description : Required. The version to publish. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{version}

          Required : Yes

          Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+/versions/[^/]+$

          Type : string

      Parameter Order : name

      HTTP Method : POST

  • integrations.projects.locations.products.integrations.versions.archive

      HTTP Method : POST

      Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions/{versionsId}:archive

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

      Parameter Order : name

      Path : v1alpha/{+name}:archive

      Description : Soft-deletes the integration. Changes the status of the integration to ARCHIVED. If the integration being ARCHIVED is tagged as "HEAD", the tag is removed from this snapshot and set to the previous non-ARCHIVED snapshot. The PUBLISH_REQUESTED, DUE_FOR_DELETION tags are removed too. This RPC throws an exception if the version being archived is DRAFT, and if the `locked_by` user is not the same as the user performing the Archive. Audit fields updated include last_modified_timestamp, last_modified_by. Any existing lock is released when Archiving a integration. Currently, there is no unarchive mechanism.

      Parameters :

        name

          Required : Yes

          Type : string

          Description : Required. The version to archive. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{version}

          Location : path

          Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+/versions/[^/]+$

  • integrations.projects.locations.products.integrations.versions.validate

      Path : v1alpha/{+name}:validate

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

      Parameter Order : name

      Description : Validates the given integration. If the id doesn't exist, a NotFoundException is thrown. If validation fails a CanonicalCodeException is thrown. If there was no failure an empty response is returned.

      HTTP Method : POST

      Parameters :

        name

          Description : Required. The version to validate. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{version}

          Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+/versions/[^/]+$

          Type : string

          Location : path

          Required : Yes

      Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions/{versionsId}:validate

  • integrations.projects.locations.products.integrations.versions.takeoverEditLock

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

      HTTP Method : POST

      Parameter Order : integrationVersion

      Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions/{versionsId}:takeoverEditLock

      Path : v1alpha/{+integrationVersion}:takeoverEditLock

      Parameters :

        integrationVersion

          Type : string

          Location : path

          Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+/versions/[^/]+$

          Description : Required. The version to take over edit lock. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{version}

          Required : Yes

      Description : Clears the `locked_by` and `locked_at_timestamp`in the DRAFT version of this integration. It then performs the same action as the CreateDraftIntegrationVersion (i.e., copies the DRAFT version of the integration as a SNAPSHOT and then creates a new DRAFT version with the `locked_by` set to the `user_taking_over` and the `locked_at_timestamp` set to the current timestamp). Both the `locked_by` and `user_taking_over` are notified via email about the takeover. This RPC throws an exception if the integration is not in DRAFT status or if the `locked_by` and `locked_at_timestamp` fields are not set.The TakeoverEdit lock is treated the same as an edit of the integration, and hence shares ACLs with edit. Audit fields updated include last_modified_timestamp, last_modified_by.

  • integrations.projects.locations.products.integrations.versions.download

      Description : Downloads an integration. Retrieves the `IntegrationVersion` for a given `integration_id` and returns the response as a string.

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

      Parameters :

        name

          Location : path

          Required : Yes

          Type : string

          Description : Required. The version to download. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{version}

          Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+/versions/[^/]+$

        fileFormat

          Type : string

          Description : File format for download request.

          Enum Descriptions :

        • Unspecified file format
        • JSON File Format
        • YAML File Format
        • Location : query

          Enum :

        • FILE_FORMAT_UNSPECIFIED
        • JSON
        • YAML

      HTTP Method : GET

      Parameter Order : name

      Path : v1alpha/{+name}:download

      Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions/{versionsId}:download

  • integrations.projects.locations.products.integrations.versions.updateBundle

      HTTP Method : PATCH

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

      Description : THIS METHOD WILL BE MOVED TO A SEPARATE SERVICE. RPC to update the Bundle

      Path : v1alpha/{+name}:updateBundle

      Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions/{versionsId}:updateBundle

      Parameters :

        name

          Description : Required. Bundle name

          Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+/versions/[^/]+$

          Type : string

          Required : Yes

          Location : path

      Parameter Order : name

  • integrations.projects.locations.products.integrations.versions.patch

      Parameter Order : name

      Path : v1alpha/{+name}

      Parameters :

        name

          Location : path

          Required : Yes

          Description : Output only. Auto-generated primary key.

          Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+/versions/[^/]+$

          Type : string

        updateMask

          Type : string

          Format : google-fieldmask

          Location : query

          Description : Field mask specifying the fields in the above integration that have been modified and need to be updated.

      Description : Update a integration with a draft version in the specified project.

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

      HTTP Method : PATCH

      Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions/{versionsId}

  • integrations.projects.locations.products.integrations.versions.create

      Description : Create a integration with a draft version in the specified project.

      Path : v1alpha/{+parent}/versions

      HTTP Method : POST

      Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions

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

      Parameter Order : parent

      Parameters :

        parent

          Location : path

          Type : string

          Description : Required. The parent resource where this version will be created. Format: projects/{project}/locations/{location}/integrations/{integration}

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

          Required : Yes

        newIntegration

          Type : boolean

          Location : query

          Description : Set this flag to true, if draft version is to be created for a brand new integration. False, if the request is for an existing integration. For backward compatibility reasons, even if this flag is set to `false` and no existing integration is found, a new draft integration will still be created.

  • integrations.projects.locations.products.integrations.versions.get

      Parameters :

        name

          Location : path

          Description : Required. The version to retrieve. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{version}

          Required : Yes

          Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+/versions/[^/]+$

          Type : string

      Description : Get a integration in the specified project.

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

      HTTP Method : GET

      Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions/{versionsId}

      Path : v1alpha/{+name}

      Parameter Order : name

  • integrations.projects.locations.products.integrations.versions.list

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

      Parameter Order : parent

      Path : v1alpha/{+parent}/versions

      Description : Returns the list of all integration versions in the specified project.

      HTTP Method : GET

      Parameters :

        parent

          Required : Yes

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

          Type : string

          Description : Required. The parent resource where this version will be created. Format: projects/{project}/locations/{location}/integrations/{integration} Specifically, when parent equals: 1. projects//locations//integrations/, Meaning: "List versions (with filter) for a particular integration". 2. projects//locations//integrations/- Meaning: "List versions (with filter) for a client within a particular region". 3. projects//locations/-/integrations/- Meaning: "List versions (with filter) for a client".

          Location : path

        pageSize

          Location : query

          Description : The maximum number of versions to return. The service may return fewer than this value. If unspecified, at most 50 versions will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

          Format : int32

          Type : integer

        pageToken

          Type : string

          Description : A page token, received from a previous `ListIntegrationVersions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListIntegrationVersions` must match the call that provided the page token.

          Location : query

        filter

          Type : string

          Location : query

          Description : Filter on fields of IntegrationVersion. Fields can be compared with literal values by use of ":" (containment), "=" (equality), ">" (greater), "<" (less than), >=" (greater than or equal to), "<=" (less than or equal to), and "!=" (inequality) operators. Negation, conjunction, and disjunction are written using NOT, AND, and OR keywords. For example, organization_id=\"1\" AND state=ACTIVE AND description:"test". Filtering cannot be performed on repeated fields like `task_config`.

        fieldMask

          Type : string

          Description : The field mask which specifies the particular data to be returned.

          Location : query

          Format : google-fieldmask

        orderBy

          Location : query

          Type : string

          Description : The results would be returned in order you specified here. Currently supported sort keys are: Descending sort order for "last_modified_time", "created_time", "snapshot_number" Ascending sort order for "name".

      Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions

  • integrations.projects.locations.products.integrations.versions.upload

      Parameters :

        parent

          Type : string

          Required : Yes

          Location : path

          Description : Required. The version to upload. Format: projects/{project}/locations/{location}/integrations/{integration}

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

      Path : v1alpha/{+parent}/versions:upload

      Parameter Order : parent

      Description : Uploads an integration. The content can be a previously downloaded integration. Performs the same function as CreateDraftIntegrationVersion, but accepts input in a string format, which holds the complete representation of the IntegrationVersion content.

      HTTP Method : POST

      Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions:upload

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

  • integrations.projects.locations.products.integrations.executions.list

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

      Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/executions

      Path : v1alpha/{+parent}/executions

      Parameters :

        filterParams.taskStatuses

          Description : List of possible task statuses.

          Repeated : Yes

          Type : string

          Location : query

        filterParams.parameterKey

          Description : Param key. DEPRECATED. User parameter_pair_key instead.

          Location : query

          Type : string

        filterParams.eventStatuses

          Type : string

          Location : query

          Description : List of possible event statuses.

          Repeated : Yes

        pageToken

          Location : query

          Description : Optional. The token returned in the previous response.

          Type : string

        filterParams.workflowName

          Type : string

          Location : query

          Description : Workflow name.

        truncateParams

          Type : boolean

          Location : query

          Description : Optional. If true, the service will truncate the params to only keep the first 1000 characters of string params and empty the executions in order to make response smaller. Only works for UI and when the params fields are not filtered out.

        filterParams.startTime

          Description : Start timestamp.

          Type : string

          Format : int64

          Location : query

        refreshAcl

          Description : Optional. If true, the service will use the most recent acl information to list event execution infos and renew the acl cache. Note that fetching the most recent acl is synchronous, so it will increase RPC call latency.

          Type : boolean

          Location : query

        readMask

          Type : string

          Location : query

          Description : Optional. View mask for the response data. If set, only the field specified will be returned as part of the result. If not set, all fields in event execution info will be filled and returned.

          Format : google-fieldmask

        filterParams.parameterPairKey

          Location : query

          Type : string

          Description : Param key in the key value pair filter.

        orderBy

          Description : Optional. The results would be returned in order you specified here. Currently supporting "last_modified_time" and "create_time".

          Location : query

          Type : string

        filterParams.parameterPairValue

          Description : Param value in the key value pair filter.

          Location : query

          Type : string

        filterParams.endTime

          Type : string

          Description : End timestamp.

          Format : int64

          Location : query

        parent

          Required : Yes

          Description : Required. The parent resource name of the integration execution.

          Location : path

          Type : string

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

        filterParams.parameterType

          Type : string

          Description : Param type.

          Location : query

        filterParams.executionId

          Location : query

          Description : Execution id.

          Type : string

        pageSize

          Location : query

          Type : integer

          Description : Optional. The size of entries in the response.

          Format : int32

        filterParams.customFilter

          Type : string

          Location : query

          Description : Optional user-provided custom filter.

        filterParams.parameterValue

          Location : query

          Description : Param value. DEPRECATED. User parameter_pair_value instead.

          Type : string

        filter

          Description : Optional. Standard filter field, we support filtering on all fields in EventExecutionParamIndexes table. All fields support for EQUALS, in additional: CreateTimestamp support for LESS_THAN, GREATER_THAN ParameterKey, ParameterValue, ParameterType support for HAS For example: "parameter_value" HAS \"parameter1\" Also supports operators like AND, OR, NOT For example, trigger_id=\"id1\" AND event_execution_state=\"FAILED\"

          Type : string

          Location : query

      Description : Lists the results of all the integration executions. The response includes the same information as the [execution log](https://cloud.google.com/application-integration/docs/viewing-logs) in the Integration UI.

      Parameter Order : parent

      HTTP Method : GET

  • integrations.projects.locations.products.integrations.executions.cancel

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

      Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/executions/{executionsId}:cancel

      Description : Cancellation of an execution

      Parameter Order : name

      Path : v1alpha/{+name}:cancel

      HTTP Method : POST

      Parameters :

        name

          Description : Required. The execution resource name. Format: projects/{gcp_project_id}/locations/{location}/products/{product}/integrations/{integration_id}/executions/{execution_id}

          Location : path

          Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+/executions/[^/]+$

          Type : string

          Required : Yes

  • integrations.projects.locations.products.integrations.executions.get

      Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/executions/{executionsId}

      Description : Get an execution in the specified project.

      Path : v1alpha/{+name}

      Parameter Order : name

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

      Parameters :

        name

          Required : Yes

          Location : path

          Description : Required. The execution resource name. Format: projects/{gcp_project_id}/locations/{location}/products/{product}/integrations/{integration_id}/executions/{execution_id}

          Type : string

          Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+/executions/[^/]+$

      HTTP Method : GET

  • integrations.projects.locations.products.integrations.executions.suspensions.list

      Description : * Lists suspensions associated with a specific execution. Only those with permissions to resolve the relevant suspensions will be able to view them.

      Parameters :

        parent

          Type : string

          Location : path

          Required : Yes

          Description : Required. projects/{gcp_project_id}/locations/{location}/products/{product}/integrations/{integration_name}/executions/{execution_name}

          Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+/executions/[^/]+$

        pageSize

          Location : query

          Type : integer

          Description : Maximum number of entries in the response.

          Format : int32

        pageToken

          Type : string

          Location : query

          Description : Token to retrieve a specific page.

        orderBy

          Location : query

          Type : string

          Description : Field name to order by.

        filter

          Description : Standard filter field.

          Type : string

          Location : query

      Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/executions/{executionsId}/suspensions

      Parameter Order : parent

      Path : v1alpha/{+parent}/suspensions

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

      HTTP Method : GET

  • integrations.projects.locations.products.integrations.executions.suspensions.lift

      Path : v1alpha/{+name}:lift

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

      Parameter Order : name

      Description : * Lifts suspension for advanced suspension task. Fetch corresponding suspension with provided suspension Id, resolve suspension, and set up suspension result for the Suspension Task.

      Parameters :

        name

          Location : path

          Required : Yes

          Description : Required. The resource that the suspension belongs to. "projects/{project}/locations/{location}/products/{product}/integrations/{integration}/executions/{execution}/suspensions/{suspenion}" format.

          Type : string

          Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+/executions/[^/]+/suspensions/[^/]+$

      Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/executions/{executionsId}/suspensions/{suspensionsId}:lift

      HTTP Method : POST

  • integrations.projects.locations.products.integrations.executions.suspensions.resolve

      Parameters :

        name

          Required : Yes

          Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+/executions/[^/]+/suspensions/[^/]+$

          Type : string

          Description : Required. projects/{gcp_project_id}/locations/{location}/products/{product}/integrations/{integration_name}/executions/{execution_name}/suspensions/{suspension_id}

          Location : path

      Description : * Resolves (lifts/rejects) any number of suspensions. If the integration is already running, only the status of the suspension is updated. Otherwise, the suspended integration will begin execution again.

      Path : v1alpha/{+name}:resolve

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

      Parameter Order : name

      HTTP Method : POST

      Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/executions/{executionsId}/suspensions/{suspensionsId}:resolve

  • integrations.projects.locations.products.integrations.executionsnapshots.list

      Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/executionsnapshots

      Parameter Order : parent

      Description : Lists the snapshots of a given integration executions. This RPC is not being used.

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

      Path : v1alpha/{+parent}/executionsnapshots

      Parameters :

        readMask

          Type : string

          Description : View mask for the response data. If set, only the field specified will be returned as part of the result. If not set, all fields in event execution snapshot will be filled and returned.

          Location : query

          Format : google-fieldmask

        pageSize

          Type : integer

          Format : int32

          Location : query

          Description : Number of entries to be returned in a page.

        filter

          Type : string

          Description : Currently supports filter by `execution_info_id` or `execution_snapshot_id`.

          Location : query

        pageToken

          Location : query

          Description : The token used to retrieve the next page results.

          Type : string

        parent

          Type : string

          Required : Yes

          Location : path

          Description : Required. The parent resource name of the integration execution.

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

      HTTP Method : GET

  • integrations.projects.locations.products.integrations.schedule

      Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}:schedule

      HTTP Method : POST

      Path : v1alpha/{+name}:schedule

      Parameters :

        name

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

          Description : The integration resource name.

          Location : path

          Required : Yes

          Type : string

      Description : Schedules an integration for execution by passing the trigger id and the scheduled time in the request body.

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

      Parameter Order : name

  • integrations.projects.locations.products.integrations.execute

      Parameter Order : name

      HTTP Method : POST

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

      Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}:execute

      Description : Executes integrations synchronously by passing the trigger id in the request body. The request is not returned until the requested executions are either fulfilled or experienced an error. If the integration name is not specified (passing `-`), all of the associated integration under the given trigger_id will be executed. Otherwise only the specified integration for the given `trigger_id` is executed. This is helpful for execution the integration from UI.

      Parameters :

        name

          Location : path

          Required : Yes

          Type : string

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

          Description : Required. The integration resource name.

      Path : v1alpha/{+name}:execute

  • integrations.projects.locations.products.integrations.monitorexecutionstats

      Parameters :

        parent

          Location : path

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

          Description : Required. The parent resource name: {parent=projects/*/locations/*}.

          Required : Yes

          Type : string

      Path : v1alpha/{+parent}:monitorexecutionstats

      Parameter Order : parent

      Description : Get execution stats

      Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}:monitorexecutionstats

      HTTP Method : POST

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

  • integrations.projects.locations.products.integrations.archiveBundle

      HTTP Method : POST

      Path : v1alpha/{+name}:archiveBundle

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

      Parameter Order : name

      Description : PROTECT WITH A VISIBILITY LABEL. THIS METHOD WILL BE MOVED TO A SEPARATE SERVICE. Soft-deletes the bundle.

      Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}:archiveBundle

      Parameters :

        name

          Required : Yes

          Type : string

          Location : path

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

          Description : Required. The bundle to archive. Format: projects/{project}/locations/{location}/integrations/{integration}

  • integrations.projects.locations.products.integrations.list

      Parameter Order : parent

      Description : Returns the list of all integrations in the specified project.

      HTTP Method : GET

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

      Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations

      Path : v1alpha/{+parent}/integrations

      Parameters :

        orderBy

          Location : query

          Type : string

          Description : The results would be returned in order you specified here. Supported sort keys are: Descending sort order by "last_modified_time", "created_time", "snapshot_number". Ascending sort order by the integration name.

        pageToken

          Location : query

          Description : The page token for the resquest.

          Type : string

        filter

          Description : Filter on fields of IntegrationVersion. Fields can be compared with literal values by use of ":" (containment), "=" (equality), ">" (greater), "<" (less than), >=" (greater than or equal to), "<=" (less than or equal to), and "!=" (inequality) operators. Negation, conjunction, and disjunction are written using NOT, AND, and OR keywords. For example, organization_id=\"1\" AND state=ACTIVE AND description:"test". Filtering cannot be performed on repeated fields like `task_config`.

          Type : string

          Location : query

        parent

          Type : string

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

          Location : path

          Required : Yes

          Description : Required. Project and location from which the integrations should be listed. Format: projects/{project}

        pageSize

          Type : integer

          Location : query

          Description : The page size for the resquest.

          Format : int32

  • integrations.projects.locations.products.certificates.get

      Path : v1alpha/{+name}

      Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/certificates/{certificatesId}

      HTTP Method : GET

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

      Description : Get a certificates in the specified project.

      Parameter Order : name

      Parameters :

        name

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

          Type : string

          Location : path

          Description : Required. The certificate to retrieve. Format: projects/{project}/locations/{location}/certificates/{certificate}

          Required : Yes

  • integrations.projects.locations.products.certificates.list

      Path : v1alpha/{+parent}/certificates

      HTTP Method : GET

      Parameter Order : parent

      Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/certificates

      Parameters :

        pageToken

          Description : The token returned in the previous response.

          Type : string

          Location : query

        readMask

          Format : google-fieldmask

          Type : string

          Description : The mask which specifies fields that need to be returned in the Certificate's response.

          Location : query

        parent

          Description : Required. The client, which owns this collection of Certificates.

          Type : string

          Required : Yes

          Location : path

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

        pageSize

          Description : The size of entries in the response. If unspecified, defaults to 100.

          Location : query

          Format : int32

          Type : integer

        filter

          Description : Filtering as supported in https://developers.google.com/authorized-buyers/apis/guides/v2/list-filters.

          Type : string

          Location : query

      Description : List all the certificates that match the filter. Restrict to certificate of current client only.

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

  • integrations.projects.locations.products.certificates.delete

      Description : Delete a certificate

      Parameter Order : name

      Parameters :

        name

          Required : Yes

          Type : string

          Location : path

          Description : Required. The name that is associated with the Certificate.

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

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

      Path : v1alpha/{+name}

      HTTP Method : DELETE

      Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/certificates/{certificatesId}

  • integrations.projects.locations.products.certificates.patch

      Parameters :

        updateMask

          Location : query

          Description : Field mask specifying the fields in the above Certificate that have been modified and need to be updated.

          Format : google-fieldmask

          Type : string

        name

          Required : Yes

          Location : path

          Type : string

          Description : Output only. Auto generated primary key

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

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

      Parameter Order : name

      HTTP Method : PATCH

      Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/certificates/{certificatesId}

      Description : Updates the certificate by id. If new certificate file is updated, it will register with the trawler service, re-encrypt with cloud KMS and update the Spanner record. Other fields will directly update the Spanner record. Returns the Certificate.

      Path : v1alpha/{+name}

  • integrations.projects.locations.products.certificates.create

      HTTP Method : POST

      Description : Creates a new certificate. The certificate will be registered to the trawler service and will be encrypted using cloud KMS and stored in Spanner Returns the certificate.

      Parameter Order : parent

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

      Path : v1alpha/{+parent}/certificates

      Parameters :

        parent

          Description : Required. "projects/{project}/locations/{location}" format.

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

          Required : Yes

          Location : path

          Type : string

      Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/certificates

  • integrations.projects.locations.products.authConfigs.get

      Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/authConfigs/{authConfigsId}

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

      HTTP Method : GET

      Parameter Order : name

      Parameters :

        name

          Description : Required. The name that is associated with the AuthConfig.

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

          Required : Yes

          Type : string

          Location : path

      Description : Gets a complete auth config. If the auth config doesn't exist, Code.NOT_FOUND exception will be thrown. Returns the decrypted auth config.

      Path : v1alpha/{+name}

  • integrations.projects.locations.products.authConfigs.create

      Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/authConfigs

      Parameter Order : parent

      HTTP Method : POST

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

      Path : v1alpha/{+parent}/authConfigs

      Parameters :

        clientCertificate.sslCertificate

          Location : query

          Type : string

          Description : The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines. For example, -----BEGIN CERTIFICATE----- MIICTTCCAbagAwIBAgIJAPT0tSKNxan/MA0GCSqGSIb3DQEBCwUAMCoxFzAVBgNV BAoTDkdvb2dsZSBURVNUSU5HMQ8wDQYDVQQDEwZ0ZXN0Q0EwHhcNMTUwMTAxMDAw MDAwWhcNMjUwMTAxMDAwMDAwWjAuMRcwFQYDVQQKEw5Hb29nbGUgVEVTVElORzET MBEGA1UEAwwKam9lQGJhbmFuYTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA vDYFgMgxi5W488d9J7UpCInl0NXmZQpJDEHE4hvkaRlH7pnC71H0DLt0/3zATRP1 JzY2+eqBmbGl4/sgZKYv8UrLnNyQNUTsNx1iZAfPUflf5FwgVsai8BM0pUciq1NB xD429VFcrGZNucvFLh72RuRFIKH8WUpiK/iZNFkWhZ0CAwEAAaN3MHUwDgYDVR0P AQH/BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAMBgNVHRMB Af8EAjAAMBkGA1UdDgQSBBCVgnFBCWgL/iwCqnGrhTPQMBsGA1UdIwQUMBKAEKey Um2o4k2WiEVA0ldQvNYwDQYJKoZIhvcNAQELBQADgYEAYK986R4E3L1v+Q6esBtW JrUwA9UmJRSQr0N5w3o9XzarU37/bkjOP0Fw0k/A6Vv1n3vlciYfBFaBIam1qRHr 5dMsYf4CZS6w50r7hyzqyrwDoyNxkLnd2PdcHT/sym1QmflsjEs7pejtnohO6N2H wQW6M0H7Zt8claGRla4fKkg= -----END CERTIFICATE-----

        clientCertificate.passphrase

          Type : string

          Description : 'passphrase' should be left unset if private key is not encrypted. Note that 'passphrase' is not the password for web server, but an extra layer of security to protected private key.

          Location : query

        clientCertificate.encryptedPrivateKey

          Description : The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines. For example, -----BEGIN CERTIFICATE----- MIICTTCCAbagAwIBAgIJAPT0tSKNxan/MA0GCSqGSIb3DQEBCwUAMCoxFzAVBgNV BAoTDkdvb2dsZSBURVNUSU5HMQ8wDQYDVQQDEwZ0ZXN0Q0EwHhcNMTUwMTAxMDAw MDAwWhcNMjUwMTAxMDAwMDAwWjAuMRcwFQYDVQQKEw5Hb29nbGUgVEVTVElORzET MBEGA1UEAwwKam9lQGJhbmFuYTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA vDYFgMgxi5W488d9J7UpCInl0NXmZQpJDEHE4hvkaRlH7pnC71H0DLt0/3zATRP1 JzY2+eqBmbGl4/sgZKYv8UrLnNyQNUTsNx1iZAfPUflf5FwgVsai8BM0pUciq1NB xD429VFcrGZNucvFLh72RuRFIKH8WUpiK/iZNFkWhZ0CAwEAAaN3MHUwDgYDVR0P AQH/BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAMBgNVHRMB Af8EAjAAMBkGA1UdDgQSBBCVgnFBCWgL/iwCqnGrhTPQMBsGA1UdIwQUMBKAEKey Um2o4k2WiEVA0ldQvNYwDQYJKoZIhvcNAQELBQADgYEAYK986R4E3L1v+Q6esBtW JrUwA9UmJRSQr0N5w3o9XzarU37/bkjOP0Fw0k/A6Vv1n3vlciYfBFaBIam1qRHr 5dMsYf4CZS6w50r7hyzqyrwDoyNxkLnd2PdcHT/sym1QmflsjEs7pejtnohO6N2H wQW6M0H7Zt8claGRla4fKkg= -----END CERTIFICATE-----

          Type : string

          Location : query

        parent

          Required : Yes

          Location : path

          Description : Required. "projects/{project}/locations/{location}" format.

          Type : string

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

      Description : Creates an auth config record. Fetch corresponding credentials for specific auth types, e.g. access token for OAuth 2.0, JWT token for JWT. Encrypt the auth config with Cloud KMS and store the encrypted credentials in Spanner. Returns the encrypted auth config.

  • integrations.projects.locations.products.authConfigs.patch

      Description : Updates an auth config. If credential is updated, fetch the encrypted auth config from Spanner, decrypt with Cloud KMS key, update the credential fields, re-encrypt with Cloud KMS key and update the Spanner record. For other fields, directly update the Spanner record. Returns the encrypted auth config.

      Parameter Order : name

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

      Path : v1alpha/{+name}

      Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/authConfigs/{authConfigsId}

      Parameters :

        updateMask

          Format : google-fieldmask

          Location : query

          Type : string

          Description : Field mask specifying the fields in the above AuthConfig that have been modified and need to be updated.

        name

          Type : string

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

          Required : Yes

          Description : Resource name of the SFDC instance projects/{project}/locations/{location}/authConfigs/{authConfig}.

          Location : path

        clientCertificate.passphrase

          Location : query

          Description : 'passphrase' should be left unset if private key is not encrypted. Note that 'passphrase' is not the password for web server, but an extra layer of security to protected private key.

          Type : string

        clientCertificate.encryptedPrivateKey

          Type : string

          Location : query

          Description : The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines. For example, -----BEGIN CERTIFICATE----- MIICTTCCAbagAwIBAgIJAPT0tSKNxan/MA0GCSqGSIb3DQEBCwUAMCoxFzAVBgNV BAoTDkdvb2dsZSBURVNUSU5HMQ8wDQYDVQQDEwZ0ZXN0Q0EwHhcNMTUwMTAxMDAw MDAwWhcNMjUwMTAxMDAwMDAwWjAuMRcwFQYDVQQKEw5Hb29nbGUgVEVTVElORzET MBEGA1UEAwwKam9lQGJhbmFuYTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA vDYFgMgxi5W488d9J7UpCInl0NXmZQpJDEHE4hvkaRlH7pnC71H0DLt0/3zATRP1 JzY2+eqBmbGl4/sgZKYv8UrLnNyQNUTsNx1iZAfPUflf5FwgVsai8BM0pUciq1NB xD429VFcrGZNucvFLh72RuRFIKH8WUpiK/iZNFkWhZ0CAwEAAaN3MHUwDgYDVR0P AQH/BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAMBgNVHRMB Af8EAjAAMBkGA1UdDgQSBBCVgnFBCWgL/iwCqnGrhTPQMBsGA1UdIwQUMBKAEKey Um2o4k2WiEVA0ldQvNYwDQYJKoZIhvcNAQELBQADgYEAYK986R4E3L1v+Q6esBtW JrUwA9UmJRSQr0N5w3o9XzarU37/bkjOP0Fw0k/A6Vv1n3vlciYfBFaBIam1qRHr 5dMsYf4CZS6w50r7hyzqyrwDoyNxkLnd2PdcHT/sym1QmflsjEs7pejtnohO6N2H wQW6M0H7Zt8claGRla4fKkg= -----END CERTIFICATE-----

        clientCertificate.sslCertificate

          Location : query

          Type : string

          Description : The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines. For example, -----BEGIN CERTIFICATE----- MIICTTCCAbagAwIBAgIJAPT0tSKNxan/MA0GCSqGSIb3DQEBCwUAMCoxFzAVBgNV BAoTDkdvb2dsZSBURVNUSU5HMQ8wDQYDVQQDEwZ0ZXN0Q0EwHhcNMTUwMTAxMDAw MDAwWhcNMjUwMTAxMDAwMDAwWjAuMRcwFQYDVQQKEw5Hb29nbGUgVEVTVElORzET MBEGA1UEAwwKam9lQGJhbmFuYTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA vDYFgMgxi5W488d9J7UpCInl0NXmZQpJDEHE4hvkaRlH7pnC71H0DLt0/3zATRP1 JzY2+eqBmbGl4/sgZKYv8UrLnNyQNUTsNx1iZAfPUflf5FwgVsai8BM0pUciq1NB xD429VFcrGZNucvFLh72RuRFIKH8WUpiK/iZNFkWhZ0CAwEAAaN3MHUwDgYDVR0P AQH/BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAMBgNVHRMB Af8EAjAAMBkGA1UdDgQSBBCVgnFBCWgL/iwCqnGrhTPQMBsGA1UdIwQUMBKAEKey Um2o4k2WiEVA0ldQvNYwDQYJKoZIhvcNAQELBQADgYEAYK986R4E3L1v+Q6esBtW JrUwA9UmJRSQr0N5w3o9XzarU37/bkjOP0Fw0k/A6Vv1n3vlciYfBFaBIam1qRHr 5dMsYf4CZS6w50r7hyzqyrwDoyNxkLnd2PdcHT/sym1QmflsjEs7pejtnohO6N2H wQW6M0H7Zt8claGRla4fKkg= -----END CERTIFICATE-----

      HTTP Method : PATCH

  • integrations.projects.locations.products.authConfigs.list

      HTTP Method : GET

      Parameters :

        readMask

          Format : google-fieldmask

          Description : The mask which specifies fields that need to be returned in the AuthConfig's response.

          Location : query

          Type : string

        pageToken

          Type : string

          Description : The token returned in the previous response.

          Location : query

        filter

          Location : query

          Description : Filtering as supported in https://developers.google.com/authorized-buyers/apis/guides/v2/list-filters.

          Type : string

        pageSize

          Description : The size of entries in the response. If unspecified, defaults to 100.

          Type : integer

          Format : int32

          Location : query

        parent

          Location : path

          Type : string

          Description : Required. The client, which owns this collection of AuthConfigs.

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

          Required : Yes

      Parameter Order : parent

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

      Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/authConfigs

      Path : v1alpha/{+parent}/authConfigs

      Description : Lists all auth configs that match the filter. Restrict to auth configs belong to the current client only.

  • integrations.projects.locations.products.authConfigs.delete

      Description : Deletes an auth config.

      Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/authConfigs/{authConfigsId}

      Parameter Order : name

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

      Path : v1alpha/{+name}

      HTTP Method : DELETE

      Parameters :

        name

          Type : string

          Required : Yes

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

          Description : Required. The name that is associated with the AuthConfig.

          Location : path

  • integrations.projects.locations.products.integrationtemplates.versions.get

      HTTP Method : GET

      Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrationtemplates/{integrationtemplatesId}/versions/{versionsId}

      Description : Returns an IntegrationTemplateVersion in the specified project.

      Parameters :

        name

          Description : Required. The TemplateVersion to retrieve. Format: projects/{project}/locations/{location}/products/{product}/integrationtemplates/{integrationtemplate}/versions/{version}

          Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrationtemplates/[^/]+/versions/[^/]+$

          Type : string

          Required : Yes

          Location : path

      Path : v1alpha/{+name}

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

      Parameter Order : name

  • integrations.projects.locations.products.integrationtemplates.versions.create

      Parameter Order : parent

      HTTP Method : POST

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

      Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrationtemplates/{integrationtemplatesId}/versions

      Path : v1alpha/{+parent}/versions

      Parameters :

        parent

          Required : Yes

          Description : Required. The parent resource where this TemplateVersion will be created. Format: projects/{project}/location/{location}/product/{product}/integrationtemplates/{integrationtemplate}

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

          Location : path

          Type : string

      Description : Creates an IntegrationTemplateVersion.

  • integrations.projects.locations.products.integrationtemplates.versions.list

      Parameters :

        parent

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

          Location : path

          Description : Required. Format: projects/{project}/location/{location}/product/{product}/integrationtemplates/{integrationtemplate}

          Type : string

          Required : Yes

        filter

          Description : Filter syntax: defined in the EBNF grammar.

          Location : query

          Type : string

        pageToken

          Location : query

          Description : A page token, received from a previous `ListIntegrationTemplateVersions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListIntegrationTemplateVersions` must match the call that provided the page token.

          Type : string

        pageSize

          Location : query

          Type : integer

          Description : The maximum number of IntegrationTemplateVersions to return. The service may return fewer than this value. If unspecified, at most 50 versions will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

          Format : int32

      Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrationtemplates/{integrationtemplatesId}/versions

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

      Parameter Order : parent

      Description : Returns the list of all IntegrationTemplateVersions in the specified project.

      Path : v1alpha/{+parent}/versions

      HTTP Method : GET

  • integrations.projects.locations.integrations.schedule

      Path : v1alpha/{+name}:schedule

      Parameter Order : name

      HTTP Method : POST

      Description : Schedules an integration for execution by passing the trigger id and the scheduled time in the request body.

      Parameters :

        name

          Required : Yes

          Type : string

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

          Description : The integration resource name.

          Location : path

      Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}:schedule

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

  • integrations.projects.locations.integrations.list

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

      Parameter Order : parent

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

      Description : Returns the list of all integrations in the specified project.

      Parameters :

        pageSize

          Format : int32

          Location : query

          Type : integer

          Description : The page size for the resquest.

        orderBy

          Description : The results would be returned in order you specified here. Supported sort keys are: Descending sort order by "last_modified_time", "created_time", "snapshot_number". Ascending sort order by the integration name.

          Location : query

          Type : string

        parent

          Required : Yes

          Description : Required. Project and location from which the integrations should be listed. Format: projects/{project}

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

          Location : path

          Type : string

        pageToken

          Location : query

          Type : string

          Description : The page token for the resquest.

        filter

          Description : Filter on fields of IntegrationVersion. Fields can be compared with literal values by use of ":" (containment), "=" (equality), ">" (greater), "<" (less than), >=" (greater than or equal to), "<=" (less than or equal to), and "!=" (inequality) operators. Negation, conjunction, and disjunction are written using NOT, AND, and OR keywords. For example, organization_id=\"1\" AND state=ACTIVE AND description:"test". Filtering cannot be performed on repeated fields like `task_config`.

          Location : query

          Type : string

      HTTP Method : GET

      Path : v1alpha/{+parent}/integrations

  • integrations.projects.locations.integrations.monitorexecutionstats

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

      HTTP Method : POST

      Path : v1alpha/{+parent}:monitorexecutionstats

      Parameters :

        parent

          Location : path

          Required : Yes

          Type : string

          Description : Required. The parent resource name: {parent=projects/*/locations/*}.

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

      Parameter Order : parent

      Description : Get execution stats

      Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}:monitorexecutionstats

  • integrations.projects.locations.integrations.execute

      HTTP Method : POST

      Description : Executes integrations synchronously by passing the trigger id in the request body. The request is not returned until the requested executions are either fulfilled or experienced an error. If the integration name is not specified (passing `-`), all of the associated integration under the given trigger_id will be executed. Otherwise only the specified integration for the given `trigger_id` is executed. This is helpful for execution the integration from UI.

      Path : v1alpha/{+name}:execute

      Parameter Order : name

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

      Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}:execute

      Parameters :

        name

          Required : Yes

          Type : string

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

          Location : path

          Description : Required. The integration resource name.

  • integrations.projects.locations.integrations.versions.get

      Parameters :

        name

          Type : string

          Description : Required. The version to retrieve. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{version}

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

          Required : Yes

          Location : path

      Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}

      Description : Get a integration in the specified project.

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

      Parameter Order : name

      Path : v1alpha/{+name}

      HTTP Method : GET

  • integrations.projects.locations.integrations.versions.patch

      HTTP Method : PATCH

      Parameters :

        updateMask

          Description : Field mask specifying the fields in the above integration that have been modified and need to be updated.

          Format : google-fieldmask

          Location : query

          Type : string

        name

          Description : Output only. Auto-generated primary key.

          Type : string

          Required : Yes

          Location : path

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

      Path : v1alpha/{+name}

      Description : Update a integration with a draft version in the specified project.

      Parameter Order : name

      Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}

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

  • integrations.projects.locations.integrations.versions.publish

      HTTP Method : POST

      Parameter Order : name

      Path : v1alpha/{+name}:publish

      Description : This RPC throws an exception if the integration is in ARCHIVED or ACTIVE state. This RPC throws an exception if the version being published is DRAFT, and if the `locked_by` user is not the same as the user performing the Publish. Audit fields updated include last_published_timestamp, last_published_by, last_modified_timestamp, last_modified_by. Any existing lock is on this integration is released.

      Parameters :

        name

          Location : path

          Description : Required. The version to publish. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{version}

          Required : Yes

          Type : string

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

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

      Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}:publish

  • integrations.projects.locations.integrations.versions.create

      HTTP Method : POST

      Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions

      Description : Create a integration with a draft version in the specified project.

      Parameters :

        newIntegration

          Location : query

          Description : Set this flag to true, if draft version is to be created for a brand new integration. False, if the request is for an existing integration. For backward compatibility reasons, even if this flag is set to `false` and no existing integration is found, a new draft integration will still be created.

          Type : boolean

        parent

          Required : Yes

          Type : string

          Description : Required. The parent resource where this version will be created. Format: projects/{project}/locations/{location}/integrations/{integration}

          Location : path

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

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

      Parameter Order : parent

      Path : v1alpha/{+parent}/versions

  • integrations.projects.locations.integrations.versions.deactivate

      Path : v1alpha/{+name}:deactivate

      Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}:deactivate

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

      Description : Sets the status of the ACTIVE integration to SNAPSHOT with a new tag "PREVIOUSLY_PUBLISHED" after validating it. The "HEAD" and "PUBLISH_REQUESTED" tags do not change. This RPC throws an exception if the version being snapshot is not ACTIVE. Audit fields added include action, action_by, action_timestamp.

      HTTP Method : POST

      Parameters :

        name

          Type : string

          Location : path

          Description : Required. The version to deactivate. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{version}

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

          Required : Yes

      Parameter Order : name

  • integrations.projects.locations.integrations.versions.takeoverEditLock

      Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}:takeoverEditLock

      Parameter Order : integrationVersion

      Description : Clears the `locked_by` and `locked_at_timestamp`in the DRAFT version of this integration. It then performs the same action as the CreateDraftIntegrationVersion (i.e., copies the DRAFT version of the integration as a SNAPSHOT and then creates a new DRAFT version with the `locked_by` set to the `user_taking_over` and the `locked_at_timestamp` set to the current timestamp). Both the `locked_by` and `user_taking_over` are notified via email about the takeover. This RPC throws an exception if the integration is not in DRAFT status or if the `locked_by` and `locked_at_timestamp` fields are not set.The TakeoverEdit lock is treated the same as an edit of the integration, and hence shares ACLs with edit. Audit fields updated include last_modified_timestamp, last_modified_by.

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

      Path : v1alpha/{+integrationVersion}:takeoverEditLock

      HTTP Method : POST

      Parameters :

        integrationVersion

          Location : path

          Required : Yes

          Description : Required. The version to take over edit lock. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{version}

          Type : string

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

  • integrations.projects.locations.integrations.versions.validate

      Description : Validates the given integration. If the id doesn't exist, a NotFoundException is thrown. If validation fails a CanonicalCodeException is thrown. If there was no failure an empty response is returned.

      Path : v1alpha/{+name}:validate

      HTTP Method : POST

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

      Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}:validate

      Parameter Order : name

      Parameters :

        name

          Description : Required. The version to validate. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{version}

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

          Required : Yes

          Location : path

          Type : string

  • integrations.projects.locations.integrations.versions.list

      Parameters :

        pageSize

          Type : integer

          Format : int32

          Description : The maximum number of versions to return. The service may return fewer than this value. If unspecified, at most 50 versions will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

          Location : query

        orderBy

          Location : query

          Description : The results would be returned in order you specified here. Currently supported sort keys are: Descending sort order for "last_modified_time", "created_time", "snapshot_number" Ascending sort order for "name".

          Type : string

        fieldMask

          Format : google-fieldmask

          Location : query

          Type : string

          Description : The field mask which specifies the particular data to be returned.

        pageToken

          Description : A page token, received from a previous `ListIntegrationVersions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListIntegrationVersions` must match the call that provided the page token.

          Type : string

          Location : query

        filter

          Type : string

          Description : Filter on fields of IntegrationVersion. Fields can be compared with literal values by use of ":" (containment), "=" (equality), ">" (greater), "<" (less than), >=" (greater than or equal to), "<=" (less than or equal to), and "!=" (inequality) operators. Negation, conjunction, and disjunction are written using NOT, AND, and OR keywords. For example, organization_id=\"1\" AND state=ACTIVE AND description:"test". Filtering cannot be performed on repeated fields like `task_config`.

          Location : query

        parent

          Location : path

          Required : Yes

          Type : string

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

          Description : Required. The parent resource where this version will be created. Format: projects/{project}/locations/{location}/integrations/{integration} Specifically, when parent equals: 1. projects//locations//integrations/, Meaning: "List versions (with filter) for a particular integration". 2. projects//locations//integrations/- Meaning: "List versions (with filter) for a client within a particular region". 3. projects//locations/-/integrations/- Meaning: "List versions (with filter) for a client".

      HTTP Method : GET

      Parameter Order : parent

      Path : v1alpha/{+parent}/versions

      Description : Returns the list of all integration versions in the specified project.

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

      Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions

  • integrations.projects.locations.integrations.versions.archive

      Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}:archive

      HTTP Method : POST

      Description : Soft-deletes the integration. Changes the status of the integration to ARCHIVED. If the integration being ARCHIVED is tagged as "HEAD", the tag is removed from this snapshot and set to the previous non-ARCHIVED snapshot. The PUBLISH_REQUESTED, DUE_FOR_DELETION tags are removed too. This RPC throws an exception if the version being archived is DRAFT, and if the `locked_by` user is not the same as the user performing the Archive. Audit fields updated include last_modified_timestamp, last_modified_by. Any existing lock is released when Archiving a integration. Currently, there is no unarchive mechanism.

      Path : v1alpha/{+name}:archive

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

      Parameters :

        name

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

          Location : path

          Description : Required. The version to archive. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{version}

          Required : Yes

          Type : string

      Parameter Order : name

  • integrations.projects.locations.integrations.executions.list

      Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/executions

      HTTP Method : GET

      Parameter Order : parent

      Parameters :

        filterParams.taskStatuses

          Location : query

          Description : List of possible task statuses.

          Type : string

          Repeated : Yes

        filterParams.startTime

          Format : int64

          Location : query

          Description : Start timestamp.

          Type : string

        readMask

          Format : google-fieldmask

          Type : string

          Location : query

          Description : Optional. View mask for the response data. If set, only the field specified will be returned as part of the result. If not set, all fields in event execution info will be filled and returned.

        filterParams.executionId

          Description : Execution id.

          Location : query

          Type : string

        filterParams.endTime

          Type : string

          Format : int64

          Location : query

          Description : End timestamp.

        filter

          Description : Optional. Standard filter field, we support filtering on all fields in EventExecutionParamIndexes table. All fields support for EQUALS, in additional: CreateTimestamp support for LESS_THAN, GREATER_THAN ParameterKey, ParameterValue, ParameterType support for HAS For example: "parameter_value" HAS \"parameter1\" Also supports operators like AND, OR, NOT For example, trigger_id=\"id1\" AND event_execution_state=\"FAILED\"

          Type : string

          Location : query

        filterParams.parameterType

          Description : Param type.

          Location : query

          Type : string

        truncateParams

          Location : query

          Description : Optional. If true, the service will truncate the params to only keep the first 1000 characters of string params and empty the executions in order to make response smaller. Only works for UI and when the params fields are not filtered out.

          Type : boolean

        orderBy

          Location : query

          Description : Optional. The results would be returned in order you specified here. Currently supporting "last_modified_time" and "create_time".

          Type : string

        filterParams.parameterPairKey

          Type : string

          Description : Param key in the key value pair filter.

          Location : query

        filterParams.customFilter

          Type : string

          Description : Optional user-provided custom filter.

          Location : query

        filterParams.eventStatuses

          Description : List of possible event statuses.

          Type : string

          Repeated : Yes

          Location : query

        parent

          Location : path

          Required : Yes

          Type : string

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

          Description : Required. The parent resource name of the integration execution.

        filterParams.parameterKey

          Location : query

          Description : Param key. DEPRECATED. User parameter_pair_key instead.

          Type : string

        filterParams.parameterValue

          Type : string

          Location : query

          Description : Param value. DEPRECATED. User parameter_pair_value instead.

        filterParams.workflowName

          Type : string

          Location : query

          Description : Workflow name.

        pageToken

          Description : Optional. The token returned in the previous response.

          Type : string

          Location : query

        filterParams.parameterPairValue

          Type : string

          Description : Param value in the key value pair filter.

          Location : query

        refreshAcl

          Type : boolean

          Description : Optional. If true, the service will use the most recent acl information to list event execution infos and renew the acl cache. Note that fetching the most recent acl is synchronous, so it will increase RPC call latency.

          Location : query

        pageSize

          Location : query

          Type : integer

          Format : int32

          Description : Optional. The size of entries in the response.

      Description : Lists the results of all the integration executions. The response includes the same information as the [execution log](https://cloud.google.com/application-integration/docs/viewing-logs) in the Integration UI.

      Path : v1alpha/{+parent}/executions

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

  • integrations.projects.locations.authConfigs.get

      Path : v1alpha/{+name}

      Parameters :

        name

          Location : path

          Description : Required. The name that is associated with the AuthConfig.

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

          Type : string

          Required : Yes

      Parameter Order : name

      Description : Gets a complete auth config. If the auth config doesn't exist, Code.NOT_FOUND exception will be thrown. Returns the decrypted auth config.

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

      HTTP Method : GET

      Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/authConfigs/{authConfigsId}

  • integrations.projects.locations.authConfigs.patch

      Path : v1alpha/{+name}

      Description : Updates an auth config. If credential is updated, fetch the encrypted auth config from Spanner, decrypt with Cloud KMS key, update the credential fields, re-encrypt with Cloud KMS key and update the Spanner record. For other fields, directly update the Spanner record. Returns the encrypted auth config.

      HTTP Method : PATCH

      Parameter Order : name

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

      Parameters :

        clientCertificate.sslCertificate

          Type : string

          Location : query

          Description : The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines. For example, -----BEGIN CERTIFICATE----- MIICTTCCAbagAwIBAgIJAPT0tSKNxan/MA0GCSqGSIb3DQEBCwUAMCoxFzAVBgNV BAoTDkdvb2dsZSBURVNUSU5HMQ8wDQYDVQQDEwZ0ZXN0Q0EwHhcNMTUwMTAxMDAw MDAwWhcNMjUwMTAxMDAwMDAwWjAuMRcwFQYDVQQKEw5Hb29nbGUgVEVTVElORzET MBEGA1UEAwwKam9lQGJhbmFuYTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA vDYFgMgxi5W488d9J7UpCInl0NXmZQpJDEHE4hvkaRlH7pnC71H0DLt0/3zATRP1 JzY2+eqBmbGl4/sgZKYv8UrLnNyQNUTsNx1iZAfPUflf5FwgVsai8BM0pUciq1NB xD429VFcrGZNucvFLh72RuRFIKH8WUpiK/iZNFkWhZ0CAwEAAaN3MHUwDgYDVR0P AQH/BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAMBgNVHRMB Af8EAjAAMBkGA1UdDgQSBBCVgnFBCWgL/iwCqnGrhTPQMBsGA1UdIwQUMBKAEKey Um2o4k2WiEVA0ldQvNYwDQYJKoZIhvcNAQELBQADgYEAYK986R4E3L1v+Q6esBtW JrUwA9UmJRSQr0N5w3o9XzarU37/bkjOP0Fw0k/A6Vv1n3vlciYfBFaBIam1qRHr 5dMsYf4CZS6w50r7hyzqyrwDoyNxkLnd2PdcHT/sym1QmflsjEs7pejtnohO6N2H wQW6M0H7Zt8claGRla4fKkg= -----END CERTIFICATE-----

        name

          Description : Resource name of the SFDC instance projects/{project}/locations/{location}/authConfigs/{authConfig}.

          Type : string

          Location : path

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

          Required : Yes

        clientCertificate.passphrase

          Location : query

          Type : string

          Description : 'passphrase' should be left unset if private key is not encrypted. Note that 'passphrase' is not the password for web server, but an extra layer of security to protected private key.

        updateMask

          Type : string

          Location : query

          Format : google-fieldmask

          Description : Field mask specifying the fields in the above AuthConfig that have been modified and need to be updated.

        clientCertificate.encryptedPrivateKey

          Type : string

          Location : query

          Description : The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines. For example, -----BEGIN CERTIFICATE----- MIICTTCCAbagAwIBAgIJAPT0tSKNxan/MA0GCSqGSIb3DQEBCwUAMCoxFzAVBgNV BAoTDkdvb2dsZSBURVNUSU5HMQ8wDQYDVQQDEwZ0ZXN0Q0EwHhcNMTUwMTAxMDAw MDAwWhcNMjUwMTAxMDAwMDAwWjAuMRcwFQYDVQQKEw5Hb29nbGUgVEVTVElORzET MBEGA1UEAwwKam9lQGJhbmFuYTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA vDYFgMgxi5W488d9J7UpCInl0NXmZQpJDEHE4hvkaRlH7pnC71H0DLt0/3zATRP1 JzY2+eqBmbGl4/sgZKYv8UrLnNyQNUTsNx1iZAfPUflf5FwgVsai8BM0pUciq1NB xD429VFcrGZNucvFLh72RuRFIKH8WUpiK/iZNFkWhZ0CAwEAAaN3MHUwDgYDVR0P AQH/BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAMBgNVHRMB Af8EAjAAMBkGA1UdDgQSBBCVgnFBCWgL/iwCqnGrhTPQMBsGA1UdIwQUMBKAEKey Um2o4k2WiEVA0ldQvNYwDQYJKoZIhvcNAQELBQADgYEAYK986R4E3L1v+Q6esBtW JrUwA9UmJRSQr0N5w3o9XzarU37/bkjOP0Fw0k/A6Vv1n3vlciYfBFaBIam1qRHr 5dMsYf4CZS6w50r7hyzqyrwDoyNxkLnd2PdcHT/sym1QmflsjEs7pejtnohO6N2H wQW6M0H7Zt8claGRla4fKkg= -----END CERTIFICATE-----

      Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/authConfigs/{authConfigsId}

  • integrations.projects.locations.authConfigs.create

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

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

      Parameters :

        parent

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

          Type : string

          Location : path

          Description : Required. "projects/{project}/locations/{location}" format.

          Required : Yes

        clientCertificate.encryptedPrivateKey

          Location : query

          Type : string

          Description : The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines. For example, -----BEGIN CERTIFICATE----- MIICTTCCAbagAwIBAgIJAPT0tSKNxan/MA0GCSqGSIb3DQEBCwUAMCoxFzAVBgNV BAoTDkdvb2dsZSBURVNUSU5HMQ8wDQYDVQQDEwZ0ZXN0Q0EwHhcNMTUwMTAxMDAw MDAwWhcNMjUwMTAxMDAwMDAwWjAuMRcwFQYDVQQKEw5Hb29nbGUgVEVTVElORzET MBEGA1UEAwwKam9lQGJhbmFuYTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA vDYFgMgxi5W488d9J7UpCInl0NXmZQpJDEHE4hvkaRlH7pnC71H0DLt0/3zATRP1 JzY2+eqBmbGl4/sgZKYv8UrLnNyQNUTsNx1iZAfPUflf5FwgVsai8BM0pUciq1NB xD429VFcrGZNucvFLh72RuRFIKH8WUpiK/iZNFkWhZ0CAwEAAaN3MHUwDgYDVR0P AQH/BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAMBgNVHRMB Af8EAjAAMBkGA1UdDgQSBBCVgnFBCWgL/iwCqnGrhTPQMBsGA1UdIwQUMBKAEKey Um2o4k2WiEVA0ldQvNYwDQYJKoZIhvcNAQELBQADgYEAYK986R4E3L1v+Q6esBtW JrUwA9UmJRSQr0N5w3o9XzarU37/bkjOP0Fw0k/A6Vv1n3vlciYfBFaBIam1qRHr 5dMsYf4CZS6w50r7hyzqyrwDoyNxkLnd2PdcHT/sym1QmflsjEs7pejtnohO6N2H wQW6M0H7Zt8claGRla4fKkg= -----END CERTIFICATE-----

        clientCertificate.sslCertificate

          Type : string

          Description : The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines. For example, -----BEGIN CERTIFICATE----- MIICTTCCAbagAwIBAgIJAPT0tSKNxan/MA0GCSqGSIb3DQEBCwUAMCoxFzAVBgNV BAoTDkdvb2dsZSBURVNUSU5HMQ8wDQYDVQQDEwZ0ZXN0Q0EwHhcNMTUwMTAxMDAw MDAwWhcNMjUwMTAxMDAwMDAwWjAuMRcwFQYDVQQKEw5Hb29nbGUgVEVTVElORzET MBEGA1UEAwwKam9lQGJhbmFuYTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA vDYFgMgxi5W488d9J7UpCInl0NXmZQpJDEHE4hvkaRlH7pnC71H0DLt0/3zATRP1 JzY2+eqBmbGl4/sgZKYv8UrLnNyQNUTsNx1iZAfPUflf5FwgVsai8BM0pUciq1NB xD429VFcrGZNucvFLh72RuRFIKH8WUpiK/iZNFkWhZ0CAwEAAaN3MHUwDgYDVR0P AQH/BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAMBgNVHRMB Af8EAjAAMBkGA1UdDgQSBBCVgnFBCWgL/iwCqnGrhTPQMBsGA1UdIwQUMBKAEKey Um2o4k2WiEVA0ldQvNYwDQYJKoZIhvcNAQELBQADgYEAYK986R4E3L1v+Q6esBtW JrUwA9UmJRSQr0N5w3o9XzarU37/bkjOP0Fw0k/A6Vv1n3vlciYfBFaBIam1qRHr 5dMsYf4CZS6w50r7hyzqyrwDoyNxkLnd2PdcHT/sym1QmflsjEs7pejtnohO6N2H wQW6M0H7Zt8claGRla4fKkg= -----END CERTIFICATE-----

          Location : query

        clientCertificate.passphrase

          Type : string

          Location : query

          Description : 'passphrase' should be left unset if private key is not encrypted. Note that 'passphrase' is not the password for web server, but an extra layer of security to protected private key.

      Description : Creates an auth config record. Fetch corresponding credentials for specific auth types, e.g. access token for OAuth 2.0, JWT token for JWT. Encrypt the auth config with Cloud KMS and store the encrypted credentials in Spanner. Returns the encrypted auth config.

      Path : v1alpha/{+parent}/authConfigs

      HTTP Method : POST

      Parameter Order : parent

  • integrations.projects.locations.authConfigs.list

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

      Parameters :

        pageToken

          Type : string

          Location : query

          Description : The token returned in the previous response.

        filter

          Location : query

          Type : string

          Description : Filtering as supported in https://developers.google.com/authorized-buyers/apis/guides/v2/list-filters.

        readMask

          Location : query

          Type : string

          Description : The mask which specifies fields that need to be returned in the AuthConfig's response.

          Format : google-fieldmask

        parent

          Required : Yes

          Type : string

          Location : path

          Description : Required. The client, which owns this collection of AuthConfigs.

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

        pageSize

          Description : The size of entries in the response. If unspecified, defaults to 100.

          Type : integer

          Location : query

          Format : int32

      Parameter Order : parent

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

      Path : v1alpha/{+parent}/authConfigs

      HTTP Method : GET

      Description : Lists all auth configs that match the filter. Restrict to auth configs belong to the current client only.

  • integrations.projects.locations.authConfigs.delete

      Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/authConfigs/{authConfigsId}

      Path : v1alpha/{+name}

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

      Parameter Order : name

      Description : Deletes an auth config.

      HTTP Method : DELETE

      Parameters :

        name

          Type : string

          Description : Required. The name that is associated with the AuthConfig.

          Required : Yes

          Location : path

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

  • integrations.projects.locations.listTaskEntities

      Path : v1alpha/{+parent}:listTaskEntities

      Parameters :

        parent

          Type : string

          Location : path

          Required : Yes

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

          Description : Required. The location resource of the request. This is not going to be used but preserve the field for future.

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

      HTTP Method : GET

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

      Description : This is a UI only method and will be moved away. Returns a list of common tasks.

      Parameter Order : parent

  • integrations.callback.generateToken

      Description : Receives the auth code and auth config id to combine that with the client id and secret to retrieve access tokens from the token endpoint. Returns either a success or error message when it's done.

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

      Parameters :

        code

          Type : string

          Description : The auth code for the given request

          Location : query

        state

          Type : string

          Location : query

          Description : The auth config id for the given request

        redirectUri

          Type : string

          Location : query

          Description : Redirect uri of the auth code request

        gcpProjectId

          Location : query

          Type : string

          Description : The gcp project id of the request

        product

          Location : query

          Description : Which product sends the request

          Type : string

          Enum :

        • UNSPECIFIED_PRODUCT
        • IP
        • APIGEE
        • SECURITY
        • Enum Descriptions :

      HTTP Method : GET

      Flat Path : v1alpha/callback:generateToken

      Path : v1alpha/callback:generateToken