Application Integration API (integrations:v1alpha)

Deletions

Methods


• ▼ ▲ integrations.projects.locations.products.integrations.archiveBundle

  Parameters:

  name

  Required: Yes

  Type: string

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

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

  Location: path

  Parameter Order: name

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

  Path: v1alpha/{+name}:archiveBundle

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

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

  HTTP Method: POST

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

  Parameters:

  name

  Location: path

  Type: string

  Required: Yes

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

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

  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

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

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

  Path: v1alpha/{+name}:deactivate

  HTTP Method: POST

• ▼ ▲ integrations.projects.locations.products.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.

  Parameter Order: name

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

  Path: v1alpha/{+name}:validate

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

  Parameters:

  name

  Required: Yes

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

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

  Type: string

  Location: path

  HTTP Method: POST

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

  Path: v1alpha/{+name}:archive

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

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

  HTTP Method: POST

  Parameter Order: name

  Parameters:

  name

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

  Type: string

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

  Required: Yes

  Location: path

  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.

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

  HTTP Method: PATCH

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

  Parameters:

  name

  Description: Required. Bundle name

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

  Type: string

  Location: path

  Required: Yes

  Parameter Order: name

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

  Path: v1alpha/{+name}:updateBundle

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

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

  HTTP Method: GET

  Parameter Order: name

  Path: v1alpha/{+name}:getBundle

  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

  Parameters:

  name

  Location: path

  Description: Required. The bundle name.

  Type: string

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

  Required: Yes

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

  Parameter Order: parent

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

  Path: v1alpha/{+parent}/executionsnapshots

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

  HTTP Method: GET

  Parameters:

  parent

  Required: Yes

  Location: path

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

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

  Type: string

  pageToken

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

  Location: query

  Type: string

  pageSize

  Type: integer

  Format: int32

  Location: query

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

  readMask

  Location: query

  Format: google-fieldmask

  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.

  Type: string

  filter

  Location: query

  Type: string

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

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

• ▼ ▲ integrations.projects.locations.products.listTaskEntities

  Path: v1alpha/{+parent}:listTaskEntities

  HTTP Method: GET

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

  Parameter Order: parent

  Parameters:

  parent

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

  Required: Yes

  Location: path

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

  Type: string

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

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

• ▼ ▲ integrations.projects.locations.products.createBundle

  Parameter Order: parent

  HTTP Method: POST

  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.

  Location: path

  Required: Yes

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

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

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

  HTTP Method: POST

  Parameter Order: name

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

  Path: v1alpha/{+name}:deactivate

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

  Parameters:

  name

  Required: Yes

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

  Location: path

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

  Type: string

  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.

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

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

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

  HTTP Method: POST

  Parameter Order: name

  Path: v1alpha/{+name}: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.

  Parameters:

  name

  Required: Yes

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

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

  Type: string

  Location: path

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

  Path: v1alpha/{+name}:archive

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

  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 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.

  HTTP Method: POST

  Parameters:

  name

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

  Required: Yes

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

  Location: path

  Type: string

  Parameter Order: name

• ▼ ▲ integrations.projects.locations.listTaskEntities

  Parameter Order: parent

  Parameters:

  parent

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

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

  Location: path

  Type: string

  Required: Yes

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

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

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

  Path: v1alpha/{+parent}:listTaskEntities

  HTTP Method: GET