2022-09-19
▼ ▲ integrations.callback.generateToken
Parameters :
gcpProjectId
Description : The gcp project id of the request
Type : string
Location : query
code
Location : query
Type : string
Description : The auth code for the given request
product
Enum :
Location : query
Type : string
Description : Which product sends the request
Enum Descriptions :
state
Location : query
Type : string
Description : The auth config id for the given request
redirectUri
Description : Redirect uri of the auth code request
Location : query
Type : string
Flat Path : v1alpha/callback:generateToken
Path : v1alpha/callback:generateToken
HTTP Method : GET
Scopes : https://www.googleapis.com/auth/cloud-platform
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.
▼ ▲ integrations.connectorPlatformRegions.enumerate
Path : v1alpha/connectorPlatformRegions:enumerate
Description : Enumerates the regions for which Connector Platform is provisioned.
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : GET
Flat Path : v1alpha/connectorPlatformRegions:enumerate
▼ ▲ integrations.projects.locations.connections.runtimeEntitySchemas.list
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/runtimeEntitySchemas
Description : Lists the JSON schemas for the properties of runtime entities, filtered by entity name.
Parameter Order : parent
HTTP Method : GET
Path : v1alpha/{+parent}/runtimeEntitySchemas
Parameters :
pageSize
Description : Page size.
Location : query
Format : int32
Type : integer
filter
Description : Filter. Only the entity field with literal equality operator is supported.
Location : query
Type : string
pageToken
Description : Page token.
Location : query
Type : string
parent
Pattern : ^projects/[^/]+/locations/[^/]+/connections/[^/]+$
Type : string
Location : path
Required : Yes
Description : Required. Parent resource of RuntimeEntitySchema. Format: projects/{project}/locations/{location}/connections/{connection}
▼ ▲ integrations.projects.locations.connections.runtimeActionSchemas.list
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : parent
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/runtimeActionSchemas
HTTP Method : GET
Path : v1alpha/{+parent}/runtimeActionSchemas
Description : Lists the JSON schemas for the inputs and outputs of actions, filtered by action name.
Parameters :
pageToken
Description : Page token.
Location : query
Type : string
pageSize
Type : integer
Description : Page size.
Format : int32
Location : query
parent
Description : Required. Parent resource of RuntimeActionSchema. Format: projects/{project}/locations/{location}/connections/{connection}
Required : Yes
Location : path
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/connections/[^/]+$
filter
Location : query
Description : Filter. Only the action field with literal equality operator is supported.
Type : string
▼ ▲ integrations.projects.locations.connections.list
HTTP Method : GET
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/connections
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
pageToken
Description : Page token.
Location : query
Type : string
filter
Type : string
Location : query
Description : Filter.
orderBy
Description : Order by parameters.
Type : string
Location : query
pageSize
Location : query
Format : int32
Type : integer
Description : Page size.
parent
Description : Required. Parent resource of the Connection, of the form: `projects/*/locations/*`
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Type : string
Required : Yes
Description : Lists Connections in a given project and location.
Path : v1alpha/{+parent}/connections
Parameter Order : parent
▼ ▲ integrations.projects.locations.connections.getConnectionSchemaMetadata
Path : v1alpha/{+name}
Parameter Order : name
Description : Lists the available entities and actions associated with a Connection.
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/connectionSchemaMetadata
HTTP Method : GET
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
name
Type : string
Required : Yes
Description : Required. ConnectionSchemaMetadata name. Format: projects/{project}/locations/{location}/connections/{connection}/connectionSchemaMetadata
Pattern : ^projects/[^/]+/locations/[^/]+/connections/[^/]+/connectionSchemaMetadata$
Location : path
▼ ▲ integrations.projects.locations.authConfigs.list
Parameter Order : parent
Path : v1alpha/{+parent}/authConfigs
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/authConfigs
Parameters :
parent
Pattern : ^projects/[^/]+/locations/[^/]+$
Description : Required. The client, which owns this collection of AuthConfigs.
Required : Yes
Location : path
Type : string
readMask
Location : query
Type : string
Format : google-fieldmask
Description : The mask which specifies fields that need to be returned in the AuthConfig's response.
pageSize
Location : query
Description : The size of entries in the response. If unspecified, defaults to 100.
Format : int32
Type : integer
pageToken
Description : The token returned in the previous response.
Location : query
Type : string
filter
Location : query
Description : Filtering as supported in https://developers.google.com/authorized-buyers/apis/guides/v2/list-filters.
Type : string
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.create
Parameter Order : parent
Path : v1alpha/{+parent}/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.
HTTP Method : POST
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/authConfigs
Parameters :
parent
Required : Yes
Type : string
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+$
Description : Required. "projects/{project}/locations/{location}" format.
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
Location : query
Type : string
Description : The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines. For example, -----BEGIN CERTIFICATE----- MIICTTCCAbagAwIBAgIJAPT0tSKNxan/MA0GCSqGSIb3DQEBCwUAMCoxFzAVBgNV BAoTDkdvb2dsZSBURVNUSU5HMQ8wDQYDVQQDEwZ0ZXN0Q0EwHhcNMTUwMTAxMDAw MDAwWhcNMjUwMTAxMDAwMDAwWjAuMRcwFQYDVQQKEw5Hb29nbGUgVEVTVElORzET MBEGA1UEAwwKam9lQGJhbmFuYTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA vDYFgMgxi5W488d9J7UpCInl0NXmZQpJDEHE4hvkaRlH7pnC71H0DLt0/3zATRP1 JzY2+eqBmbGl4/sgZKYv8UrLnNyQNUTsNx1iZAfPUflf5FwgVsai8BM0pUciq1NB xD429VFcrGZNucvFLh72RuRFIKH8WUpiK/iZNFkWhZ0CAwEAAaN3MHUwDgYDVR0P AQH/BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAMBgNVHRMB Af8EAjAAMBkGA1UdDgQSBBCVgnFBCWgL/iwCqnGrhTPQMBsGA1UdIwQUMBKAEKey Um2o4k2WiEVA0ldQvNYwDQYJKoZIhvcNAQELBQADgYEAYK986R4E3L1v+Q6esBtW JrUwA9UmJRSQr0N5w3o9XzarU37/bkjOP0Fw0k/A6Vv1n3vlciYfBFaBIam1qRHr 5dMsYf4CZS6w50r7hyzqyrwDoyNxkLnd2PdcHT/sym1QmflsjEs7pejtnohO6N2H wQW6M0H7Zt8claGRla4fKkg= -----END CERTIFICATE-----
clientCertificate.encryptedPrivateKey
Description : The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines. For example, -----BEGIN CERTIFICATE----- MIICTTCCAbagAwIBAgIJAPT0tSKNxan/MA0GCSqGSIb3DQEBCwUAMCoxFzAVBgNV BAoTDkdvb2dsZSBURVNUSU5HMQ8wDQYDVQQDEwZ0ZXN0Q0EwHhcNMTUwMTAxMDAw MDAwWhcNMjUwMTAxMDAwMDAwWjAuMRcwFQYDVQQKEw5Hb29nbGUgVEVTVElORzET MBEGA1UEAwwKam9lQGJhbmFuYTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA vDYFgMgxi5W488d9J7UpCInl0NXmZQpJDEHE4hvkaRlH7pnC71H0DLt0/3zATRP1 JzY2+eqBmbGl4/sgZKYv8UrLnNyQNUTsNx1iZAfPUflf5FwgVsai8BM0pUciq1NB xD429VFcrGZNucvFLh72RuRFIKH8WUpiK/iZNFkWhZ0CAwEAAaN3MHUwDgYDVR0P AQH/BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAMBgNVHRMB Af8EAjAAMBkGA1UdDgQSBBCVgnFBCWgL/iwCqnGrhTPQMBsGA1UdIwQUMBKAEKey Um2o4k2WiEVA0ldQvNYwDQYJKoZIhvcNAQELBQADgYEAYK986R4E3L1v+Q6esBtW JrUwA9UmJRSQr0N5w3o9XzarU37/bkjOP0Fw0k/A6Vv1n3vlciYfBFaBIam1qRHr 5dMsYf4CZS6w50r7hyzqyrwDoyNxkLnd2PdcHT/sym1QmflsjEs7pejtnohO6N2H wQW6M0H7Zt8claGRla4fKkg= -----END CERTIFICATE-----
Location : query
Type : string
▼ ▲ integrations.projects.locations.authConfigs.delete
Parameters :
name
Type : string
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/authConfigs/[^/]+$
Description : Required. The name that is associated with the AuthConfig.
Required : Yes
Description : Deletes an auth config.
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/authConfigs/{authConfigsId}
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : name
Path : v1alpha/{+name}
HTTP Method : DELETE
▼ ▲ integrations.projects.locations.authConfigs.patch
Path : v1alpha/{+name}
Description : Updates an auth config. If credential is updated, fetch the encrypted auth config from Spanner, decrypt with Cloud KMS key, update the credential fields, re-encrypt with Cloud KMS key and update the Spanner record. For other fields, directly update the Spanner record. Returns the encrypted auth config.
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : PATCH
Parameter Order : name
Parameters :
clientCertificate.encryptedPrivateKey
Description : The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines. For example, -----BEGIN CERTIFICATE----- MIICTTCCAbagAwIBAgIJAPT0tSKNxan/MA0GCSqGSIb3DQEBCwUAMCoxFzAVBgNV BAoTDkdvb2dsZSBURVNUSU5HMQ8wDQYDVQQDEwZ0ZXN0Q0EwHhcNMTUwMTAxMDAw MDAwWhcNMjUwMTAxMDAwMDAwWjAuMRcwFQYDVQQKEw5Hb29nbGUgVEVTVElORzET MBEGA1UEAwwKam9lQGJhbmFuYTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA vDYFgMgxi5W488d9J7UpCInl0NXmZQpJDEHE4hvkaRlH7pnC71H0DLt0/3zATRP1 JzY2+eqBmbGl4/sgZKYv8UrLnNyQNUTsNx1iZAfPUflf5FwgVsai8BM0pUciq1NB xD429VFcrGZNucvFLh72RuRFIKH8WUpiK/iZNFkWhZ0CAwEAAaN3MHUwDgYDVR0P AQH/BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAMBgNVHRMB Af8EAjAAMBkGA1UdDgQSBBCVgnFBCWgL/iwCqnGrhTPQMBsGA1UdIwQUMBKAEKey Um2o4k2WiEVA0ldQvNYwDQYJKoZIhvcNAQELBQADgYEAYK986R4E3L1v+Q6esBtW JrUwA9UmJRSQr0N5w3o9XzarU37/bkjOP0Fw0k/A6Vv1n3vlciYfBFaBIam1qRHr 5dMsYf4CZS6w50r7hyzqyrwDoyNxkLnd2PdcHT/sym1QmflsjEs7pejtnohO6N2H wQW6M0H7Zt8claGRla4fKkg= -----END CERTIFICATE-----
Location : query
Type : string
name
Description : Resource name of the SFDC instance projects/{project}/locations/{location}/authConfigs/{authConfig}.
Location : path
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/authConfigs/[^/]+$
Required : Yes
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
Location : query
Type : string
Description : 'passphrase' should be left unset if private key is not encrypted. Note that 'passphrase' is not the password for web server, but an extra layer of security to protected private key.
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/authConfigs/{authConfigsId}
▼ ▲ integrations.projects.locations.authConfigs.get
Parameters :
name
Description : Required. The name that is associated with the AuthConfig.
Required : Yes
Type : string
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/authConfigs/[^/]+$
Path : v1alpha/{+name}
HTTP Method : GET
Scopes : https://www.googleapis.com/auth/cloud-platform
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.
Parameter Order : name
▼ ▲ integrations.projects.locations.products.authConfigs.patch
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : PATCH
Parameters :
clientCertificate.passphrase
Location : query
Type : string
Description : 'passphrase' should be left unset if private key is not encrypted. Note that 'passphrase' is not the password for web server, but an extra layer of security to protected private key.
updateMask
Format : google-fieldmask
Description : Field mask specifying the fields in the above AuthConfig that have been modified and need to be updated.
Type : string
Location : query
name
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/authConfigs/[^/]+$
Location : path
Type : string
Required : Yes
Description : Resource name of the SFDC instance projects/{project}/locations/{location}/authConfigs/{authConfig}.
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
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
Path : v1alpha/{+name}
Description : Updates an auth config. If credential is updated, fetch the encrypted auth config from Spanner, decrypt with Cloud KMS key, update the credential fields, re-encrypt with Cloud KMS key and update the Spanner record. For other fields, directly update the Spanner record. Returns the encrypted auth config.
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/authConfigs/{authConfigsId}
Parameter Order : name
▼ ▲ integrations.projects.locations.products.authConfigs.delete
HTTP Method : DELETE
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/authConfigs/{authConfigsId}
Parameters :
name
Location : path
Type : string
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/authConfigs/[^/]+$
Description : Required. The name that is associated with the AuthConfig.
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Deletes an auth config.
Path : v1alpha/{+name}
Parameter Order : name
▼ ▲ integrations.projects.locations.products.authConfigs.get
HTTP Method : GET
Parameters :
name
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/authConfigs/[^/]+$
Description : Required. The name that is associated with the AuthConfig.
Required : Yes
Type : string
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/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.
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1alpha/{+name}
Parameter Order : name
▼ ▲ integrations.projects.locations.products.authConfigs.list
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/authConfigs
Path : v1alpha/{+parent}/authConfigs
Description : Lists all auth configs that match the filter. Restrict to auth configs belong to the current client only.
Parameters :
filter
Location : query
Type : string
Description : Filtering as supported in https://developers.google.com/authorized-buyers/apis/guides/v2/list-filters.
parent
Required : Yes
Description : Required. The client, which owns this collection of AuthConfigs.
Location : path
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+$
pageSize
Type : integer
Location : query
Description : The size of entries in the response. If unspecified, defaults to 100.
Format : int32
readMask
Format : google-fieldmask
Description : The mask which specifies fields that need to be returned in the AuthConfig's response.
Location : query
Type : string
pageToken
Type : string
Location : query
Description : The token returned in the previous response.
Parameter Order : parent
HTTP Method : GET
▼ ▲ integrations.projects.locations.products.authConfigs.create
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.
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/authConfigs
Parameters :
clientCertificate.sslCertificate
Location : query
Type : string
Description : The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines. For example, -----BEGIN CERTIFICATE----- MIICTTCCAbagAwIBAgIJAPT0tSKNxan/MA0GCSqGSIb3DQEBCwUAMCoxFzAVBgNV BAoTDkdvb2dsZSBURVNUSU5HMQ8wDQYDVQQDEwZ0ZXN0Q0EwHhcNMTUwMTAxMDAw MDAwWhcNMjUwMTAxMDAwMDAwWjAuMRcwFQYDVQQKEw5Hb29nbGUgVEVTVElORzET MBEGA1UEAwwKam9lQGJhbmFuYTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA vDYFgMgxi5W488d9J7UpCInl0NXmZQpJDEHE4hvkaRlH7pnC71H0DLt0/3zATRP1 JzY2+eqBmbGl4/sgZKYv8UrLnNyQNUTsNx1iZAfPUflf5FwgVsai8BM0pUciq1NB xD429VFcrGZNucvFLh72RuRFIKH8WUpiK/iZNFkWhZ0CAwEAAaN3MHUwDgYDVR0P AQH/BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAMBgNVHRMB Af8EAjAAMBkGA1UdDgQSBBCVgnFBCWgL/iwCqnGrhTPQMBsGA1UdIwQUMBKAEKey Um2o4k2WiEVA0ldQvNYwDQYJKoZIhvcNAQELBQADgYEAYK986R4E3L1v+Q6esBtW JrUwA9UmJRSQr0N5w3o9XzarU37/bkjOP0Fw0k/A6Vv1n3vlciYfBFaBIam1qRHr 5dMsYf4CZS6w50r7hyzqyrwDoyNxkLnd2PdcHT/sym1QmflsjEs7pejtnohO6N2H wQW6M0H7Zt8claGRla4fKkg= -----END CERTIFICATE-----
clientCertificate.encryptedPrivateKey
Type : string
Location : query
Description : The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines. For example, -----BEGIN CERTIFICATE----- MIICTTCCAbagAwIBAgIJAPT0tSKNxan/MA0GCSqGSIb3DQEBCwUAMCoxFzAVBgNV BAoTDkdvb2dsZSBURVNUSU5HMQ8wDQYDVQQDEwZ0ZXN0Q0EwHhcNMTUwMTAxMDAw MDAwWhcNMjUwMTAxMDAwMDAwWjAuMRcwFQYDVQQKEw5Hb29nbGUgVEVTVElORzET MBEGA1UEAwwKam9lQGJhbmFuYTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA vDYFgMgxi5W488d9J7UpCInl0NXmZQpJDEHE4hvkaRlH7pnC71H0DLt0/3zATRP1 JzY2+eqBmbGl4/sgZKYv8UrLnNyQNUTsNx1iZAfPUflf5FwgVsai8BM0pUciq1NB xD429VFcrGZNucvFLh72RuRFIKH8WUpiK/iZNFkWhZ0CAwEAAaN3MHUwDgYDVR0P AQH/BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAMBgNVHRMB Af8EAjAAMBkGA1UdDgQSBBCVgnFBCWgL/iwCqnGrhTPQMBsGA1UdIwQUMBKAEKey Um2o4k2WiEVA0ldQvNYwDQYJKoZIhvcNAQELBQADgYEAYK986R4E3L1v+Q6esBtW JrUwA9UmJRSQr0N5w3o9XzarU37/bkjOP0Fw0k/A6Vv1n3vlciYfBFaBIam1qRHr 5dMsYf4CZS6w50r7hyzqyrwDoyNxkLnd2PdcHT/sym1QmflsjEs7pejtnohO6N2H wQW6M0H7Zt8claGRla4fKkg= -----END CERTIFICATE-----
clientCertificate.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
parent
Type : string
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+$
Location : path
Description : Required. "projects/{project}/locations/{location}" format.
Path : v1alpha/{+parent}/authConfigs
HTTP Method : POST
▼ ▲ integrations.projects.locations.products.sfdcInstances.list
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
pageSize
Description : The size of entries in the response. If unspecified, defaults to 100.
Type : integer
Location : query
Format : int32
parent
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+$
Location : path
Description : Required. The client, which owns this collection of SfdcInstances.
Required : Yes
pageToken
Type : string
Location : query
Description : The token returned in the previous response.
readMask
Location : query
Description : The mask which specifies fields that need to be returned in the SfdcInstance's response.
Type : string
Format : google-fieldmask
filter
Location : query
Type : string
Description : Filtering as supported in https://developers.google.com/authorized-buyers/apis/guides/v2/list-filters.
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/sfdcInstances
Parameter Order : parent
Description : Lists all sfdc instances that match the filter. Restrict to sfdc instances belonging to the current client only.
HTTP Method : GET
Path : v1alpha/{+parent}/sfdcInstances
▼ ▲ integrations.projects.locations.products.sfdcInstances.get
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/sfdcInstances/{sfdcInstancesId}
Parameter Order : name
Parameters :
name
Location : path
Required : Yes
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/sfdcInstances/[^/]+$
Description : Required. The name that is associated with the SfdcInstance.
Path : v1alpha/{+name}
HTTP Method : GET
Description : Gets an sfdc instance. If the instance doesn't exist, Code.NOT_FOUND exception will be thrown.
▼ ▲ integrations.projects.locations.products.sfdcInstances.create
Description : Creates an sfdc instance record. Store the sfdc instance in Spanner. Returns the sfdc instance.
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/sfdcInstances
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : parent
Path : v1alpha/{+parent}/sfdcInstances
HTTP Method : POST
Parameters :
parent
Required : Yes
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+$
Location : path
Description : Required. "projects/{project}/locations/{location}" format.
▼ ▲ integrations.projects.locations.products.sfdcInstances.patch
HTTP Method : PATCH
Description : Updates an sfdc instance. Updates the sfdc instance in spanner. Returns the sfdc instance.
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1alpha/{+name}
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/sfdcInstances/{sfdcInstancesId}
Parameters :
updateMask
Description : Field mask specifying the fields in the above SfdcInstance that have been modified and need to be updated.
Format : google-fieldmask
Type : string
Location : query
name
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/sfdcInstances/[^/]+$
Required : Yes
Description : Resource name of the SFDC instance projects/{project}/locations/{location}/sfdcInstances/{sfdcInstance}.
Type : string
▼ ▲ integrations.projects.locations.products.sfdcInstances.delete
Description : Deletes an sfdc instance.
Path : v1alpha/{+name}
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : name
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/sfdcInstances/{sfdcInstancesId}
Parameters :
name
Required : Yes
Location : path
Description : Required. The name that is associated with the SfdcInstance.
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/sfdcInstances/[^/]+$
HTTP Method : DELETE
▼ ▲ integrations.projects.locations.products.sfdcInstances.sfdcChannels.list
HTTP Method : GET
Path : v1alpha/{+parent}/sfdcChannels
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/sfdcInstances/{sfdcInstancesId}/sfdcChannels
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
pageToken
Location : query
Type : string
Description : The token returned in the previous response.
pageSize
Location : query
Description : The size of entries in the response. If unspecified, defaults to 100.
Format : int32
Type : integer
readMask
Format : google-fieldmask
Description : The mask which specifies fields that need to be returned in the SfdcChannel's response.
Type : string
Location : query
parent
Description : Required. The client, which owns this collection of SfdcChannels.
Location : path
Required : Yes
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/sfdcInstances/[^/]+$
filter
Type : string
Location : query
Description : Filtering as supported in https://developers.google.com/authorized-buyers/apis/guides/v2/list-filters.
Description : Lists all sfdc channels that match the filter. Restrict to sfdc channels belonging to the current client only.
▼ ▲ integrations.projects.locations.products.sfdcInstances.sfdcChannels.patch
HTTP Method : PATCH
Description : Updates an sfdc channel. Updates the sfdc channel in spanner. Returns the sfdc channel.
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/sfdcInstances/{sfdcInstancesId}/sfdcChannels/{sfdcChannelsId}
Parameters :
updateMask
Type : string
Description : Field mask specifying the fields in the above SfdcChannel that have been modified and need to be updated.
Location : query
Format : google-fieldmask
name
Location : path
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/sfdcInstances/[^/]+/sfdcChannels/[^/]+$
Description : Resource name of the SFDC channel projects/{project}/locations/{location}/sfdcInstances/{sfdc_instance}/sfdcChannels/{sfdc_channel}.
Type : string
Parameter Order : name
Path : v1alpha/{+name}
▼ ▲ integrations.projects.locations.products.sfdcInstances.sfdcChannels.get
Parameters :
name
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/sfdcInstances/[^/]+/sfdcChannels/[^/]+$
Type : string
Location : path
Description : Required. The name that is associated with the SfdcChannel.
Description : Gets an sfdc channel. If the channel doesn't exist, Code.NOT_FOUND exception will be thrown.
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/sfdcInstances/{sfdcInstancesId}/sfdcChannels/{sfdcChannelsId}
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : GET
Parameter Order : name
Path : v1alpha/{+name}
▼ ▲ integrations.projects.locations.products.sfdcInstances.sfdcChannels.create
HTTP Method : POST
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/sfdcInstances/{sfdcInstancesId}/sfdcChannels
Description : Creates an sfdc channel record. Store the sfdc channel in Spanner. Returns the sfdc channel.
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : parent
Path : v1alpha/{+parent}/sfdcChannels
Parameters :
parent
Description : Required. "projects/{project}/locations/{location}" format.
Location : path
Type : string
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/sfdcInstances/[^/]+$
▼ ▲ integrations.projects.locations.products.sfdcInstances.sfdcChannels.delete
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1alpha/{+name}
HTTP Method : DELETE
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/sfdcInstances/{sfdcInstancesId}/sfdcChannels/{sfdcChannelsId}
Description : Deletes an sfdc channel.
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.integrations.execute
Parameters :
name
Location : path
Description : Required. The integration resource name.
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+$
Type : string
Description : Executes integrations synchronously by passing the trigger id in the request body. The request is not returned until the requested executions are either fulfilled or experienced an error. If the integration name is not specified (passing `-`), all of the associated integration under the given trigger_id will be executed. Otherwise only the specified integration for the given `trigger_id` is executed. This is helpful for execution the integration from UI.
Path : v1alpha/{+name}:execute
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : POST
Parameter Order : name
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}:execute
▼ ▲ integrations.projects.locations.products.integrations.monitorexecutionstats
HTTP Method : POST
Description : Get execution stats
Path : v1alpha/{+parent}:monitorexecutionstats
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : parent
Parameters :
parent
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+$
Location : path
Type : string
Description : Required. The parent resource name: {parent=projects/*/locations/*}.
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}:monitorexecutionstats
▼ ▲ integrations.projects.locations.products.integrations.schedule
Parameter Order : name
HTTP Method : POST
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}:schedule
Path : v1alpha/{+name}:schedule
Parameters :
name
Description : The integration resource name.
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+$
Type : string
Required : Yes
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.archiveBundle
HTTP Method : POST
Path : v1alpha/{+name}:archiveBundle
Parameters :
name
Description : Required. The bundle to archive. Format: projects/{project}/integrations/{integration}
Required : Yes
Location : path
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+$
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}:archiveBundle
Description : PROTECT WITH A VISIBILITY LABEL. THIS METHOD WILL BE MOVED TO A SEPARATE SERVICE. Soft-deletes the bundle.
Parameter Order : name
▼ ▲ integrations.projects.locations.products.integrations.list
Parameter Order : parent
HTTP Method : GET
Parameters :
orderBy
Type : string
Location : query
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.
parent
Type : string
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+$
Location : path
Description : Required. Project and location from which the integrations should be listed. Format: projects/{project}
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
pageSize
Location : query
Type : integer
Format : int32
Description : The page size for the resquest.
pageToken
Location : query
Description : The page token for the resquest.
Type : string
Description : Returns the list of all integrations in the specified project.
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1alpha/{+parent}/integrations
▼ ▲ integrations.projects.locations.products.integrations.executions.suspensions.lift
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/executions/{executionsId}/suspensions/{suspensionsId}:lift
HTTP Method : POST
Description : * Lifts suspension for advanced suspension task. Fetch corresponding suspension with provided suspension Id, resolve suspension, and set up suspension result for the Suspension Task.
Parameters :
name
Description : Required. The resource that the suspension belongs to. "projects/{project}/locations/{location}/products/{product}/integrations/{integration}/executions/{execution}/suspensions/{suspenion}" format.
Type : string
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+/executions/[^/]+/suspensions/[^/]+$
Location : path
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1alpha/{+name}:lift
Parameter Order : name
▼ ▲ integrations.projects.locations.products.integrations.executions.suspensions.resolve
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/executions/{executionsId}/suspensions/{suspensionsId}:resolve
HTTP Method : POST
Path : v1alpha/{+name}:resolve
Scopes : https://www.googleapis.com/auth/cloud-platform
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.
Parameters :
name
Description : Required. projects/{gcp_project_id}/locations/{location}/products/{product}/integrations/{integration_name}/executions/{execution_name}/suspensions/{suspension_id}
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+/executions/[^/]+/suspensions/[^/]+$
Location : path
Required : Yes
Parameter Order : name
▼ ▲ integrations.projects.locations.products.integrations.executions.suspensions.list
Parameter Order : parent
HTTP Method : GET
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/executions/{executionsId}/suspensions
Parameters :
filter
Description : Standard filter field.
Location : query
Type : string
pageSize
Location : query
Type : integer
Description : Maximum number of entries in the response.
Format : int32
pageToken
Location : query
Description : Token to retrieve a specific page.
Type : string
parent
Description : Required. projects/{gcp_project_id}/locations/{location}/products/{product}/integrations/{integration_name}/executions/{execution_name}
Location : path
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+/executions/[^/]+$
Required : Yes
orderBy
Description : Field name to order by.
Location : query
Type : string
Path : v1alpha/{+parent}/suspensions
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.cancel
Description : Cancellation of an execution
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
Required : Yes
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+/executions/[^/]+$
Parameter Order : name
Path : v1alpha/{+name}:cancel
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/executions/{executionsId}:cancel
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : POST
▼ ▲ integrations.projects.locations.products.integrations.executions.get
Scopes : https://www.googleapis.com/auth/cloud-platform
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}
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+/executions/[^/]+$
Required : Yes
Parameter Order : name
Description : Get an execution in the specified project.
HTTP Method : GET
Path : v1alpha/{+name}
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/executions/{executionsId}
▼ ▲ integrations.projects.locations.products.integrations.executions.list
Parameter Order : parent
Description : Lists the status of the integration executions.
Path : v1alpha/{+parent}/executions
HTTP Method : GET
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
parent
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+$
Description : Required. The parent resource name of the integration execution.
Required : Yes
Location : path
filterParams.executionId
Description : Execution id.
Type : string
Location : query
filterParams.customFilter
Location : query
Description : Optional user-provided custom filter.
Type : string
pageSize
Location : query
Description : Optional. The size of entries in the response.
Format : int32
Type : integer
truncateParams
Type : boolean
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.
Location : query
filterParams.eventStatuses
Location : query
Description : List of possible event statuses.
Repeated : Yes
Type : string
filterParams.startTime
Type : string
Description : Start timestamp.
Format : int64
Location : query
filterParams.parameterPairKey
Type : string
Description : Param key in the key value pair filter.
Location : query
orderBy
Description : Optional. The results would be returned in order you specified here. Currently supporting "last_modified_time" and "create_time".
Type : string
Location : query
filterParams.parameterKey
Location : query
Description : Param key. DEPRECATED. User parameter_pair_key instead.
Type : string
filterParams.workflowName
Type : string
Description : Workflow name.
Location : query
filterParams.parameterValue
Description : Param value. DEPRECATED. User parameter_pair_value instead.
Type : string
Location : query
pageToken
Location : query
Type : string
Description : Optional. The token returned in the previous response.
filterParams.triggerId
Description : Trigger id.
Location : query
Type : string
readMask
Format : google-fieldmask
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.
Location : query
Type : string
filterParams.parameterType
Description : Param type.
Type : string
Location : query
filterParams.parameterPairValue
Type : string
Description : Param value in the key value pair filter.
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.
Location : query
Type : boolean
filterParams.taskStatuses
Type : string
Description : List of possible task statuses.
Location : query
Repeated : Yes
filterParams.endTime
Location : query
Type : string
Format : int64
Description : End timestamp.
filter
Description : Optional. Standard filter field, we support filtering on all fields in EventExecutionParamIndexes table. All fields support for EQUALS, in additional: CreateTimestamp support for LESS_THAN, GREATER_THAN ParameterKey, ParameterValue, ParameterType support for HAS For example: "parameter_value" HAS \"parameter1\" Also supports operators like AND, OR, NOT For example, trigger_id=\"id1\" AND event_execution_state=\"FAILED\"
Location : query
Type : string
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/executions
▼ ▲ integrations.projects.locations.products.integrations.versions.download
HTTP Method : GET
Path : v1alpha/{+name}:download
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions/{versionsId}:download
Parameters :
fileFormat
Description : File format for download request.
Enum Descriptions :
Type : string
Enum :
Location : query
name
Location : path
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+/versions/[^/]+$
Required : Yes
Description : Required. The version to download. Format: projects/{project}/integrations/{integration}/versions/{version}
Parameter Order : name
Description : Downloads an integration. Retrieves the `IntegrationVersion` for a given `integration_id` and returns the response as a string.
▼ ▲ integrations.projects.locations.products.integrations.versions.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.
Path : v1alpha/{+name}:publish
HTTP Method : POST
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
name
Location : path
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+/versions/[^/]+$
Description : Required. The version to publish. Format: projects/{project}/integrations/{integration}/versions/{version}
Required : Yes
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions/{versionsId}:publish
Parameter Order : name
▼ ▲ integrations.projects.locations.products.integrations.versions.create
Path : v1alpha/{+parent}/versions
Parameter Order : parent
HTTP Method : POST
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions
Parameters :
newIntegration
Type : boolean
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
parent
Type : string
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+$
Description : Required. The parent resource where this version will be created. Format: projects/{project}/integrations/{integration}
Location : path
Description : Create a integration with a draft version in the specified project.
▼ ▲ integrations.projects.locations.products.integrations.versions.deactivate
Description : Sets the status of the ACTIVE integration to SNAPSHOT with a new tag "PREVIOUSLY_PUBLISHED" after validating it. The "HEAD" and "PUBLISH_REQUESTED" tags do not change. This RPC throws an exception if the version being snapshot is not ACTIVE. Audit fields added include action, action_by, action_timestamp.
Parameters :
name
Required : Yes
Type : string
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+/versions/[^/]+$
Description : Required. The version to deactivate. Format: projects/{project}/integrations/{integration}/versions/{version}
HTTP Method : POST
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions/{versionsId}:deactivate
Parameter Order : name
Path : v1alpha/{+name}:deactivate
▼ ▲ integrations.projects.locations.products.integrations.versions.validate
Parameter Order : name
Path : v1alpha/{+name}:validate
HTTP Method : POST
Description : Validates the given integration. If the id doesn't exist, a NotFoundException is thrown. If validation fails a CanonicalCodeException is thrown. If there was no failure an empty response is returned.
Parameters :
name
Required : Yes
Description : Required. The version to validate. Format: projects/{project}/integrations/{integration}/versions/{version}
Location : path
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+/versions/[^/]+$
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions/{versionsId}:validate
▼ ▲ integrations.projects.locations.products.integrations.versions.updateBundle
Path : v1alpha/{+name}:updateBundle
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : THIS METHOD WILL BE MOVED TO A SEPARATE SERVICE. RPC to update the Bundle
Parameters :
name
Description : Required. Bundle name
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+/versions/[^/]+$
Location : path
Type : string
HTTP Method : PATCH
Parameter Order : name
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions/{versionsId}:updateBundle
▼ ▲ integrations.projects.locations.products.integrations.versions.takeoverEditLock
Parameter Order : integrationVersion
Parameters :
integrationVersion
Location : path
Type : string
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+/versions/[^/]+$
Description : Required. The version to take over edit lock. Format: projects/{project}/integrations/{integration}/versions/{version}
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.
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions/{versionsId}:takeoverEditLock
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : POST
▼ ▲ integrations.projects.locations.products.integrations.versions.upload
HTTP Method : POST
Parameters :
parent
Description : Required. The version to upload. Format: projects/{project}/integrations/{integration}
Required : Yes
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+$
Location : path
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : parent
Description : Uploads an integration. The content can be a previously downloaded integration. Performs the same function as CreateDraftIntegrationVersion, but accepts input in a string format, which holds the complete representation of the IntegrationVersion content.
Path : v1alpha/{+parent}/versions:upload
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions:upload
▼ ▲ integrations.projects.locations.products.integrations.versions.get
Path : v1alpha/{+name}
Parameter Order : name
Parameters :
name
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+/versions/[^/]+$
Location : path
Description : Required. The version to retrieve. Format: projects/{project}/integrations/{integration}/versions/{version}
Required : Yes
Description : Get a integration in the specified project.
HTTP Method : GET
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions/{versionsId}
▼ ▲ integrations.projects.locations.products.integrations.versions.patch
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
updateMask
Format : google-fieldmask
Type : string
Location : query
Description : Field mask specifying the fields in the above integration that have been modified and need to be updated.
name
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+/versions/[^/]+$
Required : Yes
Location : path
Description : Output only. Auto-generated primary key.
Parameter Order : name
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions/{versionsId}
Description : Update a integration with a draft version in the specified project.
Path : v1alpha/{+name}
HTTP Method : PATCH
▼ ▲ integrations.projects.locations.products.integrations.versions.getBundle
Parameters :
name
Location : path
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+/versions/[^/]+$
Description : Required. The bundle name.
Required : Yes
Path : v1alpha/{+name}:getBundle
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions/{versionsId}:getBundle
Description : PROTECT WITH A VISIBILITY LABEL. THIS METHOD WILL BE MOVED TO A SEPARATE SERVICE. RPC to get details of the Bundle
HTTP Method : GET
Parameter Order : name
▼ ▲ integrations.projects.locations.products.integrations.versions.list
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions
Parameter Order : parent
Parameters :
pageToken
Description : A page token, received from a previous `ListIntegrationVersions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListIntegrationVersions` must match the call that provided the page token.
Location : query
Type : string
parent
Type : string
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+$
Description : Required. The parent resource where this version will be created. Format: projects/{project}/integrations/{integration} Specifically, when parent equals: 1. projects//locations//integrations/, Meaning: "List versions (with filter) for a particular integration". 2. projects//locations//integrations/- Meaning: "List versions (with filter) for a client within a particular region". 3. projects//locations/-/integrations/- Meaning: "List versions (with filter) for a client".
Location : path
pageSize
Format : int32
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.
orderBy
Location : query
Type : string
Description : The results would be returned in order you specified here. Currently supported sort keys are: Descending sort order for "last_modified_time", "created_time", "snapshot_number" Ascending sort order for "name".
fieldMask
Type : string
Location : query
Format : google-fieldmask
Description : The field mask which specifies the particular data to be returned.
filter
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`.
Type : string
HTTP Method : GET
Path : v1alpha/{+parent}/versions
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Returns the list of all integration versions in the specified project.
▼ ▲ integrations.projects.locations.products.integrations.versions.archive
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : name
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+/versions/[^/]+$
Type : string
Description : Required. The version to archive. Format: projects/{project}/integrations/{integration}/versions/{version}
Required : Yes
Location : path
Path : v1alpha/{+name}:archive
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions/{versionsId}:archive
Description : Soft-deletes the integration. Changes the status of the integration to ARCHIVED. If the integration being ARCHIVED is tagged as "HEAD", the tag is removed from this snapshot and set to the previous non-ARCHIVED snapshot. The PUBLISH_REQUESTED, DUE_FOR_DELETION tags are removed too. This RPC throws an exception if the version being archived is DRAFT, and if the `locked_by` user is not the same as the user performing the Archive. Audit fields updated include last_modified_timestamp, last_modified_by. Any existing lock is released when Archiving a integration. Currently, there is no unarchive mechanism.
HTTP Method : POST
▼ ▲ integrations.projects.locations.products.integrations.executionsnapshots.list
Description : Lists the snapshots of a given integration executions. This RPC is not being used.
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
pageSize
Type : integer
Location : query
Description : Number of entries to be returned in a page.
Format : int32
parent
Description : Required. The parent resource name of the integration execution.
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+$
Required : Yes
Location : path
pageToken
Location : query
Type : string
Description : The token used to retrieve the next page results.
filter
Type : string
Description : Currently supports filter by `execution_info_id` or `execution_snapshot_id`.
Location : query
readMask
Format : google-fieldmask
Type : string
Description : View mask for the response data. If set, only the field specified will be returned as part of the result. If not set, all fields in event execution snapshot will be filled and returned.
Location : query
Parameter Order : parent
Path : v1alpha/{+parent}/executionsnapshots
HTTP Method : GET
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/executionsnapshots
▼ ▲ integrations.projects.locations.products.integrationtemplates.versions.list
Parameters :
pageToken
Location : query
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.
filter
Type : string
Location : query
Description : Filter syntax: defined in the EBNF grammar.
parent
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrationtemplates/[^/]+$
Required : Yes
Location : path
Description : Required. Format: projects/{project}/location/{location}/product/{product}/integrationtemplates/{integrationtemplate}
Type : string
pageSize
Type : integer
Description : The maximum number of IntegrationTemplateVersions to return. The service may return fewer than this value. If unspecified, at most 50 versions will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
Format : int32
Location : query
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrationtemplates/{integrationtemplatesId}/versions
Description : Returns the list of all IntegrationTemplateVersions in the specified project.
Path : v1alpha/{+parent}/versions
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : GET
▼ ▲ integrations.projects.locations.products.integrationtemplates.versions.get
Parameter Order : name
HTTP Method : GET
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1alpha/{+name}
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/[^/]+$
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrationtemplates/{integrationtemplatesId}/versions/{versionsId}
Description : Returns an IntegrationTemplateVersion in the specified project.
▼ ▲ integrations.projects.locations.products.integrationtemplates.versions.create
Parameter Order : parent
Parameters :
parent
Location : path
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/integrationtemplates/[^/]+$
Required : Yes
Description : Required. The parent resource where this TemplateVersion will be created. Format: projects/{project}/location/{location}/product/{product}/integrationtemplates/{integrationtemplate}
HTTP Method : POST
Path : v1alpha/{+parent}/versions
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Creates an IntegrationTemplateVersion.
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrationtemplates/{integrationtemplatesId}/versions
▼ ▲ integrations.projects.locations.products.certificates.create
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.
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1alpha/{+parent}/certificates
HTTP Method : POST
Parameter Order : parent
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/certificates
Parameters :
parent
Location : path
Required : Yes
Type : string
Description : Required. "projects/{project}/locations/{location}" format.
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+$
▼ ▲ integrations.projects.locations.products.certificates.list
HTTP Method : GET
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/certificates
Description : List all the certificates that match the filter. Restrict to certificate of current client only.
Parameters :
parent
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+$
Description : Required. The client, which owns this collection of Certificates.
Type : string
Location : path
Required : Yes
filter
Location : query
Type : string
Description : Filtering as supported in https://developers.google.com/authorized-buyers/apis/guides/v2/list-filters.
pageSize
Format : int32
Description : The size of entries in the response. If unspecified, defaults to 100.
Location : query
Type : integer
readMask
Location : query
Description : The mask which specifies fields that need to be returned in the Certificate's response.
Format : google-fieldmask
Type : string
pageToken
Location : query
Description : The token returned in the previous response.
Type : string
Path : v1alpha/{+parent}/certificates
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : parent
▼ ▲ integrations.projects.locations.products.certificates.delete
Description : Delete a certificate
Path : v1alpha/{+name}
HTTP Method : DELETE
Parameter Order : name
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/certificates/[^/]+$
Required : Yes
Type : string
Description : Required. The name that is associated with the Certificate.
Location : path
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/certificates/{certificatesId}
▼ ▲ integrations.projects.locations.products.certificates.patch
HTTP Method : PATCH
Parameters :
name
Type : string
Description : Output only. Auto generated primary key
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/certificates/[^/]+$
Location : path
Required : Yes
updateMask
Description : Field mask specifying the fields in the above Certificate that have been modified and need to be updated.
Format : google-fieldmask
Location : query
Type : string
Path : v1alpha/{+name}
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/certificates/{certificatesId}
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
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.
▼ ▲ integrations.projects.locations.products.certificates.get
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
name
Description : Required. The certificate to retrieve. Format: projects/{project}/locations/{location}/certificates/{certificate}
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+/certificates/[^/]+$
Type : string
Location : path
Required : Yes
Parameter Order : name
HTTP Method : GET
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/certificates/{certificatesId}
Description : Get a certificates in the specified project.
Path : v1alpha/{+name}
▼ ▲ integrations.projects.locations.products.listTaskEntities
Path : v1alpha/{+parent}:listTaskEntities
HTTP Method : GET
Parameters :
parent
Type : string
Location : path
Description : Required. The location resource of the request. This is not going to be used but preserve the field for future.
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+$
Required : Yes
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}:listTaskEntities
Description : This is a UI only method and will be moved away. Returns a list of common tasks.
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : parent
▼ ▲ integrations.projects.locations.products.createBundle
Path : v1alpha/{+parent}:createBundle
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : parent
HTTP Method : POST
Description : PROTECT WITH A VISIBILITY LABEL. THIS METHOD WILL BE MOVED TO A SEPARATE SERVICE. Create a bundle.
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}:createBundle
Parameters :
parent
Location : path
Description : Required. The location resource of the request.
Type : string
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/products/[^/]+$
▼ ▲ integrations.projects.locations.certificates.get
Description : Get a certificates in the specified project.
Parameters :
name
Description : Required. The certificate to retrieve. Format: projects/{project}/locations/{location}/certificates/{certificate}
Type : string
Required : Yes
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/certificates/[^/]+$
Path : v1alpha/{+name}
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/certificates/{certificatesId}
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : GET
▼ ▲ integrations.projects.locations.appsScriptProjects.create
Parameter Order : parent
Path : v1alpha/{+parent}/appsScriptProjects
Description : Creates an Apps Script project.
Parameters :
parent
Description : Required. The project that the executed integration belongs to.
Pattern : ^projects/[^/]+/locations/[^/]+$
Type : string
Required : Yes
Location : path
HTTP Method : POST
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/appsScriptProjects
▼ ▲ integrations.projects.locations.appsScriptProjects.link
Parameters :
parent
Description : Required. The project that the executed integration belongs to.
Pattern : ^projects/[^/]+/locations/[^/]+$
Type : string
Required : Yes
Location : path
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/appsScriptProjects:link
HTTP Method : POST
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : parent
Description : Links a existing Apps Script project.
Path : v1alpha/{+parent}/appsScriptProjects:link
▼ ▲ integrations.projects.locations.sfdcInstances.get
HTTP Method : GET
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
name
Location : path
Required : Yes
Type : string
Description : Required. The name that is associated with the SfdcInstance.
Pattern : ^projects/[^/]+/locations/[^/]+/sfdcInstances/[^/]+$
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/sfdcInstances/{sfdcInstancesId}
Path : v1alpha/{+name}
Description : Gets an sfdc instance. If the instance doesn't exist, Code.NOT_FOUND exception will be thrown.
Parameter Order : name
▼ ▲ integrations.projects.locations.sfdcInstances.create
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1alpha/{+parent}/sfdcInstances
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/sfdcInstances
Parameter Order : parent
HTTP Method : POST
Description : Creates an sfdc instance record. Store the sfdc instance in Spanner. Returns the sfdc instance.
Parameters :
parent
Type : string
Required : Yes
Location : path
Description : Required. "projects/{project}/locations/{location}" format.
Pattern : ^projects/[^/]+/locations/[^/]+$
▼ ▲ integrations.projects.locations.sfdcInstances.delete
Description : Deletes an sfdc instance.
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/sfdcInstances/[^/]+$
Type : string
Description : Required. The name that is associated with the SfdcInstance.
Location : path
Required : Yes
Path : v1alpha/{+name}
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : DELETE
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/sfdcInstances/{sfdcInstancesId}
▼ ▲ integrations.projects.locations.sfdcInstances.list
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/sfdcInstances
HTTP Method : GET
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : parent
Path : v1alpha/{+parent}/sfdcInstances
Parameters :
filter
Location : query
Type : string
Description : Filtering as supported in https://developers.google.com/authorized-buyers/apis/guides/v2/list-filters.
pageToken
Location : query
Type : string
Description : The token returned in the previous response.
readMask
Type : string
Description : The mask which specifies fields that need to be returned in the SfdcInstance's response.
Location : query
Format : google-fieldmask
pageSize
Description : The size of entries in the response. If unspecified, defaults to 100.
Format : int32
Type : integer
Location : query
parent
Description : Required. The client, which owns this collection of SfdcInstances.
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Description : Lists all sfdc instances that match the filter. Restrict to sfdc instances belonging to the current client only.
▼ ▲ integrations.projects.locations.sfdcInstances.patch
Parameter Order : name
Parameters :
updateMask
Location : query
Format : google-fieldmask
Description : Field mask specifying the fields in the above SfdcInstance that have been modified and need to be updated.
Type : string
name
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/sfdcInstances/[^/]+$
Description : Resource name of the SFDC instance projects/{project}/locations/{location}/sfdcInstances/{sfdcInstance}.
Type : string
Required : Yes
HTTP Method : PATCH
Path : v1alpha/{+name}
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/sfdcInstances/{sfdcInstancesId}
Description : Updates an sfdc instance. Updates the sfdc instance in spanner. Returns the sfdc instance.
▼ ▲ integrations.projects.locations.sfdcInstances.sfdcChannels.patch
Parameter Order : name
Description : Updates an sfdc channel. Updates the sfdc channel in spanner. Returns the sfdc channel.
HTTP Method : PATCH
Parameters :
updateMask
Location : query
Type : string
Format : google-fieldmask
Description : Field mask specifying the fields in the above SfdcChannel that have been modified and need to be updated.
name
Type : string
Required : Yes
Description : Resource name of the SFDC channel projects/{project}/locations/{location}/sfdcInstances/{sfdc_instance}/sfdcChannels/{sfdc_channel}.
Pattern : ^projects/[^/]+/locations/[^/]+/sfdcInstances/[^/]+/sfdcChannels/[^/]+$
Location : path
Path : v1alpha/{+name}
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/sfdcInstances/{sfdcInstancesId}/sfdcChannels/{sfdcChannelsId}
▼ ▲ integrations.projects.locations.sfdcInstances.sfdcChannels.create
Parameter Order : parent
HTTP Method : POST
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.
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
parent
Required : Yes
Type : string
Location : path
Description : Required. "projects/{project}/locations/{location}" format.
Pattern : ^projects/[^/]+/locations/[^/]+/sfdcInstances/[^/]+$
Path : v1alpha/{+parent}/sfdcChannels
▼ ▲ integrations.projects.locations.sfdcInstances.sfdcChannels.get
Description : Gets an sfdc channel. If the channel doesn't exist, Code.NOT_FOUND exception will be thrown.
HTTP Method : GET
Path : v1alpha/{+name}
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : name
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/sfdcInstances/{sfdcInstancesId}/sfdcChannels/{sfdcChannelsId}
Parameters :
name
Required : Yes
Description : Required. The name that is associated with the SfdcChannel.
Pattern : ^projects/[^/]+/locations/[^/]+/sfdcInstances/[^/]+/sfdcChannels/[^/]+$
Location : path
Type : string
▼ ▲ integrations.projects.locations.sfdcInstances.sfdcChannels.list
Path : v1alpha/{+parent}/sfdcChannels
Description : Lists all sfdc channels that match the filter. Restrict to sfdc channels belonging to the current client only.
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : parent
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/sfdcInstances/{sfdcInstancesId}/sfdcChannels
Parameters :
readMask
Format : google-fieldmask
Description : The mask which specifies fields that need to be returned in the SfdcChannel's response.
Type : string
Location : query
filter
Location : query
Type : string
Description : Filtering as supported in https://developers.google.com/authorized-buyers/apis/guides/v2/list-filters.
pageSize
Description : The size of entries in the response. If unspecified, defaults to 100.
Format : int32
Location : query
Type : integer
parent
Type : string
Location : path
Description : Required. The client, which owns this collection of SfdcChannels.
Pattern : ^projects/[^/]+/locations/[^/]+/sfdcInstances/[^/]+$
Required : Yes
pageToken
Location : query
Description : The token returned in the previous response.
Type : string
HTTP Method : GET
▼ ▲ integrations.projects.locations.sfdcInstances.sfdcChannels.delete
Description : Deletes an sfdc channel.
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/sfdcInstances/{sfdcInstancesId}/sfdcChannels/{sfdcChannelsId}
HTTP Method : DELETE
Path : v1alpha/{+name}
Parameter Order : name
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/sfdcInstances/[^/]+/sfdcChannels/[^/]+$
Required : Yes
Type : string
Location : path
Description : Required. The name that is associated with the SfdcChannel.
▼ ▲ integrations.projects.locations.integrations.list
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : parent
Parameters :
parent
Location : path
Description : Required. Project and location from which the integrations should be listed. Format: projects/{project}
Pattern : ^projects/[^/]+/locations/[^/]+$
Type : string
Required : Yes
orderBy
Description : The results would be returned in order you specified here. Supported sort keys are: Descending sort order by "last_modified_time", "created_time", "snapshot_number". Ascending sort order by the integration name.
Type : string
Location : query
pageToken
Location : query
Type : string
Description : The page token for the resquest.
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`.
pageSize
Location : query
Description : The page size for the resquest.
Format : int32
Type : integer
Path : v1alpha/{+parent}/integrations
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/integrations
Description : Returns the list of all integrations in the specified project.
HTTP Method : GET
▼ ▲ integrations.projects.locations.integrations.schedule
HTTP Method : POST
Path : v1alpha/{+name}:schedule
Description : Schedules an integration for execution by passing the trigger id and the scheduled time in the request body.
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}:schedule
Parameter Order : name
Parameters :
name
Description : The integration resource name.
Pattern : ^projects/[^/]+/locations/[^/]+/integrations/[^/]+$
Required : Yes
Location : path
Type : string
▼ ▲ integrations.projects.locations.integrations.execute
HTTP Method : POST
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}:execute
Parameter Order : name
Parameters :
name
Required : Yes
Location : path
Description : Required. The integration resource name.
Pattern : ^projects/[^/]+/locations/[^/]+/integrations/[^/]+$
Type : string
Path : v1alpha/{+name}: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
HTTP Method : POST
Parameters :
parent
Type : string
Description : Required. The parent resource name: {parent=projects/*/locations/*}.
Required : Yes
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/integrations/[^/]+$
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}:monitorexecutionstats
Description : Get execution stats
Parameter Order : parent
Path : v1alpha/{+parent}:monitorexecutionstats
▼ ▲ integrations.projects.locations.integrations.executions.list
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
filterParams.triggerId
Description : Trigger id.
Type : string
Location : query
truncateParams
Location : query
Type : boolean
Description : Optional. If true, the service will truncate the params to only keep the first 1000 characters of string params and empty the executions in order to make response smaller. Only works for UI and when the params fields are not filtered out.
filterParams.endTime
Location : query
Description : End timestamp.
Type : string
Format : int64
filterParams.eventStatuses
Type : string
Description : List of possible event statuses.
Repeated : Yes
Location : query
filterParams.parameterKey
Type : string
Description : Param key. DEPRECATED. User parameter_pair_key instead.
Location : query
filterParams.taskStatuses
Location : query
Type : string
Repeated : Yes
Description : List of possible task statuses.
filterParams.parameterPairValue
Type : string
Location : query
Description : Param value in the key value pair filter.
filterParams.parameterValue
Description : Param value. DEPRECATED. User parameter_pair_value instead.
Type : string
Location : query
filterParams.customFilter
Type : string
Description : Optional user-provided custom filter.
Location : query
filter
Type : string
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
filterParams.parameterPairKey
Description : Param key in the key value pair filter.
Type : string
Location : query
pageToken
Type : string
Description : Optional. The token returned in the previous response.
Location : query
filterParams.startTime
Type : string
Location : query
Description : Start timestamp.
Format : int64
filterParams.executionId
Location : query
Description : Execution id.
Type : string
filterParams.parameterType
Description : Param type.
Location : query
Type : string
parent
Description : Required. The parent resource name of the integration execution.
Pattern : ^projects/[^/]+/locations/[^/]+/integrations/[^/]+$
Type : string
Location : path
Required : Yes
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
Description : Optional. The size of entries in the response.
Location : query
Type : integer
Format : int32
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.workflowName
Location : query
Type : string
Description : Workflow name.
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
Parameter Order : parent
Description : Lists the status of the integration executions.
HTTP Method : GET
Path : v1alpha/{+parent}/executions
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/executions
▼ ▲ integrations.projects.locations.integrations.versions.list
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1alpha/{+parent}/versions
Parameters :
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
pageToken
Type : string
Location : query
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.
pageSize
Description : The maximum number of versions to return. The service may return fewer than this value. If unspecified, at most 50 versions will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
Location : query
Format : int32
Type : integer
filter
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`.
Type : string
parent
Location : path
Type : string
Description : Required. The parent resource where this version will be created. Format: projects/{project}/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".
Pattern : ^projects/[^/]+/locations/[^/]+/integrations/[^/]+$
Required : Yes
fieldMask
Location : query
Format : google-fieldmask
Type : string
Description : The field mask which specifies the particular data to be returned.
HTTP Method : GET
Description : Returns the list of all integration versions in the specified project.
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions
Parameter Order : parent
▼ ▲ integrations.projects.locations.integrations.versions.archive
Path : v1alpha/{+name}:archive
Parameter Order : name
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
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}:archive
HTTP Method : POST
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/integrations/[^/]+/versions/[^/]+$
Required : Yes
Type : string
Description : Required. The version to archive. Format: projects/{project}/integrations/{integration}/versions/{version}
Location : path
▼ ▲ integrations.projects.locations.integrations.versions.deactivate
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Sets the status of the ACTIVE integration to SNAPSHOT with a new tag "PREVIOUSLY_PUBLISHED" after validating it. The "HEAD" and "PUBLISH_REQUESTED" tags do not change. This RPC throws an exception if the version being snapshot is not ACTIVE. Audit fields added include action, action_by, action_timestamp.
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/integrations/[^/]+/versions/[^/]+$
Description : Required. The version to deactivate. Format: projects/{project}/integrations/{integration}/versions/{version}
Location : path
Required : Yes
Type : string
Parameter Order : name
Path : v1alpha/{+name}:deactivate
HTTP Method : POST
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}:deactivate
▼ ▲ integrations.projects.locations.integrations.versions.validate
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.
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1alpha/{+name}:validate
HTTP Method : POST
Parameters :
name
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/integrations/[^/]+/versions/[^/]+$
Description : Required. The version to validate. Format: projects/{project}/integrations/{integration}/versions/{version}
Type : string
Required : Yes
▼ ▲ integrations.projects.locations.integrations.versions.publish
Parameters :
name
Required : Yes
Description : Required. The version to publish. Format: projects/{project}/integrations/{integration}/versions/{version}
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/integrations/[^/]+/versions/[^/]+$
Type : string
HTTP Method : POST
Scopes : https://www.googleapis.com/auth/cloud-platform
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.
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}:publish
Parameter Order : name
Path : v1alpha/{+name}:publish
▼ ▲ integrations.projects.locations.integrations.versions.patch
Description : Update a integration with a draft version in the specified project.
HTTP Method : PATCH
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : name
Path : v1alpha/{+name}
Parameters :
name
Description : Output only. Auto-generated primary key.
Pattern : ^projects/[^/]+/locations/[^/]+/integrations/[^/]+/versions/[^/]+$
Type : string
Required : Yes
Location : path
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
▼ ▲ integrations.projects.locations.integrations.versions.create
Description : Create a integration with a draft version in the specified project.
HTTP Method : POST
Parameter Order : parent
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions
Path : v1alpha/{+parent}/versions
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
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
parent
Location : path
Type : string
Description : Required. The parent resource where this version will be created. Format: projects/{project}/integrations/{integration}
Pattern : ^projects/[^/]+/locations/[^/]+/integrations/[^/]+$
Required : Yes
▼ ▲ integrations.projects.locations.integrations.versions.get
Description : Get a integration in the specified project.
Parameters :
name
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/integrations/[^/]+/versions/[^/]+$
Required : Yes
Location : path
Description : Required. The version to retrieve. Format: projects/{project}/integrations/{integration}/versions/{version}
Parameter Order : name
Path : v1alpha/{+name}
HTTP Method : GET
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}
▼ ▲ integrations.projects.locations.integrations.versions.takeoverEditLock
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
Parameter Order : integrationVersion
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}:takeoverEditLock
Parameters :
integrationVersion
Type : string
Description : Required. The version to take over edit lock. Format: projects/{project}/integrations/{integration}/versions/{version}
Pattern : ^projects/[^/]+/locations/[^/]+/integrations/[^/]+/versions/[^/]+$
Required : Yes
Location : path
▼ ▲ integrations.projects.locations.listTaskEntities
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : This is a UI only method and will be moved away. Returns a list of common tasks.
HTTP Method : GET
Parameter Order : parent
Parameters :
parent
Required : Yes
Description : Required. The location resource of the request. This is not going to be used but preserve the field for future.
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+$
Type : string
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}:listTaskEntities
Path : v1alpha/{+parent}:listTaskEntities