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