com.microsoft.azure.spring.cloud.config

Class RestAPIBuilder

java.lang.Object

com.microsoft.azure.spring.cloud.config.RestAPIBuilder

public class RestAPIBuilder
extends Object

This class is used to build REST API uris for different service rest endpoints.

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY_VALUE_API
static String	NULL_LABEL
static String	REVISIONS_API

Constructor Summary

Constructors

Constructor and Description
RestAPIBuilder()

Method Summary

Modifier and Type	Method and Description
RestAPIBuilder	addParam(String key, String value)
String	buildKVApi() User is responsible to configure the required endpoint, path and params ahead
String	buildKVApi(QueryOptions options) Build REST API for kv request, depending on the query options, the URI built can be different.
String	buildRevisionsApi(QueryOptions options)
RestAPIBuilder	withEndpoint(String endpoint)
RestAPIBuilder	withPath(String path)

Methods inherited from class java.lang.Object

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

Field Detail

KEY_VALUE_API

public static final String KEY_VALUE_API

See Also:

Constant Field Values

REVISIONS_API

public static final String REVISIONS_API

See Also:

Constant Field Values

NULL_LABEL

public static final String NULL_LABEL

See Also:

Constant Field Values

Constructor Detail

RestAPIBuilder

public RestAPIBuilder()

Method Detail

withEndpoint

public RestAPIBuilder withEndpoint(String endpoint)

withPath

public RestAPIBuilder withPath(String path)

addParam

public RestAPIBuilder addParam(String key,
                               String value)

buildKVApi

public String buildKVApi(@NonNull
                         QueryOptions options)

Build REST API for kv request, depending on the query options, the URI built can be different.

e.g., https://host.domain.io/kv https://host.domain.io/kv?key=abc https://host.domain.io/kv?key=abc* https://host.domain.io/kv?key=abc*&label=prod

Parameters:

options - is NonNull, query options used to build the KV API

Returns:

valid full path of target REST API

buildRevisionsApi

public String buildRevisionsApi(@NonNull
                                QueryOptions options)

buildKVApi

public String buildKVApi()

User is responsible to configure the required endpoint, path and params ahead

Returns:

valid full path of target REST API