Application Integration API (integrations:v1alpha)

Additions

Methods


• ▼ ▲ integrations.connectorPlatformRegions.enumerate

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

  Path : v1alpha/connectorPlatformRegions:enumerate

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

  HTTP Method : GET

  Flat Path : v1alpha/connectorPlatformRegions:enumerate

• ▼ ▲ integrations.projects.locations.appsScriptProjects.create

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

  Path : v1alpha/{+parent}/appsScriptProjects

  HTTP Method : POST

  Description : Creates an Apps Script project.

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

  Parameters :

  parent

  Type : string

  Location : path

  Required : Yes

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

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

  Parameter Order : parent

• ▼ ▲ integrations.projects.locations.appsScriptProjects.link

  Parameters :

  parent

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

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

  Location : path

  Type : string

  Required : Yes

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

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

  Description : Links a existing Apps Script project.

  HTTP Method : POST

  Parameter Order : parent

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

• ▼ ▲ integrations.projects.locations.authConfigs.list

  Parameters :

  parent

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

  Location : path

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

  Type : string

  Required : Yes

  filter

  Location : query

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

  Type : string

  readMask

  Format : google-fieldmask

  Location : query

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

  Type : string

  pageSize

  Format : int32

  Type : integer

  Location : query

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

  pageToken

  Location : query

  Type : string

  Description : The token returned in the previous response.

  Parameter Order : parent

  Path : v1alpha/{+parent}/authConfigs

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

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

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

  HTTP Method : GET

• ▼ ▲ integrations.projects.locations.authConfigs.get

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

  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.

  Parameters :

  name

  Required : Yes

  Location : path

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

  Type : string

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

  HTTP Method : GET

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

  Parameter Order : name

  Path : v1alpha/{+name}

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

  Path : v1alpha/{+name}

  Parameter Order : name

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

  Parameters :

  name

  Type : string

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

  Required : Yes

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

  Location : path

  Description : Deletes an auth config.

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

  HTTP Method : DELETE

• ▼ ▲ integrations.projects.locations.authConfigs.create

  Parameters :

  clientCertificate.passphrase

  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

  Type : string

  parent

  Type : string

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

  Location : path

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

  Required : Yes

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

  clientCertificate.encryptedPrivateKey

  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

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

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

  Parameter Order : parent

  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.

  HTTP Method : POST

  Path : v1alpha/{+parent}/authConfigs

• ▼ ▲ integrations.projects.locations.authConfigs.patch

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

  Parameters :

  updateMask

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

  Format : google-fieldmask

  Type : string

  Location : query

  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

  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

  Type : string

  name

  Location : path

  Type : string

  Required : Yes

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

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

  clientCertificate.encryptedPrivateKey

  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

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

  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.

  Path : v1alpha/{+name}

  Parameter Order : name

  HTTP Method : PATCH

