Package com.oracle.bmc.streaming

Class StreamClient

    • Field Detail

      • SERVICE

        public static final Service SERVICE
        Service instance for Stream.

      • clientCommonLibraryVersion

        public final String clientCommonLibraryVersion
        Compatible SDK version, provided by the codegen.

      • minimumClientCommonLibraryVersionFromClient

        public final Optional<String> minimumClientCommonLibraryVersionFromClient
        Minimum compatible SDK version, maybe provided by the codegen.

    • Method Detail

      • builder

        public static StreamClientBuilder builder()
        Create a builder for this client.
        Returns:
        builder

      • consumerCommit

        public ConsumerCommitResponse consumerCommit​(ConsumerCommitRequest request)
        Description copied from interface: Stream
        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.

        Specified by:
        consumerCommit in interface Stream
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation

      • consumerHeartbeat

        public ConsumerHeartbeatResponse consumerHeartbeat​(ConsumerHeartbeatRequest request)
        Description copied from interface: Stream
        Allows long-running processes to extend the timeout on partitions reserved by a consumer instance.
        Specified by:
        consumerHeartbeat in interface Stream
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation

      • createCursor

        public CreateCursorResponse createCursor​(CreateCursorRequest request)
        Description copied from interface: Stream
        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.

        Specified by:
        createCursor in interface Stream
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation

      • getGroup

        public GetGroupResponse getGroup​(GetGroupRequest request)
        Description copied from interface: Stream
        Returns the current state of a consumer group.
        Specified by:
        getGroup in interface Stream
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation

      • getMessages

        public GetMessagesResponse getMessages​(GetMessagesRequest request)
        Description copied from interface: Stream
        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.

        Specified by:
        getMessages in interface Stream
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation

      • putMessages

        public PutMessagesResponse putMessages​(PutMessagesRequest request)
        Description copied from interface: Stream
        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.

        Specified by:
        putMessages in interface Stream
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation

      • updateGroup

        public UpdateGroupResponse updateGroup​(UpdateGroupRequest request)
        Description copied from interface: Stream
        Forcefully changes the current location of a group as a whole; reseting processing location of all consumers to a particular location in the stream.
        Specified by:
        updateGroup in interface Stream
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation

      • enableDualStackEndpoints

        public void enableDualStackEndpoints​(boolean enableDualStackEndpoints)
        This method should be used to enable or disable the use of dual-stack endpoints.

        The default value is false i.e. dual-stack endpoints are disabled by default.

        Parameters:
        enableDualStackEndpoints - This flag can be set to true or false to enable or disable the use of dual-stack endpoints respectively

      • getOptionsMap

        public Map<String,​Boolean> getOptionsMap()
        Return an immutable snapshot representing the current options set for this client.
        Returns:
        immutable snapshot representing the current options set for this client

      • getResolvedEndpoint

        public String getResolvedEndpoint​(Map<String,​Object> requiredParametersMap)
        Returns the endpoint after filling in the current options, as determined by BaseClient.getOptionsMap(), and then filling in the required parameters in requiredParametersMap into the placeholders in the endpoint.
        Parameters:
        requiredParametersMap - the map from required parameter name to their values
        Returns:
        resolved endpoint, with all options and placeholders filled in

      • useRealmSpecificEndpointTemplate

        public void useRealmSpecificEndpointTemplate​(boolean useOfRealmSpecificEndpointTemplateEnabled)
        This method should be used to enable or disable the use of realm-specific endpoint template.

        The default value is null. To enable the use of endpoint template defined for the realm in use, set the flag to true To disable the use of endpoint template defined for the realm in use, set the flag to false

        Parameters:
        useOfRealmSpecificEndpointTemplateEnabled - This flag can be set to true or false to enable or disable the use of realm-specific endpoint template respectively

      • setEndpoint

        public final void setEndpoint​(String endpoint)

      • getEndpoint

        public final String getEndpoint()
        Get the endpoint of the client.

        Note that the endpoint may be parameterized and contain placeholders and options. The region subdomain and realm domain will have been properly replaced already if the endpoint was selected using a Region.

        Examples of endpoints this may return:

        • Unparameterized endpoints 
                       https://identity.us-phoenix-1.oci.oraclecloud.com
             https://identity.us-ashburn-1.oci.oraclecloud.com
             https://test-namespace.objectstorage.us-ashburn-1.oci.customer-oci.com
        • Parameterized endpoints with placeholders 
                       https://{namespaceName+Dot}objectstorage.us-phoenix-1.oci.customer-oci.com
             https://{namespaceName+Dot}objectstorage.us-ashburn-1.oci.customer-oci.com
        • Parameterized endpoints with options 
                       https://{dualStack?ds.:}identity.us-phoenix-1.oci.oraclecloud.com
             https://{dualStack?ds.:}identity.us-ashburn-1.oci.oraclecloud.com
        • Parameterized endpoints with placeholders and options 
                       https://{namespaceName+Dot}{dualStack?ds.:}objectstorage.us-phoenix-1.oci.customer-oci.com
             https://{namespaceName+Dot}{dualStack?ds.:}objectstorage.us-ashburn-1.oci.customer-oci.com

        To get the actual endpoint for a parameterized request, you can use BaseClient.getResolvedEndpoint(Map) or ParameterizedEndpointUtil.getEndpointWithPopulatedServiceParameters(String, Map, Map).

        Returns:
        the endpoint being used by the client

      • refreshClient

        public final void refreshClient()
        Rebuild the backing HttpClient.

        This will call ClientConfigurators again, and can be used to e.g. refresh the SSL certificate.

      • setRegion

        protected void setRegion​(Region region)

      • setRegion

        protected void setRegion​(String regionId)

      • getClientCommonLibraryVersion

        public String getClientCommonLibraryVersion()

      • getMinimumClientCommonLibraryVersionFromClient

        public Optional<String> getMinimumClientCommonLibraryVersionFromClient()