com.microsoft.rest.v2.annotations

Annotation Type HostParam

@Retention(value=RUNTIME)
 @Target(value=PARAMETER)
public @interface HostParam

A host parameter replaces the parametrized segments in a dynamic Host. You provide the value, which should be the same (case sensitive) with the parametrized segments in '{}' in the host, unless there's only one parametrized segment, then you can leave the value empty. This is extremely useful when the designer of the API interface doesn't know about the named parameters in the host. Example 1: named parameters @Host("{accountName}.{suffix}") interface DatalakeService { @GET("jobs/{jobIdentity}") Job getJob(@HostParam("accountName") String accountName, @HostParam("suffix") String suffix, @PathParam("jobIdentity") jobIdentity); } Example 2: unnamed parameter @Host(KEY_VAULT_ENDPOINT) interface KeyVaultService { @GET("secrets/{secretName}") Secret get(@HostParam String vaultName, @PathParam("secretName") String secretName); }

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	value The name of the variable in the endpoint uri template which will be replaced with the value of the parameter annotated with this annotation.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	encoded A value true for this argument indicates that value of value() is already encoded hence engine should not encode it, by default value will be encoded.

Element Detail

value

public abstract String value

The name of the variable in the endpoint uri template which will be replaced with the value of the parameter annotated with this annotation.

Returns:

The name of the variable in the endpoint uri template which will be replaced with the value of the parameter annotated with this annotation.

encoded

public abstract boolean encoded

A value true for this argument indicates that value of value() is already encoded hence engine should not encode it, by default value will be encoded.

Returns:

Whether or not this argument is already encoded.

Default:

true