Package dev.adlin.vts4j.request

Class RequestBuilder

java.lang.Object

dev.adlin.vts4j.request.RequestBuilder

public class RequestBuilder
extends Object

Constructor Summary

Constructors

Constructor	Description
RequestBuilder()

Method Summary

Modifier and Type	Method	Description
@NonNull Request	build()	Builds and returns a new Request object with the configured parameters.
static @NonNull RequestBuilder	of(@NonNull RequestType requestType)
static @NonNull RequestBuilder	of(@NonNull String requestTypeName)
@NonNull RequestBuilder	setApiName(@NonNull String apiName)	Sets the name of the API for the request.
@NonNull RequestBuilder	setApiVersion(@NonNull String apiVersion)	Sets the version of the API for the request.
@NonNull RequestBuilder	setPayload(@NonNull com.google.gson.JsonObject payload)	Sets payload required for certain types of requests.
@NonNull RequestBuilder	setRequestId(@NonNull String requestId)	Sets the unique identifier for the request.

Methods inherited from class java.lang.Object

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

Constructor Details

RequestBuilder

public RequestBuilder()

Method Details

of

public static @NonNull RequestBuilder of(@NonNull RequestType requestType)

of

public static @NonNull RequestBuilder of(@NonNull String requestTypeName)

setApiName

public @NonNull RequestBuilder setApiName(@NonNull String apiName)

Sets the name of the API for the request.

Parameters:

apiName - The name of the API. Cannot be null.

Returns:

This Builder instance to allow method chaining.

setApiVersion

public @NonNull RequestBuilder setApiVersion(@NonNull String apiVersion)

Sets the version of the API for the request.

Parameters:

apiVersion - The version of the API. Cannot be null.

Returns:

This Builder instance to allow method chaining.

setRequestId

public @NonNull RequestBuilder setRequestId(@NonNull String requestId)

Sets the unique identifier for the request.

Parameters:

requestId - The unique identifier for the request. Cannot be null.

Returns:

This Builder instance to allow method chaining.

setPayload

public @NonNull RequestBuilder setPayload(@NonNull com.google.gson.JsonObject payload)

Sets payload required for certain types of requests. More details about the payload structure can be found at this page.

Parameters:

payload - Additional information required for certain types of requests

Returns:

This Builder instance to allow method chaining

build

public @NonNull Request build()

Builds and returns a new Request object with the configured parameters. If messageType is not set, an IllegalArgumentException is thrown.

Returns:

A new Request object with the configured parameters.

Throws:

IllegalArgumentException - If messageType is null.