• ▼ ▲ 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.

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

  Path : v1alpha/{+name}

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

  Parameter Order : name

  HTTP Method : PATCH

  Parameters :

  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

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

  Type : string

  name

  Required : Yes

  Location : path

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

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

  Type : string

  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

  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

  Location : query

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

  Description : Deletes an auth config.

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

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

  Path : v1alpha/{+name}

  HTTP Method : DELETE

  Parameters :

  name

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

  Location : path

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

  Required : Yes

  Type : string

  Parameter Order : name

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

  Parameters :

  pageToken

  Type : string

  Description : The token returned in the previous response.

  Location : query

  filter

  Type : string

  Location : query

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

  parent

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

  Location : path

  Type : string

  Required : Yes

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

  readMask

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

  Format : google-fieldmask

  Location : query

  Type : string

  pageSize

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

  Type : integer

  Location : query

  Format : int32

  Path : v1alpha/{+parent}/authConfigs

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

  HTTP Method : GET

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

  Parameter Order : parent

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

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

  Path : v1alpha/{+parent}/authConfigs

  HTTP Method : POST

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

  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.

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

  Parameters :

  clientCertificate.encryptedPrivateKey

  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

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

  parent

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

  Type : string

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

  Required : Yes

  Location : path

  Parameter Order : parent

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

  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

  Path : v1alpha/{+name}

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

  Parameters :

  name

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

  Required : Yes

  Location : path

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

  Type : string

  Parameter Order : name

  HTTP Method : GET

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

  Path : v1alpha/{+name}:archiveBundle

  Parameters :

  name

  Required : Yes

  Location : path

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

  Type : string

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

  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

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

  HTTP Method : POST

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

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

  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

  Type : string

  Description : The page token for the resquest.

  Location : query

  parent

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

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

  Type : string

  Required : Yes

  Location : path

  pageSize

  Type : integer

  Description : The page size for the resquest.

  Location : query

  Format : int32

  filter

  Location : query

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

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

  HTTP Method : GET

  Parameter Order : parent

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

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

  Parameter Order : name

  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.

  Parameters :

  name

  Required : Yes

  Description : Required. The integration resource name.

  Location : path

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

  Type : string

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

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

  Path : v1alpha/{+name}:execute

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

  HTTP Method : POST

  Parameters :

  name

  Location : path

  Description : The integration resource name.

  Type : string

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

  Required : Yes

  Path : v1alpha/{+name}:schedule

  Parameter Order : name

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

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

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

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

  HTTP Method : POST

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

  Path : v1alpha/{+parent}:monitorexecutionstats

  Parameters :

  parent

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

  Location : path

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

  Type : string

  Required : Yes

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

  Parameter Order : parent

  Description : Get execution stats

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

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

  Parameter Order : parent

  Path : v1alpha/{+parent}/suspensions

  HTTP Method : GET

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

  Parameters :

  pageSize

  Format : int32

  Description : Maximum number of entries in the response.

  Location : query

  Type : integer

  parent

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

  Type : string

  Location : path

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

  Required : Yes

  filter

  Location : query

  Type : string

  Description : Standard filter field.

  pageToken

  Description : Token to retrieve a specific page.

  Location : query

  Type : string

  orderBy

  Location : query

  Type : string

  Description : Field name to order by.

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

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

  Path : v1alpha/{+name}:lift

  HTTP Method : POST

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

  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.

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

  Parameter Order : name

  Parameters :

  name

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

  Type : string

  Location : path

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

  Required : Yes

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

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

  Parameters :

  name

  Required : Yes

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

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

  Location : path

  Type : string

  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.

  HTTP Method : POST

  Path : v1alpha/{+name}:resolve

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

  Parameter Order : name

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

  Description : Get an execution in the specified project.

  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

  Type : string

  Required : Yes

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

  HTTP Method : GET

  Path : v1alpha/{+name}

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

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

  Parameter Order : name

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

  Parameter Order : parent

  Path : v1alpha/{+parent}/executions

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

  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.

  Parameters :

  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\"

  Location : query

  Type : string

  filterParams.parameterPairValue

  Description : Param value in the key value pair filter.

  Type : string

  Location : query

  filterParams.parameterType

  Type : string

  Description : Param type.

  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

  filterParams.endTime

  Format : int64

  Type : string

  Description : End timestamp.

  Location : query

  filterParams.parameterPairKey

  Type : string

  Description : Param key in the key value pair filter.

  Location : query

  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

  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

  Location : query

  parent

  Required : Yes

  Location : path

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

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

  Type : string

  filterParams.eventStatuses

  Description : List of possible event statuses.

  Location : query

  Repeated : Yes

  Type : string

  pageToken

  Location : query

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

  Type : string

  filterParams.startTime

  Description : Start timestamp.

  Type : string

  Location : query

  Format : int64

  filterParams.workflowName

  Location : query

  Type : string

  Description : Workflow name.

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

  pageSize

  Type : integer

  Location : query

  Format : int32

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

  filterParams.taskStatuses

  Type : string

  Description : List of possible task statuses.

  Repeated : Yes

  Location : query

  filterParams.customFilter

  Type : string

  Description : Optional user-provided custom filter.

  Location : query

  filterParams.parameterValue

  Description : Param value. DEPRECATED. User parameter_pair_value instead.

  Type : string

  Location : query

  filterParams.executionId

  Description : Execution id.

  Type : string

  Location : query

  filterParams.parameterKey

  Type : string

  Location : query

  Description : Param key. DEPRECATED. User parameter_pair_key instead.

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

  HTTP Method : GET

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

  Parameters :

  name

  Location : path

  Type : string

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

  Required : Yes

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

  Parameter Order : name

  HTTP Method : POST

  Description : Cancellation of an execution

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

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

  Path : v1alpha/{+name}:cancel

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

  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}

  Parameters :

  name

  Location : path

  Required : Yes

  Type : string

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

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

  Parameter Order : name

  Path : v1alpha/{+name}

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

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

  HTTP Method : PATCH

  Parameters :

  updateMask

  Format : google-fieldmask

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

  Location : query

  Type : string

  name

  Type : string

  Location : path

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

  Required : Yes

  Description : Output only. Auto-generated primary key.

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

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

  Parameter Order : name

  Path : v1alpha/{+name}

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

  Path : v1alpha/{+name}:download

  Parameter Order : name

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

  HTTP Method : GET

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

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

  Parameters :

  name

  Location : path

  Type : string

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

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

  Required : Yes

  fileFormat

  Enum :

  • FILE_FORMAT_UNSPECIFIED
  • JSON
  • YAML

  Type : string

  Description : File format for download request.

  Enum Descriptions :

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

  Location : query

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

  Path : v1alpha/{+integrationVersion}:takeoverEditLock

  Parameters :

  integrationVersion

  Type : string

  Required : Yes

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

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

  Location : path

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

  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.

  HTTP Method : POST

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

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

  Parameters :

  name

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

  Location : path

  Type : string

  Description : Required. The bundle name.

  Required : Yes

  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

  HTTP Method : GET

  Path : v1alpha/{+name}:getBundle

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

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

  Parameter Order : parent

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

  Path : v1alpha/{+parent}/versions

  Parameters :

  parent

  Location : path

  Required : Yes

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

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

  Type : string

  newIntegration

  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

  Location : query

  HTTP Method : POST

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

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

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

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

  Parameters :

  name

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

  Required : Yes

  Type : string

  Location : path

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

  HTTP Method : POST

  Path : v1alpha/{+name}:validate

  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.

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

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

  HTTP Method : GET

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

  Parameter Order : parent

  Parameters :

  pageToken

  Location : query

  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.

  orderBy

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

  Location : query

  parent

  Type : string

  Required : Yes

  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

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

  pageSize

  Location : query

  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.

  fieldMask

  Location : query

  Format : google-fieldmask

  Type : string

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

  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

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

  Path : v1alpha/{+parent}/versions

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

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

  HTTP Method : PATCH

  Parameter Order : name

  Path : v1alpha/{+name}:updateBundle

  Parameters :

  name

  Description : Required. Bundle name

  Required : Yes

  Type : string

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

  Location : path

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

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

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

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

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

  Parameter Order : name

  Path : v1alpha/{+name}:archive

  Parameters :

  name

  Required : Yes

  Location : path

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

  Type : string

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

  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.

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

