Package com.oracle.bmc.streaming

Interface Stream

  • All Superinterfaces:
    AutoCloseable
    All Known Implementing Classes:
    StreamClient
    @Generated(value="OracleSDKGenerator",
           comments="API Version: 20180418")
public interface Stream
extends AutoCloseable
    Use the Streaming API to produce and consume messages, create streams and stream pools, and manage related items.

    For more information, see Streaming. This service client does not use circuit breakers by default if the user has not defined a circuit breaker configuration.

    • Method Detail

      • refreshClient

        void refreshClient()
        Rebuilds the client from scratch.

        Useful to refresh certificates.

      • setEndpoint

        void setEndpoint​(String endpoint)
        Sets the endpoint to call (ex, https://www.example.com).
        Parameters:
        endpoint - The endpoint of the service.

      • getEndpoint

        String getEndpoint()
        Gets the set endpoint for REST call (ex, https://www.example.com)

      • consumerCommit

        ConsumerCommitResponse consumerCommit​(ConsumerCommitRequest request)
        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.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/streaming/ConsumerCommitExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ConsumerCommit API.

      • consumerHeartbeat

        ConsumerHeartbeatResponse consumerHeartbeat​(ConsumerHeartbeatRequest request)
        Allows long-running processes to extend the timeout on partitions reserved by a consumer instance.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/streaming/ConsumerHeartbeatExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ConsumerHeartbeat API.

      • createCursor

        CreateCursorResponse createCursor​(CreateCursorRequest request)
        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.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/streaming/CreateCursorExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateCursor API.

      • createGroupCursor

        CreateGroupCursorResponse createGroupCursor​(CreateGroupCursorRequest request)
        Creates a group-cursor.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/streaming/CreateGroupCursorExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateGroupCursor API.

      • getGroup

        GetGroupResponse getGroup​(GetGroupRequest request)
        Returns the current state of a consumer group.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/streaming/GetGroupExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetGroup API.

      • getMessages

        GetMessagesResponse getMessages​(GetMessagesRequest request)
        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 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.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/streaming/GetMessagesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetMessages API.

      • putMessages

        PutMessagesResponse putMessages​(PutMessagesRequest request)
        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.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/streaming/PutMessagesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use PutMessages API.

      • updateGroup

        UpdateGroupResponse updateGroup​(UpdateGroupRequest request)
        Forcefully changes the current location of a group as a whole; reseting processing location of all consumers to a particular location in the stream.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/streaming/UpdateGroupExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateGroup API.