Package model

Class MeasurementRequest.MeasurementRequestBuilder

java.lang.Object

model.MeasurementRequest.MeasurementRequestBuilder

Enclosing class:

MeasurementRequest

public static class MeasurementRequest.MeasurementRequestBuilder
extends Object

This class represent a builder for Measurement Request.

See Also:

• MeasurementRequestBuilder(MeasurementType, MeasurementTarget)

Constructor Summary

Constructors

Constructor	Description
MeasurementRequestBuilder(MeasurementType type, MeasurementTarget target)	Constructor of Builder MeasurementRequest.

Method Summary

Modifier and Type	Method	Description
MeasurementRequest	build()	Final method in the chain to build MeasurementRequest object.
MeasurementRequest.MeasurementRequestBuilder	withInProgressUpdates(boolean inProgressUpdates)	Chain method for setting value of inProgressUpdates.
MeasurementRequest.MeasurementRequestBuilder	withLimit(int limit)	Chain method for setting value of limit.
MeasurementRequest.MeasurementRequestBuilder	withLocations(MeasurementLocations locations)	Chain method for setting value of locations.
MeasurementRequest.MeasurementRequestBuilder	withMeasurementOptions(MeasurementOption measurementOptions)	Chain method for setting value of measurementOptions.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

MeasurementRequestBuilder

public MeasurementRequestBuilder(MeasurementType type,
 MeasurementTarget target)

Constructor of Builder MeasurementRequest.

Example Usage:

      MeasurementRequest measurementRequest = new MeasurementRequestBuilder(
      MeasurementType.ping,
      new MeasurementTarget(TargetType.HostName, "cdn.jsdelivr.net"))
      .withLocations(new MeasurementLocations(
        Arrays.asList(MeasurementLocationOption.withRegion(RegionName.NORTHERN_AMERICA),
        MeasurementLocationOption.withCountry("JP"))))
      .withMeasurementOptions(new PingOptionsBuilder().withPackets(3).withIpVersion(4)
      .build()).build();
     
 

Parameters:

type - MeasurementType

target - MeasurementTarget

Method Details

withInProgressUpdates

public MeasurementRequest.MeasurementRequestBuilder withInProgressUpdates(boolean inProgressUpdates)

Chain method for setting value of inProgressUpdates.

Parameters:

inProgressUpdates - MeasurementRequest.inProgressUpdates

Returns:

MeasurementRequest.MeasurementRequestBuilder

withLocations

public MeasurementRequest.MeasurementRequestBuilder withLocations(MeasurementLocations locations)

Chain method for setting value of locations.

Parameters:

locations - MeasurementLocations

Returns:

MeasurementRequest.MeasurementRequestBuilder

withLimit

public MeasurementRequest.MeasurementRequestBuilder withLimit(int limit)
                                                       throws PayloadException

Chain method for setting value of limit.

Parameters:

limit - MeasurementRequest.limit

Returns:

MeasurementRequest.MeasurementRequestBuilder

Throws:

PayloadException - if limit param is invalid.

withMeasurementOptions

public MeasurementRequest.MeasurementRequestBuilder withMeasurementOptions(MeasurementOption measurementOptions)

Chain method for setting value of measurementOptions.

Parameters:

measurementOptions - MeasurementOption

Returns:

MeasurementRequest.MeasurementRequestBuilder

build

public MeasurementRequest build()
                         throws PayloadException

Final method in the chain to build MeasurementRequest object.

Returns:

MeasurementRequest

Throws:

PayloadException