REST Resource: projects.locations.providers.connectors

Resource: Connector

Connectors indicates a specific connector type, e.x. Salesforce, SAP etc.

JSON representation
{
  "name": string,
  "createTime": string,
  "updateTime": string,
  "labels": {
    string: string,
    ...
  },
  "documentationUri": string,
  "externalUri": string,
  "description": string,
  "webAssetsLocation": string,
  "displayName": string,
  "launchStage": enum (LaunchStage),
  "eventingDetails": {
    object (EventingDetails)
  },
  "category": string,
  "tags": [
    string
  ],
  "connectorType": enum (ConnectorType),
  "marketplaceConnectorDetails": {
    object (MarketplaceConnectorDetails)
  }
}
Fields
name

string

Output only. Resource name of the Connector. Format: projects/{project}/locations/{location}/providers/{provider}/connectors/{connector} Only global location is supported for Connector resource.

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)

Output only. 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" }.

documentationUri

string

Output only. Link to documentation page.

externalUri

string

Output only. Link to external page.

description

string

Output only. Description of the resource.

webAssetsLocation

string

Output only. Cloud storage location of icons etc consumed by UI.

displayName

string

Output only. Display name.

launchStage

enum (LaunchStage)

Output only. Flag to mark the version indicating the launch stage.

eventingDetails

object (EventingDetails)

Output only. Eventing details. Will be null if eventing is not supported.

category

string

Output only. Category of the connector.

tags[]

string

Output only. Tags of the connector.

connectorType

enum (ConnectorType)

Output only. The type of the connector.

marketplaceConnectorDetails

object (MarketplaceConnectorDetails)

Output only. Marketplace connector details. Will be null if the connector is not marketplace connector.

EventingDetails

Eventing Details message.

JSON representation
{
  "name": string,
  "iconLocation": string,
  "description": string,
  "searchTags": [
    string
  ],
  "documentationLink": string,
  "launchStage": enum (LaunchStage),
  "customEventTypes": boolean,
  "type": enum (Type)
}
Fields
name

string

Output only. Name of the Eventing trigger.

iconLocation

string

Output only. Cloud storage location of the icon.

description

string

Output only. Description.

searchTags[]

string

Output only. Array of search keywords.

launchStage

enum (LaunchStage)

Output only. Eventing Launch Stage.

customEventTypes

boolean

Output only. Custom Event Types.

type

enum (Type)

Output only. The type of the event listener for a specific connector.

Type

The different types of the event listener for a connector.

Enums
TYPE_UNSPECIFIED Default value.
WEBHOOK Webhook listener. e.g. Jira, Zendesk, Servicenow etc.,
JMS JMS Listener. e.g. IBM MQ, Rabbit MQ etc.,

ConnectorType

The type of the connector.

Enums
CONNECTOR_TYPE_UNSPECIFIED Default value.
CONNECTOR_TYPE_GOOGLE Google connectors.
CONNECTOR_TYPE_TECHNICAL Technical connectors.
CONNECTOR_TYPE_THIRD_PARTY Third Party connectors.

MarketplaceConnectorDetails

Marketplace connector details.

JSON representation
{
  "partner": string,
  "marketplaceProductId": string,
  "marketplaceProduct": string,
  "marketplaceProductUri": string
}
Fields
partner

string

The name of the partner.

marketplaceProductId

string

Marketplace product ID.

marketplaceProduct

string

Marketplace product name.

marketplaceProductUri

string

Marketplace product URL.

Methods

get

Gets details of a single Connector.

list

Lists Connectors in a given project and location.