Preview

This product or feature is subject to the "Pre-GA Offerings Terms" in the General Service Terms section of the Service Specific Terms. Pre-GA products and features are available "as is" and might have limited support. For more information, see the launch stage descriptions.

Manage custom connector versions

Create a custom connector version

To create a custom connector version, follow these steps:

1. In the Console, go to the Integration Connectors > Custom connectors page, and then select or create a Google Cloud project.

   Go to the Custom connectors page

   This displays the list of custom connectors.

2. Click the custom connector for which you want to add a version.

   The displays the connection details page.

3. Click Versions.

   The page displays all the versions of the connector.

4. Click Create. This displays the Create new version page with the new version number. The steps to create a new version are similar to that of creating a new custom connector. It means that you can create a version with direct or indirect connectivity.
   • For creating a version with direct connectivity, do steps (from step 3 onwards) as documented in Create a custom connector with direct connectivity.
   • For creating a version with indirect connectivity, do steps (from step 3 onwards) as documented in Create a custom connector with indirect connectivity.

Manage a custom connector version

To edit a custom connector, do the following steps:

1. In the Console, go to the Integration Connectors > Custom connectors page, and then select or create a Google Cloud project.

   Go to the Custom connectors page

   This displays the list of custom connectors.

2. Click the custom connector that has versions.

   The displays the connection details page.

3. Click Versions.

   The versions for the selected connector appears.

4. Click Actions to select one of the following options:
   • View Details: To view the custom connector version details.
   • Deprecate Version: To deprecate the version.
   • Delete: To delete the version.
   • Export: To downloads the connector version as a JSON specification file. For more information, see Export and import.

Export and import

You can share the connector between different Google Cloud projects by exporting and importing the connector specification. You can export any connection version and then import the specification to the same project or different Google Cloud projects. Exporting deprecated connector versions is not supported.

Required roles and permissions

To get the permissions that you need to export and import a custom connector, ask your administrator to grant you the following IAM roles:

• Storage Object Admin (roles/storage.objectAdmin) on the Cloud Storage bucket
• Security Admin (roles/iam.securityAdmin) on the project in which the secret is present. Alternatively, you can also ask your administrator to grant you or the service account, the secretmanager.secrets.getIamPolicy and secretmanager.secrets.setIamPolicy permissions on the project in which the secret is present.

For more information about granting roles, see Manage access to projects, folders, and organizations.

You might also be able to get the required permissions through custom roles or other predefined roles.

Export a custom connector

To export a connector version, follow these steps:

1. In the Console, go to the Integration Connectors > Custom connectors page, and then select or create a Google Cloud project.

   Go to the Custom connectors page

2. Click the custom connector that you want to export. The custom connector's overview page opens.
3. Click Versions. A list of versions of the custom connector is displayed.
4. Click More Actions and then click Export. A JSON specification file for the custom connector is downloaded.

Import a custom connector

To import a connector version, follow these steps:

1. In the Console, go to the Integration Connectors > Custom connectors page, and then select or create a Google Cloud project.

   Go to the Custom connectors page

The Custom connectors page appears.
2. Click Import.
3. Browse and select the JSON specification file for the custom connector. If you are importing the connector to a different project, then the Service account field is not prefilled.
   Note: Ensure that the connector that you want to import is not deprecated.

   Based on whether the connector already exists or not, the following scenarios are possible:

   • Connector with the same name doesn't exist: The Create custom connector page appears. The connector version in the imported JSON is prefilled. This version can't be changed.
   • Connector with the same name exists but the same version doesn't exist: The Create version page for that connector appears. Connector properties like connector type, name, description are prefilled from the existing connector and are not overwritten from the imported JSON. However, the connector version details and name are read from the imported JSON. Only the version name can be edited.
   • Connector with the same name and version exists: A warning message appears stating that the version already exists and a new version will be used when you import the JSON specification. If you click Import, the Create version page for that connector appears. Connector properties like the connector type, name, description are prefilled from the existing connector and are not overwritten by the imported JSON. However, the version details are read from the imported JSON and can be edited. The latest available version number is used for the version name.
4. Fill the remaining details and click Create. The connector is created with the imported JSON specification.