Package org.jclouds.openstack.marconi.v1

Interface MarconiApi

  • All Superinterfaces:
    AutoCloseable, Closeable
    public interface MarconiApi
extends Closeable
    Marconi is a robust, web-scale message queuing service to support the distributed nature of large web applications.

    • Method Detail

      • getConfiguredRegions

        @Provides
Set<String> getConfiguredRegions()
        Returns:
        the Region codes configured

      • getQueueApi

        QueueApi getQueueApi​(String region,
                     @HeaderParam("Client-ID")
                     UUID clientId)
        Provides access to Queue features.
        Parameters:
        region - The region where this queue will live.
        clientId - A UUID for each client instance. The UUID must be submitted in its canonical form (for example, 3381af92-2b9e-11e3-b191-71861300734c). The client generates the Client-ID once. Client-ID persists between restarts of the client so the client should reuse that same Client-ID. All message-related operations require the use of Client-ID in the headers to ensure that messages are not echoed back to the client that posted them, unless the client explicitly requests this.

      • getMessageApi

        @Path("/queues/{name}")
MessageApi getMessageApi​(String region,
                         @HeaderParam("Client-ID")
                         UUID clientId,
                         @PathParam("name")
                         String name)
        Provides access to Message features.
        Parameters:
        region - The region where this queue lives.
        clientId - A UUID for each client instance. The UUID must be submitted in its canonical form (for example, 3381af92-2b9e-11e3-b191-71861300734c). The client generates the Client-ID once. Client-ID persists between restarts of the client so the client should reuse that same Client-ID. All message-related operations require the use of Client-ID in the headers to ensure that messages are not echoed back to the client that posted them, unless the client explicitly requests this.
        name - Name of the queue.

      • getClaimApi

        @Path("/queues/{name}")
ClaimApi getClaimApi​(String region,
                     @HeaderParam("Client-ID")
                     UUID clientId,
                     @PathParam("name")
                     String name)
        Provides access to Claim features.
        Parameters:
        region - The region where this queue lives.
        clientId - A UUID for each client instance. The UUID must be submitted in its canonical form (for example, 3381af92-2b9e-11e3-b191-71861300734c). The client generates the Client-ID once. Client-ID persists between restarts of the client so the client should reuse that same Client-ID. All message-related operations require the use of Client-ID in the headers to ensure that messages are not echoed back to the client that posted them, unless the client explicitly requests this.
        name - Name of the queue.

      • getQueueApiForZoneAndClient

        @Deprecated
QueueApi getQueueApiForZoneAndClient​(String zone,
                                     @HeaderParam("Client-ID")
                                     UUID clientId)
        Deprecated.
        Please use getQueueApi(String, UUID) instead. To be removed in jclouds 2.0.
        Provides access to Queue features.
        Parameters:
        zone - The zone where this queue will live.
        clientId - A UUID for each client instance. The UUID must be submitted in its canonical form (for example, 3381af92-2b9e-11e3-b191-71861300734c). The client generates the Client-ID once. Client-ID persists between restarts of the client so the client should reuse that same Client-ID. All message-related operations require the use of Client-ID in the headers to ensure that messages are not echoed back to the client that posted them, unless the client explicitly requests this.

      • getMessageApiForZoneAndClientAndQueue

        @Deprecated
@Path("/queues/{name}")
MessageApi getMessageApiForZoneAndClientAndQueue​(String zone,
                                                 @HeaderParam("Client-ID")
                                                 UUID clientId,
                                                 @PathParam("name")
                                                 String name)
        Deprecated.
        Please use getMessageApi(String, UUID, String) instead. To be removed in jclouds 2.0.
        Provides access to Message features.
        Parameters:
        zone - The zone where this queue lives.
        clientId - A UUID for each client instance. The UUID must be submitted in its canonical form (for example, 3381af92-2b9e-11e3-b191-71861300734c). The client generates the Client-ID once. Client-ID persists between restarts of the client so the client should reuse that same Client-ID. All message-related operations require the use of Client-ID in the headers to ensure that messages are not echoed back to the client that posted them, unless the client explicitly requests this.
        name - Name of the queue.

      • getClaimApiForZoneAndClientAndQueue

        @Deprecated
@Path("/queues/{name}")
ClaimApi getClaimApiForZoneAndClientAndQueue​(String zone,
                                             @HeaderParam("Client-ID")
                                             UUID clientId,
                                             @PathParam("name")
                                             String name)
        Deprecated.
        Please use getClaimApi(String, UUID, String) instead. To be removed in jclouds 2.0.
        Provides access to Claim features.
        Parameters:
        zone - The zone where this queue lives.
        clientId - A UUID for each client instance. The UUID must be submitted in its canonical form (for example, 3381af92-2b9e-11e3-b191-71861300734c). The client generates the Client-ID once. Client-ID persists between restarts of the client so the client should reuse that same Client-ID. All message-related operations require the use of Client-ID in the headers to ensure that messages are not echoed back to the client that posted them, unless the client explicitly requests this.
        name - Name of the queue.