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