basePath: /20180418
consumes:
- application/json
definitions:
  ActionType:
    description: Possible types of actions.
    enum: &id003
    - CREATED
    - UPDATED
    - DELETED
    - IN_PROGRESS
    - RELATED
    - FAILED
    type: string
  ChangeConnectHarnessCompartmentDetails:
    description: Detailed representation of a change connect harness compartment operation.
    properties:
      compartmentId:
        description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the
          compartment

          into which the resource should be moved.

          '
        maxLength: 255
        minLength: 1
        type: string
    required:
    - compartmentId
    type: object
  ChangeStreamCompartmentDetails:
    description: Detailed representation of a change stream compartment operation.
    properties:
      compartmentId:
        description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the
          compartment

          into which the resource should be moved.

          '
        maxLength: 255
        minLength: 1
        type: string
    required:
    - compartmentId
    type: object
  ChangeStreamPoolCompartmentDetails:
    description: Detailed representation of a change stream pool compartment operation.
    properties:
      compartmentId:
        description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the
          compartment

          into which the resource should be moved.

          '
        maxLength: 255
        minLength: 1
        type: string
    required:
    - compartmentId
    type: object
  ConnectHarness:
    description: Detailed representation of a connect harness.
    properties:
      compartmentId:
        description: The OCID of the compartment that contains the connect harness.
        example: ocid1.compartment.realm.region.zxcvbn432765
        type: string
      definedTags:
        additionalProperties:
          additionalProperties:
            description: 'The value of the tag. Only the String type is supported.

              '
            type: object
          description: 'Key-value pair representing a defined tag key and value, scoped
            to a namespace.


            Example: `{"CostCenter": "42"}''

            '
          type: object
        description: 'Defined tags for this resource. Each key is predefined and scoped
          to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).


          Example: `{"Operations": {"CostCenter": "42"}}''

          '
        type: object
      freeformTags:
        additionalProperties:
          type: string
        description: 'Free-form tags for this resource. Each tag is a simple key-value
          pair with no predefined name, type, or namespace. Exists for cross-compatibility
          only.

          For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).


          Example: `{"Department": "Finance"}`

          '
        type: object
      id:
        description: The OCID of the connect harness.
        example: ocid1.connectharness.realm.region.mnopqr789
        type: string
      lifecycleState:
        description: The current state of the connect harness.
        enum:
        - CREATING
        - ACTIVE
        - DELETING
        - DELETED
        - FAILED
        - UPDATING
        type: string
      lifecycleStateDetails:
        description: Any additional details about the current state of the connect
          harness.
        type: string
      name:
        description: 'The name of the connect harness. Avoid entering confidential
          information.


          Example: `JDBCConnector`

          '
        example: TelemetryEvents
        type: string
      timeCreated:
        description: 'The date and time the connect harness was created, expressed
          in in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) timestamp format.


          Example: `2018-04-20T00:00:07.405Z`

          '
        format: date-time
        type: string
    required:
    - name
    - id
    - compartmentId
    - lifecycleState
    - timeCreated
    type: object
    x-example: "{\n  \"name\": \"mynewstream\",\n  \"id\": \"ocid1.stream.oc1..exampleakzxrjqcvbj2rpflj6xqnej3gus4xse3fxmnfauxbdtovpuhywnua\"\
      ,\n  \"compartmentId\": \"ocid1.tenancy.oc1..exampleasgadvsw7l6cvb4fhssurjqs4irbkzma3wc2fauxv4novazj5guta\"\
      ,\n  \"lifecycleState\": \"CREATING\",\n  \"timeCreated\": \"2018-04-25T23:28:30.629Z\"\
      ,\n  \"messagesEndpoint\": \"https://streaming-api-1.us-phoenix-1.oraclecloud.com\"\
      ,\n  \"freeformTags\": { },\n  \"definedTags\": { }\n}\n"
  ConnectHarnessSummary:
    description: Summary representation of a ConnectHarness.
    properties:
      compartmentId:
        description: The OCID of the compartment that contains the connect harness.
        example: ocid1.compartment.realm.region.zxcvbn432765
        type: string
      definedTags:
        additionalProperties:
          additionalProperties:
            description: 'The value of the tag. Only the String type is supported.

              '
            type: object
          description: 'Key-value pair representing a defined tag key and value, scoped
            to a namespace.


            Example: `{"CostCenter": "42"}`

            '
          type: object
        description: 'Defined tags for this resource. Each key is predefined and scoped
          to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).


          Example: `{"Operations": {"CostCenter": "42"}}`

          '
        type: object
      freeformTags:
        additionalProperties:
          type: string
        description: 'Free-form tags for this resource. Each tag is a simple key-value
          pair that is applied with no predefined name, type, or namespace. Exists
          for cross-compatibility only.

          For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).


          Example: `{"Department": "Finance"}`

          '
        type: object
      id:
        description: The OCID of the connect harness.
        example: ocid1.connectharness.realm.region.mnopqr789
        type: string
      lifecycleState:
        description: The current state of the connect harness.
        enum:
        - CREATING
        - ACTIVE
        - DELETING
        - DELETED
        - FAILED
        - UPDATING
        type: string
      name:
        description: 'The name of the connect harness.


          Example: `TelemetryEvents`

          '
        example: TelemetryEvents
        type: string
      timeCreated:
        description: 'The date and time the connect harness was created, expressed
          in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) timestamp format.


          Example: `2018-04-20T00:00:07.405Z`

          '
        format: date-time
        type: string
    required:
    - name
    - id
    - compartmentId
    - lifecycleState
    - timeCreated
    type: object
    x-example: "[\n  {\n    \"name\": \"config-topic\",\n    \"id\": \"ocid1.connectharness.oc1..exampleakzxrjqcvbj2rpflj6xqnej3gus4xse3fxmnfauxbdtovpuhywnua\"\
      ,\n    \"compartmentId\": \"ocid1.tenancy.oc1..exampleasgadvsw7l6cvb4fhssurjqs4irbkzma3wc2fauxv4novazj5guta\"\
      ,\n    \"lifecycleState\": \"ACTIVE\",\n    \"timeCreated\": \"2018-04-25T23:28:30.629Z\"\
      ,\n    \"messagesEndpoint\": \"https://streaming-api-1.us-phoenix-1.oraclecloud.com\"\
      ,\n    \"freeformTags\": {\n      \"Department\": \"Finance\"\n      },\n  \
      \  \"definedTags\":\n    {\n      \"MyNamespace\":\n      {\n        \"CostCenter\"\
      : \"42\"\n      }\n    }\n  },\n  {\n    \"name\": \"status-topic\",\n    \"\
      id\": \"ocid1.connectharness.oc1..exampleak737ys3cvb5xs42lbuy3qr3wiqmfaux5ugnn7wmpvb4d2sgk7dmq\"\
      ,\n    \"compartmentId\": \"ocid1.tenancy.oc1..exampleasgadvsw7l6cvb4fhssurjqs4irbkzma3wc2fauxv4novazj5guta\"\
      ,\n    \"lifecycleState\": \"ACTIVE\",\n    \"timeCreated\": \"2018-04-25T15:35:07.306Z\"\
      ,\n    \"messagesEndpoint\": \"https://streaming-api-1.us-phoenix-1.oraclecloud.com\"\
      ,\n    \"freeformTags\": { },\n    \"definedTags\": { }\n  }\n]\n"
  CreateConnectHarnessDetails:
    description: Object used to create a connect harness.
    properties:
      compartmentId:
        description: The OCID of the compartment that contains the connect harness.
        example: ocid1.compartment.realm.region.zxcvbn432765
        maxLength: 1024
        minLength: 1
        type: string
      definedTags:
        additionalProperties:
          additionalProperties:
            description: 'The value of the tag. Only the String type is supported.

              '
            type: object
          description: 'Key-value pair representing a defined tag key and value, scoped
            to a namespace.


            Example: `{"CostCenter": "42"}`

            '
          type: object
        description: 'Defined tags for this resource. Each key is predefined and scoped
          to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).


          Example: `{"Operations": {"CostCenter": "42"}}`

          '
        type: object
      freeformTags:
        additionalProperties:
          type: string
        description: 'Free-form tags for this resource. Each tag is a simple key-value
          pair that is applied with no predefined name, type, or namespace. Exists
          for cross-compatibility only.

          For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).


          Example: `{"Department": "Finance"}`

          '
        type: object
      name:
        description: 'The name of the connect harness. Avoid entering confidential
          information.


          Example: `JDBCConnector`

          '
        example: JDBCConnector
        maxLength: 1024
        minLength: 1
        type: string
    required:
    - name
    - compartmentId
    type: object
    x-example: "{\n  \"compartmentId\": \"ocid1.tenancy.oc1..exampleasgadvsw7l6cvb4fhssurjqs4irbkzma3wc2fauxv4novazj5guta\"\
      ,\n  \"name\": \"jdbcconnector\"\n}\n"
  CreateCursorDetails:
    description: Object used to create a cursor to consume messages in a stream.
    properties:
      offset:
        description: The offset to consume from if the cursor type is `AT_OFFSET`
          or `AFTER_OFFSET`.
        example: 42
        format: int64
        type: integer
      partition:
        description: The partition to get messages from.
        minimum: 0
        type: string
      time:
        description: 'The time to consume from if the cursor type is `AT_TIME`, expressed
          in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) timestamp format.

          '
        format: date-time
        type: string
      type:
        description: 'The type of cursor, which determines the starting point from
          which the stream will be consumed:


          - `AFTER_OFFSET:` The partition position immediately following the offset
          you specify. (Offsets are assigned when you successfully append a message
          to a partition in a stream.)

          - `AT_OFFSET:` The exact partition position indicated by the offset you
          specify.

          - `AT_TIME:` A specific point in time.

          - `LATEST:` The most recent message in the partition that was added after
          the cursor was created.

          - `TRIM_HORIZON:` The oldest message in the partition that is within the
          retention period window.

          '
        enum:
        - AFTER_OFFSET
        - AT_OFFSET
        - AT_TIME
        - LATEST
        - TRIM_HORIZON
        type: string
    required:
    - type
    - partition
    type: object
    x-example: "{\n  \"partition\": \"0\",\n  \"type\": \"TRIM_HORIZON\"\n}\n"
  CreateGroupCursorDetails:
    description: Object used to create a group cursor.
    properties:
      commitOnGet:
        default: true
        description: 'When using consumer-groups, the default commit-on-get behaviour
          can be overriden by setting this value to false.

          If disabled, a consumer must manually commit their cursors.

          '
        type: boolean
      groupName:
        description: Name of the consumer group.
        type: string
      instanceName:
        description: A unique identifier for the instance joining the consumer group.
          If an instanceName is not provided, a UUID will be generated and used.
        type: string
      time:
        description: The time to consume from if type is AT_TIME.
        format: date-time
        type: string
      timeoutInMs:
        default: 30000
        description: The amount of a consumer instance inactivity time, before partition
          reservations are released.
        format: int32
        minimum: 5000
        type: integer
      type:
        description: The type of the cursor. This value is only used when the group
          is created.
        enum:
        - AT_TIME
        - LATEST
        - TRIM_HORIZON
        type: string
    required:
    - groupName
    - type
    type: object
  CreateStreamDetails:
    description: Object used to create a stream.
    properties:
      compartmentId:
        description: The OCID of the compartment that contains the stream.
        example: ocid1.compinstance.realm.region.zxcvbn432765
        maxLength: 1024
        minLength: 1
        type: string
      definedTags:
        additionalProperties:
          additionalProperties:
            description: 'The value of the tag. Only the String type is supported.

              '
            type: object
          description: 'Key-value pair representing a defined tag key and value, scoped
            to a namespace.


            Example: `{"CostCenter": "42"}`

            '
          type: object
        description: 'Defined tags for this resource. Each key is predefined and scoped
          to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).


          Example: `{"Operations": {"CostCenter": "42"}}`

          '
        type: object
      freeformTags:
        additionalProperties:
          type: string
        description: 'Free-form tags for this resource. Each tag is a simple key-value
          pair that is applied with no predefined name, type, or namespace. Exists
          for cross-compatibility only.

          For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).


          Example: `{"Department": "Finance"}`

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


          Example: `TelemetryEvents`

          '
        example: TelemetryEvents
        maxLength: 1024
        minLength: 1
        type: string
      partitions:
        description: The number of partitions in the stream.
        example: 1
        minimum: 1
        type: integer
      retentionInHours:
        description: 'The retention period of the stream, in hours. Accepted values
          are between 24 and 168 (7 days).

          If not specified, the stream will have a retention period of 24 hours.

          '
        example: 24
        type: integer
      streamPoolId:
        description: The OCID of the stream pool that contains the stream.
        example: ocid1.streampool.realm.region.zxcvbn432765
        maxLength: 1024
        minLength: 1
        type: string
    required:
    - name
    - partitions
    type: object
    x-example: "{\n  \"compartmentId\": \"ocid1.tenancy.oc1..exampleasgadvsw7l6cvb4fhssurjqs4irbkzma3wc2fauxv4novazj5guta\"\
      ,\n  \"name\": \"mynewstream\",\n  \"partitions\": \"4\"\n}\n"
  CreateStreamPoolDetails:
    description: Object used to create a stream pool.
    properties:
      compartmentId:
        description: The OCID of the compartment that contains the stream.
        example: ocid1.compinstance.realm.region.zxcvbn432765
        maxLength: 1024
        minLength: 1
        type: string
      customEncryptionKeyDetails:
        $ref: '#/definitions/CustomEncryptionKeyDetails'
      definedTags:
        additionalProperties:
          additionalProperties:
            description: 'The value of the tag. Only the String type is supported.

              '
            type: object
          description: 'Key-value pair representing a defined tag key and value, scoped
            to a namespace.


            Example: `{"CostCenter": "42"}`

            '
          type: object
        description: 'Defined tags for this resource. Each key is predefined and scoped
          to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).


          Example: `{"Operations": {"CostCenter": "42"}}`

          '
        type: object
      freeformTags:
        additionalProperties:
          type: string
        description: 'Free-form tags for this resource. Each tag is a simple key-value
          pair that is applied with no predefined name, type, or namespace. Exists
          for cross-compatibility only.

          For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).


          Example: `{"Department": "Finance"}`

          '
        type: object
      kafkaSettings:
        $ref: '#/definitions/KafkaSettings'
      name:
        description: 'The name of the stream pool. Avoid entering confidential information.


          Example: `MyStreamPool`

          '
        example: MyStreamPool
        maxLength: 1024
        minLength: 1
        type: string
      privateEndpointDetails:
        $ref: '#/definitions/PrivateEndpointDetails'
      securityAttributes:
        additionalProperties:
          additionalProperties:
            description: 'Attribute value and mode. Only the String type is supported
              for value. Mode is currently always "enforce".

              '
            type: object
          description: 'Key-value pair representing a security attribute key and value,
            scoped to a namespace.


            Example: `{"MaxEgressCount": {"value": "42", "mode": "enforce"}}`

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

          For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).


          Example: `{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "enforce"}}}`

          '
        type: object
    required:
    - name
    - compartmentId
    type: object
    x-example: "{\n  \"compartmentId\": \"ocid1.tenancy.oc1..exampleasgadvsw7l6cvb4fhssurjqs4irbkzma3wc2fauxv4novazj5guta\"\
      ,\n  \"name\": \"MyStreamPool\",\n  \"kafkaSettings\": {\n    \"autoCreateTopicsEnable\"\
      : false\n  }\n"
  Cursor:
    description: 'A cursor that indicates the position in the stream from which you
      want to begin consuming messages and which is required by the [GetMessages](#/en/streaming/20180418/Message/GetMessages)
      operation.

      '
    properties:
      value:
        description: The cursor to pass to the `GetMessages` operation.
        type: string
    required:
    - value
    type: object
    x-example: "{\n  \"value\": \"examplelIjoiVHJpbUhcvbl6b24iLCJvZmZzZXQiOm51bGwsInRpbWUiOm51bGwsInBhcnRpdGlvbiI6IjAiLCJzdHJlYW1JZCI6Im9jaWQxLnN0cmVhbS5kZXNrdG9wLi5hYWFhYWFhYWN1ZG5udHFjeXN4dHF6NTZuNWVoYWZ3c3JudHp5dHhjNmF3cDM0N3dxa2R0Ymt2d3VpaXEiLCJleHBfaux0aW9uIjoxNTI0Njg0MDE3NzUwfQ==\"\
      \n}\n"
  CustomEncryptionKey:
    description: Custom Encryption Key which will be used for encryption by all the
      streams in the pool.
    properties:
      keyState:
        description: Life cycle State of the custom key
        enum:
        - ACTIVE
        - CREATING
        - DELETING
        - NONE
        - FAILED
        - UPDATING
        type: string
      kmsKeyId:
        description: Custom Encryption Key (Master Key) ocid.
        maxLength: 1024
        minLength: 1
        type: string
    type: object
  CustomEncryptionKeyDetails:
    description: The OCID of the custom encryption key to be used or deleted if currently
      being used.
    properties:
      kmsKeyId:
        description: Custom Encryption Key (Master Key) ocid.
        maxLength: 1024
        minLength: 1
        type: string
    required:
    - kmsKeyId
    type: object
  Error:
    description: The representation of an error.
    properties:
      code:
        description: 'A short error code that defines the error, meant for programmatic
          parsing. See [API Errors](/Content/API/References/apierrors.htm).

          '
        type: string
      message:
        description: A human-readable error string.
        type: string
    required:
    - code
    - message
    type: object
  Group:
    description: 'Represents the current state of a consumer group, including partition
      reservations and committed offsets.

      '
    properties:
      groupName:
        description: The name of the consumer group.
        type: string
      reservations:
        description: An array of the partition reservations of a group.
        items:
          $ref: '#/definitions/PartitionReservation'
        type: array
      streamId:
        description: The streamId for which the group exists.
        type: string
    required:
    - streamId
    - groupName
    type: object
  KafkaSettings:
    description: Settings for the Kafka compatibility layer.
    properties:
      autoCreateTopicsEnable:
        description: Enable auto creation of topic on the server.
        type: boolean
      bootstrapServers:
        description: Bootstrap servers.
        type: string
      logRetentionHours:
        description: The number of hours to keep a log file before deleting it (in
          hours).
        maximum: 672
        minimum: 1
        type: integer
      numPartitions:
        description: The default number of log partitions per topic.
        minimum: 1
        type: integer
    type: object
  Message:
    description: A message in a stream.
    properties:
      key:
        description: The key associated with the message, expressed as a byte array.
        format: byte
        type: string
      offset:
        description: The offset of the message, which uniquely identifies it within
          the partition.
        example: 42
        format: int64
        type: integer
      partition:
        description: The ID of the partition where the message is stored.
        example: '1'
        type: string
      stream:
        description: The name of the stream that the message belongs to.
        example: ocid1.stream.realm.region.mnopqr789
        type: string
      timestamp:
        description: The timestamp indicating when the server appended the message
          to the stream.
        format: date-time
        type: string
      value:
        description: The value associated with the message, expressed as a byte array.
        format: byte
        type: string
    required:
    - stream
    - partition
    - key
    - value
    - offset
    - timestamp
    type: object
    x-example: "{\n  \"stream\": \"mynewstream\",\n  \"partition\": \"0\",\n  \"key\"\
      : null,\n  \"value\": \"VGhlIHF1aWNrIGJyb3duIGZveCBqdW1wZWQgb3ZlciB0aGUgbGF6eSBkb2cu\"\
      ,\n  \"offset\": 0,\n  \"timestamp\": \"2018-04-26T01:03:06.051Z\"\n}\n"
  OperationStatus:
    description: The status of the work request.
    enum: &id002
    - ACCEPTED
    - IN_PROGRESS
    - WAITING
    - NEEDS_ATTENTION
    - FAILED
    - SUCCEEDED
    - CANCELING
    - CANCELED
    type: string
  OperationType:
    description: The asynchronous operation tracked by the work request.
    enum: &id001
    - CREATE_STREAM
    - UPDATE_STREAM
    - DELETE_STREAM
    - CREATE_STREAM_POOL
    - UPDATE_STREAM_POOL
    - DELETE_STREAM_POOL
    - CREATE_CONNECT_HARNESS
    - UPDATE_CONNECT_HARNESS
    - DELETE_CONNECT_HARNESS
    type: string
  PartitionReservation:
    description: 'Represents the state of a single partition reservation.

      '
    properties:
      committedOffset:
        description: The latest offset which has been committed for this partition.
        format: int64
        type: integer
      partition:
        description: The partition for which the reservation applies.
        type: string
      reservedInstance:
        description: The consumer instance which currently has the partition reserved.
        type: string
      timeReservedUntil:
        description: A timestamp when the current reservation expires.
        format: date-time
        type: string
    type: object
  PrivateEndpointDetails:
    description: Optional parameters if a private stream pool is requested.
    properties:
      nsgIds:
        description: 'The optional list of network security groups to be used with
          the private endpoint of the stream pool.

          That value cannot be changed.

          '
        items:
          type: string
        maxLength: 1024
        minLength: 1
        type: array
        uniqueItems: true
      privateEndpointIp:
        description: 'The optional private IP you want to be associated with your
          private stream pool.

          That parameter can only be specified when the subnetId parameter is set.
          It cannot be changed.

          The private IP needs to be part of the CIDR range of the specified subnetId
          or the creation will fail.

          If not specified a random IP inside the subnet will be chosen.

          After the stream pool is created, a custom FQDN, pointing to this private
          IP, is created.

          The FQDN is then used to access the service instead of the private IP.

          '
        example: 10.0.0.5
        type: string
      subnetId:
        description: 'If specified, the stream pool will be private and only accessible
          from inside that subnet.

          Producing-to and consuming-from a stream inside a private stream pool can
          also only be done from inside the subnet.

          That value cannot be changed.

          '
        example: ocid1.subnet.realm.region.zxcvbn432765
        maxLength: 1024
        minLength: 1
        type: string
    type: object
  PrivateEndpointSettings:
    description: Optional settings if the stream pool is private.
    properties:
      nsgIds:
        description: The optional list of network security groups that are associated
          with the private endpoint of the stream pool.
        items:
          type: string
        maxLength: 1024
        minLength: 1
        type: array
        uniqueItems: true
      privateEndpointIp:
        description: 'The private IP associated with the stream pool in the associated
          subnetId.

          The stream pool''s FQDN resolves to that IP and should be used - instead
          of the private IP - in order to not trigger any TLS issues.

          '
        example: 10.0.0.5
        type: string
      subnetId:
        description: 'The subnet id from which the private stream pool can be accessed.

          Trying to access the streams from another network location will result in
          an error.

          '
        example: ocid1.subnet.realm.region.zxcvbn432765
        type: string
    type: object
  PutMessagesDetails:
    description: Object that represents an array of messages to emit to a stream.
    properties:
      messages:
        description: The array of messages to put into a stream.
        items:
          $ref: '#/definitions/PutMessagesDetailsEntry'
        minItems: 1
        type: array
    required:
    - messages
    type: object
    x-example: "{\n  \"messages\":\n  [\n    {\n      \"key\": null,\n      \"value\"\
      : \"VGhlIHF1aWNrIGJyb3duIGZveCBqdW1wZWQgb3ZlciB0aGUgbGF6eSBkb2cu\"\n    }\n\
      \  ]\n}\n"
  PutMessagesDetailsEntry:
    description: Object that represents a message to emit to a stream.
    properties:
      key:
        description: 'The key of the message, expressed as a byte array up to 256
          bytes in size. Messages with the same key are stored in the same partition.

          '
        format: byte
        maxItems: 256
        type: string
      value:
        description: The message, expressed as a byte array up to 1 MiB in size.
        format: byte
        maxItems: 1048576
        minItems: 1
        type: string
    required:
    - value
    type: object
  PutMessagesResult:
    description: 'The response to a [PutMessages](#/en/streaming/20180418/methods/PutMessages)
      request. It indicates the number

      of failed messages as well as an array of results for successful and failed
      messages.

      '
    properties:
      entries:
        description: 'An array of items representing the result of each message.

          The order is guaranteed to be the same as in the `PutMessagesDetails` object.

          If a message was successfully appended to the stream, the entry includes
          the `offset`, `partition`, and `timestamp`.

          If a message failed to be appended to the stream, the entry includes the
          `error` and `errorMessage`.

          '
        items:
          $ref: '#/definitions/PutMessagesResultEntry'
        minItems: 1
        type: array
      failures:
        description: The number of messages that failed to be added to the stream.
        type: integer
    required:
    - failures
    - entries
    type: object
    x-example: "{\n  \"failures\": 0,\n  \"entries\": {\n    \"partition\": \"3\"\
      ,\n    \"offset\": 0,\n    \"timestamp\": \"2018-04-20T23:21:12.428Z\"\n  }\n\
      }\n"
  PutMessagesResultEntry:
    description: 'Represents the result of a [PutMessages](#/en/streaming/20180418/methods/PutMessages)
      request, whether it was successful or not.

      If a message was successfully appended to the stream, the entry includes the
      `offset`, `partition`, and `timestamp`.

      If the message failed to be appended to the stream, the entry includes the `error`
      and `errorMessage`.

      '
    properties:
      error:
        description: The error code, in case the message was not successfully appended
          to the stream.
        type: string
      errorMessage:
        description: A human-readable error message associated with the error code.
        type: string
      offset:
        description: The offset of the message in the partition.
        example: 42
        format: int64
        type: integer
      partition:
        description: The ID of the partition where the message was stored.
        example: '1'
        type: string
      timestamp:
        description: The timestamp indicating when the server appended the message
          to the stream.
        format: date-time
        type: string
    type: object
  Stream:
    description: Detailed representation of a stream, including all its partitions.
    properties:
      compartmentId:
        description: The OCID of the stream.
        example: ocid1.compinstance.realm.region.zxcvbn432765
        type: string
      definedTags:
        additionalProperties:
          additionalProperties:
            description: 'The value of the tag. Only the String type is supported.

              '
            type: object
          description: 'Key-value pair representing a defined tag key and value, scoped
            to a namespace.


            Example: `{"CostCenter": "42"}''

            '
          type: object
        description: 'Defined tags for this resource. Each key is predefined and scoped
          to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).


          Example: `{"Operations": {"CostCenter": "42"}}''

          '
        type: object
      freeformTags:
        additionalProperties:
          type: string
        description: 'Free-form tags for this resource. Each tag is a simple key-value
          pair with no predefined name, type, or namespace. Exists for cross-compatibility
          only.

          For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).


          Example: `{"Department": "Finance"}`

          '
        type: object
      id:
        description: The OCID of the stream.
        example: ocid1.stream.realm.region.mnopqr789
        type: string
      lifecycleState:
        description: The current state of the stream.
        enum:
        - CREATING
        - ACTIVE
        - DELETING
        - DELETED
        - FAILED
        - UPDATING
        type: string
      lifecycleStateDetails:
        description: Any additional details about the current state of the stream.
        type: string
      messagesEndpoint:
        description: 'The endpoint to use when creating the StreamClient to consume
          or publish messages in the stream.

          If the associated stream pool is private, the endpoint is also private and
          can only be accessed from inside the stream pool''s associated subnet.

          '
        type: string
      name:
        description: 'The name of the stream. Avoid entering confidential information.


          Example: `TelemetryEvents`

          '
        example: TelemetryEvents
        type: string
      partitions:
        description: The number of partitions in the stream.
        example: 10
        type: integer
      retentionInHours:
        description: The retention period of the stream, in hours. This property is
          read-only.
        example: 24
        type: integer
      streamPoolId:
        description: The OCID of the stream pool that contains the stream.
        example: ocid1.streampool.realm.region.zxcvbn432765
        type: string
      timeCreated:
        description: 'The date and time the stream was created, expressed in in [RFC
          3339](https://tools.ietf.org/rfc/rfc3339) timestamp format.


          Example: `2018-04-20T00:00:07.405Z`

          '
        format: date-time
        type: string
    required:
    - name
    - id
    - partitions
    - compartmentId
    - streamPoolId
    - lifecycleState
    - timeCreated
    - retentionInHours
    - messagesEndpoint
    type: object
    x-example: "{\n  \"name\": \"mynewstream\",\n  \"id\": \"ocid1.stream.oc1..exampleakzxrjqcvbj2rpflj6xqnej3gus4xse3fxmnfauxbdtovpuhywnua\"\
      ,\n  \"partitions\": 4,\n  \"retentionInHours\": 24,\n  \"compartmentId\": \"\
      ocid1.tenancy.oc1..exampleasgadvsw7l6cvb4fhssurjqs4irbkzma3wc2fauxv4novazj5guta\"\
      ,\n  \"lifecycleState\": \"CREATING\",\n  \"timeCreated\": \"2018-04-25T23:28:30.629Z\"\
      ,\n  \"messagesEndpoint\": \"https://streaming-api-1.us-phoenix-1.oraclecloud.com\"\
      ,\n  \"freeformTags\": { },\n  \"definedTags\": { }\n}\n"
  StreamPool:
    description: The details of a stream pool.
    properties:
      compartmentId:
        description: Compartment OCID that the pool belongs to.
        example: ocid1.compartment.oc1..aaaaaaaa2byuam5ewxzrcs2iqzh7okx84jae6j4uhkih5wdbrkkwuxv3qgpa
        type: string
      customEncryptionKey:
        $ref: '#/definitions/CustomEncryptionKey'
      definedTags:
        additionalProperties:
          additionalProperties:
            description: 'The value of the tag. Only the String type is supported.

              '
            type: object
          description: 'Key-value pair representing a defined tag key and value, scoped
            to a namespace.


            Example: `{"CostCenter": "42"}''

            '
          type: object
        description: 'Defined tags for this resource. Each key is predefined and scoped
          to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).


          Example: `{"Operations": {"CostCenter": "42"}}''

          '
        type: object
      endpointFqdn:
        description: 'The FQDN used to access the streams inside the stream pool (same
          FQDN as the messagesEndpoint attribute of a [Stream](#/en/streaming/20180418/Stream)
          object).

          If the stream pool is private, the FQDN is customized and can only be accessed
          from inside the associated subnetId, otherwise the FQDN is publicly resolvable.

          Depending on which protocol you attempt to use, you need to either prepend
          https or append the Kafka port.

          '
        type: string
      freeformTags:
        additionalProperties:
          type: string
        description: 'Free-form tags for this resource. Each tag is a simple key-value
          pair with no predefined name, type, or namespace. Exists for cross-compatibility
          only.

          For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).


          Example: `{"Department": "Finance"}`

          '
        type: object
      id:
        description: The OCID of the stream pool.
        example: ocid1.streampool.realm.region.mnopqr789
        type: string
      isPrivate:
        description: 'True if the stream pool is private, false otherwise.

          If the stream pool is private, the streams inside the stream pool can only
          be accessed from inside the associated subnetId.

          '
        type: boolean
      kafkaSettings:
        $ref: '#/definitions/KafkaSettings'
      lifecycleState:
        description: The current state of the stream pool.
        enum:
        - CREATING
        - ACTIVE
        - DELETING
        - DELETED
        - FAILED
        - UPDATING
        type: string
      lifecycleStateDetails:
        description: Any additional details about the current state of the stream.
        type: string
      name:
        description: The name of the stream pool.
        example: MyStreamPool
        type: string
      privateEndpointSettings:
        $ref: '#/definitions/PrivateEndpointSettings'
      securityAttributes:
        additionalProperties:
          additionalProperties:
            description: 'Attribute value and mode. Only the String type is supported
              for value. Mode is currently always "enforce".

              '
            type: object
          description: 'Key-value pair representing a security attribute key and value,
            scoped to a namespace.


            Example: `{"MaxEgressCount": {"value": "42", "mode": "enforce"}}`

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

          For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).


          Example: `{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "enforce"}}}`

          '
        type: object
      timeCreated:
        description: 'The date and time the stream pool was created, expressed in
          in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) timestamp format.


          Example: `2018-04-20T00:00:07.405Z`

          '
        format: date-time
        type: string
    required:
    - id
    - compartmentId
    - name
    - kafkaSettings
    - customEncryptionKey
    - lifecycleState
    - timeCreated
    type: object
    x-example: "{\n  \"id\": \"ocid1.streampool.realm.region.mnopqr789\",\n  \"compartmentId\"\
      : \"ocid1.compartment.oc1..aaaaaaaa2byuam5ewxzrcs2iqzh7okx84jae6j4uhkih5wdbrkkwuxv3qgpa\"\
      ,\n  \"name\": \"MyStreamPool\",\n  \"kafkaSettings\": {\n    \"autoCreateTopicsEnable\"\
      : true,\n    \"logRetentionHours\": 24,\n    \"numPartitions\": 1,\n  },\n \
      \ \"freeformTags\": {},\n  \"definedTags\": {}\n}\n"
  StreamPoolSummary:
    description: The summary representation of a stream pool.
    properties:
      compartmentId:
        description: Compartment OCID that the pool belongs to.
        example: ocid1.compartment.oc1..aaaaaaaa2byuam5ewxzrcs2iqzh7okx84jae6j4uhkih5wdbrkkwuxv3qgpa
        type: string
      definedTags:
        additionalProperties:
          additionalProperties:
            description: 'The value of the tag. Only the String type is supported.

              '
            type: object
          description: 'Key-value pair representing a defined tag key and value, scoped
            to a namespace.


            Example: `{"CostCenter": "42"}`

            '
          type: object
        description: 'Defined tags for this resource. Each key is predefined and scoped
          to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).


          Example: `{"Operations": {"CostCenter": "42"}}`

          '
        type: object
      freeformTags:
        additionalProperties:
          type: string
        description: 'Free-form tags for this resource. Each tag is a simple key-value
          pair that is applied with no predefined name, type, or namespace. Exists
          for cross-compatibility only.

          For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).


          Example: `{"Department": "Finance"}`

          '
        type: object
      id:
        description: The OCID of the stream pool.
        example: ocid1.streampool.realm.region.mnopqr789
        type: string
      isPrivate:
        description: 'True if the stream pool is private, false otherwise.

          The associated endpoint and subnetId of a private stream pool can be retrieved
          through the [GetStreamPool](#/en/streaming/20180418/StreamPool/GetStreamPool)
          API.

          '
        type: boolean
      lifecycleState:
        description: The current state of the stream pool.
        enum:
        - CREATING
        - ACTIVE
        - DELETING
        - DELETED
        - FAILED
        - UPDATING
        type: string
      name:
        description: The name of the stream pool.
        example: MyStreamPool
        type: string
      securityAttributes:
        additionalProperties:
          additionalProperties:
            description: 'Attribute value and mode. Only the String type is supported
              for value. Mode is currently always "enforce".

              '
            type: object
          description: 'Key-value pair representing a security attribute key and value,
            scoped to a namespace.


            Example: `{"MaxEgressCount": {"value": "42", "mode": "enforce"}}`

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

          For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).


          Example: `{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "enforce"}}}`

          '
        type: object
      timeCreated:
        description: 'The date and time the stream pool was created, expressed in
          in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) timestamp format.


          Example: `2018-04-20T00:00:07.405Z`

          '
        format: date-time
        type: string
    required:
    - id
    - compartmentId
    - name
    - lifecycleState
    - timeCreated
    type: object
    x-example: "{\n  \"id\": \"ocid1.streampool.realm.region.mnopqr789\",\n  \"compartmentId\"\
      : \"ocid1.compartment.oc1..aaaaaaaa2byuam5ewxzrcs2iqzh7okx84jae6j4uhkih5wdbrkkwuxv3qgpa\"\
      ,\n  \"name\": \"MyStreamPool\"\n}\n"
  StreamSummary:
    description: Summary representation of a stream.
    properties:
      compartmentId:
        description: The OCID of the compartment that contains the stream.
        example: ocid1.compinstance.realm.region.zxcvbn432765
        type: string
      definedTags:
        additionalProperties:
          additionalProperties:
            description: 'The value of the tag. Only the String type is supported.

              '
            type: object
          description: 'Key-value pair representing a defined tag key and value, scoped
            to a namespace.


            Example: `{"CostCenter": "42"}`

            '
          type: object
        description: 'Defined tags for this resource. Each key is predefined and scoped
          to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).


          Example: `{"Operations": {"CostCenter": "42"}}`

          '
        type: object
      freeformTags:
        additionalProperties:
          type: string
        description: 'Free-form tags for this resource. Each tag is a simple key-value
          pair that is applied with no predefined name, type, or namespace. Exists
          for cross-compatibility only.

          For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).


          Example: `{"Department": "Finance"}`

          '
        type: object
      id:
        description: The OCID of the stream.
        example: ocid1.stream.realm.region.mnopqr789
        type: string
      lifecycleState:
        description: The current state of the stream.
        enum:
        - CREATING
        - ACTIVE
        - DELETING
        - DELETED
        - FAILED
        - UPDATING
        type: string
      messagesEndpoint:
        description: 'The endpoint to use when creating the StreamClient to consume
          or publish messages in the stream.

          If the associated stream pool is private, the endpoint is also private and
          can only be accessed from inside the stream pool''s associated subnet.

          '
        type: string
      name:
        description: 'The name of the stream.


          Example: `TelemetryEvents`

          '
        example: TelemetryEvents
        type: string
      partitions:
        description: The number of partitions in the stream.
        example: 10
        type: integer
      streamPoolId:
        description: The OCID of the stream pool that contains the stream.
        example: ocid1.streampool.realm.region.zxcvbn432765
        type: string
      timeCreated:
        description: 'The date and time the stream was created, expressed in [RFC
          3339](https://tools.ietf.org/rfc/rfc3339) timestamp format.


          Example: `2018-04-20T00:00:07.405Z`

          '
        format: date-time
        type: string
    required:
    - name
    - id
    - partitions
    - compartmentId
    - lifecycleState
    - timeCreated
    - messagesEndpoint
    - streamPoolId
    type: object
    x-example: "[\n  {\n    \"name\": \"mynewstream\",\n    \"id\": \"ocid1.stream.oc1..exampleakzxrjqcvbj2rpflj6xqnej3gus4xse3fxmnfauxbdtovpuhywnua\"\
      ,\n    \"partitions\": 4,\n    \"compartmentId\": \"ocid1.tenancy.oc1..exampleasgadvsw7l6cvb4fhssurjqs4irbkzma3wc2fauxv4novazj5guta\"\
      ,\n    \"lifecycleState\": \"ACTIVE\",\n    \"timeCreated\": \"2018-04-25T23:28:30.629Z\"\
      ,\n    \"messagesEndpoint\": \"https://streaming-api-1.us-phoenix-1.oraclecloud.com\"\
      ,\n    \"freeformTags\": {\n      \"Department\": \"Finance\"\n      },\n  \
      \  \"definedTags\":\n    {\n      \"MyNamespace\":\n      {\n        \"CostCenter\"\
      : \"42\"\n      }\n    }\n  },\n  {\n    \"name\": \"Stream1\",\n    \"id\"\
      : \"ocid1.stream.oc1..exampleak737ys3cvb5xs42lbuy3qr3wiqmfaux5ugnn7wmpvb4d2sgk7dmq\"\
      ,\n    \"partitions\": 1,\n    \"compartmentId\": \"ocid1.tenancy.oc1..exampleasgadvsw7l6cvb4fhssurjqs4irbkzma3wc2fauxv4novazj5guta\"\
      ,\n    \"lifecycleState\": \"ACTIVE\",\n    \"timeCreated\": \"2018-04-25T15:35:07.306Z\"\
      ,\n    \"messagesEndpoint\": \"https://streaming-api-1.us-phoenix-1.oraclecloud.com\"\
      ,\n    \"freeformTags\": { },\n    \"definedTags\": { }\n  }\n]\n"
  UpdateConnectHarnessDetails:
    description: Object used to update a connect harness.
    properties:
      definedTags:
        additionalProperties:
          additionalProperties:
            description: 'The value of the tag. Only the String type is supported.

              '
            type: object
          description: 'Key-value pair representing a defined tag key and value, scoped
            to a namespace.


            Example: `{"CostCenter": "42"}`

            '
          type: object
        description: 'Defined tags for this resource. Each key is predefined and scoped
          to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).


          Example: `{"Operations": {"CostCenter": "42"}}`

          '
        type: object
      freeformTags:
        additionalProperties:
          type: string
        description: 'Free-form tags for this resource. Each tag is a simple key-value
          pair that is applied with no predefined name, type, or namespace. Exists
          for cross-compatibility only.

          For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).


          Example: `{"Department": "Finance"}`

          '
        type: object
    type: object
  UpdateGroupDetails:
    description: 'Request body for operationally managing a group.

      '
    properties:
      time:
        description: The time to consume from if type is AT_TIME.
        format: date-time
        type: string
      type:
        description: The type of the cursor.
        enum:
        - AT_TIME
        - LATEST
        - TRIM_HORIZON
        type: string
    type: object
  UpdateStreamDetails:
    description: Object used to update a stream.
    properties:
      definedTags:
        additionalProperties:
          additionalProperties:
            description: 'The value of the tag. Only the String type is supported.

              '
            type: object
          description: 'Key-value pair representing a defined tag key and value, scoped
            to a namespace.


            Example: `{"CostCenter": "42"}`

            '
          type: object
        description: 'Defined tags for this resource. Each key is predefined and scoped
          to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).


          Example: `{"Operations": {"CostCenter": "42"}}`

          '
        type: object
      freeformTags:
        additionalProperties:
          type: string
        description: 'Free-form tags for this resource. Each tag is a simple key-value
          pair that is applied with no predefined name, type, or namespace. Exists
          for cross-compatibility only.

          For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).


          Example: `{"Department": "Finance"}`

          '
        type: object
      streamPoolId:
        description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the
          stream pool where the stream should be moved.

          '
        maxLength: 255
        minLength: 1
        type: string
    type: object
  UpdateStreamPoolDetails:
    description: Object used to update the stream pool's details.
    properties:
      customEncryptionKeyDetails:
        $ref: '#/definitions/CustomEncryptionKeyDetails'
      definedTags:
        additionalProperties:
          additionalProperties:
            description: 'The value of the tag. Only the String type is supported.

              '
            type: object
          description: 'Key-value pair representing a defined tag key and value, scoped
            to a namespace.


            Example: `{"CostCenter": "42"}`

            '
          type: object
        description: 'Defined tags for this resource. Each key is predefined and scoped
          to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).


          Example: `{"Operations": {"CostCenter": "42"}}`

          '
        type: object
      freeformTags:
        additionalProperties:
          type: string
        description: 'Free-form tags for this resource. Each tag is a simple key-value
          pair that is applied with no predefined name, type, or namespace. Exists
          for cross-compatibility only.

          For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).


          Example: `{"Department": "Finance"}`

          '
        type: object
      kafkaSettings:
        $ref: '#/definitions/KafkaSettings'
      name:
        description: 'The name of the stream pool. Avoid entering confidential information.


          Example: `MyStreamPool`

          '
        maxLength: 1024
        minLength: 1
        type: string
      securityAttributes:
        additionalProperties:
          additionalProperties:
            description: 'Attribute value and mode. Only the String type is supported
              for value. Mode is currently always "enforce".

              '
            type: object
          description: 'Key-value pair representing a security attribute key and value,
            scoped to a namespace.


            Example: `{"MaxEgressCount": {"value": "42", "mode": "enforce"}}`

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

          For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).


          Example: `{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "enforce"}}}`

          '
        type: object
    type: object
  WorkRequest:
    description: 'An asynchronous work request. Work requests help you monitor long-running
      operations. When you start a long-running operation,

      the service creates a work request. A work request is an activity log that lets
      you track each step in the operation''s

      progress. Each work request has an OCID that lets you interact with it programmatically
      and use it for automation.

      '
    properties:
      compartmentId:
        description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of
          the compartment that contains the work request.

          '
        type: string
      id:
        description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of
          the work request.
        type: string
      operationType:
        description: The asynchronous operation tracked by this work request.
        enum: *id001
        type: string
        x-obmcs-top-level-enum: '#/definitions/OperationType'
      percentComplete:
        description: 'Shows the progress of the operation tracked by the work request,
          as a percentage of the total work

          that must be performed.

          '
        format: float
        type: number
      resources:
        description: The resources that are affected by the work request.
        items:
          $ref: '#/definitions/WorkRequestResource'
        type: array
      status:
        description: The status of the work request.
        enum: *id002
        type: string
        x-obmcs-top-level-enum: '#/definitions/OperationStatus'
      timeAccepted:
        description: 'The date and time the request was created, as described in

          [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29.

          '
        format: date-time
        type: string
      timeFinished:
        description: 'The date and time the object was finished, as described in [RFC
          3339](https://tools.ietf.org/rfc/rfc3339).

          '
        format: date-time
        type: string
      timeStarted:
        description: 'The date and time the request was started, as described in [RFC
          3339](https://tools.ietf.org/rfc/rfc3339),

          section 14.29.

          '
        format: date-time
        type: string
    required:
    - operationType
    - status
    - id
    - compartmentId
    - resources
    - percentComplete
    - timeAccepted
    type: object
  WorkRequestError:
    description: An error encountered while performing an operation that is tracked
      by a work request.
    properties:
      code:
        description: 'A machine-usable code for the error that occurred. For a list
          of error codes, see

          [API Errors](/iaas/Content/API/References/apierrors.htm).

          '
        type: string
      message:
        description: A human-readable error message.
        type: string
      timestamp:
        description: The date and time the error occurred, in the format defined by
          [RFC 3339](https://tools.ietf.org/html/rfc3339).
        format: date-time
        type: string
    required:
    - code
    - message
    - timestamp
    type: object
  WorkRequestErrorCollection:
    description: A list of work request errors. Can contain both errors and other
      information, such as metadata.
    properties:
      items:
        description: A list of work request errors.
        items:
          $ref: '#/definitions/WorkRequestError'
        type: array
    required:
    - items
    type: object
  WorkRequestLogEntry:
    description: A log message from performing an operation that is tracked by a work
      request.
    properties:
      message:
        description: A human-readable log message.
        type: string
      timestamp:
        description: The date and time the log message was written, in the format
          defined by [RFC 3339](https://tools.ietf.org/html/rfc3339).
        format: date-time
        type: string
    required:
    - message
    - timestamp
    type: object
  WorkRequestLogEntryCollection:
    description: A list of work request logs. Can contain both logs and other information,
      such as metadata.
    properties:
      items:
        description: A list of work request log entries.
        items:
          $ref: '#/definitions/WorkRequestLogEntry'
        type: array
    required:
    - items
    type: object
  WorkRequestResource:
    description: A resource created or operated on by a work request.
    properties:
      actionType:
        description: 'The way in which this resource is affected by the operation
          tracked in the work request.

          A resource being created, updated, or deleted remains in the IN_PROGRESS
          state until

          work is complete for that resource, at which point it transitions to CREATED,
          UPDATED,

          or DELETED, respectively.

          '
        enum: *id003
        type: string
        x-obmcs-top-level-enum: '#/definitions/ActionType'
      entityType:
        description: The resource type that the work request affects.
        type: string
      entityUri:
        description: The URI path that you can use for a GET request to access the
          resource metadata
        type: string
      identifier:
        description: An [OCID](/iaas/Content/General/Concepts/identifiers.htm) or
          other unique identifier for the resource.
        type: string
    required:
    - actionType
    - entityType
    - identifier
    type: object
  WorkRequestSummary:
    description: 'An asynchronous work request. Work requests help you monitor long-running
      operations. When you start a long-running operation,

      the service creates a work request. A work request is an activity log that lets
      you track each step in the operation''s

      progress. Each work request has an OCID that lets you interact with it programmatically
      and use it for automation.

      '
    properties:
      compartmentId:
        description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of
          the compartment that contains the work request.

          '
        type: string
      id:
        description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of
          the work request.
        type: string
      operationType:
        description: The asynchronous operation tracked by this work request.
        enum: *id001
        type: string
        x-obmcs-top-level-enum: '#/definitions/OperationType'
      percentComplete:
        description: 'Shows the progress of the operation tracked by the work request,
          as a percentage of the total work

          that must be performed.

          '
        format: float
        type: number
      resources:
        description: The resources that are affected by the work request.
        items:
          $ref: '#/definitions/WorkRequestResource'
        type: array
      status:
        description: The status of the work request.
        enum: *id002
        type: string
        x-obmcs-top-level-enum: '#/definitions/OperationStatus'
      timeAccepted:
        description: 'The date and time the request was created, as described in

          [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29.

          '
        format: date-time
        type: string
      timeFinished:
        description: 'The date and time the object was finished, as described in [RFC
          3339](https://tools.ietf.org/rfc/rfc3339).

          '
        format: date-time
        type: string
      timeStarted:
        description: 'The date and time the request was started, as described in [RFC
          3339](https://tools.ietf.org/rfc/rfc3339),

          section 14.29.

          '
        format: date-time
        type: string
    required:
    - operationType
    - status
    - id
    - compartmentId
    - resources
    - percentComplete
    - timeAccepted
    type: object
  WorkRequestSummaryCollection:
    description: A list of work requests. Can contain both work requests and other
      information, such as metadata.
    properties:
      items:
        description: A list of work requests.
        items:
          $ref: '#/definitions/WorkRequestSummary'
        type: array
    required:
    - items
    type: object
host: streaming.{region}.oci.oraclecloud.com
info:
  description: Use the Streaming API to produce and consume messages, create streams
    and stream pools, and manage related items. For more information, see [Streaming](/Content/Streaming/Concepts/streamingoverview.htm).
  title: Streaming API
  version: '20180418'
parameters:
  CompartmentIdQueryOptionalParam:
    description: The OCID of the compartment. Is exclusive with the `streamPoolId`
      parameter. One of them is required.
    in: query
    maxLength: 1024
    minLength: 1
    name: compartmentId
    type: string
  CompartmentIdQueryParam:
    description: The OCID of the compartment.
    in: query
    maxLength: 1024
    minLength: 1
    name: compartmentId
    required: true
    type: string
  ConnectHarnessIdPathParam:
    description: 'The OCID of the connect harness.

      '
    in: path
    maxLength: 256
    minLength: 1
    name: connectHarnessId
    required: true
    type: string
  FilterByIdQueryParam:
    description: 'A filter to return only resources that match the given ID exactly.

      '
    in: query
    maxLength: 1024
    minLength: 1
    name: id
    required: false
    type: string
    x-default-description: 'null'
  FilterByNameQueryParam:
    description: 'A filter to return only resources that match the given name exactly.

      '
    in: query
    maxLength: 1024
    minLength: 1
    name: name
    required: false
    type: string
    x-default-description: 'null'
  GroupCursorQueryParam:
    description: 'The group-cursor representing the offsets of the group. This cursor
      is retrieved from the CreateGroupCursor API call.

      '
    in: query
    maxLength: 1024
    minLength: 1
    name: cursor
    required: true
    type: string
  OpcIfMatchHeaderParam:
    description: For optimistic concurrency control. In the PUT or DELETE call for
      a resource, set the if-match parameter to the value of the etag from a previous
      GET or POST response for that resource. The resource will be updated or deleted
      only if the etag you provide matches the resource's current etag value.
    in: header
    maxLength: 255
    name: if-match
    required: false
    type: string
  OpcRequestIdHeaderParam:
    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
    required: false
    type: string
  OpcRetryTokenHeaderParam:
    description: A token that uniquely identifies a request so it can be retried in
      case of a timeout or server error without risk of executing that same action
      again. Retry tokens expire after 24 hours, but can be invalidated before then
      due to conflicting operations (for example, if a resource has been deleted and
      purged from the system, then a retry of the original creation request may be
      rejected).
    in: header
    maxLength: 255
    name: opc-retry-token
    required: false
    type: string
  PaginationLimitQueryParam:
    default: 10
    description: The maximum number of items to return. The value must be between
      1 and 50. The default is 10.
    in: query
    maximum: 50
    minimum: 1
    name: limit
    required: false
    type: integer
  PaginationTokenQueryParam:
    description: The page at which to start retrieving results.
    in: query
    maxLength: 1024
    minLength: 1
    name: page
    required: false
    type: string
    x-default-description: 'null'
  ResourceIdentifierQueryParam:
    description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the
      resource affected by the work request.
    in: query
    name: resourceId
    type: string
    x-default-description: 'null'
  SortByQueryParam:
    description: 'The field to sort by. You can provide no more than one sort order.
      By default, `TIMECREATED` sorts results in descending order and `NAME` sorts
      results in ascending order.

      '
    enum:
    - NAME
    - TIMECREATED
    in: query
    name: sortBy
    required: false
    type: string
    x-default-description: By default, TIMECREATED is used to sort by.
  SortOrderQueryParam:
    description: 'The sort order to use, either ''asc'' or ''desc''.

      '
    enum:
    - ASC
    - DESC
    in: query
    name: sortOrder
    required: false
    type: string
    x-default-description: For time-based fields, the default sort order is `DESC`
      (descending). For all others, it is `ASC` (ascending).
  StreamIdPathParam:
    description: 'The OCID of the stream.

      '
    in: path
    maxLength: 256
    minLength: 1
    name: streamId
    required: true
    type: string
  StreamPoolIdPathParam:
    description: 'The OCID of the stream pool.

      '
    in: path
    maxLength: 256
    minLength: 1
    name: streamPoolId
    required: true
    type: string
  StreamPoolIdQueryParam:
    description: The OCID of the stream pool. Is exclusive with the `compartmentId`
      parameter. One of them is required.
    in: query
    maxLength: 1024
    minLength: 1
    name: streamPoolId
    type: string
  WorkRequestIdPathParam:
    description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the
      asynchronous work request.
    in: path
    name: workRequestId
    required: true
    type: string
  WorkRequestIdQueryOptionalParam:
    description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the
      asynchronous work request.
    in: query
    name: workRequestId
    required: false
    type: string
  WorkRequestSortByQueryParam:
    default: TIMEACCEPTED
    description: 'The field to sort by. Only one sort order may be provided. Default
      order for `timeAccepted` is descending.

      '
    enum:
    - TIMEACCEPTED
    in: query
    name: sortBy
    type: string
paths:
  /connectharnesses:
    get:
      description: Lists the connectharness.
      operationId: ListConnectHarnesses
      parameters:
      - $ref: '#/parameters/CompartmentIdQueryParam'
      - $ref: '#/parameters/FilterByIdQueryParam'
      - $ref: '#/parameters/FilterByNameQueryParam'
      - $ref: '#/parameters/PaginationLimitQueryParam'
      - $ref: '#/parameters/PaginationTokenQueryParam'
      - $ref: '#/parameters/SortByQueryParam'
      - $ref: '#/parameters/SortOrderQueryParam'
      - description: 'A filter to only return resources that match the given lifecycle
          state. The state value is case-insensitive.

          '
        in: query
        name: lifecycleState
        required: false
        type: string
        x-obmcs-enumref: '#/definitions/ConnectHarnessSummary/lifecycleState'
      - $ref: '#/parameters/OpcRequestIdHeaderParam'
      responses:
        200:
          description: The list of connect harnesses.
          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).
              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
          schema:
            items:
              $ref: '#/definitions/ConnectHarnessSummary'
            type: array
        400:
          $ref: '#/responses/400'
        401:
          $ref: '#/responses/401'
        404:
          $ref: '#/responses/404'
        429:
          $ref: '#/responses/429'
        500:
          $ref: '#/responses/500'
        default:
          $ref: '#/responses/DefaultError'
      summary: Lists the connectharnesses.
      tags:
      - streamAdmin
      x-example: 'GET /20180418/connectharnesses?compartmentId=<var>&lt;compartmentId&gt;</var>&limit=10&page=1

        Host: streaming.us-phoenix-1.oraclecloud.com

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

        '
    post:
      description: 'Starts the provisioning of a new connect harness.

        To track the progress of the provisioning, you can periodically call [GetConnectHarness].

        In the response, the `lifecycleState` parameter of the [ConnectHarness](#/en/streaming/20180418/ConnectHarness/)
        object tells you its current state.

        '
      operationId: CreateConnectHarness
      parameters:
      - description: The connect harness to create.
        in: body
        name: CreateConnectHarnessDetails
        required: true
        schema:
          $ref: '#/definitions/CreateConnectHarnessDetails'
      - $ref: '#/parameters/OpcRequestIdHeaderParam'
      - $ref: '#/parameters/OpcRetryTokenHeaderParam'
      responses:
        200:
          description: Created
          headers:
            etag:
              description: For optimistic concurrency control. See `if-match`.
              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
          schema:
            $ref: '#/definitions/ConnectHarness'
        400:
          $ref: '#/responses/400'
        401:
          $ref: '#/responses/401'
        409:
          $ref: '#/responses/409'
        429:
          $ref: '#/responses/429'
        500:
          $ref: '#/responses/500'
        default:
          $ref: '#/responses/DefaultError'
      summary: Create a connect harness
      tags:
      - streamAdmin
      x-example: "POST /20180418/connectharnesses\nHost: streaming.us-phoenix-1.oraclecloud.com\n\
        <var>&lt;authorization and other headers&gt;</var>\n{\n  \"compartmentId\"\
        : \"ocid1.tenancy.oc1..exampleasgadvsw7l6cvb4fhssurjqs4irbkzma3wc2fauxv4novazj5guta\"\
        ,\n  \"name\": \"mynewconnectharness\"\n}\n"
  /connectharnesses/{connectHarnessId}:
    delete:
      description: 'Deletes a connect harness and its content. Connect harness contents
        are deleted immediately. The service retains records of the connect harness
        itself for 90 days after deletion.

        The `lifecycleState` parameter of the `ConnectHarness` object changes to `DELETING`
        and the connect harness becomes inaccessible for read or write operations.

        To verify that a connect harness has been deleted, make a [GetConnectHarness](#/en/streaming/20180418/ConnectHarness/GetConnectHarness)
        request. If the call returns the connect harness''s

        lifecycle state as `DELETED`, then the connect harness has been deleted. If
        the call returns a "404 Not Found" error, that means all records of the

        connect harness have been deleted.

        '
      operationId: DeleteConnectHarness
      parameters:
      - $ref: '#/parameters/ConnectHarnessIdPathParam'
      - $ref: '#/parameters/OpcRequestIdHeaderParam'
      - $ref: '#/parameters/OpcIfMatchHeaderParam'
      responses:
        204:
          description: The connect harness is being deleted.
          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.

                '
              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
        401:
          $ref: '#/responses/401'
        404:
          $ref: '#/responses/404'
        412:
          $ref: '#/responses/412'
        429:
          $ref: '#/responses/429'
        500:
          $ref: '#/responses/500'
        default:
          $ref: '#/responses/DefaultError'
      summary: Deletes a connect harness.
      tags:
      - streamAdmin
      x-example: 'DELETE /20180418/connectharnesses/<var>&lt;connectHarnessId&gt;</var>

        Host: streaming.us-phoenix-1.oraclecloud.com

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

        '
      x-related-resource: '#/definitions/ConnectHarness'
    get:
      description: Gets detailed information about a connect harness.
      operationId: GetConnectHarness
      parameters:
      - $ref: '#/parameters/ConnectHarnessIdPathParam'
      - $ref: '#/parameters/OpcRequestIdHeaderParam'
      responses:
        200:
          description: Success
          headers:
            etag:
              description: For optimistic concurrency control. See `if-match`.
              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
          schema:
            $ref: '#/definitions/ConnectHarness'
        401:
          $ref: '#/responses/401'
        404:
          $ref: '#/responses/404'
        429:
          $ref: '#/responses/429'
        500:
          $ref: '#/responses/500'
        default:
          $ref: '#/responses/DefaultError'
      summary: Gets a connectharness
      tags:
      - streamAdmin
      x-example: 'GET /20180418/connectharnesses/<var>&lt;connectHarnessId&gt;</var>

        Host: streaming.us-phoenix-1.oraclecloud.com

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

        '
    put:
      description: 'Updates the tags applied to the connect harness.

        '
      operationId: UpdateConnectHarness
      parameters:
      - $ref: '#/parameters/ConnectHarnessIdPathParam'
      - description: The connect harness is updated with the tags provided.
        in: body
        name: UpdateConnectHarnessDetails
        required: true
        schema:
          $ref: '#/definitions/UpdateConnectHarnessDetails'
      - $ref: '#/parameters/OpcRequestIdHeaderParam'
      - $ref: '#/parameters/OpcIfMatchHeaderParam'
      responses:
        200:
          description: Updated
          headers:
            etag:
              description: For optimistic concurrency control. See `if-match`.
              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
          schema:
            $ref: '#/definitions/ConnectHarness'
        400:
          $ref: '#/responses/400'
        401:
          $ref: '#/responses/401'
        404:
          $ref: '#/responses/404'
        412:
          $ref: '#/responses/412'
        429:
          $ref: '#/responses/429'
        500:
          $ref: '#/responses/500'
        default:
          $ref: '#/responses/DefaultError'
      summary: Updates a connect harness.
      tags:
      - streamAdmin
      x-example: "PUT /20180418/connectharnesses/<var>&lt;connectHarnessId&gt;</var>\n\
        Host: streaming.us-phoenix-1.oraclecloud.com\n<var>&lt;authorization and other\
        \ headers&gt;</var>\n{\n  \"definedTags\": {\n    \"Operations\": {\n    \
        \  \"CostCenter\": \"42\"\n    }\n  },\n  \"freeformTags\": {\n    \"Department\"\
        : \"Finance\"\n  }\n}\n"
  /connectharnesses/{connectHarnessId}/actions/changeCompartment:
    post:
      description: Moves a resource into a different compartment. When provided, If-Match
        is checked against ETag values of the resource.
      operationId: ChangeConnectHarnessCompartment
      parameters:
      - $ref: '#/parameters/ConnectHarnessIdPathParam'
      - $ref: '#/parameters/OpcIfMatchHeaderParam'
      - $ref: '#/parameters/OpcRequestIdHeaderParam'
      - description: The connect harness will be moved into the compartment specified
          within this entity.
        in: body
        name: ChangeConnectHarnessCompartmentDetails
        required: true
        schema:
          $ref: '#/definitions/ChangeConnectHarnessCompartmentDetails'
      responses:
        204:
          description: ConnectHarness's compartment has been changed.
          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.

                '
              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
        401:
          $ref: '#/responses/401'
        404:
          $ref: '#/responses/404'
        409:
          $ref: '#/responses/409'
        412:
          $ref: '#/responses/412'
        500:
          $ref: '#/responses/500'
        default:
          $ref: '#/responses/DefaultError'
      summary: Moves a resource into a different compartment.
      tags:
      - streamAdmin
      x-related-resource: '#/definitions/ConnectHarness'
  /streamingConsumption: {}
  /streampools:
    get:
      description: List the stream pools for a given compartment ID.
      operationId: ListStreamPools
      parameters:
      - $ref: '#/parameters/CompartmentIdQueryParam'
      - $ref: '#/parameters/FilterByIdQueryParam'
      - $ref: '#/parameters/FilterByNameQueryParam'
      - $ref: '#/parameters/PaginationLimitQueryParam'
      - $ref: '#/parameters/PaginationTokenQueryParam'
      - $ref: '#/parameters/SortByQueryParam'
      - $ref: '#/parameters/SortOrderQueryParam'
      - description: 'A filter to only return resources that match the given lifecycle
          state. The state value is case-insensitive.

          '
        in: query
        name: lifecycleState
        required: false
        type: string
        x-obmcs-enumref: '#/definitions/StreamPoolSummary/lifecycleState'
      - $ref: '#/parameters/OpcRequestIdHeaderParam'
      responses:
        200:
          description: A list containing the stream pools for the compartment.
          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).
              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
          schema:
            items:
              $ref: '#/definitions/StreamPoolSummary'
            type: array
        400:
          $ref: '#/responses/400'
        401:
          $ref: '#/responses/401'
        404:
          $ref: '#/responses/404'
        429:
          $ref: '#/responses/429'
        500:
          $ref: '#/responses/500'
        default:
          $ref: '#/responses/DefaultError'
      summary: List the stream pools for a given compartment ID.
      tags:
      - streamAdmin
      x-example: 'GET /20180418/streampools?compartmentId=<var>&lt;compartmentId&gt;</var>

        Host: streaming.us-phoenix-1.oraclecloud.com

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

        '
    post:
      description: 'Starts the provisioning of a new stream pool.

        To track the progress of the provisioning, you can periodically call GetStreamPool.

        In the response, the `lifecycleState` parameter of the object tells you its
        current state.

        '
      operationId: CreateStreamPool
      parameters:
      - description: The stream pool to create.
        in: body
        name: CreateStreamPoolDetails
        required: true
        schema:
          $ref: '#/definitions/CreateStreamPoolDetails'
      - $ref: '#/parameters/OpcRequestIdHeaderParam'
      - $ref: '#/parameters/OpcRetryTokenHeaderParam'
      responses:
        200:
          description: Created
          headers:
            etag:
              description: For optimistic concurrency control. See `if-match`.
              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
          schema:
            $ref: '#/definitions/StreamPool'
        400:
          $ref: '#/responses/400'
        401:
          $ref: '#/responses/401'
        409:
          $ref: '#/responses/409'
        429:
          $ref: '#/responses/429'
        500:
          $ref: '#/responses/500'
        default:
          $ref: '#/responses/DefaultError'
      summary: Creates a stream pool.
      tags:
      - streamAdmin
      x-example: "POST /20180418/streampools\nHost: streaming.us-phoenix-1.oraclecloud.com\n\
        <var>&lt;authorization and other headers&gt;</var>\n{\n  \"compartmentId\"\
        : \"ocid1.tenancy.oc1..exampleasgadvsw7l6cvb4fhssurjqs4irbkzma3wc2fauxv4novazj5guta\"\
        ,\n  \"name\": \"MyStreamPool\"\n}\n"
  /streampools/{streamPoolId}:
    delete:
      description: 'Deletes a stream pool. All containing streams will also be deleted.

        The default stream pool of a compartment cannot be deleted.

        '
      operationId: DeleteStreamPool
      parameters:
      - $ref: '#/parameters/StreamPoolIdPathParam'
      - $ref: '#/parameters/OpcRequestIdHeaderParam'
      - $ref: '#/parameters/OpcIfMatchHeaderParam'
      responses:
        204:
          description: The stream pool is being deleted.
          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.

                '
              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
        401:
          $ref: '#/responses/401'
        404:
          $ref: '#/responses/404'
        412:
          $ref: '#/responses/412'
        429:
          $ref: '#/responses/429'
        500:
          $ref: '#/responses/500'
        default:
          $ref: '#/responses/DefaultError'
      summary: Deletes a stream pool.
      tags:
      - streamAdmin
      x-example: 'DELETE /20180418/streampools/<var>&lt;streamPoolId&gt;</var>

        Host: streaming.us-phoenix-1.oraclecloud.com

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

        '
      x-related-resource: '#/definitions/StreamPool'
    get:
      description: Gets detailed information about the stream pool, such as Kafka
        settings.
      operationId: GetStreamPool
      parameters:
      - $ref: '#/parameters/StreamPoolIdPathParam'
      - $ref: '#/parameters/OpcRequestIdHeaderParam'
      responses:
        200:
          description: Success
          headers:
            etag:
              description: For optimistic concurrency control. See `if-match`.
              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
          schema:
            $ref: '#/definitions/StreamPool'
        400:
          $ref: '#/responses/400'
        401:
          $ref: '#/responses/401'
        404:
          $ref: '#/responses/404'
        429:
          $ref: '#/responses/429'
        500:
          $ref: '#/responses/500'
        default:
          $ref: '#/responses/DefaultError'
      summary: Gets the stream pool
      tags:
      - streamAdmin
      x-example: 'GET /20180418/streampools/<var>&lt;streamPoolId&gt;</var>

        Host: streaming.us-phoenix-1.oraclecloud.com

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

        '
    put:
      description: 'Updates the specified stream pool.

        '
      operationId: UpdateStreamPool
      parameters:
      - $ref: '#/parameters/StreamPoolIdPathParam'
      - description: The pool is updated with the provided fields.
        in: body
        name: UpdateStreamPoolDetails
        required: true
        schema:
          $ref: '#/definitions/UpdateStreamPoolDetails'
      - $ref: '#/parameters/OpcRequestIdHeaderParam'
      - $ref: '#/parameters/OpcIfMatchHeaderParam'
      responses:
        200:
          description: Updated
          headers:
            etag:
              description: For optimistic concurrency control. See `if-match`.
              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
          schema:
            $ref: '#/definitions/StreamPool'
        400:
          $ref: '#/responses/400'
        401:
          $ref: '#/responses/401'
        404:
          $ref: '#/responses/404'
        412:
          $ref: '#/responses/412'
        429:
          $ref: '#/responses/429'
        500:
          $ref: '#/responses/500'
        default:
          $ref: '#/responses/DefaultError'
      summary: Updates the stream pool.
      tags:
      - streamAdmin
      x-example: "PUT /20180418/streampools/<var>&lt;streamPoolId&gt;</var>\nHost:\
        \ streaming.us-phoenix-1.oraclecloud.com\n<var>&lt;authorization and other\
        \ headers&gt;</var>\n{\n  \"kafkaSettings\": {\n    \"autoCreateTopicsEnable\"\
        : true,\n    \"logRetentionHours\": 24,\n    \"numPartitions\": 1\n  }\n}\n"
  /streampools/{streamPoolId}/actions/changeCompartment:
    post:
      description: Moves a resource into a different compartment. When provided, If-Match
        is checked against ETag values of the resource.
      operationId: ChangeStreamPoolCompartment
      parameters:
      - $ref: '#/parameters/StreamPoolIdPathParam'
      - $ref: '#/parameters/OpcIfMatchHeaderParam'
      - $ref: '#/parameters/OpcRequestIdHeaderParam'
      - description: The stream pool will be moved into the compartment specified
          within this entity.
        in: body
        name: ChangeStreamPoolCompartmentDetails
        required: true
        schema:
          $ref: '#/definitions/ChangeStreamPoolCompartmentDetails'
      responses:
        204:
          description: The compartment has been changed.
          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.

                '
              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
        400:
          $ref: '#/responses/400'
        401:
          $ref: '#/responses/401'
        404:
          $ref: '#/responses/404'
        409:
          $ref: '#/responses/409'
        412:
          $ref: '#/responses/412'
        500:
          $ref: '#/responses/500'
        default:
          $ref: '#/responses/DefaultError'
      summary: Moves a resource into a different compartment.
      tags:
      - streamAdmin
      x-related-resource: '#/definitions/StreamPool'
  /streams:
    get:
      description: 'Lists the streams in the given compartment id.

        If the compartment id is specified, it will list streams in the compartment,
        regardless of their stream pool.

        If the stream pool id is specified, the action will be scoped to that stream
        pool.

        The compartment id and stream pool id cannot be specified at the same time.

        '
      operationId: ListStreams
      parameters:
      - $ref: '#/parameters/CompartmentIdQueryOptionalParam'
      - $ref: '#/parameters/StreamPoolIdQueryParam'
      - $ref: '#/parameters/FilterByIdQueryParam'
      - $ref: '#/parameters/FilterByNameQueryParam'
      - $ref: '#/parameters/PaginationLimitQueryParam'
      - $ref: '#/parameters/PaginationTokenQueryParam'
      - $ref: '#/parameters/SortByQueryParam'
      - $ref: '#/parameters/SortOrderQueryParam'
      - description: 'A filter to only return resources that match the given lifecycle
          state. The state value is case-insensitive.

          '
        in: query
        name: lifecycleState
        required: false
        type: string
        x-obmcs-enumref: '#/definitions/Stream/lifecycleState'
      - $ref: '#/parameters/OpcRequestIdHeaderParam'
      responses:
        200:
          description: The list of streams.
          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).
              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
          schema:
            items:
              $ref: '#/definitions/StreamSummary'
            type: array
        400:
          $ref: '#/responses/400'
        401:
          $ref: '#/responses/401'
        429:
          $ref: '#/responses/429'
        500:
          $ref: '#/responses/500'
        default:
          $ref: '#/responses/DefaultError'
      summary: Lists the streams in the given compartment id.
      tags:
      - streamAdmin
      x-example: 'GET /20180418/streams?compartmentId=<var>&lt;compartmentId&gt;</var>&limit=10&page=1

        Host: streaming.us-phoenix-1.oraclecloud.com

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

        '
    post:
      description: 'Starts the provisioning of a new stream.

        The stream will be created in the given compartment id or stream pool id,
        depending on which parameter is specified.

        Compartment id and stream pool id cannot be specified at the same time.

        To track the progress of the provisioning, you can periodically call [GetStream](#/en/streaming/20180418/Stream/GetStream).

        In the response, the `lifecycleState` parameter of the [Stream](#/en/streaming/20180418/Stream/)
        object tells you its current state.

        '
      operationId: CreateStream
      parameters:
      - description: The stream to create.
        in: body
        name: CreateStreamDetails
        required: true
        schema:
          $ref: '#/definitions/CreateStreamDetails'
      - $ref: '#/parameters/OpcRequestIdHeaderParam'
      responses:
        200:
          description: Created
          headers:
            etag:
              description: For optimistic concurrency control. See `if-match`.
              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
          schema:
            $ref: '#/definitions/Stream'
        400:
          $ref: '#/responses/400'
        401:
          $ref: '#/responses/401'
        409:
          description: A stream with an identical name already exists.
          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.

                '
              type: string
          schema:
            $ref: '#/definitions/Error'
        429:
          $ref: '#/responses/429'
        500:
          $ref: '#/responses/500'
        default:
          $ref: '#/responses/DefaultError'
      summary: Creates a stream.
      tags:
      - streamAdmin
      x-example: "POST /20180418/streams\nHost: streaming.us-phoenix-1.oraclecloud.com\n\
        <var>&lt;authorization and other headers&gt;</var>\n{\n  \"compartmentId\"\
        : \"ocid1.tenancy.oc1..exampleasgadvsw7l6cvb4fhssurjqs4irbkzma3wc2fauxv4novazj5guta\"\
        ,\n  \"name\": \"mynewstream\",\n  \"partitions\": \"4\"\n}\n"
  /streams/{streamId}:
    delete:
      description: 'Deletes a stream and its content. Stream contents are deleted
        immediately. The service retains records of the stream itself for 90 days
        after deletion.

        The `lifecycleState` parameter of the `Stream` object changes to `DELETING`
        and the stream becomes inaccessible for read or write operations.

        To verify that a stream has been deleted, make a [GetStream](#/en/streaming/20180418/Stream/GetStream)
        request. If the call returns the stream''s

        lifecycle state as `DELETED`, then the stream has been deleted. If the call
        returns a "404 Not Found" error, that means all records of the

        stream have been deleted.

        '
      operationId: DeleteStream
      parameters:
      - $ref: '#/parameters/StreamIdPathParam'
      - $ref: '#/parameters/OpcRequestIdHeaderParam'
      - $ref: '#/parameters/OpcIfMatchHeaderParam'
      responses:
        204:
          description: The stream is being deleted.
          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.

                '
              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
        401:
          $ref: '#/responses/401'
        404:
          $ref: '#/responses/404'
        412:
          $ref: '#/responses/412'
        429:
          $ref: '#/responses/429'
        500:
          $ref: '#/responses/500'
        default:
          $ref: '#/responses/DefaultError'
      summary: Deletes a stream.
      tags:
      - streamAdmin
      x-example: 'DELETE /20180418/streams/<var>&lt;streamId&gt;</var>

        Host: streaming.us-phoenix-1.oraclecloud.com

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

        '
      x-related-resource: '#/definitions/Stream'
    get:
      description: Gets detailed information about a stream, including the number
        of partitions.
      operationId: GetStream
      parameters:
      - $ref: '#/parameters/StreamIdPathParam'
      - $ref: '#/parameters/OpcRequestIdHeaderParam'
      responses:
        200:
          description: Success
          headers:
            etag:
              description: For optimistic concurrency control. See `if-match`.
              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
          schema:
            $ref: '#/definitions/Stream'
        401:
          $ref: '#/responses/401'
        404:
          $ref: '#/responses/404'
        429:
          $ref: '#/responses/429'
        500:
          $ref: '#/responses/500'
        default:
          $ref: '#/responses/DefaultError'
      summary: Gets a stream
      tags:
      - streamAdmin
      x-example: 'GET /20180418/streams/<var>&lt;streamId&gt;</var>

        Host: streaming.us-phoenix-1.oraclecloud.com

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

        '
    put:
      description: 'Updates the stream. Only specified values will be updated.

        '
      operationId: UpdateStream
      parameters:
      - $ref: '#/parameters/StreamIdPathParam'
      - description: The stream is updated with the values provided.
        in: body
        name: UpdateStreamDetails
        required: true
        schema:
          $ref: '#/definitions/UpdateStreamDetails'
      - $ref: '#/parameters/OpcRequestIdHeaderParam'
      - $ref: '#/parameters/OpcIfMatchHeaderParam'
      responses:
        200:
          description: Updated
          headers:
            etag:
              description: For optimistic concurrency control. See `if-match`.
              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
          schema:
            $ref: '#/definitions/Stream'
        400:
          $ref: '#/responses/400'
        401:
          $ref: '#/responses/401'
        404:
          $ref: '#/responses/404'
        412:
          $ref: '#/responses/412'
        429:
          $ref: '#/responses/429'
        500:
          $ref: '#/responses/500'
        default:
          $ref: '#/responses/DefaultError'
      summary: Updates a stream.
      tags:
      - streamAdmin
      x-example: "PUT /20180418/streams/<var>&lt;streamId&gt;</var>\nHost: streaming.us-phoenix-1.oraclecloud.com\n\
        <var>&lt;authorization and other headers&gt;</var>\n{\n  \"definedTags\":\
        \ {\n    \"Operations\": {\n      \"CostCenter\": \"42\"\n    }\n  },\n  \"\
        freeformTags\": {\n    \"Department\": \"Finance\"\n  },\n  \"streamPoolId\"\
        : \"ocid1.streampool.realm.region.zxcvbn432765\"\n}\n"
  /streams/{streamId}/actions/changeCompartment:
    post:
      description: 'Moves a resource into a different compartment.

        When provided, If-Match is checked against ETag values of the resource.

        The stream will also be moved into the default stream pool in the destination
        compartment.

        '
      operationId: ChangeStreamCompartment
      parameters:
      - $ref: '#/parameters/StreamIdPathParam'
      - $ref: '#/parameters/OpcIfMatchHeaderParam'
      - $ref: '#/parameters/OpcRequestIdHeaderParam'
      - description: The stream will be moved into the compartment specified within
          this entity.
        in: body
        name: ChangeStreamCompartmentDetails
        required: true
        schema:
          $ref: '#/definitions/ChangeStreamCompartmentDetails'
      responses:
        204:
          description: Stream's compartment has been changed.
          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.

                '
              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
        401:
          $ref: '#/responses/401'
        404:
          $ref: '#/responses/404'
        412:
          $ref: '#/responses/412'
        409:
          $ref: '#/responses/409'
        500:
          $ref: '#/responses/500'
        default:
          $ref: '#/responses/DefaultError'
      summary: Moves a resource into a different compartment.
      tags:
      - streamAdmin
      x-related-resource: '#/definitions/Stream'
  /streams/{streamId}/commit:
    post:
      description: 'Provides a mechanism to manually commit offsets, if not using
        commit-on-get consumer semantics.

        This commits offsets assicated with the provided cursor, extends the timeout
        on each of the affected partitions, and returns an updated cursor.

        '
      operationId: ConsumerCommit
      parameters:
      - $ref: '#/parameters/StreamIdPathParam'
      - $ref: '#/parameters/GroupCursorQueryParam'
      - $ref: '#/parameters/OpcRequestIdHeaderParam'
      responses:
        200:
          description: Offsets were committeed successfully.
          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.

                '
              type: string
          schema:
            $ref: '#/definitions/Cursor'
        400:
          $ref: '#/responses/400'
        401:
          $ref: '#/responses/401'
        404:
          $ref: '#/responses/404'
        429:
          $ref: '#/responses/429'
        500:
          $ref: '#/responses/500'
        default:
          $ref: '#/responses/DefaultError'
      summary: Commits processed offsets to consumer group state.
      tags:
      - stream
      x-related-resource: '#/definitions/Group'
  /streams/{streamId}/cursors:
    post:
      description: 'Creates a cursor. Cursors are used to consume a stream, starting
        from a specific point in the partition and going forward from there.

        You can create a cursor based on an offset, a time, the trim horizon, or the
        most recent message in the stream. As the oldest message

        inside the retention period boundary, using the trim horizon effectively lets
        you consume all messages in the stream. A cursor based

        on the most recent message allows consumption of only messages that are added
        to the stream after you create the cursor. Cursors expire

        five minutes after you receive them from the service.

        '
      operationId: CreateCursor
      parameters:
      - $ref: '#/parameters/StreamIdPathParam'
      - description: The information used to create the cursor.
        in: body
        name: CreateCursorDetails
        required: true
        schema:
          $ref: '#/definitions/CreateCursorDetails'
      - $ref: '#/parameters/OpcRequestIdHeaderParam'
      responses:
        200:
          description: Created
          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.

                '
              type: string
          schema:
            $ref: '#/definitions/Cursor'
        400:
          $ref: '#/responses/400'
        401:
          $ref: '#/responses/401'
        429:
          $ref: '#/responses/429'
        500:
          $ref: '#/responses/500'
        default:
          $ref: '#/responses/DefaultError'
      summary: Creates a cursor for the specified stream. A cursor is used to consume
        a stream.
      tags:
      - stream
      x-example: "POST /20180418/streams/<var>&lt;streamId&gt;</var>/cursors\nHost:\
        \ streaming-api.us-phoenix-1.oraclecloud.com\n<var>&lt;authorization and other\
        \ headers&gt;</var>\n{\n  \"partition\": \"0\",\n  \"type\": \"TRIM_HORIZON\"\
        \  # Cursor will point to the oldest message in the partition that is within\
        \ the retention period window.\n}\nOR\n{\n  \"partition\": \"0\",\n  \"type\"\
        : \"LATEST\",  # Cursor will point to the most recent message in the partition\
        \ that was added after the cursor was created\n}\nOR\n{\n  \"partition\":\
        \ \"0\",\n  \"type\": \"AT_OFFSET\", # Cursor will point to the offset specified\
        \ in the offset parameter\n  \"offset\": 342334L\n}\nOR\n{\n  \"partition\"\
        : \"0\",\n  \"type\": \"AFTER_OFFSET\", # Cursor will point to the position\
        \ immediately following the offset specified in the offset parameter\n  \"\
        offset\": 34233434L\n}\nOR\n{\n  \"partition\": \"0\",\n  \"type\": \"AT_TIME\"\
        , # Cursor will point to the specific point in time\n  \"time\": \"Fri Feb\
        \ 21 15:36:49 UTC 2042\"\n}\n"
  /streams/{streamId}/groupCursors:
    post:
      description: 'Creates a group-cursor.

        '
      operationId: CreateGroupCursor
      parameters:
      - $ref: '#/parameters/StreamIdPathParam'
      - description: The information used to create the cursor.
        in: body
        name: CreateGroupCursorDetails
        required: true
        schema:
          $ref: '#/definitions/CreateGroupCursorDetails'
      - $ref: '#/parameters/OpcRequestIdHeaderParam'
      responses:
        200:
          description: Created
          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.

                '
              type: string
          schema:
            $ref: '#/definitions/Cursor'
        400:
          $ref: '#/responses/400'
        401:
          $ref: '#/responses/401'
        404:
          $ref: '#/responses/404'
        429:
          $ref: '#/responses/429'
        500:
          $ref: '#/responses/500'
        default:
          $ref: '#/responses/DefaultError'
      summary: Creates a group-cursor for the specified stream. A cursor is used to
        consume a stream.
      tags:
      - stream
      x-related-resource: '#/definitions/Cursor'
  /streams/{streamId}/groups/{groupName}:
    get:
      description: 'Returns the current state of a consumer group.

        '
      operationId: GetGroup
      parameters:
      - $ref: '#/parameters/StreamIdPathParam'
      - description: The name of the consumer group.
        in: path
        maxLength: 255
        minLength: 1
        name: groupName
        required: true
        type: string
      - $ref: '#/parameters/OpcRequestIdHeaderParam'
      responses:
        200:
          description: Group State
          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.

                '
              type: string
          schema:
            $ref: '#/definitions/Group'
        400:
          $ref: '#/responses/400'
        401:
          $ref: '#/responses/401'
        404:
          $ref: '#/responses/404'
        429:
          $ref: '#/responses/429'
        500:
          $ref: '#/responses/500'
        default:
          $ref: '#/responses/DefaultError'
      summary: Returns the current state of a consumer group.
      tags:
      - stream
      x-example: "GET /20180418/<var>&lt;streamId&gt;</var>/groups/<var>&lt;groupName&gt;</var>\n\
        Host: streaming.us-phoenix-1.oraclecloud.com\n<var>&lt;authorization and other\
        \ headers&gt;</var>\n\nHTTP/1.1 200 OK\nContent-Length: 276\nContent-Type:\
        \ application/json\nDate: Mon, 09 Jul 2018 21:19:03 GMT\nopc-request-id: /A8E351184AEE4F026738B89AD2058120/B484F7819E9FE5A487EA3091D2E4G5A9\n\
        {\n    \"group\": {\n        \"groupName\": \"group1\",\n        \"reservations\"\
        : [\n            {\n                \"committedOffset\": 20,\n           \
        \     \"partition\": \"0\",\n                \"reservedInstance\": \"51464135-9edd-4857-909c-fbfbf1c2ca8e\"\
        ,\n                \"timeReservedUntil\": \"2018-07-09T21:17:44.554Z\"\n \
        \           }, {\n                \"committedOffset\": 32,\n             \
        \   \"partition\": \"1\",\n                \"reservedInstance\": \"51464135-9edd-4857-909c-fbfbfabcdefg\"\
        ,\n                \"timeReservedUntil\": \"2018-07-09T21:17:44.554Z\"\n \
        \           }, {\n                \"committedOffset\": 103,\n            \
        \    \"partition\": \"2\",\n                \"reservedInstance\": \"51464135-9edd-4857-909c-fbfbf1c2ca8e\"\
        ,\n                \"timeReservedUntil\": \"2018-07-09T21:17:44.554Z\"\n \
        \           }\n        ],\n        \"streamId\": \"ocid1.stream.desktop..aaaaaaaaiegcfiu3pprvc3p4uase4pvaazbspmxfq6ztzu72skwlabcdefga\"\
        \n    }\n}\n"
    put:
      description: 'Forcefully changes the current location of a group as a whole;
        reseting processing location of all consumers to a particular location in
        the stream.

        '
      operationId: UpdateGroup
      parameters:
      - $ref: '#/parameters/StreamIdPathParam'
      - description: The name of the consumer group.
        in: path
        maxLength: 255
        minLength: 1
        name: groupName
        required: true
        type: string
      - description: The information used to modify the group.
        in: body
        name: UpdateGroupDetails
        required: true
        schema:
          $ref: '#/definitions/UpdateGroupDetails'
      - $ref: '#/parameters/OpcRequestIdHeaderParam'
      responses:
        200:
          description: Group details updated.
          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.

                '
              type: string
        400:
          $ref: '#/responses/400'
        401:
          $ref: '#/responses/401'
        429:
          $ref: '#/responses/429'
        500:
          $ref: '#/responses/500'
        default:
          $ref: '#/responses/DefaultError'
      summary: Forcefully changes the committed location of a group on a stream.
      tags:
      - stream
      x-related-resource: '#/definitions/Group'
  /streams/{streamId}/heartbeat:
    post:
      description: 'Allows long-running processes to extend the timeout on partitions
        reserved by a consumer instance.

        '
      operationId: ConsumerHeartbeat
      parameters:
      - $ref: '#/parameters/StreamIdPathParam'
      - $ref: '#/parameters/GroupCursorQueryParam'
      - $ref: '#/parameters/OpcRequestIdHeaderParam'
      responses:
        200:
          description: Success
          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.

                '
              type: string
          schema:
            $ref: '#/definitions/Cursor'
        400:
          $ref: '#/responses/400'
        401:
          $ref: '#/responses/401'
        404:
          $ref: '#/responses/404'
        429:
          $ref: '#/responses/429'
        500:
          $ref: '#/responses/500'
        default:
          $ref: '#/responses/DefaultError'
      summary: Extends the reservation timeout on partitions reserved by the provided
        cursor.
      tags:
      - stream
      x-related-resource: '#/definitions/Group'
  /streams/{streamId}/messages:
    get:
      description: 'Returns messages from the specified stream using the specified
        cursor as the starting point for consumption. By default, the number of messages
        returned is undefined, but the service returns as many as possible.

        To get messages, you must first obtain a cursor using the [CreateCursor](#/en/streaming/20180418/Cursor/CreateCursor)
        operation.

        In the response, retrieve the value of the ''opc-next-cursor'' header to pass
        as a parameter to get the next batch of messages in the stream.

        '
      operationId: GetMessages
      parameters:
      - $ref: '#/parameters/StreamIdPathParam'
      - description: 'The cursor used to consume the stream.

          '
        in: query
        name: cursor
        required: true
        type: string
      - description: 'The maximum number of messages to return. You can specify any
          value up to 10000. By default, the service returns as many messages as possible.

          Consider your average message size to help avoid exceeding throughput on
          the stream.

          '
        in: query
        maximum: 10000
        minimum: 1
        name: limit
        required: false
        type: integer
        x-default-description: By default, the service will return as much as possible
          within the preset limit for total bytes transferred per call.
      - $ref: '#/parameters/OpcRequestIdHeaderParam'
      responses:
        200:
          description: Success
          headers:
            opc-next-cursor:
              description: The cursor to use to get the next batch of messages.
              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
          schema:
            items:
              $ref: '#/definitions/Message'
            type: array
        400:
          $ref: '#/responses/400'
        401:
          $ref: '#/responses/401'
        404:
          $ref: '#/responses/404'
        429:
          $ref: '#/responses/429'
        500:
          $ref: '#/responses/500'
        default:
          $ref: '#/responses/DefaultError'
      summary: Gets messages from a stream.
      tags:
      - stream
      x-example: 'GET /20180418/streams/<var>&lt;streamId&gt;</var>/messages?cursor=<var>&lt;cursor&gt;</var>&limit=100

        Host: streaming.us-phoenix-1.oraclecloud.com

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

        '
    post:
      description: 'Emits messages to a stream. There''s no limit to the number of
        messages in a request, but the total size of a message or request must be
        1 MiB or less.

        The service calculates the partition ID from the message key and stores messages
        that share a key on the same partition.

        If a message does not contain a key or if the key is null, the service generates
        a message key for you.

        The partition ID cannot be passed as a parameter.

        '
      operationId: PutMessages
      parameters:
      - $ref: '#/parameters/StreamIdPathParam'
      - description: Array of messages to put into the stream.
        in: body
        name: PutMessagesDetails
        required: true
        schema:
          $ref: '#/definitions/PutMessagesDetails'
      - $ref: '#/parameters/OpcRequestIdHeaderParam'
      responses:
        200:
          description: Success
          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.

                '
              type: string
          schema:
            $ref: '#/definitions/PutMessagesResult'
        400:
          $ref: '#/responses/400'
        401:
          $ref: '#/responses/401'
        404:
          $ref: '#/responses/404'
        429:
          $ref: '#/responses/429'
        500:
          $ref: '#/responses/500'
        default:
          $ref: '#/responses/DefaultError'
      summary: Puts messages in a stream.
      tags:
      - stream
      x-example: "POST /20180418/streams/<var>&lt;streamId&gt;</var>/messages\nHost:\
        \ streaming-api.us-phoenix-1.oraclecloud.com\n<var>&lt;authorization and other\
        \ headers&gt;</var>\n{\n  \"messages\":\n  {\n    {\n      \"key\": null,\n\
        \      \"value\": \"VGhlIHF1aWNrIGJyb3duIGZveCBqdW1wZWQgb3ZlciB0aGUgbGF6eSBkb2cu\"\
        \n    },\n    {\n      \"key\": null,\n      \"value\": \"UGFjayBteSBib3ggd2l0aCBmaXZlIGRvemVuIGxpcXVvciBqdWdzLg==\"\
        \n    }\n  }\n}\n"
      x-obmcs-signing-strategy: exclude_body
      x-related-resource: '#/definitions/Message'
  /workRequests:
    get:
      description: 'Lists the work requests in a compartment.

        '
      operationId: ListWorkRequests
      parameters:
      - $ref: '#/parameters/WorkRequestIdQueryOptionalParam'
      - $ref: '#/parameters/CompartmentIdQueryOptionalParam'
      - $ref: '#/parameters/PaginationTokenQueryParam'
      - $ref: '#/parameters/PaginationLimitQueryParam'
      - $ref: '#/parameters/SortOrderQueryParam'
      - $ref: '#/parameters/WorkRequestSortByQueryParam'
      - $ref: '#/parameters/ResourceIdentifierQueryParam'
      - $ref: '#/parameters/OpcRequestIdHeaderParam'
      responses:
        200:
          description: The list of work requests 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).
              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
          schema:
            $ref: '#/definitions/WorkRequestSummaryCollection'
        400:
          $ref: '#/responses/400'
        401:
          $ref: '#/responses/401'
        404:
          $ref: '#/responses/404'
        429:
          $ref: '#/responses/429'
        500:
          $ref: '#/responses/500'
        default:
          $ref: '#/responses/DefaultError'
      summary: List Work Requests
      tags:
      - streamAdmin
      x-obmcs-client-retries-enabled: true
  /workRequests/{workRequestId}:
    get:
      description: Gets the details of a work request.
      operationId: GetWorkRequest
      parameters:
      - $ref: '#/parameters/WorkRequestIdPathParam'
      - $ref: '#/parameters/OpcRequestIdHeaderParam'
      responses:
        200:
          description: The work request 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.

                '
              type: string
          schema:
            $ref: '#/definitions/WorkRequest'
        400:
          $ref: '#/responses/400'
        401:
          $ref: '#/responses/401'
        404:
          $ref: '#/responses/404'
        429:
          $ref: '#/responses/429'
        500:
          $ref: '#/responses/500'
        default:
          $ref: '#/responses/DefaultError'
      summary: GET Work Request Status
      tags:
      - streamAdmin
      x-obmcs-client-retries-enabled: true
  /workRequests/{workRequestId}/errors:
    get:
      description: 'Lists the errors for a work request.

        '
      operationId: ListWorkRequestErrors
      parameters:
      - $ref: '#/parameters/WorkRequestIdPathParam'
      - $ref: '#/parameters/PaginationTokenQueryParam'
      - $ref: '#/parameters/PaginationLimitQueryParam'
      - $ref: '#/parameters/SortOrderQueryParam'
      - $ref: '#/parameters/WorkRequestSortByQueryParam'
      - $ref: '#/parameters/OpcRequestIdHeaderParam'
      responses:
        200:
          description: The list of work request errors 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).
              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
          schema:
            $ref: '#/definitions/WorkRequestErrorCollection'
        400:
          $ref: '#/responses/400'
        401:
          $ref: '#/responses/401'
        404:
          $ref: '#/responses/404'
        429:
          $ref: '#/responses/429'
        500:
          $ref: '#/responses/500'
        default:
          $ref: '#/responses/DefaultError'
      summary: Lists work request errors
      tags:
      - streamAdmin
      x-obmcs-client-retries-enabled: true
  /workRequests/{workRequestId}/logs:
    get:
      description: 'Lists the logs for a work request.

        '
      operationId: ListWorkRequestLogs
      parameters:
      - $ref: '#/parameters/WorkRequestIdPathParam'
      - $ref: '#/parameters/PaginationTokenQueryParam'
      - $ref: '#/parameters/PaginationLimitQueryParam'
      - $ref: '#/parameters/SortOrderQueryParam'
      - $ref: '#/parameters/WorkRequestSortByQueryParam'
      - $ref: '#/parameters/OpcRequestIdHeaderParam'
      responses:
        200:
          description: The list of work request logs.
          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).
              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
          schema:
            $ref: '#/definitions/WorkRequestLogEntryCollection'
        400:
          $ref: '#/responses/400'
        401:
          $ref: '#/responses/401'
        404:
          $ref: '#/responses/404'
        429:
          $ref: '#/responses/429'
        500:
          $ref: '#/responses/500'
        default:
          $ref: '#/responses/DefaultError'
      summary: Lists work request logs
      tags:
      - streamAdmin
      x-obmcs-client-retries-enabled: true
      x-related-resource: '#/definitions/WorkRequestLogEntry'
produces:
- application/json
responses:
  400:
    description: Bad Request
    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.

          '
        type: string
    schema:
      $ref: '#/definitions/Error'
  401:
    description: Unauthorized
    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.

          '
        type: string
    schema:
      $ref: '#/definitions/Error'
  404:
    description: Not Found
    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.

          '
        type: string
    schema:
      $ref: '#/definitions/Error'
  409:
    description: Conflict
    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.

          '
        type: string
    schema:
      $ref: '#/definitions/Error'
  412:
    description: NoEtagMatch
    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.

          '
        type: string
    schema:
      $ref: '#/definitions/Error'
  429:
    description: Too Many Requests
    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.

          '
        type: string
      retry-after:
        description: 'A retry-after header might be included to this response indicating
          how long to wait before making a new request. A non-negative decimal integer
          indicating the seconds to delay after the response is received.

          '
        type: string
    schema:
      $ref: '#/definitions/Error'
  500:
    description: Internal Server 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.

          '
        type: string
    schema:
      $ref: '#/definitions/Error'
  DefaultError:
    description: An error has occurred
    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.

          '
        type: string
    schema:
      $ref: '#/definitions/Error'
schemes:
- https
swagger: '2.0'
x-oracle-package: com.oracle.pic.oss.api
