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