class ProjectsLocationsIntegrationsVersions extends Resource (View source)

The "versions" collection of methods.

Typical usage is:

 $integrationsService = new Google\Service\Integrations(...);
 $versions = $integrationsService->projects_locations_integrations_versions;

Methods

create(string $parent, GoogleCloudIntegrationsV1alphaIntegrationVersion $postBody, array $optParams = [])

Create a integration with a draft version in the specified project.

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

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. (versions.delete)

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

Downloads an integration. Retrieves the IntegrationVersion for a given integration_id and returns the response as a string. (versions.download)

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

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.

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

Get a integration in the specified project. (versions.get)

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

Returns the list of all integration versions in the specified project.

patch(string $name, GoogleCloudIntegrationsV1alphaIntegrationVersion $postBody, array $optParams = [])

Update a integration with a draft version in the specified project.

publish(string $name, GoogleCloudIntegrationsV1alphaPublishIntegrationVersionRequest $postBody, array $optParams = [])

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. (versions.publish)

unpublish(string $name, GoogleCloudIntegrationsV1alphaUnpublishIntegrationVersionRequest $postBody, array $optParams = [])

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. (versions.unpublish)

upload(string $parent, GoogleCloudIntegrationsV1alphaUploadIntegrationVersionRequest $postBody, array $optParams = [])

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. (versions.upload)

Details

GoogleCloudIntegrationsV1alphaIntegrationVersion create(string $parent, GoogleCloudIntegrationsV1alphaIntegrationVersion $postBody, array $optParams = [])

Create a integration with a draft version in the specified project.

(versions.create)

Parameters

string $parent

Required. The parent resource where this version will be created. Format: projects/{project}/locations/{location}/integrations/{integration}

GoogleCloudIntegrationsV1alphaIntegrationVersion $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudIntegrationsV1alphaIntegrationVersion

Exceptions

Exception

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

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. (versions.delete)

Parameters

string $name

Required. The version to delete. Format: projects/{projec t}/locations/{location}/integrations/{integration}/versions/{version}

array $optParams

Optional parameters.

Return Value

GoogleProtobufEmpty

Exceptions

Exception

GoogleCloudIntegrationsV1alphaDownloadIntegrationVersionResponse download(string $name, array $optParams = [])

Downloads an integration. Retrieves the IntegrationVersion for a given integration_id and returns the response as a string. (versions.download)

Parameters

string $name

Required. The version to download. Format: projects/{proj ect}/locations/{location}/integrations/{integration}/versions/{version}

array $optParams

Optional parameters.

Return Value

GoogleCloudIntegrationsV1alphaDownloadIntegrationVersionResponse

Exceptions

Exception

GoogleCloudIntegrationsV1alphaDownloadJsonPackageResponse downloadJsonPackage(string $name, array $optParams = [])

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.

(versions.downloadJsonPackage)

Parameters

string $name

Required. Integration version name Format: projects/{proj ect}/locations/{location}/integrations/{integration}/versions/{version}

array $optParams

Optional parameters.

Return Value

GoogleCloudIntegrationsV1alphaDownloadJsonPackageResponse

Exceptions

Exception

GoogleCloudIntegrationsV1alphaIntegrationVersion get(string $name, array $optParams = [])

Get a integration in the specified project. (versions.get)

Parameters

string $name

Required. The version to retrieve. Format: projects/{proj ect}/locations/{location}/integrations/{integration}/versions/{version}

array $optParams

Optional parameters.

Return Value

GoogleCloudIntegrationsV1alphaIntegrationVersion

Exceptions

Exception

GoogleCloudIntegrationsV1alphaListIntegrationVersionsResponse listProjectsLocationsIntegrationsVersions(string $parent, array $optParams = [])

Returns the list of all integration versions in the specified project.

(versions.listProjectsLocationsIntegrationsVersions)

Parameters

string $parent

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".

array $optParams

Optional parameters.

Return Value

GoogleCloudIntegrationsV1alphaListIntegrationVersionsResponse

Exceptions

Exception

GoogleCloudIntegrationsV1alphaIntegrationVersion patch(string $name, GoogleCloudIntegrationsV1alphaIntegrationVersion $postBody, array $optParams = [])

Update a integration with a draft version in the specified project.

(versions.patch)

Parameters

string $name

Output only. Auto-generated primary key.

GoogleCloudIntegrationsV1alphaIntegrationVersion $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudIntegrationsV1alphaIntegrationVersion

Exceptions

Exception

GoogleCloudIntegrationsV1alphaPublishIntegrationVersionResponse publish(string $name, GoogleCloudIntegrationsV1alphaPublishIntegrationVersionRequest $postBody, array $optParams = [])

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. (versions.publish)

Parameters

string $name

Required. The version to publish. Format: projects/{proje ct}/locations/{location}/integrations/{integration}/versions/{version}

GoogleCloudIntegrationsV1alphaPublishIntegrationVersionRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudIntegrationsV1alphaPublishIntegrationVersionResponse

Exceptions

Exception

GoogleProtobufEmpty unpublish(string $name, GoogleCloudIntegrationsV1alphaUnpublishIntegrationVersionRequest $postBody, array $optParams = [])

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. (versions.unpublish)

Parameters

string $name

Required. The version to deactivate. Format: projects/{pr oject}/locations/{location}/integrations/{integration}/versions/{version}

GoogleCloudIntegrationsV1alphaUnpublishIntegrationVersionRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleProtobufEmpty

Exceptions

Exception

GoogleCloudIntegrationsV1alphaUploadIntegrationVersionResponse upload(string $parent, GoogleCloudIntegrationsV1alphaUploadIntegrationVersionRequest $postBody, array $optParams = [])

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. (versions.upload)

Parameters

string $parent

Required. The version to upload. Format: projects/{project}/locations/{location}/integrations/{integration}

GoogleCloudIntegrationsV1alphaUploadIntegrationVersionRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudIntegrationsV1alphaUploadIntegrationVersionResponse

Exceptions

Exception