Package com.oracle.bmc.streaming

Interface StreamAdmin

  • All Superinterfaces:
    AutoCloseable
    All Known Implementing Classes:
    StreamAdminClient
    @Generated(value="OracleSDKGenerator",
           comments="API Version: 20180418")
public interface StreamAdmin
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 uses CircuitBreakerUtils.DEFAULT_CIRCUIT_BREAKER for all the operations by default if no circuit breaker configuration is defined by the user.

    • 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)

      • setRegion

        void setRegion​(Region region)
        Sets the region to call (ex, Region.US_PHOENIX_1).

        Note, this will call setEndpoint after resolving the endpoint. If the service is not available in this Region, however, an IllegalArgumentException will be raised.

        Parameters:
        region - The region of the service.

      • setRegion

        void setRegion​(String regionId)
        Sets the region to call (ex, ‘us-phoenix-1’).

        Note, this will first try to map the region ID to a known Region and call setRegion.

        If no known Region could be determined, it will create an endpoint based on the default endpoint format (Region.formatDefaultRegionEndpoint(Service, String) and then call setEndpoint.

        Parameters:
        regionId - The public region ID.

      • useRealmSpecificEndpointTemplate

        void useRealmSpecificEndpointTemplate​(boolean realmSpecificEndpointTemplateEnabled)
        Determines whether realm specific endpoint should be used or not.

        Set realmSpecificEndpointTemplateEnabled to “true” if the user wants to enable use of realm specific endpoint template, otherwise set it to “false”

        Parameters:
        realmSpecificEndpointTemplateEnabled - flag to enable the use of realm specific endpoint template

      • changeConnectHarnessCompartment

        ChangeConnectHarnessCompartmentResponse changeConnectHarnessCompartment​(ChangeConnectHarnessCompartmentRequest request)
        Moves a resource into a different compartment.

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

        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/ChangeConnectHarnessCompartmentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ChangeConnectHarnessCompartment API.

      • changeStreamCompartment

        ChangeStreamCompartmentResponse changeStreamCompartment​(ChangeStreamCompartmentRequest request)
        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.

        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/ChangeStreamCompartmentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ChangeStreamCompartment API.

      • changeStreamPoolCompartment

        ChangeStreamPoolCompartmentResponse changeStreamPoolCompartment​(ChangeStreamPoolCompartmentRequest request)
        Moves a resource into a different compartment.

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

        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/ChangeStreamPoolCompartmentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ChangeStreamPoolCompartment API.

      • createConnectHarness

        CreateConnectHarnessResponse createConnectHarness​(CreateConnectHarnessRequest request)
        Starts the provisioning of a new connect harness.

        To track the progress of the provisioning, you can periodically call ConnectHarness object tells you its current state.

        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/CreateConnectHarnessExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateConnectHarness API.

      • createStream

        CreateStreamResponse createStream​(CreateStreamRequest request)
        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. In the response, the lifecycleState parameter of the Stream object tells you its current state.

        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/CreateStreamExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateStream API.

      • createStreamPool

        CreateStreamPoolResponse createStreamPool​(CreateStreamPoolRequest request)
        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.

        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/CreateStreamPoolExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateStreamPool API.

      • deleteConnectHarness

        DeleteConnectHarnessResponse deleteConnectHarness​(DeleteConnectHarnessRequest request)
        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 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.

        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/DeleteConnectHarnessExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteConnectHarness API.

      • deleteStream

        DeleteStreamResponse deleteStream​(DeleteStreamRequest request)
        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 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.

        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/DeleteStreamExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteStream API.

      • deleteStreamPool

        DeleteStreamPoolResponse deleteStreamPool​(DeleteStreamPoolRequest request)
        Deletes a stream pool.

        All containing streams will also be deleted. The default stream pool of a compartment cannot be deleted.

        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/DeleteStreamPoolExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteStreamPool API.

      • getConnectHarness

        GetConnectHarnessResponse getConnectHarness​(GetConnectHarnessRequest request)
        Gets detailed information about a connect harness.
        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/GetConnectHarnessExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetConnectHarness API.

      • getStream

        GetStreamResponse getStream​(GetStreamRequest request)
        Gets detailed information about a stream, including the number of partitions.
        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/GetStreamExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetStream API.

      • getStreamPool

        GetStreamPoolResponse getStreamPool​(GetStreamPoolRequest request)
        Gets detailed information about the stream pool, such as Kafka settings.
        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/GetStreamPoolExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetStreamPool API.

      • listConnectHarnesses

        ListConnectHarnessesResponse listConnectHarnesses​(ListConnectHarnessesRequest request)
        Lists the connectharness.
        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/ListConnectHarnessesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListConnectHarnesses API.

      • listStreamPools

        ListStreamPoolsResponse listStreamPools​(ListStreamPoolsRequest request)
        List the stream pools for a given compartment ID.
        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/ListStreamPoolsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListStreamPools API.

      • listStreams

        ListStreamsResponse listStreams​(ListStreamsRequest request)
        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.

        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/ListStreamsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListStreams API.

      • updateConnectHarness

        UpdateConnectHarnessResponse updateConnectHarness​(UpdateConnectHarnessRequest request)
        Updates the tags applied to the connect harness.
        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/UpdateConnectHarnessExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateConnectHarness API.

      • updateStream

        UpdateStreamResponse updateStream​(UpdateStreamRequest request)
        Updates the stream.

        Only specified values will be updated.

        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/UpdateStreamExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateStream API.

      • updateStreamPool

        UpdateStreamPoolResponse updateStreamPool​(UpdateStreamPoolRequest request)
        Updates the specified stream pool.
        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/UpdateStreamPoolExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateStreamPool API.

      • getWaiters

        StreamAdminWaiters getWaiters()
        Gets the pre-configured waiters available for resources for this service.
        Returns:
        The service waiters.

      • getPaginators

        StreamAdminPaginators getPaginators()
        Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.

        These paginators provide an Iterable interface so that service responses, or resources/records, can be iterated through without having to manually deal with pagination and page tokens.

        Returns:
        The service paginators.