REST Resource: projects.locations.global.customConnectors.customConnectorVersions

Resource: CustomConnectorVersion

CustomConnectorVersion indicates a specific version of a connector.

JSON representation
{
  "name": string,
  "createTime": string,
  "updateTime": string,
  "labels": {
    string: string,
    ...
  },
  "enableBackendDestinationConfig": boolean,
  "authConfig": {
    object (AuthConfig)
  },
  "destinationConfigs": [
    {
      object (DestinationConfig)
    }
  ],
  "specLocation": string,
  "serviceAccount": string,
  "backendVariableTemplates": [
    {
      object (ConfigVariableTemplate)
    }
  ],
  "state": enum (State),
  "specServerUrls": [
    string
  ],
  "partnerMetadata": {
    object (PartnerMetadata)
  },
  "publishStatus": {
    object (PublishStatus)
  }
}
Fields
name

string

Output only. Identifier. Resource name of the Version. Format: projects/{project}/locations/{location}/customConnectors/{customConnector}/customConnectorVersions/{customConnectorVersion}

createTime

string (Timestamp format)

Output only. Created time.

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

updateTime

string (Timestamp format)

Output only. Updated time.

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

labels

map (key: string, value: string)

Optional. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

enableBackendDestinationConfig

boolean

Optional. When enabled, the connector will be a facade/ proxy, and connects to the destination provided during connection creation.

authConfig

object (AuthConfig)

Optional. Authentication config for accessing connector facade/ proxy. This is used only when enableBackendDestinationConfig is true.

destinationConfigs[]

object (DestinationConfig)

Optional. Destination config(s) for accessing connector facade/ proxy. This is used only when enableBackendDestinationConfig is true.

specLocation

string

Optional. Location of the custom connector spec. The location can be either a public url like https://public-url.com/spec Or a Google Cloud Storage location like gs://<BUCKET_NAME>/<OBJECT_NAME>

serviceAccount

string

Optional. Service account used by runtime plane to access auth config secrets.

backendVariableTemplates[]

object (ConfigVariableTemplate)

Optional. Backend variables config templates. This translates to additional variable templates in connection.

state

enum (State)

Output only. State of the custom connector version.

specServerUrls[]

string

Output only. Server URLs parsed from the spec.

partnerMetadata

object (PartnerMetadata)

Optional. Partner metadata details. This should be populated only when publishing the custom connector to partner connector.

publishStatus

object (PublishStatus)

Output only. Publish status of a custom connector.

State

All the possible custom connector version states.

Enums
STATE_UNSPECIFIED State Unspecified.
ACTIVE Active state. By default we set the state to Active.
DEPRECATED Deprecated state.

PartnerMetadata

Partner metadata details. This will be populated when publishing the custom connector as a partner connector version. On publishing, parntner connector version will be created using the fields in PartnerMetadata.

JSON representation
{
  "partner": string,
  "marketplaceProductId": string,
  "marketplaceProduct": string,
  "marketplaceProductUri": string,
  "marketplaceProductProjectId": string,
  "acceptGcpTos": boolean,
  "confirmPartnerRequirements": boolean,
  "targetApplication": string,
  "useCases": string,
  "targetCustomerSegment": string,
  "demoUri": string,
  "integrationTemplates": string,
  "additionalComments": string,
  "partnerConnectorDisplayName": string,
  "publishRequestTime": string,
  "hasDynamicSpecUri": boolean,
  "localSpecPath": string
}
Fields
partner

string

Required. Partner name.

marketplaceProductId

string

Required. Marketplace product ID.

marketplaceProduct

string

Optional. Marketplace product name.

marketplaceProductUri

string

Optional. Marketplace product URL.

marketplaceProductProjectId

string

Optional. Marketplace product project ID.

acceptGcpTos

boolean

Required. Whether the user has accepted the Google Cloud Platform Terms of Service (https://cloud.google.com/terms/) and the Google Cloud Marketplace Terms of Service (https://cloud.google.com/terms/marketplace/launcher.

confirmPartnerRequirements

boolean

Required. Confirmation that connector meets all applicable requirements mentioned in the Partner Connector Publishing requirements list and Partner onboardiong requirements list (https://cloud.google.com/marketplace/docs/partners/get-started#requirements).

targetApplication

string

Required. Target application for which partner connector is built.

useCases

string

Required. Details about partner connector use cases.

targetCustomerSegment

string

Required. Target customer segment for the partner connector.

demoUri

string

Required. Public URL for the demo video.

integrationTemplates

string

Required. Integration example templates for the custom connector.

additionalComments

string

Optional. Additional comments for the submission.

partnerConnectorDisplayName

string

Required. Partner connector display name.

publishRequestTime

string (Timestamp format)

Output only. Publish request time.

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

hasDynamicSpecUri

boolean

Output only. Has dynamic open api spec uri.

localSpecPath

string

Output only. Local spec path. Required if hasDynamicSpecUri is true.

PublishStatus

Publish status of a custom connector.

JSON representation
{
  "publishState": enum (PublishState),
  "publishedAs": string,
  "publishedSource": string,
  "publishTime": string
}
Fields
publishState

enum (PublishState)

Output only. Publish state of the custom connector.

publishedAs

string

Output only. Partner connector name. Will be set on the custom connector. Format: providers/partner/connectors//versions/

publishedSource

string

Output only. Custom connector name. Will be set on the partner connector. Format: providers/customconnectors/connectors//versions/

publishTime

string (Timestamp format)

Output only. Publish time.

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

PublishState

Published state of the custom connector.

Enums
PUBLISH_STATE_UNSPECIFIED State Unspecified.
PUBLISHED Connector version has been published as partner connector version.
PUBLISH_IN_PROGRESS Connector version is in the process of being published as partner connector version.
UNPUBLISHED Connector version has been unpublished as partner connector version

Methods

create

Creates a new CustomConnectorVersion in a given project and location.

get

Gets details of a single CustomConnectorVersion.

list

List CustomConnectorVersions in a given project