openapi: 3.2.0
info:
  description: 'Use the Connector Hub API to transfer data between services in Oracle Cloud Infrastructure.

    For more information about Connector Hub, see

    [the Connector Hub documentation](/iaas/Content/connector-hub/home.htm).

    Connector Hub is formerly known as Service Connector Hub.

    '
  title: Connector Hub Connector Plugins API
  version: '20200909'
  x-provenance:
    method: harvested
    first_party: true
    publisher: Oracle
    source: https://docs.oracle.com/en-us/iaas/api/specs/23d281837e4b021adcde2cd8fb72e929da1a886c4122c7403ffaa25526a68b61.yaml
    harvested: '2026-08-04'
    note: Published by Oracle as the contract for the Connector Hub API OCI service and stored verbatim; API Evangelist added only this provenance block.
  x-evidence:
  - url: https://docs.oracle.com/en-us/iaas/api/specs/index.json
    what: Oracle's own index of every OCI service specification
  - url: https://docs.oracle.com/en-us/iaas/api/specs/23d281837e4b021adcde2cd8fb72e929da1a886c4122c7403ffaa25526a68b61.yaml
    what: the harvested document for Connector Hub API
servers:
- url: https://127.0.0.1/20200909
tags:
- name: connectorPlugins
paths:
  /connectorPlugins:
    get:
      description: 'Lists connector plugins according to the specified filter.

        '
      operationId: ListConnectorPlugins
      parameters:
      - $ref: '#/components/parameters/LifecycleStateQueryParam'
      - $ref: '#/components/parameters/DisplayNameQueryParam'
      - $ref: '#/components/parameters/ConnectorPluginNameQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/SortByQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: 'The list of service connector plugins was retrieved.

            '
          headers:
            opc-next-page:
              description: 'For list pagination. When this header appears in the response,

                additional pages of results remain. For important details about

                how pagination works, see

                [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).

                '
              schema:
                type: string
            opc-prev-page:
              description: 'For list pagination.  When this header appears in the response,

                previous pages of results exist. For important details about

                how pagination works, see

                [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorPluginCollection'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Lists all connector plugins that can be used.
      tags:
      - connectorPlugins
      x-example: 'Sample 1: List all active connector plugins, sorted by name


        GET /20200909/connectorPlugins?&lifecycleState="ACTIVE"&sortBy="displayName"

        Host: service-connector-hub.us-phoenix-1.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>


        Sample 2: List connector plugins that have the name "QueueSource"


        GET /20200909/connectorPlugins?&name="QueueSource"

        Host: service-connector-hub.us-phoenix-1.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
      x-obmcs-authz-declarations:
        authorizationRequired: false
      x-related-resource: '#/definitions/ConnectorPluginSummary'
  /connectorPlugins/{connectorPluginName}:
    get:
      description: 'Gets the specified connector plugin configuration information.

        '
      operationId: GetConnectorPlugin
      parameters:
      - $ref: '#/components/parameters/ConnectorPluginNamePathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: 'The information was retrieved.

            '
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorPlugin'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Gets the specified connector plugin configuration information.
      tags:
      - connectorPlugins
      x-example: 'GET /20200909/connectorPlugins/<connectorPluginName>

        Host: service-connector-hub.us-phoenix-1.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
      x-obmcs-authz-declarations:
        authorizationRequired: false
components:
  schemas:
    ConnectorPluginSummary:
      description: 'Summary information for a connector plugin.

        Example connector plugins include the Streaming source and the Notifications target.

        For more information about flows defined by connectors, see

        [Overview of Connector Hub](/iaas/Content/connector-hub/overview.htm).

        For configuration instructions, see

        [Creating a Connector](/iaas/Content/connector-hub/create-service-connector.htm).

        '
      discriminator:
        propertyName: kind
      properties:
        displayName:
          description: 'A user-friendly name. It does not have to be unique, and it is changeable.

            Avoid entering confidential information.

            '
          type: string
        estimatedThroughput:
          default: UNKNOWN
          description: 'The estimated throughput range (LOW, MEDIUM, HIGH).

            '
          enum:
          - LOW
          - MEDIUM
          - HIGH
          - UNKNOWN
          type: string
          x-obmcs-top-level-enum: '#/definitions/EstimatedThroughput'
        kind:
          description: 'The plugin type discriminator.

            '
          enum:
          - SOURCE
          - TARGET
          type: string
        lifecycleState:
          description: 'The current state of the service connector.

            '
          enum:
          - ACTIVE
          - DELETED
          type: string
          x-obmcs-top-level-enum: '#/definitions/ConnectorPluginLifecycleState'
        name:
          description: 'The service to be called by the connector plugin.

            '
          type: string
        timeCreated:
          description: 'The date and time when this plugin became available.

            Format is defined by [RFC3339](https://tools.ietf.org/html/rfc3339).

            Example: `2023-09-10T21:10:29.600Z`

            '
          format: date-time
          type: string
      required:
      - kind
      - lifecycleState
      - displayName
      - name
      - timeCreated
      type: object
    ConnectorPluginCollection:
      description: 'A list of connector plugins that match filter criteria. Results contain `ConnectorPlugin` objects.

        '
      properties:
        items:
          description: 'A list of connector plugins.

            '
          items:
            $ref: '#/components/schemas/ConnectorPluginSummary'
          type: array
      required:
      - items
      type: object
    Error:
      description: 'Error Information.

        '
      properties:
        code:
          description: 'A short error code that defines the error, meant for programmatic parsing.

            '
          type: string
        message:
          description: 'A human-readable error string.

            '
          type: string
      required:
      - code
      - message
    ConnectorPlugin:
      description: 'A service source or service target used to create a connector.

        Example connector plugins include the Queue source and the Notifications target.

        For more information about flows defined by connectors, see

        [Overview of Connector Hub](/iaas/Content/connector-hub/overview.htm).

        For configuration instructions, see

        [Creating a Connector](/iaas/Content/connector-hub/create-service-connector.htm).

        '
      discriminator:
        propertyName: kind
      properties:
        displayName:
          description: 'A user-friendly name. It does not have to be unique, and it is changeable.

            Avoid entering confidential information.

            '
          type: string
        estimatedThroughput:
          default: UNKNOWN
          description: 'The estimated throughput range (LOW, MEDIUM, HIGH).

            '
          enum:
          - LOW
          - MEDIUM
          - HIGH
          - UNKNOWN
          type: string
          x-obmcs-top-level-enum: '#/definitions/EstimatedThroughput'
        kind:
          description: 'The plugin type discriminator.

            '
          enum:
          - SOURCE
          - TARGET
          type: string
        lifecycleState:
          description: 'The current state of the service connector.

            '
          enum:
          - ACTIVE
          - DELETED
          type: string
          x-obmcs-top-level-enum: '#/definitions/ConnectorPluginLifecycleState'
        name:
          description: 'The service to be called by the connector plugin.

            Example: `QueueSource`

            '
          type: string
        schema:
          description: 'Gets the specified connector plugin configuration information in OpenAPI specification format.

            '
          type: string
        timeCreated:
          description: 'The date and time when this plugin became available.

            Format is defined by [RFC3339](https://tools.ietf.org/html/rfc3339).

            Example: `2023-09-09T21:10:29.600Z`

            '
          format: date-time
          type: string
      required:
      - kind
      - lifecycleState
      - displayName
      - name
      - timeCreated
      type: object
  parameters:
    ConnectorPluginNamePathParam:
      description: 'The name of the connector plugin. This name indicates the service to be called by the connector plugin. For example, `QueueSource` indicates the Queue service.

        '
      in: path
      name: connectorPluginName
      required: true
      schema:
        type: string
        maxLength: 255
        minLength: 1
    SortOrderQueryParam:
      description: 'The sort order to use, either ''asc'' or ''desc''.

        '
      in: query
      name: sortOrder
      x-obmcs-top-level-enum: '#/definitions/SortOrder'
      schema:
        type: string
        enum:
        - ASC
        - DESC
        default: ASC
    SortByQueryParam:
      description: 'The field to sort by. Only one sort order may be provided. Default order for `timeCreated` is descending.

        Default order for `displayName` is ascending. If no value is specified `timeCreated` is default.

        '
      in: query
      name: sortBy
      schema:
        type: string
        enum:
        - timeCreated
        - displayName
        default: timeCreated
    DisplayNameQueryParam:
      description: 'A filter to return only resources that match the given display name exactly.


        Example: `example_service_connector`

        '
      in: query
      name: displayName
      x-default-description: 'null'
      schema:
        type: string
        maxLength: 255
        minLength: 1
    PaginationTokenQueryParam:
      description: 'For list pagination. The value of the opc-next-page response header from the previous

        "List" call. For important details about how pagination works, see

        [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).

        '
      in: query
      name: page
      schema:
        type: string
        minLength: 1
    RequestIdHeader:
      description: 'The unique Oracle-assigned identifier for the request.

        If you need to contact Oracle about a particular request, please provide the request ID.

        '
      in: header
      name: opc-request-id
      schema:
        type: string
    PaginationLimitQueryParam:
      description: 'For list pagination. The maximum number of results per page, or items to return

        in a paginated "List" call. For important details about how pagination works, see

        [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).

        '
      in: query
      name: limit
      schema:
        type: integer
        default: 100
        maximum: 100
        minimum: 1
    ConnectorPluginNameQueryParam:
      description: 'A filter to return only resources that match the given connector plugin name ignoring case.


        Example: `QueueSource`

        '
      in: query
      name: name
      x-default-description: 'null'
      schema:
        type: string
        maxLength: 255
        minLength: 1
    LifecycleStateQueryParam:
      description: 'A filter to return only resources that match the given lifecycle state.


        Example: `ACTIVE`

        '
      in: query
      name: lifecycleState
      required: false
      x-default-description: 'null'
      x-obmcs-top-level-enum: '#/definitions/LifecycleState'
      schema:
        type: string
        enum:
        - CREATING
        - UPDATING
        - ACTIVE
        - INACTIVE
        - NEEDS_ATTENTION
        - DELETING
        - DELETED
        - FAILED
  responses:
    default:
      description: 'Unknown Error

        '
      headers:
        opc-request-id:
          description: 'Unique Oracle-assigned identifier for the request. If you need to contact

            Oracle about a particular request, please provide the request ID.

            '
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
x-anchors:
  x-connector-descriptions:
    StreamingSourceDescription:
      description: 'The Streaming source.

        For configuration instructions, see

        [Creating a Connector with a Streaming Source](/iaas/Content/connector-hub/create-service-connector-streaming-source.htm).

        '
      x-example: "{\n  \"kind\": \"streaming\",\n  \"streamId\": \"<var>&lt;stream_OCID&gt;</var>\",\n  \"cursor\" : {\n      \"kind\": \"LATEST\"\n  }\n}\n"
    StreamingSourceResponseDescription:
      description: "The Streaming source response. Private metadata is included when the target is a stream accessed through \na [private endpoint](/iaas/Content/Streaming/Concepts/streamsecurity.htm#private_endpoints).\n"
      x-example: "{\n  \"kind\": \"streaming\",\n  \"streamId\": \"<var>&lt;stream_OCID&gt;</var>\",\n  \"cursor\" : {\n      \"kind\": \"LATEST\"\n  },\n  \"privateEndpointMetadata\": {\n      \"rceTrafficIpAddress\": \"10.0.0.2\",\n      \"rceDnsIpAddress\": \"10.0.0.3\"\n  }\n}\n"
    functionTargetDescription:
      description: 'The destination function for data transferred from the source.

        For configuration instructions, see

        [Creating a Connector](/iaas/Content/connector-hub/create-service-connector.htm).

        '
      x-example: "Sample 1: Custom batch size of 5,000 kilobytes with maximum batch time of 60 seconds\n{\n  \"kind\": \"functions\",\n  \"functionId\": \"<var>&lt;function_OCID&gt;</var>\",\n  \"batchSizeInKbs\": \"5000\",\n  \"batchTimeInSec\": \"60\"\n}\nSample 2: Custom batch size of 10 messages with maximum batch time of 60 seconds\n{\n  \"kind\": \"functions\",\n  \"functionId\": \"<var>&lt;function_OCID&gt;</var>\",\n  \"batchSizeInNum\": \"10\",\n  \"batchTimeInSec\": \"60\"\n}\n"
    functionTaskDescription:
      description: "The Functions task. \nBatch input for a function can be limited by either size or time. The first limit reached determines the boundary of the batch.\nFor configuration instructions, see\n[Creating a Connector](/iaas/Content/connector-hub/create-service-connector.htm).\n"
      x-example: "{\n  \"kind\": \"function\",\n  \"functionId\": \"<var>&lt;function_OCID&gt;</var>\",\n  \"batchSizeInKbs\": \"5000\",\n  \"batchTimeInSec\": \"500\"\n}\n"
    logAnalyticsTargetDescription:
      description: 'The destination log group for data transferred from the source.

        For configuration instructions, see

        [Creating a Connector](/iaas/Content/connector-hub/create-service-connector.htm).

        '
      x-example: "{\n \"kind\": \"loggingAnalytics\",\n \"logSourceIdentifier\": \"<var>&lt;log_source_name&gt;</var>\",\n \"logGroupId\": \"<var>&lt;log_group_OCID&gt;</var>\"\n}\n"
    logRuleTaskDescription:
      description: 'The log filter task.

        For configuration instructions, see

        [Creating a Connector](/iaas/Content/connector-hub/create-service-connector.htm).

        '
      x-example: "{\n  \"kind\": \"logRule\",\n  \"condition\": \"data.action='REJECT'\"\n}\n"
    loggingSourceDescription:
      description: 'The Logging source.

        For configuration instructions, see

        [Creating a Connector with a Logging Source](/iaas/Content/connector-hub/create-service-connector-logging-source.htm).

        '
      x-example: "{\n  \"kind\": \"logging\",\n  \"logSources\": [\n    {\n      \"compartmentId\": \"<var>&lt;compartment_OCID&gt;</var>\",\n      \"logGroupId\": \"<var>&lt;log_group_OCID&gt;</var>\",\n      \"logId\": \"<var>&lt;log_OCID&gt;</var>\"\n    },\n    {\n      \"compartmentId\": \"<var>&lt;compartment_OCID&gt;</var>\",\n      \"logGroupId\": \"<var>&lt;log_group_OCID&gt;</var>\",\n      \"logId\": \"<var>&lt;log_OCID&gt;</var>\"\n    }\n  ]\n}\n"
    monitoringSourceDescription:
      description: 'The Monitoring source.

        For configuration instructions, see

        [Creating a Connector with a Monitoring Source](/iaas/Content/connector-hub/create-service-connector-monitoring-source.htm).

        '
      x-example: "{\n  \"kind\": \"monitoring\",\n  \"monitoringSources\": [\n    {\n      \"compartmentId\": \"<var>&lt;compartment_OCID&gt;</var>\",\n      \"namespaceDetails\": {\n        \"kind\": \"selected\",\n        \"namespaces\": [\n          {\n            \"namespace\": \"oci_computeagent\",\n            \"metrics\": {\n              \"kind\": \"all\"\n            }\n          },\n          {\n            \"namespace\": \"oci_logging_analytics\",\n            \"metrics\": {\n              \"kind\": \"all\"\n            }\n          }\n        ]\n      }\n    },\n    {\n      \"compartmentId\": \"<var>&lt;compartment_OCID&gt;</var>\",\n      \"namespaceDetails\": {\n        \"kind\": \"selected\",\n        \"namespaces\": [\n          {\n            \"namespace\": \"oci_objectstorage\",\n            \"metrics\": {\n              \"kind\": \"all\"\n            }\n          }\n        ]\n      }\n    }\n  ]\n}\n"
    monitoringTargetDescription:
      description: 'The destination metric for data transferred from the source.

        For configuration instructions, see

        [Creating a Connector](/iaas/Content/connector-hub/create-service-connector.htm).

        '
      x-example: "{\n  \"kind\": \"monitoring\",\n  \"compartmentId\": \"<var>&lt;compartment_OCID&gt;</var>\",\n  \"metricNamespace\": \"oci_computeagent\",\n  \"metric\": \"CpuUtilization\",\n  \"dimensions\": [\n    {\"name\": \"compartmentId\", \"dimensionValue\": {\"kind\": \"jmesPath\", \"path\": \"logContent.oracle.compartmentId\"}},\n    {\"name\": \"app\", \"dimensionValue\": {\"kind\": \"static\", \"value\": \"DataPlane\"}}\n  ]\n}\n"
    notificationTargetDescription:
      description: 'The destination topic for data transferred from the source.

        For configuration instructions, see

        [Creating a Connector](/iaas/Content/connector-hub/create-service-connector.htm).

        '
      x-example: "{\n  \"kind\": \"notifications\",\n  \"topicId\": \"<var>&lt;topic_OCID&gt;</var>\"\n}\n"
    objectStorageTargetDescription:
      description: 'The destination bucket for data transferred from the source.

        For configuration instructions, see

        [Creating a Connector](/iaas/Content/connector-hub/create-service-connector.htm).

        '
      x-example: "{\n  \"kind\": \"objectStorage\",\n  \"bucketName\": \"MyBucket\",\n  \"objectNamePrefix\": \"myprefix\"\n}\n"
    pluginSourceDescription:
      description: 'Details about a connector plugin used to fetch data from a source.

        For configuration instructions, see

        [Creating a Connector](/iaas/Content/connector-hub/create-service-connector.htm).

        '
      x-example: "{\n  \"kind\": \"plugin\",\n  \"pluginName\": \"QueueSource\",\n  \"configMap\": {\n      \"queueId\": \"<var>&lt;queue_OCID&gt;</var>\"\n  }\n}\n"
    sourceDetailsDescription:
      description: 'An object that represents the source of the flow defined by the connector.

        An example source is the VCNFlow logs within the NetworkLogs group.

        For more information about flows defined by connectors, see

        [Overview of Connector Hub](/iaas/Content/connector-hub/overview.htm).

        For configuration instructions, see

        [Creating a Connector](/iaas/Content/connector-hub/create-service-connector.htm).

        '
    streamingTargetDescription:
      description: 'The destination stream for data transferred from the source.

        For configuration instructions, see

        [Creating a Connector](/iaas/Content/connector-hub/create-service-connector.htm).

        '
      x-example: "{\n  \"kind\": \"streaming\",\n  \"streamId\": \"<var>&lt;stream_OCID&gt;</var>\"\n}\n"
    streamingTargetResponseDescription:
      description: "The Streaming target response. Private metadata is included when the target is a stream accessed through \na [private endpoint](/iaas/Content/Streaming/Concepts/streamsecurity.htm#private_endpoints).\n"
      x-example: "{\n  \"kind\": \"streaming\",\n  \"streamId\": \"<var>&lt;stream_OCID&gt;</var>\",\n  \"privateEndpointMetadata\": {\n      \"rceTrafficIpAddress\": \"10.0.0.2\",\n      \"rceDnsIpAddress\": \"10.0.0.3\"\n  }\n}\n"
    targetDetailsDescription:
      description: 'An object that represents the target of the flow defined by the connector.

        An example target is a stream (Streaming service).

        For more information about flows defined by connectors, see

        [Overview of Connector Hub](/iaas/Content/connector-hub/overview.htm).

        For configuration instructions, see

        [Creating a Connector](/iaas/Content/connector-hub/create-service-connector.htm).

        '
    taskDetailsDescription:
      description: 'An object that represents a task within the flow defined by the connector.

        An example task is a filter for error logs.

        For more information about flows defined by connectors, see

        [Overview of Connector Hub](/iaas/Content/connector-hub/overview.htm).

        For configuration instructions, see

        [Creating a Connector](/iaas/Content/connector-hub/create-service-connector.htm).

        '
  x-connector-properties:
    functionTargetFields:
      batchSizeInKbs:
        description: 'The batch rollover size in kilobytes.

          Only one size option can be specified: `batchSizeInKbs` or `batchSizeInNum`.

          '
        minimum: 1
        type: integer
      batchSizeInNum:
        description: 'The batch rollover size in number of messages.

          Only one size option can be specified: `batchSizeInKbs` or `batchSizeInNum`.

          '
        minimum: 1
        type: integer
      batchTimeInSec:
        description: 'The batch rollover time in seconds.

          '
        minimum: 60
        type: integer
      functionId:
        description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the function.

          '
        maxLength: 255
        minLength: 1
        type: string
    functionTaskFields:
      batchSizeInKbs:
        description: 'Size limit (kilobytes) for batch sent to invoke the function.

          '
        minimum: 1
        type: integer
      batchTimeInSec:
        description: 'Time limit (seconds) for batch sent to invoke the function.

          '
        minimum: 1
        type: integer
      functionId:
        description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the function to be used as a task.

          '
        maxLength: 255
        type: string
    logAnalyticsTargetFields:
      logGroupId:
        description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the Logging Analytics log group.

          '
        maxLength: 255
        minLength: 1
        type: string
      logSourceIdentifier:
        description: 'Identifier of the log source that you want to use for processing data received from the connector source.

          Applies to `StreamingSource` only.

          Equivalent to `name` at [LogAnalyticsSource](#/en/logan-api-spec/latest/LogAnalyticsSource/).

          '
        maxLength: 512
        minLength: 1
        type: string
    logRuleTaskFields:
      condition:
        description: 'A filter or mask to limit the source used in the flow defined by the connector.

          '
        maxLength: 1048576
        minLength: 1
        type: string
    loggingSourceFields:
      logSources:
        description: 'The logs for this Logging source.

          '
        items:
          $ref: '#/components/schemas/LogSource'
        maxItems: 16
        minItems: 1
        type: array
    monitoringSourceFields:
      monitoringSources:
        description: 'One or more compartment-specific lists of metric namespaces to retrieve data from.

          '
        items:
          $ref: '#/components/schemas/MonitoringSource'
        minItems: 1
        type: array
    monitoringTargetFields:
      compartmentId:
        description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the metric.

          '
        maxLength: 255
        minLength: 1
        type: string
      dimensions:
        description: 'List of dimension names and values.

          '
        items:
          $ref: '#/components/schemas/DimensionDetails'
        maxLength: 15
        minLength: 0
        type: array
      metric:
        description: 'The name of the metric.

          Example: `CpuUtilization`

          '
        maxLength: 1024
        minLength: 1
        type: string
      metricNamespace:
        description: 'The namespace of the metric.

          Example: `oci_computeagent`

          '
        maxLength: 1024
        minLength: 1
        type: string
    notificationTargetFields:
      enableFormattedMessaging:
        description: 'Whether to apply a simplified, user-friendly format to the message. Applies only when friendly formatting is supported by the connector source and the subscription protocol.

          Example: `true`

          '
        type: boolean
      topicId:
        description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the topic.

          '
        maxLength: 255
        minLength: 1
        type: string
    objectStorageTargetFields:
      batchRolloverSizeInMBs:
        description: 'The batch rollover size in megabytes.

          '
        minimum: 1
        type: integer
      batchRolloverTimeInMs:
        description: 'The batch rollover time in milliseconds.

          '
        minimum: 1
        type: integer
      bucketName:
        description: 'The name of the bucket. Valid characters are letters (upper or lower case), numbers, hyphens (-),

          underscores(_), and periods (.). Bucket names must be unique within an Object Storage namespace.

          Avoid entering confidential information. Example: my-new-bucket1

          '
        maxLength: 256
        minLength: 1
        type: string
      namespace:
        description: 'The namespace.

          '
        maxLength: 1024
        minLength: 0
        type: string
      objectNamePrefix:
        description: 'The prefix of the objects. Avoid entering confidential information.

          '
        maxLength: 1024
        type: string
    pluginSourceFields:
      configMap:
        additionalProperties: true
        description: "The configuration map for the connector plugin. This map includes parameters specific to the connector plugin type. \nFor example, for `QueueSource`, the map lists the OCID of the selected queue.\nTo find the parameters for a connector plugin, get the plugin using [GetConnectorPlugin](#/en/serviceconnectors/latest/ConnectorPlugin/GetConnectorPlugin) and review its schema value.\n"
        type: object
      pluginName:
        description: 'The name of the connector plugin. This name indicates the service to be called by the connector plugin. For example, `QueueSource` indicates the Queue service.

          To find names of connector plugins, list the plugin using [ListConnectorPlugin](#/en/serviceconnectors/latest/ConnectorPluginSummary/ListConnectorPlugins).

          '
        type: string
    sourceDetailsDiscriminator:
      kind:
        description: 'The type discriminator.

          '
        enum:
        - logging
        - monitoring
        - streaming
        - plugin
        type: string
    streamingSourceFields:
      cursor:
        $ref: '#/components/schemas/StreamingCursorDetails'
      streamId:
        description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the stream.

          '
        maxLength: 255
        type: string
    streamingTargetFields:
      streamId:
        description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the stream.

          '
        maxLength: 255
        minLength: 1
        type: string
    targetDetailsDiscriminator:
      kind:
        description: 'The type discriminator.

          '
        enum:
        - functions
        - loggingAnalytics
        - monitoring
        - notifications
        - objectStorage
        - streaming
        type: string
    taskDetailsDiscriminator:
      kind:
        description: 'The type discriminator.

          '
        enum:
        - function
        - logRule
        type: string
  x-headers:
    etag:
      description: 'For optimistic concurrency control. See `if-match`.

        '
      type: string
    opc-next-page:
      description: 'For list pagination. When this header appears in the response,

        additional pages of results remain. For important details about

        how pagination works, see

        [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).

        '
      type: string
    opc-prev-page:
      description: 'For list pagination.  When this header appears in the response,

        previous pages of results exist. For important details about

        how pagination works, see

        [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).

        '
      type: string
    opc-request-id:
      description: 'Unique Oracle-assigned identifier for the request. If you need to contact

        Oracle about a particular request, please provide the request ID.

        '
      type: string
    opc-work-request-id:
      description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.

        '
      type: string
    retry-after:
      description: 'A decimal number representing the number of seconds the client should wait before polling this endpoint again.

        '
      format: float
      type: number
  x-properties:
    definedTags:
      additionalProperties:
        additionalProperties:
          description: 'The value of the tag. Only string, integer and boolean types are supported.

            '
          type: object
        description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.

          Example: `{"bar-key": "value"}`

          '
        type: object
      description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.

        Example: `{"foo-namespace": {"bar-key": "value"}}`

        '
      type: object
    description:
      description: 'The description of the resource. Avoid entering confidential information.

        '
      maxLength: 400
      type: string
    freeformTags:
      additionalProperties:
        type: string
      description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.

        Example: `{"bar-key": "value"}`

        '
      type: object
    systemTags:
      additionalProperties:
        additionalProperties:
          type: object
        type: object
      description: 'The system tags associated with this resource, if any. The system tags are set by Oracle Cloud Infrastructure services. Each key is predefined and scoped to namespaces.

        For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).

        Example: `{orcl-cloud: {free-tier-retain: true}}`

        '
      type: object
x-obmcs-client-retries-enabled: true
x-oracle-package: com.oracle.pic.connectors