Package com.aerisweather.aeris.communication

Class BatchBuilder

  • public class BatchBuilder
extends Object

    • Constructor Detail

      • BatchBuilder

        public BatchBuilder()

    • Method Detail

      • withId

        public BatchBuilder withId​(String id)
        Adds the batch id to the builder. This cannot be used with withAction(Action). An id or action must be passed.
        Parameters:
        id - id to use for the batch request
        Returns:
        the builder

      • withAction

        public BatchBuilder withAction​(Action action)
        Adds the batch Action to the builder. This cannot be used with withId(String). An id or action must be passed.
        Parameters:
        action - action to use for the batch request
        Returns:
        the builder

      • addEndpoint

        public BatchBuilder addEndpoint​(Endpoint endpoint)
        Add an endpoint to the batch request.
        Parameters:
        endpoint - endpoint to add
        Returns:
        the builder.

      • addEndpoint

        public BatchBuilder addEndpoint​(EndpointType type)
        Add an endpoint to the batch request.
        Parameters:
        type - Endpoint type
        Returns:
        BatchBuilder object

      • addEndpoint

        public BatchBuilder addEndpoint​(EndpointType type,
                                Action action)
        Add an endpoint to the batch request.
        Parameters:
        type - Endpoint type
        action - Action to take on the endpoint
        Returns:
        BatchBuilder object

      • addGlobalParameter

        public BatchBuilder addGlobalParameter​(Parameter param)
        Add a parameter that will be applied to all of the requests.
        Parameters:
        param - parameter to apply
        Returns:
        the builder

      • build

        public AerisRequest build()
        Builds the appropriate AerisRequest from the BatchBuilder.
        Returns:
        AerisRequest based on builder