Application Integration API (integrations:v1alpha)

2023-01-26

7 new methods

Additions

    Methods

  • ▼ ▲ integrations.projects.locations.products.integrations.versions.unpublish

      Parameter Order : name

      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

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

          Type : string

          Location : path

          Required : Yes

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

      Path : v1alpha/{+name}:unpublish

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

      HTTP Method : POST

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

  • ▼ ▲ integrations.projects.locations.products.integrations.versions.delete

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

      Path : v1alpha/{+name}

      Parameters :

        name

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

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

          Required : Yes

          Location : path

          Type : string

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

      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 deleted is DRAFT, and if the `locked_by` user is not the same as the user performing the Delete. Audit fields updated include last_modified_timestamp, last_modified_by. Any existing lock is released when Deleting a integration. Currently, there is no undelete mechanism.

      HTTP Method : DELETE

      Parameter Order : name

  • ▼ ▲ integrations.projects.locations.integrations.delete

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

      HTTP Method : DELETE

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

      Path : v1alpha/{+name}

      Parameters :

        name

          Description : Required. The location resource of the request.

          Location : path

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

          Type : string

          Required : Yes

      Parameter Order : name

      Description : Delete the selected integration and all versions inside

  • ▼ ▲ integrations.projects.locations.integrations.versions.delete

      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 deleted is DRAFT, and if the `locked_by` user is not the same as the user performing the Delete. Audit fields updated include last_modified_timestamp, last_modified_by. Any existing lock is released when Deleting a integration. Currently, there is no undelete mechanism.

      Parameter Order : name

      Parameters :

        name

          Required : Yes

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

          Type : string

          Location : path

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

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

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

      HTTP Method : DELETE

      Path : v1alpha/{+name}

  • ▼ ▲ integrations.projects.locations.integrations.versions.download

      HTTP Method : GET

      Parameter Order : name

      Parameters :

        name

          Location : path

          Type : string

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

          Required : Yes

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

        fileFormat

          Enum Descriptions :

        • Unspecified file format
        • JSON File Format
        • YAML File Format

          • Enum :

        • FILE_FORMAT_UNSPECIFIED
        • JSON
        • YAML

          • Location : query

          Type : string

          Description : File format for download request.

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

      Path : v1alpha/{+name}:download

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

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

  • ▼ ▲ integrations.projects.locations.integrations.versions.upload

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

      HTTP Method : POST

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

      Parameters :

        parent

          Type : string

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

          Required : Yes

          Location : path

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

      Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/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.

  • ▼ ▲ integrations.projects.locations.integrations.versions.unpublish

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

      HTTP Method : POST

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

      Path : v1alpha/{+name}:unpublish

      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.

      Parameter Order : name

      Parameters :

        name

          Required : Yes

          Location : path

          Type : string

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

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