• ▼ ▲ 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.

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

  Parameter Order : name

  Path : v1alpha/{+name}:deactivate

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

  Parameters :

  name

  Type : string

  Location : path

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

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

  Required : Yes

  HTTP Method : POST

• ▼ ▲ 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

  HTTP Method : POST

  Parameters :

  name

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

  Type : string

  Location : path

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

  Required : Yes

  Parameter Order : name

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

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

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

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

  Parameter Order : parent

  HTTP Method : POST

  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.

  Parameters :

  parent

  Type : string

  Required : Yes

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

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

  Location : path

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

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

  Parameters :

  filter

  Type : string

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

  Location : query

  readMask

  Type : string

  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.

  pageSize

  Format : int32

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

  Type : integer

  Location : query

  parent

  Type : string

  Required : Yes

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

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

  Location : path

  pageToken

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

  Type : string

  Location : query

  Parameter Order : parent

  Path : v1alpha/{+parent}/executionsnapshots

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

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

  HTTP Method : GET

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

  Path : v1alpha/{+name}

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

  Parameter Order : name

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

  Parameters :

  name

  Type : string

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

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

  Required : Yes

  Location : path

  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

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

  HTTP Method : PATCH

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

  Path : v1alpha/{+parent}/sfdcChannels

  Parameters :

  parent

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

  Location : path

  Type : string

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

  Required : Yes

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

  Parameter Order : parent

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

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

  HTTP Method : POST

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

  HTTP Method : GET

  Path : v1alpha/{+name}

  Parameter Order : name

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

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

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

  Parameters :

  name

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

  Location : path

  Required : Yes

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

  Type : string

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

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

  Parameter Order : parent

  HTTP Method : GET

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

  Parameters :

  parent

  Required : Yes

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

  Type : string

  Location : path

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

  pageToken

  Description : The token returned in the previous response.

  Type : string

  Location : query

  pageSize

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

  Location : query

  Format : int32

  Type : integer

  readMask

  Location : query

  Type : string

  Format : google-fieldmask

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

  filter

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

  Type : string

  Location : query

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

  Path : v1alpha/{+parent}/sfdcChannels

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

  Parameter Order : name

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

  HTTP Method : DELETE

  Parameters :

  name

  Type : string

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

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

  Required : Yes

  Location : path

  Path : v1alpha/{+name}

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

  Description : Deletes an sfdc channel.

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

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

  HTTP Method : GET

  Path : v1alpha/{+parent}/sfdcInstances

  Parameter Order : parent

  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.

  Parameters :

  pageSize

  Format : int32

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

  Location : query

  Type : integer

  readMask

  Type : string

  Location : query

  Format : google-fieldmask

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

  parent

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

  Type : string

  Location : path

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

  Required : Yes

  pageToken

  Description : The token returned in the previous response.

  Type : string

  Location : query

  filter

  Type : string

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

  Location : query

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

  Parameters :

  name

  Type : string

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

  Required : Yes

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

  Location : path

  Description : Deletes an sfdc instance.

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

  Path : v1alpha/{+name}

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

  HTTP Method : DELETE

  Parameter Order : name

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

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

  Parameters :

  name

  Type : string

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

  Location : path

  Required : Yes

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

  Parameter Order : name

  HTTP Method : GET

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

  Path : v1alpha/{+name}

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

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

  Parameters :

  parent

  Type : string

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

  Location : path

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

  Required : Yes

  HTTP Method : POST

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

  Parameter Order : parent

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

  Path : v1alpha/{+parent}/sfdcInstances

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

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

  Parameter Order : name

  Parameters :

  name

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

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

  Type : string

  Required : Yes

  Location : path

  updateMask

  Type : string

  Format : google-fieldmask

  Location : query

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

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

  HTTP Method : PATCH

  Path : v1alpha/{+name}

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

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

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

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

  Parameter Order : parent

  HTTP Method : POST

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

  Parameters :

  parent

  Required : Yes

  Type : string

  Location : path

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

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

  Path : v1alpha/{+parent}/versions

  Description : Creates an IntegrationTemplateVersion.

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

  Parameters :

  name

  Location : path

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

  Required : Yes

  Type : string

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

  Description : Returns an IntegrationTemplateVersion in the specified project.

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

  Parameter Order : name

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

  Path : v1alpha/{+name}

  HTTP Method : GET

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

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

  Path : v1alpha/{+parent}/versions

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

  Parameters :

  filter

  Type : string

  Description : Filter syntax: defined in the EBNF grammar.

  Location : query

  pageToken

  Type : string

  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.

  Location : query

  parent

  Type : string

  Required : Yes

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

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

  Location : path

  pageSize

  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.

  Location : query

  Format : int32

  Type : integer

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

  Parameter Order : parent

  HTTP Method : GET

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

  Parameters :

  pageToken

  Type : string

  Description : The token returned in the previous response.

  Location : query

  pageSize

  Location : query

  Type : integer

  Format : int32

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

  parent

  Required : Yes

  Location : path

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

  Type : string

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

  readMask

  Location : query

  Type : string

  Format : google-fieldmask

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

  filter

  Type : string

  Location : query

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

  Parameter Order : parent

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

  HTTP Method : GET

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

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

  Path : v1alpha/{+parent}/certificates

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

  Parameters :

  parent

  Type : string

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

  Required : Yes

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

  Location : path

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

  HTTP Method : POST

  Path : v1alpha/{+parent}/certificates

  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

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

  HTTP Method : PATCH

  Parameter Order : name

  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.

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

  Parameters :

  updateMask

  Location : query

  Type : string

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

  Format : google-fieldmask

  name

  Required : Yes

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

  Location : path

  Description : Output only. Auto generated primary key

  Type : string

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

  Path : v1alpha/{+name}

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

  Description : Delete a certificate

  Parameter Order : name

  Parameters :

  name

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

  Required : Yes

  Location : path

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

  Type : string

  Path : v1alpha/{+name}

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

  HTTP Method : DELETE

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

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

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

  HTTP Method : GET

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

  Parameter Order : name

  Path : v1alpha/{+name}

  Description : Get a certificates in the specified project.

  Parameters :

  name

  Type : string

  Required : Yes

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

  Location : path

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

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

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

  HTTP Method : POST

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

  Path : v1alpha/{+parent}:createBundle

  Parameter Order : parent

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

  Parameters :

  parent

  Type : string

  Required : Yes

  Location : path

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

  Description : Required. The location resource of the request.

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

  Parameter Order : parent

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

  Parameters :

  parent

  Required : Yes

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

  Type : string

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

  Location : path

  HTTP Method : GET

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

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

  Path : v1alpha/{+parent}:listTaskEntities

