Application Integration API (integrations:v1alpha)

2023-09-29

7 new methods

Additions

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

      Path: v1alpha/{+parent}/testCases

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

      Description: Lists all the test cases that satisfy the filters.

      Parameters:

        parent

          Location: path

          Required: Yes

          Description: Required. The parent resource where this TestCase was created.

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

          Type: string

        pageToken

          Location: query

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

          Type: string

        orderBy

          Type: string

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

          Location: query

        pageSize

          Format: int32

          Type: integer

          Location: query

          Description: Optional. The maximum number of test cases to return. The service may return fewer than this value. If unspecified, at most 100 test cases will be returned.

        readMask

          Location: query

          Type: string

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

          Format: google-fieldmask

        filter

          Description: Optional. Standard filter field. Filtering as supported in https://developers.google.com/authorized-buyers/apis/guides/list-filters.

          Type: string

          Location: query

      HTTP Method: GET

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

      Parameter Order: parent

  • integrations.projects.locations.integrations.versions.testCases.delete

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

      Path: v1alpha/{+name}

      Parameter Order: name

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

      Description: Deletes a test case

      HTTP Method: DELETE

      Parameters:

        name

          Required: Yes

          Type: string

          Description: Required. ID for the test case to be deleted

          Location: path

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

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

      Parameters:

        testCaseId

          Location: query

          Description: Required. Required

          Type: string

        parent

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

          Location: path

          Description: Required.

          Type: string

          Required: Yes

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

      Parameter Order: parent

      Path: v1alpha/{+parent}/testCases

      Description: Creates a new test case

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

      HTTP Method: POST

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

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

      Parameter Order: name

      Path: v1alpha/{+name}

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

      Parameters:

        name

          Location: path

          Description: Required. The ID of the test case to retrieve

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

          Required: Yes

          Type: string

      HTTP Method: GET

      Description: Get a test case

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

      Path: v1alpha/{+name}

      HTTP Method: PATCH

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

      Description: Updates a test case

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

      Parameters:

        name

          Required: Yes

          Location: path

          Type: string

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

          Description: Output only. Auto-generated primary key.

        updateMask

          Format: google-fieldmask

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

          Type: string

          Location: query

      Parameter Order: name

  • integrations.projects.locations.integrations.versions.testCases.listExecutions

      HTTP Method: GET

      Parameter Order: parent

      Parameters:

        filter

          Type: string

          Description: Optional. Standard filter field, we support filtering on following fields: test_case_id: the ID of the test case. CreateTimestamp: the execution created time. event_execution_state: the state of the executions. execution_id: the id of the execution. trigger_id: the id of the trigger. parameter_type: the type of the parameters involved in the execution. All fields support for EQUALS, in additional: CreateTimestamp support for LESS_THAN, GREATER_THAN ParameterType support for HAS For example: "parameter_type" HAS \"string\" Also supports operators like AND, OR, NOT For example, trigger_id=\"id1\" AND test_case_id=\"testCaseId\"

          Location: query

        pageSize

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

          Type: integer

          Format: int32

          Location: query

        orderBy

          Type: string

          Location: query

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

        parent

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

          Description: Required. The parent resource name of the test case execution.

          Type: string

          Required: Yes

          Location: path

        pageToken

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

          Location: query

          Type: string

        readMask

          Location: query

          Format: google-fieldmask

          Type: string

          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.

        truncateParams

          Deprecated: Yes

          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.

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

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

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

      Path: v1alpha/{+parent}:executions

  • integrations.projects.locations.integrations.versions.testCases.executeTest

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

      HTTP Method: POST

      Description: Executes functional test

      Parameter Order: testCaseName

      Parameters:

        testCaseName

          Description: Required. Test case resource name

          Required: Yes

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

          Type: string

          Location: path

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

      Path: v1alpha/{+testCaseName}:executeTest