Class ViewRequest

java.lang.Object
com.couchbase.client.core.msg.BaseRequest<ViewResponse>
com.couchbase.client.core.msg.view.ViewRequest
All Implemented Interfaces:
ChunkDecodable<ViewChunkHeader,ViewChunkRow,ViewChunkTrailer,ViewResponse>, Encodable<com.couchbase.client.core.deps.io.netty.handler.codec.http.FullHttpRequest>, HttpRequest<ViewChunkHeader,ViewChunkRow,ViewChunkTrailer,ViewResponse>, Request<ViewResponse>, ScopedRequest

  • Constructor Details

  • Method Details

    • serviceType

      public ServiceType serviceType()
      Description copied from interface: Request
      The service type of this request.

      Can be null if this is a 'virtual service' (e.g. transactions), which don't map 1:1 to a particular cluster service, but need to integrate into various codepaths that are built around ServiceType such as ThresholdLoggingTracer. Virtual requests must not be sent into core at present, as there is limited support for them.

      Specified by:
      serviceType in interface Request<ViewResponse>
      Returns:
      the service type for this request.
    • encode

      public com.couchbase.client.core.deps.io.netty.handler.codec.http.FullHttpRequest encode()
      Specified by:
      encode in interface Encodable<com.couchbase.client.core.deps.io.netty.handler.codec.http.FullHttpRequest>
    • decode

      public ViewResponse decode(ResponseStatus status, ViewChunkHeader header, Flux<ViewChunkRow> rows, Mono<ViewChunkTrailer> trailer)
      Description copied from interface: ChunkDecodable
      Decodes a chunked response into the response format.
      Specified by:
      decode in interface ChunkDecodable<ViewChunkHeader,ViewChunkRow,ViewChunkTrailer,ViewResponse>
      Parameters:
      status - the http response status.
      header - the chunk header.
      rows - the chunk rows.
      trailer - the chunk trailer.
      Returns:
      a decoded response including all the chunk parts.
    • bucket

      public String bucket()
      Description copied from interface: Request
      Returns the name of the bucket this request is scoped to, or null if not scoped to a bucket.
      Specified by:
      bucket in interface Request<ViewResponse>
      Returns:
      (nullable)
    • idempotent

      public boolean idempotent()
      Description copied from interface: Request
      Returns if the given request is idempotent or not.

      By default, this method always returns false for data consistency reasons. Only specific idempotent operations should override this default since it impacts retry handling quite a bit. DO NOT SET THIS TO TRUE ON MUTATING OPERATIONS!

      Specified by:
      idempotent in interface Request<ViewResponse>
      Returns:
      true if idempotent.
    • serviceContext

      public Map<String,Object> serviceContext()
      Description copied from interface: Request
      Returns contextual information for each individual service.
      Specified by:
      serviceContext in interface Request<ViewResponse>
      Overrides:
      serviceContext in class BaseRequest<ViewResponse>
      Returns:
      the service context.
    • name

      public String name()
      Description copied from interface: Request
      The unique name of the request, usually related to the type but not necessarily.

      The default implementation is derived from the class name (i.e. FooRequest returns foo), but if that does not match up it should be overridden in the actual class.

      Specified by:
      name in interface Request<ViewResponse>
      Returns:
      the name of the request type.