• ▼ ▲ integrations.projects.locations.integrations.schedule

  Parameter Order : name

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

  Path : v1alpha/{+name}:schedule

  Parameters :

  name

  Type : string

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

  Required : Yes

  Description : The integration resource name.

  Location : path

  HTTP Method : POST

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

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

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

  Parameters :

  pageToken

  Type : string

  Location : query

  Description : The page token for the resquest.

  pageSize

  Type : integer

  Format : int32

  Location : query

  Description : The page size for the resquest.

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

  orderBy

  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.

  Location : query

  parent

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

  Type : string

  Required : Yes

  Location : path

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

  Path : v1alpha/{+parent}/integrations

  HTTP Method : GET

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

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

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

  Parameter Order : parent

• ▼ ▲ integrations.projects.locations.integrations.execute

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

  HTTP Method : POST

  Parameter Order : name

  Path : v1alpha/{+name}:execute

  Parameters :

  name

  Description : Required. The integration resource name.

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

  Type : string

  Required : Yes

  Location : path

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

• ▼ ▲ integrations.projects.locations.integrations.monitorexecutionstats

  Description : Get execution stats

  HTTP Method : POST

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

  Parameters :

  parent

  Required : Yes

  Type : string

  Location : path

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

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

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

  Parameter Order : parent

  Path : v1alpha/{+parent}:monitorexecutionstats

