Package org.azd.abstractions.internals

Class ClientRequestBuilder

java.lang.Object

org.azd.abstractions.internals.ClientRequestBuilder

All Implemented Interfaces:

ClientRequest.Builder

public class ClientRequestBuilder
extends Object
implements ClientRequest.Builder

Client request builder implementation to build the request.

Constructor Summary

Constructors

Constructor	Description
ClientRequestBuilder()	Default.
ClientRequestBuilder(AccessTokenCredential accessTokenCredential)	Default with access token credential.

Method Summary

Modifier and Type	Method	Description
AccessTokenCredential	accessTokenCredential()	Get the access token credential object.
ClientRequest.Builder	apiVersion(String apiVersion)	Pass the api version.
ClientRequest.Builder	area(String area)	Pass the Azure DevOps service area.
ClientRequest.Builder	baseInstance(String baseInstance)	Pass the base url instance.
ClientRequest	build()	Constructs and the client request object.
ClientRequest.Builder	DELETE()	Represents the DELETE request and sets the RequestMethod for sending the request.
ClientRequest.Builder	GET()	Represents the GET request and sets the RequestMethod for sending the request.
ClientRequest.Builder	HEAD()	Represents the HEAD request and sets the RequestMethod for sending the request.
ClientRequest.Builder	header(CustomHeader customHeader)	Set the request header.
ClientRequest.Builder	headers(RequestHeaders requestHeaders)	Set the request headers.
ClientRequest.Builder	location(String locationId)	Pass the location id.
ClientRequest.Builder	OPTIONS()	Represents the OPTIONS request and sets the RequestMethod for sending the request.
ClientRequest.Builder	PATCH(Object requestBody)	Represents the PATCH request and sets the RequestMethod for sending the request.
ClientRequest.Builder	POST(Object requestBody)	Represents the POST request and sets the RequestMethod for sending the request.
ClientRequest.Builder	PUT(Object requestBody)	Represents the PUT request and sets the RequestMethod for sending the request.
ClientRequest.Builder	query(String name, Object value)	Pass the query parameters
<T> ClientRequest.Builder	query(Supplier<T> config, Consumer<T> requestConfig, Function<T,Object> func)	Supply the values to set the query parameters.
RequestInformation	request()	Get the request information.
ClientRequest.Builder	request(RequestInformation requestInfo)	Set the complete request information.
ClientRequest.Builder	serviceEndpoint(String key, Object value)	Pass the service endpoint to append the URL with.
ClientRequest.Builder	URI(String url)	Pass the complete request url.
ClientRequest.Builder	URI(URI uri)	Pass the complete request url.

Methods inherited from class java.lang.Object

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

Constructor Details

ClientRequestBuilder

public ClientRequestBuilder()

Default.

ClientRequestBuilder

public ClientRequestBuilder(AccessTokenCredential accessTokenCredential)

Default with access token credential.

Parameters:

accessTokenCredential - AccessTokenCredential AccessTokenCredential

Method Details

baseInstance

public ClientRequest.Builder baseInstance(String baseInstance)

Pass the base url instance. (dev.azure.com/{organisation})

Specified by:

baseInstance in interface ClientRequest.Builder

Parameters:

baseInstance - Base instance to set to construct the request url.

Returns:

Client request builder object ClientRequest.Builder

area

public ClientRequest.Builder area(String area)

Pass the Azure DevOps service area.

Specified by:

area in interface ClientRequest.Builder

Parameters:

area - Pass the value for area. E.g. core or build or git etc.

Returns:

Client request builder object ClientRequest.Builder

location

public ClientRequest.Builder location(String locationId)

Pass the location id.

Specified by:

location in interface ClientRequest.Builder

Parameters:

locationId - Pass the location id for service specific area.

Returns:

Client request builder object ClientRequest.Builder

apiVersion

public ClientRequest.Builder apiVersion(String apiVersion)

Pass the api version.

Specified by:

apiVersion in interface ClientRequest.Builder

Parameters:

apiVersion - Api version to set.

Returns:

Client request builder object ClientRequest.Builder

GET

public ClientRequest.Builder GET()

Represents the GET request and sets the RequestMethod for sending the request.

Specified by:

GET in interface ClientRequest.Builder

Returns:

Client request builder object ClientRequest.Builder

POST

public ClientRequest.Builder POST(Object requestBody)

