class ProjectsLocationsIntegrations extends Resource (View source)

The "integrations" collection of methods.

Typical usage is:

 $integrationsService = new Google\Service\Integrations(...);
 $integrations = $integrationsService->projects_locations_integrations;

Methods

delete(string $name, array $optParams = [])

Delete the selected integration and all versions inside (integrations.delete)

execute(string $name, GoogleCloudIntegrationsV1alphaExecuteIntegrationsRequest $postBody, array $optParams = [])

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. (integrations.execute)

executeEvent(string $name, ExecuteEventRequestContent $postBody, array $optParams = [])

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 (integrations.executeEvent)

listProjectsLocationsIntegrations(string $parent, array $optParams = [])

Returns the list of all integrations in the specified project.

schedule(string $name, GoogleCloudIntegrationsV1alphaScheduleIntegrationsRequest $postBody, array $optParams = [])

Schedules an integration for execution by passing the trigger id and the scheduled time in the request body. (integrations.schedule)

test(string $name, GoogleCloudIntegrationsV1alphaTestIntegrationsRequest $postBody, array $optParams = [])

Execute the integration in draft state (integrations.test)

Details

GoogleProtobufEmpty delete(string $name, array $optParams = [])

Delete the selected integration and all versions inside (integrations.delete)

Parameters

string $name

Required. The location resource of the request.

array $optParams

Optional parameters.

Return Value

GoogleProtobufEmpty

Exceptions

Exception

GoogleCloudIntegrationsV1alphaExecuteIntegrationsResponse execute(string $name, GoogleCloudIntegrationsV1alphaExecuteIntegrationsRequest $postBody, array $optParams = [])

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. (integrations.execute)

Parameters

string $name

Required. The integration resource name.

GoogleCloudIntegrationsV1alphaExecuteIntegrationsRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudIntegrationsV1alphaExecuteIntegrationsResponse

Exceptions

Exception

GoogleCloudIntegrationsV1alphaExecuteEventResponse executeEvent(string $name, ExecuteEventRequestContent $postBody, array $optParams = [])

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 (integrations.executeEvent)

Parameters

string $name

Required. The integration resource name. Format: projects/{gcp_project_id}/locations/{location}/integrations/{integration_id}

ExecuteEventRequestContent $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudIntegrationsV1alphaExecuteEventResponse

Exceptions

Exception

GoogleCloudIntegrationsV1alphaListIntegrationsResponse listProjectsLocationsIntegrations(string $parent, array $optParams = [])

Returns the list of all integrations in the specified project.

(integrations.listProjectsLocationsIntegrations)

Parameters

string $parent

Required. Project and location from which the integrations should be listed. Format: projects/{project}

array $optParams

Optional parameters.

Return Value

GoogleCloudIntegrationsV1alphaListIntegrationsResponse

Exceptions

Exception

GoogleCloudIntegrationsV1alphaScheduleIntegrationsResponse schedule(string $name, GoogleCloudIntegrationsV1alphaScheduleIntegrationsRequest $postBody, array $optParams = [])

Schedules an integration for execution by passing the trigger id and the scheduled time in the request body. (integrations.schedule)

Parameters

string $name

The integration resource name.

GoogleCloudIntegrationsV1alphaScheduleIntegrationsRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudIntegrationsV1alphaScheduleIntegrationsResponse

Exceptions

Exception

GoogleCloudIntegrationsV1alphaTestIntegrationsResponse test(string $name, GoogleCloudIntegrationsV1alphaTestIntegrationsRequest $postBody, array $optParams = [])

Execute the integration in draft state (integrations.test)

Parameters

string $name

Output only. Auto-generated primary key.

GoogleCloudIntegrationsV1alphaTestIntegrationsRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudIntegrationsV1alphaTestIntegrationsResponse

Exceptions

Exception