• ▼ ▲ integrations.projects.locations.integrations.executions.list

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

  Parameter Order : parent

  HTTP Method : GET

  Path : v1alpha/{+parent}/executions

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

  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.

  Parameters :

  parent

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

  Required : Yes

  Location : path

  Type : string

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

  pageSize

  Location : query

  Type : integer

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

  Format : int32

  filterParams.workflowName

  Location : query

  Description : Workflow name.

  Type : string

  pageToken

  Location : query

  Type : string

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

  filterParams.startTime

  Type : string

  Description : Start timestamp.

  Location : query

  Format : int64

  filterParams.executionId

  Location : query

  Type : string

  Description : Execution id.

  filterParams.customFilter

  Description : Optional user-provided custom filter.

  Type : string

  Location : query

  filterParams.taskStatuses

  Type : string

  Repeated : Yes

  Location : query

  Description : List of possible task statuses.

  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

  filterParams.parameterPairValue

  Type : string

  Description : Param value in the key value pair filter.

  Location : query

  filterParams.parameterPairKey

  Type : string

  Description : Param key in the key value pair filter.

  Location : query

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

  Description : Param key. DEPRECATED. User parameter_pair_key instead.

  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

  filterParams.endTime

  Description : End timestamp.

  Type : string

  Location : query

  Format : int64

  filterParams.parameterType

  Description : Param type.

  Location : query

  Type : string

  readMask

  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.

  Type : string

  Format : google-fieldmask

  Location : query

  filterParams.eventStatuses

  Description : List of possible event statuses.

  Location : query

  Type : string

  Repeated : Yes

  refreshAcl

  Location : query

  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.

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

  Parameter Order : name

  Path : v1alpha/{+name}:deactivate

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

  Type : string

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

  Required : Yes

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

  Location : path

  HTTP Method : POST

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

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

  Parameters :

  name

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

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

  Type : string

  Required : Yes

  Location : path

  HTTP Method : POST

  Parameter Order : name

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

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

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

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

  Path : v1alpha/{+name}:publish

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

  HTTP Method : POST

  Parameter Order : name

  Parameters :

  name

  Location : path

  Required : Yes

  Type : string

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

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

  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.

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

  Description : Get a integration in the specified project.

  Parameters :

  name

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

  Type : string

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

  Required : Yes

  Location : path

  HTTP Method : GET

  Parameter Order : name

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

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

  Path : v1alpha/{+name}

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

  Path : v1alpha/{+parent}/versions

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

  Parameter Order : parent

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

  HTTP Method : GET

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

  Parameters :

  fieldMask

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

  Location : query

  Type : string

  Format : google-fieldmask

  pageSize

  Type : integer

  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

  orderBy

  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

  Location : query

  filter

  Location : query

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

  parent

  Location : path

  Required : Yes

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

  Type : string

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

  pageToken

  Location : query

  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.

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

  HTTP Method : POST

  Path : v1alpha/{+parent}/versions

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

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

  Parameters :

  parent

  Location : path

  Required : Yes

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

  Type : string

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

  newIntegration

  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.

  Location : query

  Type : boolean

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

  Parameter Order : parent

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

  HTTP Method : PATCH

  Parameters :

  name

  Required : Yes

  Description : Output only. Auto-generated primary key.

  Location : path

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

  Type : string

  updateMask

  Format : google-fieldmask

  Location : query

  Type : string

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

  Path : v1alpha/{+name}

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

  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}

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

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

  Parameter Order : integrationVersion

  Parameters :

  integrationVersion

  Required : Yes

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

  Location : path

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

  Type : string

  HTTP Method : POST

  Path : v1alpha/{+integrationVersion}:takeoverEditLock

  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

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

  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

  Parameter Order : name

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

  HTTP Method : POST

