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