Represents the POST request and sets the RequestMethod for sending the request.

Specified by:

POST in interface ClientRequest.Builder

Parameters:

requestBody - Pass the request body.

Returns:

Client request builder object ClientRequest.Builder

PATCH

public ClientRequest.Builder PATCH(Object requestBody)

Represents the PATCH request and sets the RequestMethod for sending the request.

Specified by:

PATCH in interface ClientRequest.Builder

Parameters:

requestBody - Pass the request body.

Returns:

Client request builder object ClientRequest.Builder

PUT

public ClientRequest.Builder PUT(Object requestBody)

Represents the PUT request and sets the RequestMethod for sending the request.

Specified by:

PUT in interface ClientRequest.Builder

Parameters:

requestBody - Pass the request body.

Returns:

Client request builder object ClientRequest.Builder

DELETE

public ClientRequest.Builder DELETE()

Represents the DELETE request and sets the RequestMethod for sending the request.

Specified by:

DELETE in interface ClientRequest.Builder

Returns:

Client request builder object ClientRequest.Builder

OPTIONS

public ClientRequest.Builder OPTIONS()

Represents the OPTIONS request and sets the RequestMethod for sending the request.

Specified by:

OPTIONS in interface ClientRequest.Builder

Returns:

Client request builder object ClientRequest.Builder

HEAD

public ClientRequest.Builder HEAD()

Represents the HEAD request and sets the RequestMethod for sending the request.

Specified by:

HEAD in interface ClientRequest.Builder

Returns:

Client request builder object ClientRequest.Builder

URI

public ClientRequest.Builder URI(String url)

Pass the complete request url.

Specified by:

URI in interface ClientRequest.Builder

Parameters:

url - Request url to set.

Returns:

Client request builder object ClientRequest.Builder

URI

public ClientRequest.Builder URI(URI uri)

Pass the complete request url.

Specified by:

URI in interface ClientRequest.Builder

Parameters:

uri - Request url to set.

Returns:

Client request builder object ClientRequest.Builder

serviceEndpoint

public ClientRequest.Builder serviceEndpoint(String key,
 Object value)

Pass the service endpoint to append the URL with.

Specified by:

serviceEndpoint in interface ClientRequest.Builder

Parameters:

key - Represents the path parameter of the url.

value - Value for the path parameter.

Returns:

Client request builder object ClientRequest.Builder

query

public ClientRequest.Builder query(String name,
 Object value)

Pass the query parameters

Specified by:

query in interface ClientRequest.Builder

Parameters:

name - Name of the query parameter.

value - Value of the query parameter.

Returns:

Client request builder object ClientRequest.Builder

query

public <T> ClientRequest.Builder query(Supplier<T> config,
 Consumer<T> requestConfig,
 Function<T,Object> func)

Supply the values to set the query parameters.

Specified by:

query in interface ClientRequest.Builder

Parameters:

config - Supplier of request configuration instance.

requestConfig - Consumer of request configuration that contains the query parameters.

func - Function of request configuration query parameters that returns any object.

Returns:

Client request builder object ClientRequest.Builder

header

public ClientRequest.Builder header(CustomHeader customHeader)

Set the request header.

Specified by:

header in interface ClientRequest.Builder

Parameters:

customHeader - Custom header to add. CustomHeader

Returns:

Client request builder object ClientRequest.Builder

headers

public ClientRequest.Builder headers(RequestHeaders requestHeaders)

Set the request headers.

Specified by:

headers in interface ClientRequest.Builder

Parameters:

requestHeaders - Request headers value. RequestHeaders

Returns:

Client request builder object ClientRequest.Builder

request

public ClientRequest.Builder request(RequestInformation requestInfo)

Set the complete request information.

Specified by:

request in interface ClientRequest.Builder

Parameters:

requestInfo - Request information object.

Returns:

Client request builder object ClientRequest.Builder

request

public RequestInformation request()

Get the request information.

Specified by:

request in interface ClientRequest.Builder

Returns:

Request information object RequestInformation

accessTokenCredential

public AccessTokenCredential accessTokenCredential()

Get the access token credential object.

Specified by:

accessTokenCredential in interface ClientRequest.Builder

Returns:

AccessTokenCredential AccessTokenCredential

build

public ClientRequest build()

Constructs and the client request object.

Specified by:

build in interface ClientRequest.Builder

Returns:

ClientRequest ClientRequest