• ▼ ▲ integrations.projects.locations.connections.list

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

  Path : v1alpha/{+parent}/connections

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

  HTTP Method : GET

  Description : Lists Connections in a given project and location.

  Parameter Order : parent

  Parameters :

  pageSize

  Type : integer

  Description : Page size.

  Format : int32

  Location : query

  parent

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

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

  Type : string

  Required : Yes

  Location : path

  orderBy

  Location : query

  Description : Order by parameters.

  Type : string

  filter

  Type : string

  Location : query

  Description : Filter.

  pageToken

  Location : query

  Type : string

  Description : Page token.

• ▼ ▲ integrations.projects.locations.connections.getConnectionSchemaMetadata

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

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

  Path : v1alpha/{+name}

  HTTP Method : GET

  Parameters :

  name

  Required : Yes

  Location : path

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

  Type : string

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

  Parameter Order : name

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

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

  Path : v1alpha/{+parent}/runtimeEntitySchemas

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

  Parameters :

  filter

  Type : string

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

  Location : query

  pageToken

  Type : string

  Description : Page token.

  Location : query

  parent

  Required : Yes

  Type : string

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

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

  Location : path

  pageSize

  Type : integer

  Location : query

  Description : Page size.

  Format : int32

  HTTP Method : GET

  Parameter Order : parent

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

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

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

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

  HTTP Method : GET

  Path : v1alpha/{+parent}/runtimeActionSchemas

  Parameter Order : parent

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

  Parameters :

  parent

  Required : Yes

  Location : path

  Type : string

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

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

  filter

  Type : string

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

  Location : query

  pageSize

  Format : int32

  Location : query

  Description : Page size.

  Type : integer

  pageToken

  Type : string

  Description : Page token.

  Location : query

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

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

  Parameter Order : name

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

  Path : v1alpha/{+name}

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

  HTTP Method : GET

  Parameters :

  name

  Type : string

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

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

  Required : Yes

  Location : path

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

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

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

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

  Parameter Order : parent

  HTTP Method : POST

  Path : v1alpha/{+parent}/sfdcChannels

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

  Parameters :

  parent

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

  Required : Yes

  Type : string

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

  Location : path

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

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

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

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

  HTTP Method : PATCH

  Path : v1alpha/{+name}

  Parameters :

  updateMask

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

  Location : query

  Format : google-fieldmask

  Type : string

  name

  Type : string

  Required : Yes

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

  Location : path

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

  Parameter Order : name

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

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

  Parameter Order : name

  HTTP Method : DELETE

  Description : Deletes an sfdc channel.

  Path : v1alpha/{+name}

  Parameters :

  name

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

  Location : path

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

  Required : Yes

  Type : string

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

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

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

  Path : v1alpha/{+parent}/sfdcChannels

  Parameter Order : parent

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

  HTTP Method : GET

  Parameters :

  readMask

  Type : string

  Location : query

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

  Format : google-fieldmask

  filter

  Type : string

  Location : query

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

  pageSize

  Location : query

  Format : int32

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

  Type : integer

  parent

  Type : string

  Required : Yes

  Location : path

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

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

  pageToken

  Location : query

  Type : string

  Description : The token returned in the previous response.

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

