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