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