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