• ▼ ▲ integrations.projects.locations.sfdcInstances.get

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

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

  HTTP Method : GET

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

  Parameter Order : name

  Parameters :

  name

  Required : Yes

  Type : string

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

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

  Location : path

  Path : v1alpha/{+name}

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

  Description : Deletes an sfdc instance.

  HTTP Method : DELETE

  Parameters :

  name

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

  Location : path

  Required : Yes

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

  Type : string

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

  Parameter Order : name

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

  Path : v1alpha/{+name}

• ▼ ▲ integrations.projects.locations.sfdcInstances.list

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

  Parameter Order : parent

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

  HTTP Method : GET

  Parameters :

  pageToken

  Location : query

  Description : The token returned in the previous response.

  Type : string

  parent

  Location : path

  Type : string

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

  Required : Yes

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

  pageSize

  Location : query

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

  Type : integer

  Format : int32

  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

  Location : query

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

  Type : string

  Path : v1alpha/{+parent}/sfdcInstances

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

• ▼ ▲ integrations.projects.locations.sfdcInstances.patch

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

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

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

  Parameter Order : name

  Path : v1alpha/{+name}

  Parameters :

  updateMask

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

  Location : query

  Format : google-fieldmask

  Type : string

  name

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

  Type : string

  Required : Yes

  Location : path

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

  HTTP Method : PATCH

• ▼ ▲ integrations.projects.locations.sfdcInstances.create

  HTTP Method : POST

  Parameter Order : parent

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

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

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

  Path : v1alpha/{+parent}/sfdcInstances

  Parameters :

  parent

  Location : path

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

  Type : string

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

  Required : Yes

• ▼ ▲ integrations.projects.locations.certificates.get

  Parameter Order : name

  Path : v1alpha/{+name}

  HTTP Method : GET

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

  Parameters :

  name

  Type : string

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

  Required : Yes

  Location : path

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

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

  Description : Get a certificates in the specified project.

• ▼ ▲ integrations.projects.locations.listTaskEntities

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

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

  Parameter Order : parent

  Path : v1alpha/{+parent}:listTaskEntities

  Parameters :

  parent

  Type : string

  Required : Yes

  Location : path

  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

• ▼ ▲ 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.

  Parameters :

  state

  Location : query

  Description : The auth config id for the given request

  Type : string

  gcpProjectId

  Location : query

  Description : The gcp project id of the request

  Type : string

  code

  Description : The auth code for the given request

  Location : query

  Type : string

  product

  Type : string

  Enum Descriptions :

  Enum :

  • UNSPECIFIED_PRODUCT
  • IP
  • APIGEE
  • SECURITY

  Location : query

  Description : Which product sends the request

  redirectUri

  Type : string

  Location : query

  Description : Redirect uri of the auth code request

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

  Path : v1alpha/callback:generateToken

  HTTP Method : GET

  Flat Path : v1alpha/callback:generateToken