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