Package com.azure.core.http

Enum HttpPipelinePosition

java.lang.Object

java.lang.Enum<HttpPipelinePosition>

com.azure.core.http.HttpPipelinePosition

All Implemented Interfaces:

Serializable, Comparable<HttpPipelinePosition>, java.lang.constant.Constable

public enum HttpPipelinePosition
extends Enum<HttpPipelinePosition>

Enum representing the position in an HttpPipeline to place an HttpPipelinePolicy.

This enum encapsulates the positions where an HTTP pipeline policy can be placed in the HTTP pipeline. The positions are before or after a RetryPolicy.

Each position is represented by an enum constant. For example, you can use PER_CALL to represent the position before a RetryPolicy, and PER_RETRY to represent the position after a RetryPolicy.

The PER_CALL position means that the policy will only be invoked once per pipeline invocation (service call), and the PER_RETRY position means that the policy will be invoked every time a request is sent (including retries).

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
PER_CALL	Policy is placed before a RetryPolicy and will only be invoked once per pipeline invocation (service call).
PER_RETRY	Policy is placed after a RetryPolicy and will be invoked every time a request is sent.

Method Summary

Modifier and Type	Method	Description
static HttpPipelinePosition	valueOf(String name)	Returns the enum constant of this type with the specified name.
static HttpPipelinePosition[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

PER_CALL

public static final HttpPipelinePosition PER_CALL

Policy is placed before a RetryPolicy and will only be invoked once per pipeline invocation (service call).

PER_RETRY

public static final HttpPipelinePosition PER_RETRY

Policy is placed after a RetryPolicy and will be invoked every time a request is sent.

The policy will be invoked at least once for the initial service call and each time the request is retried.

Method Details

values

public static HttpPipelinePosition[] values()

Returns an array containing the constants of this enum type, in the order they are declared.

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static HttpPipelinePosition valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null