Package org.apache.camel.builder.endpoint.dsl

Interface RestEndpointBuilderFactory.RestEndpointConsumerBuilder

All Superinterfaces:
org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver
All Known Subinterfaces:
RestEndpointBuilderFactory.RestEndpointBuilder
Enclosing interface:
RestEndpointBuilderFactory
public static interface RestEndpointBuilderFactory.RestEndpointConsumerBuilder extends org.apache.camel.builder.EndpointConsumerBuilder
Builder for endpoint consumers for the REST component.

  • Method Details

    • advanced

      default RestEndpointBuilderFactory.AdvancedRestEndpointConsumerBuilder advanced()

    • consumes

      default RestEndpointBuilderFactory.RestEndpointConsumerBuilder consumes(String consumes)
      Media type such as: 'text/xml', or 'application/json' this REST service accepts. By default we accept all kinds of types. The option is a: <code>java.lang.String</code> type. Group: common
      Parameters:
      consumes - the value to set
      Returns:
      the dsl builder

    • inType

      default RestEndpointBuilderFactory.RestEndpointConsumerBuilder inType(String inType)
      To declare the incoming POJO binding type as a FQN class name. The option is a: <code>java.lang.String</code> type. Group: common
      Parameters:
      inType - the value to set
      Returns:
      the dsl builder

    • outType

      default RestEndpointBuilderFactory.RestEndpointConsumerBuilder outType(String outType)
      To declare the outgoing POJO binding type as a FQN class name. The option is a: <code>java.lang.String</code> type. Group: common
      Parameters:
      outType - the value to set
      Returns:
      the dsl builder

    • produces

      default RestEndpointBuilderFactory.RestEndpointConsumerBuilder produces(String produces)
      Media type such as: 'text/xml', or 'application/json' this REST service returns. The option is a: <code>java.lang.String</code> type. Group: common
      Parameters:
      produces - the value to set
      Returns:
      the dsl builder

    • routeId

      default RestEndpointBuilderFactory.RestEndpointConsumerBuilder routeId(String routeId)
      Name of the route this REST services creates. The option is a: <code>java.lang.String</code> type. Group: common
      Parameters:
      routeId - the value to set
      Returns:
      the dsl builder

    • consumerComponentName

      default RestEndpointBuilderFactory.RestEndpointConsumerBuilder consumerComponentName(String consumerComponentName)
      The Camel Rest component to use for the consumer REST transport, such as jetty, servlet, undertow. If no component has been explicitly configured, then Camel will lookup if there is a Camel component that integrates with the Rest DSL, or if a org.apache.camel.spi.RestConsumerFactory is registered in the registry. If either one is found, then that is being used. The option is a: <code>java.lang.String</code> type. Group: consumer
      Parameters:
      consumerComponentName - the value to set
      Returns:
      the dsl builder

    • description

      default RestEndpointBuilderFactory.RestEndpointConsumerBuilder description(String description)
      Human description to document this REST service. The option is a: <code>java.lang.String</code> type. Group: consumer
      Parameters:
      description - the value to set
      Returns:
      the dsl builder