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