Skip navigation links
A B C D E F G H I J K L M N O P R S T U V W X 

A

addAllOf(Schema) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
Adds the given Schema to the list of schemas used by the allOf property.
addAnyOf(Schema) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
Adds the given Schema to the list of schemas used by the anyOf property.
addApiResponse(String, APIResponse) - Method in interface org.eclipse.microprofile.openapi.models.responses.APIResponses
Adds an ApiResponse in the format of the name as a key and the item as the value to ApiResponses map
addCallback(String, Callback) - Method in interface org.eclipse.microprofile.openapi.models.Components
Adds the given callback to this Components' map of callbacks with the given string as its key.
addDefaultSources() - Method in interface org.eclipse.microprofile.config.spi.ConfigBuilder
Add the default config sources appearing on the builder's classpath including: System properties Environment properties /META-INF/microprofile-config.properties
addDiscoveredConverters() - Method in interface org.eclipse.microprofile.config.spi.ConfigBuilder
Add the converters to be loaded via service loader pattern
addDiscoveredSources() - Method in interface org.eclipse.microprofile.config.spi.ConfigBuilder
Add the config sources appearing to be loaded via service loader pattern
addEncoding(String, Encoding) - Method in interface org.eclipse.microprofile.openapi.models.media.MediaType
Adds an Encoding item to the encoding property of a MediaType instance.
addEnumeration(Object) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
Adds an item of the appropriate type to the enumerated list of values allowed.
addEnumeration(String) - Method in interface org.eclipse.microprofile.openapi.models.servers.ServerVariable
This method adds a string item to enumeration list of a ServerVariable instance and returns the instance.
addExample(String, Example) - Method in interface org.eclipse.microprofile.openapi.models.Components
Adds the given example to this Components' map of examples with the given string as its key.
addExample(String, Example) - Method in interface org.eclipse.microprofile.openapi.models.headers.Header
Adds an example of the media type using the specified key to this Header instance.
addExample(String, Example) - Method in interface org.eclipse.microprofile.openapi.models.media.MediaType
Adds an example item to the examples map of a MediaType instance.
addExample(String, Example) - Method in interface org.eclipse.microprofile.openapi.models.parameters.Parameter
Adds an example of the media type using the specified key.
addExtension(String, Object) - Method in interface org.eclipse.microprofile.openapi.models.Extensible
Adds the given object to this Extensible's map of extensions, with the given name as its key.
addHeader(String, Header) - Method in interface org.eclipse.microprofile.openapi.models.Components
Adds the given header to this Components' map of headers with the given string as its key.
addHeader(String, Header) - Method in interface org.eclipse.microprofile.openapi.models.responses.APIResponse
Adds the given Header to this ApiResponse instance's map of Headers with the given name and return this instance of ApiResponse.
additionalProperties(Schema) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
Sets the Schema which defines additional properties not defined by "properties" or "patternProperties".
additionalProperties(Boolean) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
Sets the value of "additionalProperties" to either True or False.
addLink(String, Link) - Method in interface org.eclipse.microprofile.openapi.models.Components
Adds the given link to this Components' map of links with the given string as its key.
addLink(String, Link) - Method in interface org.eclipse.microprofile.openapi.models.responses.APIResponse
Adds a link to this instance of ApiResponse using the given name and Link, and returns this ApiResponse instance.
addMapping(String, String) - Method in interface org.eclipse.microprofile.openapi.models.media.Discriminator
Maps the given name to the given value and stores it in this Discriminator's mapping property.
addMediaType(String, MediaType) - Method in interface org.eclipse.microprofile.openapi.models.media.Content
Adds the MediaType for this Content, where the key is the name of the MediaType and the value is the object that describes the content passed into or returned from an operation.
addOneOf(Schema) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
Adds the given Schema to the list of schemas used by the oneOf property.
addParameter(String, Parameter) - Method in interface org.eclipse.microprofile.openapi.models.Components
Adds the given parameter to this Components' map of parameters with the given string as its key.
addParameter(String, Object) - Method in interface org.eclipse.microprofile.openapi.models.links.Link
Add a new parameter to the parameters property of this instance of Link.
addParameter(Parameter) - Method in interface org.eclipse.microprofile.openapi.models.Operation
Adds the given parameter item to this Operation's list of parameters.
addParameter(Parameter) - Method in interface org.eclipse.microprofile.openapi.models.PathItem
Adds the given parameter to this PathItem's list of parameters.
addPathItem(String, PathItem) - Method in interface org.eclipse.microprofile.openapi.models.callbacks.Callback
Adds the given PathItem to this Callback's list of PathItems using the string as its key.
addPathItem(String, PathItem) - Method in interface org.eclipse.microprofile.openapi.models.Paths
Adds the given path item to this Paths and return this instance of Paths
addProperty(String, Schema) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
Adds a Schema property of the provided name using the given schema.
addRequestBody(String, RequestBody) - Method in interface org.eclipse.microprofile.openapi.models.Components
Adds the given request body to this Components' map of request bodies with the given string as its key.
addRequired(String) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
Adds the name of an item to the list of fields required in objects defined by this Schema.
addResponse(String, APIResponse) - Method in interface org.eclipse.microprofile.openapi.models.Components
Adds the given response to this Components' map of responses with the given string as its key.
addSchema(String, Schema) - Method in interface org.eclipse.microprofile.openapi.models.Components
Adds the given schema to this Components' list of schemas with the given string as its key.
addScheme(String, String) - Method in interface org.eclipse.microprofile.openapi.models.security.SecurityRequirement
Adds a security scheme to the SecurityRequirement instance based on the scheme name and required scope (optional) provided.
addScheme(String, List<String>) - Method in interface org.eclipse.microprofile.openapi.models.security.SecurityRequirement
Adds a security scheme to the SecurityRequirement instance based on the scheme name and required scopes (optional) provided.
addScheme(String) - Method in interface org.eclipse.microprofile.openapi.models.security.SecurityRequirement
Adds a security scheme to the SecurityRequirement instance based on the scheme name.
addScope(String, String) - Method in interface org.eclipse.microprofile.openapi.models.security.Scopes
Adds name of an existing scope object and item parameters to a Scopes instance as a key-value pair in a map.
addSecurityRequirement(SecurityRequirement) - Method in interface org.eclipse.microprofile.openapi.models.OpenAPI
Adds the given security requirement to this OpenAPI instance's list of security requirements.
addSecurityRequirement(SecurityRequirement) - Method in interface org.eclipse.microprofile.openapi.models.Operation
Adds the given security requirement item to this Operation's list of security mechanisms.
addSecurityScheme(String, SecurityScheme) - Method in interface org.eclipse.microprofile.openapi.models.Components
Adds the given security scheme to this Components' map of security schemes with the given string as its key.
addServer(Server) - Method in interface org.eclipse.microprofile.openapi.models.OpenAPI
Adds the given server to this OpenAPI instance's list of servers.
addServer(Server) - Method in interface org.eclipse.microprofile.openapi.models.Operation
Adds the given server to this Operation's list of servers.
addServer(Server) - Method in interface org.eclipse.microprofile.openapi.models.PathItem
Adds the given server to this PathItem's list of servers.
addServerVariable(String, ServerVariable) - Method in interface org.eclipse.microprofile.openapi.models.servers.ServerVariables
This method adds a key-value item to a ServerVariables instance from the name-item parameter pair and returns the modified instance.
addTag(String) - Method in class org.eclipse.microprofile.metrics.Metadata
Add one single tag with the format: 'key=value'.
addTag(Tag) - Method in interface org.eclipse.microprofile.openapi.models.OpenAPI
Adds the given tag to this OpenAPI instance's list of tags.
addTag(String) - Method in interface org.eclipse.microprofile.openapi.models.Operation
Adds the given tag to this Operation's list of tags.
addTags(String) - Method in class org.eclipse.microprofile.metrics.Metadata
Add multiple tags delimited by commas.
addTagsTest() - Method in class org.eclipse.microprofile.metrics.tck.TagsTest
 
ALL - Static variable in interface org.eclipse.microprofile.metrics.MetricFilter
Matches all metrics, regardless of type or name.
allOf(List<Schema>) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
Sets the schemas used by the allOf property of this Schema.
allowEmptyValue(Boolean) - Method in interface org.eclipse.microprofile.openapi.models.headers.Header
Sets this Header's allowEmptyValue property to the given value.
allowEmptyValue(Boolean) - Method in interface org.eclipse.microprofile.openapi.models.parameters.Parameter
Sets the allowEmptyValue property of a Parameter instance to the given value.
allowReserved(Boolean) - Method in interface org.eclipse.microprofile.openapi.models.media.Encoding
AllowReserved determines whether the parameter value SHOULD allow reserved characters to be encoded without percent-encoding.
allowReserved(Boolean) - Method in interface org.eclipse.microprofile.openapi.models.parameters.Parameter
Sets the allowReserved property of a Parameter instance to the given value.
anyOf(List<Schema>) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
Sets the schemas used by the anyOf property of this Schema.
APIResponse - Annotation Type in org.eclipse.microprofile.openapi.annotations.responses
The ApiResponse annotation corresponds to the OpenAPI Response model object which describes a single response from an API Operation, including design-time, static links to operations based on the response.
APIResponse - Interface in org.eclipse.microprofile.openapi.models.responses
This interface represents a single response from an API Operation, including design-time, static links to operations based on the response.
APIResponses - Annotation Type in org.eclipse.microprofile.openapi.annotations.responses
The ApiResponses annotation is a container for @ApiResponse annotations.
APIResponses - Interface in org.eclipse.microprofile.openapi.models.responses
This interface represents the container for the expected responses of an operation.
applyContext() - Method in interface org.eclipse.microprofile.rest.client.ext.AsyncInvocationInterceptor
This method will be invoked by the MP Rest Client runtime on the "async" thread (i.e.
assertEqualsWithTolerance(double, double) - Static method in class org.eclipse.microprofile.metrics.tck.TestUtils
Assert equals with a tolerance factor of TestUtils.TOLERANCE times the expected value
Asynchronous - Annotation Type in org.eclipse.microprofile.faulttolerance
Wrap the execution and invoke it asynchronously.
AsyncInvocationInterceptor - Interface in org.eclipse.microprofile.rest.client.ext
Implementations of this interface can intercept asynchronous method invocations.
AsyncInvocationInterceptorFactory - Interface in org.eclipse.microprofile.rest.client.ext
This is a provider interface intended for intercepting asynchronous method invocations.
attribute(Boolean) - Method in interface org.eclipse.microprofile.openapi.models.media.XML
This method sets the attribute property of XML instance to the given Boolean argument and returns the modified instance.
authorizationCode(OAuthFlow) - Method in interface org.eclipse.microprofile.openapi.models.security.OAuthFlows
OAuth Authorization Code flow; previously called accessCode in OpenAPI 2.0
authorizationUrl(String) - Method in interface org.eclipse.microprofile.openapi.models.security.OAuthFlow
The authorization URL to be used for this flow.

B

baseUri(URI) - Method in interface org.eclipse.microprofile.rest.client.RestClientBuilder
Specifies the base URI to be used when making requests.
baseUrl(URL) - Method in interface org.eclipse.microprofile.rest.client.RestClientBuilder
Specifies the base URL to be used when making requests.
bearerFormat(String) - Method in interface org.eclipse.microprofile.openapi.models.security.SecurityScheme
bearerFormat is intended as a hint to the client to identify how the bearer token is formatted.
BITS - Static variable in class org.eclipse.microprofile.metrics.MetricUnits
Represents bits.
build() - Method in interface org.eclipse.microprofile.config.spi.ConfigBuilder
Build the Config object.
build() - Method in class org.eclipse.microprofile.health.HealthCheckResponseBuilder
 
build(Class<T>) - Method in interface org.eclipse.microprofile.rest.client.RestClientBuilder
Based on the configured RestClientBuilder, creates a new instance of the given REST interface to invoke API calls against.
builder() - Static method in class org.eclipse.microprofile.health.HealthCheckResponse
 
buildModel() - Method in interface org.eclipse.microprofile.openapi.OASModelReader
This method is called by the vendor's OpenAPI processing framework.
Bulkhead - Annotation Type in org.eclipse.microprofile.faulttolerance
Define bulkhead policy to limit the number of the concurrent calls to an instance.
BulkheadException - Exception in org.eclipse.microprofile.faulttolerance.exceptions
The exception should be thrown when Bulkhead implementation throws an exception, e.g.
BulkheadException() - Constructor for exception org.eclipse.microprofile.faulttolerance.exceptions.BulkheadException
 
BulkheadException(Throwable) - Constructor for exception org.eclipse.microprofile.faulttolerance.exceptions.BulkheadException
 
BulkheadException(String) - Constructor for exception org.eclipse.microprofile.faulttolerance.exceptions.BulkheadException
 
BulkheadException(String, Throwable) - Constructor for exception org.eclipse.microprofile.faulttolerance.exceptions.BulkheadException
 
BYTES - Static variable in class org.eclipse.microprofile.metrics.MetricUnits

C

call() - Method in interface org.eclipse.microprofile.health.HealthCheck
 
Callback - Annotation Type in org.eclipse.microprofile.openapi.annotations.callbacks
This object represents a callback URL that will be invoked.
Callback - Interface in org.eclipse.microprofile.openapi.models.callbacks
Callback
CallbackOperation - Annotation Type in org.eclipse.microprofile.openapi.annotations.callbacks
Describes a single API callback operation.
Callbacks - Annotation Type in org.eclipse.microprofile.openapi.annotations.callbacks
This object represents an array of Callback URLs that can be invoked.
callbacks(Map<String, Callback>) - Method in interface org.eclipse.microprofile.openapi.models.Components
Sets this Components' callbacks property to the given Map containing keys and reusable callback objects.
callbacks(Map<String, Callback>) - Method in interface org.eclipse.microprofile.openapi.models.Operation
Sets this Operation's callbacks property to the given map.
CircuitBreaker - Annotation Type in org.eclipse.microprofile.faulttolerance
Define the Circuit Breaker policy
CircuitBreakerOpenException - Exception in org.eclipse.microprofile.faulttolerance.exceptions
The exception should be thrown when circuit breaker is open.
CircuitBreakerOpenException() - Constructor for exception org.eclipse.microprofile.faulttolerance.exceptions.CircuitBreakerOpenException
 
CircuitBreakerOpenException(Throwable) - Constructor for exception org.eclipse.microprofile.faulttolerance.exceptions.CircuitBreakerOpenException
 
CircuitBreakerOpenException(String) - Constructor for exception org.eclipse.microprofile.faulttolerance.exceptions.CircuitBreakerOpenException
 
CircuitBreakerOpenException(String, Throwable) - Constructor for exception org.eclipse.microprofile.faulttolerance.exceptions.CircuitBreakerOpenException
 
Claim - Annotation Type in org.eclipse.microprofile.jwt
Annotation used to signify an injection point for a ClaimValue from a JsonWebToken
claim(String) - Method in interface org.eclipse.microprofile.jwt.JsonWebToken
A utility method to access a claim value in an Optional wrapper
ClaimLiteral - Class in org.eclipse.microprofile.jwt
Annotation literal for Claim
ClaimLiteral() - Constructor for class org.eclipse.microprofile.jwt.ClaimLiteral
Creates a default value Claim literal
ClaimLiteral(String) - Constructor for class org.eclipse.microprofile.jwt.ClaimLiteral
Construct a Claim literal from a string name of a claim
ClaimLiteral(Claims) - Constructor for class org.eclipse.microprofile.jwt.ClaimLiteral
Construct a Claim literal from a standard claim defined in Claims
Claims - Enum in org.eclipse.microprofile.jwt
This enum represents the standardized claims that the MP-JWT specification allows for in terms of interoperability.
ClaimValue<T> - Interface in org.eclipse.microprofile.jwt
A representation of a claim in a JsonWebToken
cleanupApplicationMetrics() - Method in class org.eclipse.microprofile.metrics.tck.GlobalTagsTest
 
clientCredentials(OAuthFlow) - Method in interface org.eclipse.microprofile.openapi.models.security.OAuthFlows
OAuth Client Credential flow; previously called application in OpenAPI 2.0
ClientTracingRegistrar - Class in org.eclipse.microprofile.opentracing
This class registers tracing components into ClientBuilder.
ClientTracingRegistrarProvider - Interface in org.eclipse.microprofile.opentracing
Implementation of this interface will be used to configure ClientBuilder when ClientTracingRegistrar.configure(ClientBuilder) is called.
close() - Method in interface org.eclipse.microprofile.metrics.Timer.Context
Equivalent to calling Timer.Context.stop().
Components - Annotation Type in org.eclipse.microprofile.openapi.annotations
Describes the Components object that holds various reusable objects for different aspects of the OpenAPI Specification (OAS).
Components - Interface in org.eclipse.microprofile.openapi.models
Components
components(Components) - Method in interface org.eclipse.microprofile.openapi.models.OpenAPI
Sets this OpenAPI instance's components property to the given components.
Config - Interface in org.eclipse.microprofile.config
Resolves the property value by searching through all configured ConfigSources.
CONFIG_ORDINAL - Static variable in interface org.eclipse.microprofile.config.spi.ConfigSource
 
ConfigBuilder - Interface in org.eclipse.microprofile.config.spi
Builder for manually creating an instance of a Config.
ConfigProperty - Annotation Type in org.eclipse.microprofile.config.inject
Binds the injection point with a configured value.
ConfigProvider - Class in org.eclipse.microprofile.config
This is the central class to access a Config.
ConfigProviderResolver - Class in org.eclipse.microprofile.config.spi
This class is not intended to be used by end-users but for portable container integration purpose only.
ConfigProviderResolver() - Constructor for class org.eclipse.microprofile.config.spi.ConfigProviderResolver
 
ConfigSource - Interface in org.eclipse.microprofile.config.spi
Implement this interfaces to provide a ConfigSource.
ConfigSourceProvider - Interface in org.eclipse.microprofile.config.spi
Implement this interfaces to provide multiple ConfigSources.
configure(ClientBuilder) - Static method in class org.eclipse.microprofile.opentracing.ClientTracingRegistrar
Register tracing components into client builder instance.
configure(ClientBuilder, ExecutorService) - Static method in class org.eclipse.microprofile.opentracing.ClientTracingRegistrar
Register tracing components into client builder instance.
configure(ClientBuilder) - Method in interface org.eclipse.microprofile.opentracing.ClientTracingRegistrarProvider
Configures ClientBuilder with tracing integration.
configure(ClientBuilder, ExecutorService) - Method in interface org.eclipse.microprofile.opentracing.ClientTracingRegistrarProvider
Configures ClientBuilder with tracing integration.
Constructible - Interface in org.eclipse.microprofile.openapi.models
Marker interface for OpenAPI model objects that can be constructed by the OASFactory.
Contact - Annotation Type in org.eclipse.microprofile.openapi.annotations.info
Contact information for the exposed API.
Contact - Interface in org.eclipse.microprofile.openapi.models.info
This interface represents the Contact information for the exposed API.
contact(Contact) - Method in interface org.eclipse.microprofile.openapi.models.info.Info
Sets this Info instance's contact information for the exposed API and returns this instance of Info.
containsClaim(String) - Method in interface org.eclipse.microprofile.jwt.JsonWebToken
Verify is a given claim exists
Content - Annotation Type in org.eclipse.microprofile.openapi.annotations.media
This object provides schema and examples for a particular media type.
content(Content) - Method in interface org.eclipse.microprofile.openapi.models.headers.Header
Sets this Header's content property to the given object.
Content - Interface in org.eclipse.microprofile.openapi.models.media
Content
content(Content) - Method in interface org.eclipse.microprofile.openapi.models.parameters.Parameter
Sets the content property of a Parameter instance to the given object.
content(Content) - Method in interface org.eclipse.microprofile.openapi.models.parameters.RequestBody
Sets the content of this instance of RequestBody, where the keys in content are media type names and the values describe it.
content(Content) - Method in interface org.eclipse.microprofile.openapi.models.responses.APIResponse
Sets the map containing descriptions of potential response payload for this instance of ApiResponse and returns this ApiResponse instance.
contentType(String) - Method in interface org.eclipse.microprofile.openapi.models.media.Encoding
The Content-Type for encoding a specific property.
convert(String) - Method in interface org.eclipse.microprofile.config.spi.Converter
Configure the string value to a specified type
Converter<T> - Interface in org.eclipse.microprofile.config.spi
Interface for converting configured values from String to any Java type.
Counted - Annotation Type in org.eclipse.microprofile.metrics.annotation
An annotation for marking a method, constructor, or class as counted.
Counter - Interface in org.eclipse.microprofile.metrics
An incrementing and decrementing counter metric.
counter(String) - Method in class org.eclipse.microprofile.metrics.MetricRegistry
Return the Counter registered under this name; or create and register a new Counter if none is registered.
counter(Metadata) - Method in class org.eclipse.microprofile.metrics.MetricRegistry
Return the Counter registered under the Metadata's name; or create and register a new Counter if none is registered.
CounterTest - Class in org.eclipse.microprofile.metrics.tck
 
CounterTest() - Constructor for class org.eclipse.microprofile.metrics.tck.CounterTest
 
Counting - Interface in org.eclipse.microprofile.metrics
An interface for metric types which have counts.
createDeployment() - Static method in class org.eclipse.microprofile.metrics.tck.CounterTest
 
createDeployment() - Static method in class org.eclipse.microprofile.metrics.tck.GaugeTest
 
createDeployment() - Static method in class org.eclipse.microprofile.metrics.tck.GlobalTagsTest
 
createDeployment() - Static method in class org.eclipse.microprofile.metrics.tck.HistogramTest
 
createDeployment() - Static method in class org.eclipse.microprofile.metrics.tck.MeterTest
 
createDeployment() - Static method in class org.eclipse.microprofile.metrics.tck.MetricFilterTest
 
createDeployment() - Static method in class org.eclipse.microprofile.metrics.tck.MetricRegistryTest
 
createDeployment() - Static method in class org.eclipse.microprofile.metrics.tck.TagsTest
 
createDeployment() - Static method in class org.eclipse.microprofile.metrics.tck.TimerTest
 
createObject(Class<T>) - Static method in class org.eclipse.microprofile.openapi.OASFactory
This method creates a new instance of a constructible element from the OpenAPI model tree.
createObject(Class<T>) - Method in class org.eclipse.microprofile.openapi.spi.OASFactoryResolver
Create a new instance of a constructible element from the OpenAPI model tree.
createResponseBuilder() - Method in interface org.eclipse.microprofile.health.spi.HealthCheckResponseProvider
 

D

DAYS - Static variable in class org.eclipse.microprofile.metrics.MetricUnits
dec() - Method in interface org.eclipse.microprofile.metrics.Counter
Decrement the counter by one.
dec(long) - Method in interface org.eclipse.microprofile.metrics.Counter
Decrement the counter by n.
decrementLongTest() - Method in class org.eclipse.microprofile.metrics.tck.CounterTest
 
decrementTest() - Method in class org.eclipse.microprofile.metrics.tck.CounterTest
 
DEFAULT() - Constructor for class org.eclipse.microprofile.faulttolerance.Fallback.DEFAULT
 
DEFAULT - Static variable in interface org.eclipse.microprofile.openapi.models.responses.APIResponses
 
DEFAULT_ORDINAL - Static variable in interface org.eclipse.microprofile.config.spi.ConfigSource
 
DEFAULT_PRIORITY - Static variable in interface org.eclipse.microprofile.rest.client.ext.ResponseExceptionMapper
 
defaultValue(Object) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
Set the default value property of this Schema instance to the value given.
defaultValue(APIResponse) - Method in interface org.eclipse.microprofile.openapi.models.responses.APIResponses
Sets the default documentation of responses for this instance of ApiResponses and return this instance of ApiResponses.
defaultValue(String) - Method in interface org.eclipse.microprofile.openapi.models.servers.ServerVariable
The default value to use for substitution, and to send, if an alternate value is not supplied.
DELETE(Operation) - Method in interface org.eclipse.microprofile.openapi.models.PathItem
Sets this PathItem's delete property to the given operation.
deprecated(Boolean) - Method in interface org.eclipse.microprofile.openapi.models.headers.Header
Sets this Header's deprecated property to the given value.
deprecated(Boolean) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
Sets the deprecated property of this Schema.
deprecated(Boolean) - Method in interface org.eclipse.microprofile.openapi.models.Operation
Sets this Operation's deprecated property to the given value.
deprecated(Boolean) - Method in interface org.eclipse.microprofile.openapi.models.parameters.Parameter
Sets the deprecated property of a Parameter instance to the given value.
description(String) - Method in interface org.eclipse.microprofile.openapi.models.examples.Example
Sets this Example's description property to the given string.
description(String) - Method in interface org.eclipse.microprofile.openapi.models.ExternalDocumentation
Sets this ExternalDocumentation's description property to the given string.
description(String) - Method in interface org.eclipse.microprofile.openapi.models.headers.Header
Sets this Header's description property to the given string.
description(String) - Method in interface org.eclipse.microprofile.openapi.models.info.Info
Sets this Info instance's description for the application to the given description and returns this instance of Info.
description(String) - Method in interface org.eclipse.microprofile.openapi.models.links.Link
Sets this Link's description property to the given string.
description(String) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
Sets the description property of this Schema to the given string.
description(String) - Method in interface org.eclipse.microprofile.openapi.models.Operation
Sets this Operation's description property to the given string.
description(String) - Method in interface org.eclipse.microprofile.openapi.models.parameters.Parameter
Sets the description property of a Parameter instance to the given string.
description(String) - Method in interface org.eclipse.microprofile.openapi.models.parameters.RequestBody
Sets the description of this RequestBody and return this instance of RequestBody
description(String) - Method in interface org.eclipse.microprofile.openapi.models.PathItem
Sets this PathItem's description property to the given string.
description(String) - Method in interface org.eclipse.microprofile.openapi.models.responses.APIResponse
Sets the description of this instance of ApiResponse and returns this ApiResponse instance.
description(String) - Method in interface org.eclipse.microprofile.openapi.models.security.SecurityScheme
A short description for security schema.
description(String) - Method in interface org.eclipse.microprofile.openapi.models.servers.Server
This method sets the description property of a Server instance to the given description parameter and returns the modified instance.
description(String) - Method in interface org.eclipse.microprofile.openapi.models.servers.ServerVariable
This method sets the description property of ServerVariable instance to the given description argument and returns the modeified instance.
description(String) - Method in interface org.eclipse.microprofile.openapi.models.tags.Tag
Sets the description property of a Tag instance to the given string.
Discriminator - Interface in org.eclipse.microprofile.openapi.models.media
Discriminator
discriminator(Discriminator) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
Sets the discriminator property of this Schema instance to the given object.
DiscriminatorMapping - Annotation Type in org.eclipse.microprofile.openapi.annotations.media
This object maps payload values to a particular Schema.
down() - Method in class org.eclipse.microprofile.health.HealthCheckResponseBuilder
 
dump(OutputStream) - Method in class org.eclipse.microprofile.metrics.Snapshot
Writes the values of the snapshot to the given stream.

E

email(String) - Method in interface org.eclipse.microprofile.openapi.models.info.Contact
Sets this Contact instance's contact email to the given email and returns this instance of Contact
Encoding - Annotation Type in org.eclipse.microprofile.openapi.annotations.media
Single encoding definition to be applied to single Schema Object
Encoding - Interface in org.eclipse.microprofile.openapi.models.media
Encoding
encoding(Map<String, Encoding>) - Method in interface org.eclipse.microprofile.openapi.models.media.MediaType
Sets encoding property of a MediaType instance to the given map object.
Encoding.Style - Enum in org.eclipse.microprofile.openapi.models.media
 
enumeration(List<Object>) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
 
enumeration(List<String>) - Method in interface org.eclipse.microprofile.openapi.models.servers.ServerVariable
This method sets the enumeration property of ServerVariable instance to the given enumeration argument and returns the modified instance.
Example - Interface in org.eclipse.microprofile.openapi.models.examples
Example
example(Object) - Method in interface org.eclipse.microprofile.openapi.models.headers.Header
Sets this Header's example property to the given object.
example(Object) - Method in interface org.eclipse.microprofile.openapi.models.media.MediaType
Sets the example property of a MediaType instance to the given value.
example(Object) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
Sets the example property of this Schema instance.
example(Object) - Method in interface org.eclipse.microprofile.openapi.models.parameters.Parameter
Sets the example property of a Parameter instance to the given object.
ExampleObject - Annotation Type in org.eclipse.microprofile.openapi.annotations.media
This object illustrates an example of a particular content
examples(Map<String, Example>) - Method in interface org.eclipse.microprofile.openapi.models.Components
Sets this Components' examples property to the given Map containing keys and reusable example objects.
examples(Map<String, Example>) - Method in interface org.eclipse.microprofile.openapi.models.headers.Header
Sets the examples property of this Header instance to the given map.
examples(Map<String, Example>) - Method in interface org.eclipse.microprofile.openapi.models.media.MediaType
Sets the examples field of a MediaType instance to the given map object.
examples(Map<String, Example>) - Method in interface org.eclipse.microprofile.openapi.models.parameters.Parameter
Sets the examples property of a Parameter instance to the given value.
exclusiveMaximum(Boolean) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
Sets the exclusiveMaximum property of this Schema instance to the value given.
exclusiveMinimum(Boolean) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
Sets the exclusiveMinimum property of this Schema instance to the value given.
execute() - Method in class org.eclipse.microprofile.maven.pdf.PdfArtifactMojo
 
ExecutionContext - Interface in org.eclipse.microprofile.faulttolerance
The execution context for the method being executed.
executorService(ExecutorService) - Method in interface org.eclipse.microprofile.rest.client.RestClientBuilder
Specifies the ExecutorService to use when invoking asynchronous Rest Client interface methods.
Explode - Enum in org.eclipse.microprofile.openapi.annotations.enums
Enumeration used to define the value of Explode property.
explode(Boolean) - Method in interface org.eclipse.microprofile.openapi.models.headers.Header
Sets this Header's explode property to the given value.
explode(Boolean) - Method in interface org.eclipse.microprofile.openapi.models.media.Encoding
When this is true, property values of type array or object generate separate parameters for each value of the array, or key-value-pair of the map.
explode(Boolean) - Method in interface org.eclipse.microprofile.openapi.models.parameters.Parameter
Sets the explode property of a Parameter instance to the given value.
Extensible - Interface in org.eclipse.microprofile.openapi.models
The base interface for OpenAPI model objects that can contain extensions.
Extension - Annotation Type in org.eclipse.microprofile.openapi.annotations.extensions
An optionally named list of extension properties.
Extensions - Annotation Type in org.eclipse.microprofile.openapi.annotations.extensions
This object represents an array of extensions that can be added to the element.
EXTENSIONS_PREFIX - Static variable in class org.eclipse.microprofile.openapi.OASConfig
Recommended prefix for vendor specific configuration properties.
externalDocs(ExternalDocumentation) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
Sets the externalDocs property of this Schema to the indicated value.
externalDocs(ExternalDocumentation) - Method in interface org.eclipse.microprofile.openapi.models.OpenAPI
Sets this OpenAPI instance's externalDocs property to the given object.
externalDocs(ExternalDocumentation) - Method in interface org.eclipse.microprofile.openapi.models.Operation
Sets this Operation's externalDocs property to the given object.
externalDocs(ExternalDocumentation) - Method in interface org.eclipse.microprofile.openapi.models.tags.Tag
Sets the externalDocs property of a Tag instance to the given object.
ExternalDocumentation - Annotation Type in org.eclipse.microprofile.openapi.annotations
This annotation allows referencing an external resource for extended documentation.
ExternalDocumentation - Interface in org.eclipse.microprofile.openapi.models
ExternalDocumentation
externalValue(String) - Method in interface org.eclipse.microprofile.openapi.models.examples.Example
Sets this Example's externalValue property to the given string.

F

Fallback - Annotation Type in org.eclipse.microprofile.faulttolerance
The fallback annotation to define the fallback handler class so that a failure can be handled properly.
Fallback.DEFAULT - Class in org.eclipse.microprofile.faulttolerance
Create a default class so the value is not required to be set all the time.
FallbackHandler<T> - Interface in org.eclipse.microprofile.faulttolerance
The handler instance used by the container to service a fallback invocation is a non-contextual instance created using the CDI SPI.
FaultToleranceDefinitionException - Exception in org.eclipse.microprofile.faulttolerance.exceptions
The exception should be thrown when the definition of any Fault Tolerance annotations is invalid.
FaultToleranceDefinitionException() - Constructor for exception org.eclipse.microprofile.faulttolerance.exceptions.FaultToleranceDefinitionException
 
FaultToleranceDefinitionException(Throwable) - Constructor for exception org.eclipse.microprofile.faulttolerance.exceptions.FaultToleranceDefinitionException
 
FaultToleranceDefinitionException(String) - Constructor for exception org.eclipse.microprofile.faulttolerance.exceptions.FaultToleranceDefinitionException
 
FaultToleranceDefinitionException(String, Throwable) - Constructor for exception org.eclipse.microprofile.faulttolerance.exceptions.FaultToleranceDefinitionException
 
FaultToleranceException - Exception in org.eclipse.microprofile.faulttolerance.exceptions
The exception should be thrown when the maximum retries is reached or overall retry duration is reached, circuit breaker is open, timeout occurred.
FaultToleranceException() - Constructor for exception org.eclipse.microprofile.faulttolerance.exceptions.FaultToleranceException
 
FaultToleranceException(Throwable) - Constructor for exception org.eclipse.microprofile.faulttolerance.exceptions.FaultToleranceException
 
FaultToleranceException(String) - Constructor for exception org.eclipse.microprofile.faulttolerance.exceptions.FaultToleranceException
 
FaultToleranceException(String, Throwable) - Constructor for exception org.eclipse.microprofile.faulttolerance.exceptions.FaultToleranceException
 
FILTER - Static variable in class org.eclipse.microprofile.openapi.OASConfig
Configuration property to specify the fully qualified name of the OASFilter implementation.
filterAPIResponse(APIResponse) - Method in interface org.eclipse.microprofile.openapi.OASFilter
Allows filtering of a particular APIResponse.
filterCallback(Callback) - Method in interface org.eclipse.microprofile.openapi.OASFilter
Allows filtering of a particular Callback.
filterHeader(Header) - Method in interface org.eclipse.microprofile.openapi.OASFilter
Allows filtering of a particular Header.
filterLink(Link) - Method in interface org.eclipse.microprofile.openapi.OASFilter
Allows filtering of a particular Link.
filterOpenAPI(OpenAPI) - Method in interface org.eclipse.microprofile.openapi.OASFilter
Allows filtering of the singleton OpenAPI element.
filterOperation(Operation) - Method in interface org.eclipse.microprofile.openapi.OASFilter
Allows filtering of a particular Operation.
filterParameter(Parameter) - Method in interface org.eclipse.microprofile.openapi.OASFilter
Allows filtering of a particular Parameter.
filterPathItem(PathItem) - Method in interface org.eclipse.microprofile.openapi.OASFilter
Allows filtering of a particular PathItem.
filterRequestBody(RequestBody) - Method in interface org.eclipse.microprofile.openapi.OASFilter
Allows filtering of a particular RequestBody.
filterSchema(Schema) - Method in interface org.eclipse.microprofile.openapi.OASFilter
Allows filtering of a particular Schema.
filterSecurityScheme(SecurityScheme) - Method in interface org.eclipse.microprofile.openapi.OASFilter
Allows filtering of a particular SecurityScheme.
filterServer(Server) - Method in interface org.eclipse.microprofile.openapi.OASFilter
Allows filtering of a particular Server.
filterTag(Tag) - Method in interface org.eclipse.microprofile.openapi.OASFilter
Allows filtering of a particular Tag.
flows(OAuthFlows) - Method in interface org.eclipse.microprofile.openapi.models.security.SecurityScheme
Flows is a REQUIRED property.
forClassLoader(ClassLoader) - Method in interface org.eclipse.microprofile.config.spi.ConfigBuilder
Return the ConfigBuilder for a given classloader
format(String) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
Sets the format property of this Schema instance to the given string.
from(String) - Static method in enum org.eclipse.microprofile.metrics.MetricType
Convert the string representation into an enum
from(Class<?>) - Static method in enum org.eclipse.microprofile.metrics.MetricType
Convert the metric class type into an enum
fromEnvVariable() - Method in class org.eclipse.microprofile.metrics.tck.GlobalTagsTest
This expects that there is a MP_METRICS_TAGS env variable with value 'tier=integration', as described in running_the_tck.asciidoc

G

Gauge - Annotation Type in org.eclipse.microprofile.metrics.annotation
An annotation for marking a method or field as a gauge.
Gauge<T> - Interface in org.eclipse.microprofile.metrics
A gauge metric is an instantaneous reading of a particular value.
gaugeMe() - Method in class org.eclipse.microprofile.metrics.tck.GaugeTest
 
GaugeTest - Class in org.eclipse.microprofile.metrics.tck
 
GaugeTest() - Constructor for class org.eclipse.microprofile.metrics.tck.GaugeTest
 
GET(Operation) - Method in interface org.eclipse.microprofile.openapi.models.PathItem
Sets this PathItem's get property to the given operation.
get75thPercentile() - Method in class org.eclipse.microprofile.metrics.Snapshot
Returns the value at the 75th percentile in the distribution.
get95thPercentile() - Method in class org.eclipse.microprofile.metrics.Snapshot
Returns the value at the 95th percentile in the distribution.
get98thPercentile() - Method in class org.eclipse.microprofile.metrics.Snapshot
Returns the value at the 98th percentile in the distribution.
get999thPercentile() - Method in class org.eclipse.microprofile.metrics.Snapshot
Returns the value at the 99.9th percentile in the distribution.
get99thPercentile() - Method in class org.eclipse.microprofile.metrics.Snapshot
Returns the value at the 99th percentile in the distribution.
getAdditionalProperties() - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
Returns the value of the "additionalProperties" setting, which indicates whether properties not otherwise defined are allowed.
getAllOf() - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
Returns the schemas used by the allOf property.
getAllowEmptyValue() - Method in interface org.eclipse.microprofile.openapi.models.headers.Header
Returns the allowEmptyValue property from a Header instance.
getAllowEmptyValue() - Method in interface org.eclipse.microprofile.openapi.models.parameters.Parameter
Returns the allowEmptyValue property from a Parameter instance.
getAllowReserved() - Method in interface org.eclipse.microprofile.openapi.models.media.Encoding
AllowReserved determines whether the parameter value SHOULD allow reserved characters to be encoded without percent-encoding.
getAllowReserved() - Method in interface org.eclipse.microprofile.openapi.models.parameters.Parameter
Returns the allowReserved property from a Parameter instance.
getAnyOf() - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
Returns the schemas used by the anyOf property.
getAttribute() - Method in interface org.eclipse.microprofile.openapi.models.media.XML
This method returns the attribute property of XML instance.
getAudience() - Method in interface org.eclipse.microprofile.jwt.JsonWebToken
The aud(Audience) claim identifies the recipients that the JWT is intended for.
getAuthorizationCode() - Method in interface org.eclipse.microprofile.openapi.models.security.OAuthFlows
OAuth Authorization Code flow; previously called accessCode in OpenAPI 2.0
getAuthorizationUrl() - Method in interface org.eclipse.microprofile.openapi.models.security.OAuthFlow
The authorization URL to be used for this flow.
getBearerFormat() - Method in interface org.eclipse.microprofile.openapi.models.security.SecurityScheme
bearerFormat is intended as a hint to the client to identify how the bearer token is formatted.
getBuilder() - Method in class org.eclipse.microprofile.config.spi.ConfigProviderResolver
Create a fresh ConfigBuilder instance.
getCallbacks() - Method in interface org.eclipse.microprofile.openapi.models.Components
Returns the callbacks property from a Components instance.
getCallbacks() - Method in interface org.eclipse.microprofile.openapi.models.Operation
Returns the callbacks property from an Operation instance.
getClaim(String) - Method in interface org.eclipse.microprofile.jwt.JsonWebToken
Access the value of the indicated claim.
getClaimNames() - Method in interface org.eclipse.microprofile.jwt.JsonWebToken
Access the names of all claims are associated with this token.
getClientCredentials() - Method in interface org.eclipse.microprofile.openapi.models.security.OAuthFlows
OAuth Client Credential flow; previously called application in OpenAPI 2.0
getComponents() - Method in interface org.eclipse.microprofile.openapi.models.OpenAPI
Returns the components property from an OpenAPI instance.
getConfig() - Static method in class org.eclipse.microprofile.config.ConfigProvider
Provide a Config based on all ConfigSources of the current Thread Context ClassLoader (TCCL)
getConfig(ClassLoader) - Static method in class org.eclipse.microprofile.config.ConfigProvider
Provide a Config based on all ConfigSources of the specified ClassLoader
getConfig() - Method in class org.eclipse.microprofile.config.spi.ConfigProviderResolver
 
getConfig(ClassLoader) - Method in class org.eclipse.microprofile.config.spi.ConfigProviderResolver
 
getConfigSources() - Method in interface org.eclipse.microprofile.config.Config
 
getConfigSources(ClassLoader) - Method in interface org.eclipse.microprofile.config.spi.ConfigSourceProvider
Return the collection of ConfigSources.
getContact() - Method in interface org.eclipse.microprofile.openapi.models.info.Info
Returns the contact information for the exposed API from this Info instance.
getContent() - Method in interface org.eclipse.microprofile.openapi.models.headers.Header
Returns the content property from a Header instance.
getContent() - Method in interface org.eclipse.microprofile.openapi.models.parameters.Parameter
Returns the content property from a Parameter instance.
getContent() - Method in interface org.eclipse.microprofile.openapi.models.parameters.RequestBody
Returns the content of this instance of RequestBody, where the keys in content are media type names and the values describe it.
getContent() - Method in interface org.eclipse.microprofile.openapi.models.responses.APIResponse
Returns the map containing descriptions of potential response payload for this instance of ApiResponse.
getContentType() - Method in interface org.eclipse.microprofile.openapi.models.media.Encoding
The Content-Type for encoding a specific property.
getCount() - Method in interface org.eclipse.microprofile.metrics.Counter
Returns the counter's current value.
getCount() - Method in interface org.eclipse.microprofile.metrics.Counting
Returns the current count.
getCount() - Method in interface org.eclipse.microprofile.metrics.Histogram
Returns the number of values recorded.
getCount() - Method in interface org.eclipse.microprofile.metrics.Meter
 
getCount() - Method in interface org.eclipse.microprofile.metrics.Metered
Returns the number of events which have been marked.
getCount() - Method in interface org.eclipse.microprofile.metrics.Timer
 
getCounters() - Method in class org.eclipse.microprofile.metrics.MetricRegistry
Returns a map of all the counters in the registry and their names.
getCounters(MetricFilter) - Method in class org.eclipse.microprofile.metrics.MetricRegistry
Returns a map of all the counters in the registry and their names which match the given filter.
getCountTest() - Method in class org.eclipse.microprofile.metrics.tck.CounterTest
 
getData() - Method in class org.eclipse.microprofile.health.HealthCheckResponse
 
getDefault() - Method in interface org.eclipse.microprofile.openapi.models.responses.APIResponses
Returns the default documentation of responses other than the ones declared for specific HTTP response codes in this instance of ApiResponses.
getDefaultValue() - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
Returns the default value property from this Schema instance.
getDefaultValue() - Method in interface org.eclipse.microprofile.openapi.models.servers.ServerVariable
The default value to use for substitution, and to send, if an alternate value is not supplied.
getDELETE() - Method in interface org.eclipse.microprofile.openapi.models.PathItem
Returns the delete property from a PathItem instance.
getDeprecated() - Method in interface org.eclipse.microprofile.openapi.models.headers.Header
Returns the deprecated property from a Header instance.
getDeprecated() - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
Returns the deprecated property from this Schema instance.
getDeprecated() - Method in interface org.eclipse.microprofile.openapi.models.Operation
Returns the deprecated property from an Operation instance.
getDeprecated() - Method in interface org.eclipse.microprofile.openapi.models.parameters.Parameter
Returns the deprecated property from a Parameter instance.
getDescription() - Method in enum org.eclipse.microprofile.jwt.Claims
 
getDescription() - Method in class org.eclipse.microprofile.metrics.Metadata
Returns the description of the metric.
getDescription() - Method in interface org.eclipse.microprofile.openapi.models.examples.Example
Returns the description property from an Example instance.
getDescription() - Method in interface org.eclipse.microprofile.openapi.models.ExternalDocumentation
Returns the description property from an ExternalDocumentation instance.
getDescription() - Method in interface org.eclipse.microprofile.openapi.models.headers.Header
Returns the description property from a Header instance.
getDescription() - Method in interface org.eclipse.microprofile.openapi.models.info.Info
Returns a short description for the application for this Info instance.
getDescription() - Method in interface org.eclipse.microprofile.openapi.models.links.Link
Returns the description property from a Link instance.
getDescription() - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
Returns a description of the purpose of this Schema.
getDescription() - Method in interface org.eclipse.microprofile.openapi.models.Operation
Returns the description property from an Operation instance.
getDescription() - Method in interface org.eclipse.microprofile.openapi.models.parameters.Parameter
Returns the description property from a Parameter instance.
getDescription() - Method in interface org.eclipse.microprofile.openapi.models.parameters.RequestBody
Returns the description of this instance of RequestBody.
getDescription() - Method in interface org.eclipse.microprofile.openapi.models.PathItem
Returns the description property from a PathItem instance.
getDescription() - Method in interface org.eclipse.microprofile.openapi.models.responses.APIResponse
Returns a short description of this instance of ApiResponse.
getDescription() - Method in interface org.eclipse.microprofile.openapi.models.security.SecurityScheme
A short description for security schema.
getDescription() - Method in interface org.eclipse.microprofile.openapi.models.servers.Server
This method returns the description property of Server instance.
getDescription() - Method in interface org.eclipse.microprofile.openapi.models.servers.ServerVariable
This method returns the description property of ServerVariable instance.
getDescription() - Method in interface org.eclipse.microprofile.openapi.models.tags.Tag
Returns the description property from a Tag instance.
getDiscriminator() - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
Returns the discriminator property from this Schema instance.
getDisplayName() - Method in class org.eclipse.microprofile.metrics.Metadata
Returns the display name if set, otherwise this method returns the metric name.
getEmail() - Method in interface org.eclipse.microprofile.openapi.models.info.Contact
Returns the contact email of this Contact instance.
getEncoding() - Method in interface org.eclipse.microprofile.openapi.models.media.MediaType
Returns the encoding property from a MediaType instance.
getEnumeration() - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
Returns the enumerated list of values allowed for objects defined by this Schema.
getEnumeration() - Method in interface org.eclipse.microprofile.openapi.models.servers.ServerVariable
This method returns the enumeration property of ServerVariable instance.
getExample() - Method in interface org.eclipse.microprofile.openapi.models.headers.Header
Returns the example property from a Header instance.
getExample() - Method in interface org.eclipse.microprofile.openapi.models.media.MediaType
Returns the example property from a MediaType instance.
getExample() - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
Returns the example property from this Schema instance.
getExample() - Method in interface org.eclipse.microprofile.openapi.models.parameters.Parameter
Returns the example property from a Parameter instance.
getExamples() - Method in interface org.eclipse.microprofile.openapi.models.Components
Returns the examples property from a Components instance.
getExamples() - Method in interface org.eclipse.microprofile.openapi.models.headers.Header
Returns the examples property from a Header instance.
getExamples() - Method in interface org.eclipse.microprofile.openapi.models.media.MediaType
Returns the collection of examples from a MediaType instance.
getExamples() - Method in interface org.eclipse.microprofile.openapi.models.parameters.Parameter
Returns the examples property from a Parameter instance.
getExclusiveMaximum() - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
Returns the exclusiveMaximum property from this Schema instance.
getExclusiveMinimum() - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
Returns the exclusiveMinimum property from this Schema instance.
getExpirationTime() - Method in interface org.eclipse.microprofile.jwt.JsonWebToken
The exp (Expiration time) claim identifies the expiration time on or after which the JWT MUST NOT be accepted for processing in seconds since 1970-01-01T00:00:00Z UTC
getExplode() - Method in interface org.eclipse.microprofile.openapi.models.headers.Header
Returns the explode property from a Header instance.
getExplode() - Method in interface org.eclipse.microprofile.openapi.models.media.Encoding
When this is true, property values of type array or object generate separate parameters for each value of the array, or key-value-pair of the map.
getExplode() - Method in interface org.eclipse.microprofile.openapi.models.parameters.Parameter
Returns the explode property from a Parameter instance.
getExtensions() - Method in interface org.eclipse.microprofile.openapi.models.Extensible
Returns the extensions property from an Extensible instance.
getExternalDocs() - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
Returns the externalDocs property from this Schema instance.
getExternalDocs() - Method in interface org.eclipse.microprofile.openapi.models.OpenAPI
Returns the externalDocs property from an OpenAPI instance.
getExternalDocs() - Method in interface org.eclipse.microprofile.openapi.models.Operation
Returns the externalDocs property from an Operation instance.
getExternalDocs() - Method in interface org.eclipse.microprofile.openapi.models.tags.Tag
Returns the externalDocs property from a Tag instance.
getExternalValue() - Method in interface org.eclipse.microprofile.openapi.models.examples.Example
Returns the externalValue property from an Example instance.
getFailure() - Method in interface org.eclipse.microprofile.faulttolerance.ExecutionContext
Returns the failure of the method execution
getFifteenMinuteRate() - Method in interface org.eclipse.microprofile.metrics.Meter
 
getFifteenMinuteRate() - Method in interface org.eclipse.microprofile.metrics.Metered
Returns the fifteen-minute exponentially-weighted moving average rate at which events have occurred since the meter was created.
getFifteenMinuteRate() - Method in interface org.eclipse.microprofile.metrics.Timer
 
getFiveMinuteRate() - Method in interface org.eclipse.microprofile.metrics.Meter
 
getFiveMinuteRate() - Method in interface org.eclipse.microprofile.metrics.Metered
Returns the five-minute exponentially-weighted moving average rate at which events have occurred since the meter was created.
getFiveMinuteRate() - Method in interface org.eclipse.microprofile.metrics.Timer
 
getFlows() - Method in interface org.eclipse.microprofile.openapi.models.security.SecurityScheme
Flows is a REQUIRED property.
getFormat() - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
Returns the format property from this Schema instance.
getGauges() - Method in class org.eclipse.microprofile.metrics.MetricRegistry
Returns a map of all the gauges in the registry and their names.
getGauges(MetricFilter) - Method in class org.eclipse.microprofile.metrics.MetricRegistry
Returns a map of all the gauges in the registry and their names which match the given filter.
getGET() - Method in interface org.eclipse.microprofile.openapi.models.PathItem
Returns the get property from a PathItem instance.
getGroups() - Method in interface org.eclipse.microprofile.jwt.JsonWebToken
The groups claim provides the group names the JWT principal has been granted.
getHEAD() - Method in interface org.eclipse.microprofile.openapi.models.PathItem
Returns the head property from a PathItem instance.
getHeaders() - Method in interface org.eclipse.microprofile.openapi.models.Components
Returns the headers property from a Components instance.
getHeaders() - Method in interface org.eclipse.microprofile.openapi.models.media.Encoding
Headers property of an Encoding is a map that allows additional information to be provided as headers
getHeaders() - Method in interface org.eclipse.microprofile.openapi.models.responses.APIResponse
Returns the map of Headers in this instance of ApiResponse.
getHistograms() - Method in class org.eclipse.microprofile.metrics.MetricRegistry
Returns a map of all the histograms in the registry and their names.
getHistograms(MetricFilter) - Method in class org.eclipse.microprofile.metrics.MetricRegistry
Returns a map of all the histograms in the registry and their names which match the given filter.
getImplicit() - Method in interface org.eclipse.microprofile.openapi.models.security.OAuthFlows
This method returns the implicit property from OAuthFlows instance.
getIn() - Method in interface org.eclipse.microprofile.openapi.models.parameters.Parameter
Returns the in property from a Parameter instance.
getIn() - Method in interface org.eclipse.microprofile.openapi.models.security.SecurityScheme
In is a REQUIRED property that indicates the location of the API key.
getInfo() - Method in interface org.eclipse.microprofile.openapi.models.OpenAPI
Returns the info property from an OpenAPI instance.
getIssuedAtTime() - Method in interface org.eclipse.microprofile.jwt.JsonWebToken
The iat(Issued at time) claim identifies the time at which the JWT was issued in seconds since 1970-01-01T00:00:00Z UTC
getIssuer() - Method in interface org.eclipse.microprofile.jwt.JsonWebToken
The iss(Issuer) claim identifies the principal that issued the JWT
getItems() - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
Returns the Schema used for all the elements of an array typed Schema.
getLicense() - Method in interface org.eclipse.microprofile.openapi.models.info.Info
Returns the license information for the exposed API from this Info instance.
getLinks() - Method in interface org.eclipse.microprofile.openapi.models.Components
Returns the links property from a Components instance.
getLinks() - Method in interface org.eclipse.microprofile.openapi.models.responses.APIResponse
Returns the operations links that can be followed from tis instance of ApiResponse.
getMapping() - Method in interface org.eclipse.microprofile.openapi.models.media.Discriminator
Returns the mapping property from a Discriminator instance.
getMax() - Method in class org.eclipse.microprofile.metrics.Snapshot
Returns the highest value in the snapshot.
getMaximum() - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
Returns the maximum property from this Schema instance.
getMaxItems() - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
Returns the maxItems property from this Schema instance.
getMaxLength() - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
Returns the maxLength property from this Schema instance.
getMaxProperties() - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
Returns the maxProperties property from this Schema instance.
getMean() - Method in class org.eclipse.microprofile.metrics.Snapshot
Returns the arithmetic mean of the values in the snapshot.
getMeanRate() - Method in interface org.eclipse.microprofile.metrics.Meter
 
getMeanRate() - Method in interface org.eclipse.microprofile.metrics.Metered
Returns the mean rate at which events have occurred since the meter was created.
getMeanRate() - Method in interface org.eclipse.microprofile.metrics.Timer
 
getMedian() - Method in class org.eclipse.microprofile.metrics.Snapshot
Returns the median value in the distribution.
getMetadata() - Method in class org.eclipse.microprofile.metrics.MetricRegistry
Returns a map of all the metadata in the registry and their names.
getMeters() - Method in class org.eclipse.microprofile.metrics.MetricRegistry
Returns a map of all the meters in the registry and their names.
getMeters(MetricFilter) - Method in class org.eclipse.microprofile.metrics.MetricRegistry
Returns a map of all the meters in the registry and their names which match the given filter.
getMethod() - Method in interface org.eclipse.microprofile.faulttolerance.ExecutionContext
Returns the method being executed
getMetrics() - Method in class org.eclipse.microprofile.metrics.MetricRegistry
Returns a map of all the metrics in the registry and their names.
getMin() - Method in class org.eclipse.microprofile.metrics.Snapshot
Returns the lowest value in the snapshot.
getMinimum() - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
Returns the minimum property from this Schema instance.
getMinItems() - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
Returns the minItems property from this Schema instance.
getMinLength() - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
Returns the minLength property from this Schema instance.
getMinProperties() - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
Returns the minProperties property from this Schema instance.
getMultipleOf() - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
Returns the multipleOf property from this Schema instance.
getName() - Method in interface org.eclipse.microprofile.config.spi.ConfigSource
The name of the config might be used for logging or analysis of configured values.
getName() - Method in class org.eclipse.microprofile.health.HealthCheckResponse
 
getName() - Method in interface org.eclipse.microprofile.jwt.ClaimValue
Access the name of the claim.
getName() - Method in interface org.eclipse.microprofile.jwt.JsonWebToken
Returns the unique name of this principal.
getName() - Method in class org.eclipse.microprofile.metrics.Metadata
Returns the metric name.
getName() - Method in enum org.eclipse.microprofile.metrics.MetricRegistry.Type
Returns the name of the MetricRegistry scope.
getName() - Method in interface org.eclipse.microprofile.openapi.models.info.Contact
Returns the identifying name of this Contact instance.
getName() - Method in interface org.eclipse.microprofile.openapi.models.info.License
Returns the license name for this License instance that is used for the API.
getName() - Method in interface org.eclipse.microprofile.openapi.models.media.XML
This method returns the name property from XML instance.
getName() - Method in interface org.eclipse.microprofile.openapi.models.parameters.Parameter
Returns the name property from a Parameter instance.
getName() - Method in interface org.eclipse.microprofile.openapi.models.security.SecurityScheme
Name is a REQUIRED property - this is the name of the header, query or cookie parameter to be used.
getName() - Method in interface org.eclipse.microprofile.openapi.models.tags.Tag
Returns the name property from a Tag instance.
getNames() - Method in class org.eclipse.microprofile.metrics.MetricRegistry
Returns a set of the names of all the metrics in the registry.
getNamespace() - Method in interface org.eclipse.microprofile.openapi.models.media.XML
This method returns the namespace property of XML instance.
getNot() - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
Returns a Schema which describes properties not allowed in objects defined by the current schema.
getNullable() - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
Returns the nullable property from this Schema instance which indicates whether null is a valid value.
getOneMinuteRate() - Method in interface org.eclipse.microprofile.metrics.Meter
 
getOneMinuteRate() - Method in interface org.eclipse.microprofile.metrics.Metered
Returns the one-minute exponentially-weighted moving average rate at which events have occurred since the meter was created.
getOneMinuteRate() - Method in interface org.eclipse.microprofile.metrics.Timer
 
getOneOf() - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
Returns the schemas used by the oneOf property.
getOpenapi() - Method in interface org.eclipse.microprofile.openapi.models.OpenAPI
Returns the openapi property from an OpenAPI instance.
getOpenIdConnectUrl() - Method in interface org.eclipse.microprofile.openapi.models.security.SecurityScheme
openIdConnectUrl is a REQUIRED property.
getOperationId() - Method in interface org.eclipse.microprofile.openapi.models.links.Link
Returns the operationId property for this instance of Link.
getOperationId() - Method in interface org.eclipse.microprofile.openapi.models.Operation
Returns the operationId property from an Operation instance.
getOperationRef() - Method in interface org.eclipse.microprofile.openapi.models.links.Link
Returns the operationRef property from a Link instance.
getOptionalValue(String, Class<T>) - Method in interface org.eclipse.microprofile.config.Config
Return the resolved property value with the specified type for the specified property name from the underlying ConfigSources.
getOPTIONS() - Method in interface org.eclipse.microprofile.openapi.models.PathItem
Returns the options property from a PathItem instance.
getOrdinal() - Method in interface org.eclipse.microprofile.config.spi.ConfigSource
Return the ordinal for this config source.
getParameters() - Method in interface org.eclipse.microprofile.faulttolerance.ExecutionContext
Returns the parameter values being passed to the method
getParameters() - Method in interface org.eclipse.microprofile.openapi.models.Components
Returns the parameters property from a Components instance.
getParameters() - Method in interface org.eclipse.microprofile.openapi.models.links.Link
Returns the parameters property from this instance of Link.
getParameters() - Method in interface org.eclipse.microprofile.openapi.models.Operation
Returns the parameters property from an Operation instance.
getParameters() - Method in interface org.eclipse.microprofile.openapi.models.PathItem
Returns the parameters property from this PathItem instance.
getPassword() - Method in interface org.eclipse.microprofile.openapi.models.security.OAuthFlows
OAuth Resource Owner Password flow
getPATCH() - Method in interface org.eclipse.microprofile.openapi.models.PathItem
Returns the patch property from a PathItem instance.
getPaths() - Method in interface org.eclipse.microprofile.openapi.models.OpenAPI
Returns the paths property from an OpenAPI instance.
getPattern() - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
Returns the pattern property from this Schema instance.
getPOST() - Method in interface org.eclipse.microprofile.openapi.models.PathItem
Returns the post property from a PathItem instance.
getPrefix() - Method in interface org.eclipse.microprofile.openapi.models.media.XML
This method returns the prefix property of XML instance.
getPriority() - Method in interface org.eclipse.microprofile.rest.client.ext.ResponseExceptionMapper
The priority of this mapper.
getProperties() - Method in interface org.eclipse.microprofile.config.spi.ConfigSource
Return the properties in this config source
getProperties() - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
Returns the properties defined in this Schema.
getPropertyName() - Method in interface org.eclipse.microprofile.openapi.models.media.Discriminator
Returns the propertyName property from a Discriminator instance.
getPropertyNames() - Method in interface org.eclipse.microprofile.config.Config
Return a collection of property names.
getPropertyNames() - Method in interface org.eclipse.microprofile.config.spi.ConfigSource
Gets all property names known to this config source, without evaluating the values.
getPUT() - Method in interface org.eclipse.microprofile.openapi.models.PathItem
Returns the put property from a PathItem instance.
getRawToken() - Method in interface org.eclipse.microprofile.jwt.JsonWebToken
Get the raw bearer token string originally passed in the authentication header
getReadOnly() - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
Returns the readOnly property from this Schema instance.
getRef() - Method in interface org.eclipse.microprofile.openapi.models.Reference
Returns the reference property from this Reference instance.
getRefreshUrl() - Method in interface org.eclipse.microprofile.openapi.models.security.OAuthFlow
The URL to be used for obtaining refresh tokens.
getRequestBodies() - Method in interface org.eclipse.microprofile.openapi.models.Components
Returns the requestBodies property from a Components instance.
getRequestBody() - Method in interface org.eclipse.microprofile.openapi.models.links.Link
Returns the requestBody property from a Link instance.
getRequestBody() - Method in interface org.eclipse.microprofile.openapi.models.Operation
Returns the requestBody property from an Operation instance.
getRequired() - Method in interface org.eclipse.microprofile.openapi.models.headers.Header
Returns the required property from a Header instance.
getRequired() - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
Returns the required property from this Schema instance.
getRequired() - Method in interface org.eclipse.microprofile.openapi.models.parameters.Parameter
Returns the required property from a Parameter instance.
getRequired() - Method in interface org.eclipse.microprofile.openapi.models.parameters.RequestBody
Returns whether this instance of RequestBody is required for the operation.
getResponses() - Method in interface org.eclipse.microprofile.openapi.models.Components
Returns the responses property from a Components instance.
getResponses() - Method in interface org.eclipse.microprofile.openapi.models.Operation
Returns the responses property from an Operation instance.
getSchema() - Method in interface org.eclipse.microprofile.openapi.models.headers.Header
Returns the schema property from a Header instance.
getSchema() - Method in interface org.eclipse.microprofile.openapi.models.media.MediaType
Returns the schema property from a MediaType instance.
getSchema() - Method in interface org.eclipse.microprofile.openapi.models.parameters.Parameter
Returns the schema property from a Parameter instance.
getSchemas() - Method in interface org.eclipse.microprofile.openapi.models.Components
Returns the schemas property from a Components instance.
getScheme() - Method in interface org.eclipse.microprofile.openapi.models.security.SecurityScheme
Schema is a REQUIRED property that is the name of the HTTP Authorization scheme to be used in the Authorization header as defined in RFC7235.
getScopes() - Method in interface org.eclipse.microprofile.openapi.models.security.OAuthFlow
The available scopes for the OAuth2 security scheme.
getSecurity() - Method in interface org.eclipse.microprofile.openapi.models.OpenAPI
Returns the security property from an OpenAPI instance.
getSecurity() - Method in interface org.eclipse.microprofile.openapi.models.Operation
Returns the security property from an Operation instance.
getSecuritySchemes() - Method in interface org.eclipse.microprofile.openapi.models.Components
Returns the securitySchemes property from a Components instance.
getServer() - Method in interface org.eclipse.microprofile.openapi.models.links.Link
Returns the server property from a Link instance.
getServers() - Method in interface org.eclipse.microprofile.openapi.models.OpenAPI
Returns the Servers defined in the API
getServers() - Method in interface org.eclipse.microprofile.openapi.models.Operation
Returns the servers property from an Operation instance.
getServers() - Method in interface org.eclipse.microprofile.openapi.models.PathItem
Returns the servers property from a PathItem instance.
getSnapshot() - Method in interface org.eclipse.microprofile.metrics.Histogram
 
getSnapshot() - Method in interface org.eclipse.microprofile.metrics.Sampling
Returns a snapshot of the values.
getSnapshot() - Method in interface org.eclipse.microprofile.metrics.Timer
 
getState() - Method in class org.eclipse.microprofile.health.HealthCheckResponse
 
getStdDev() - Method in class org.eclipse.microprofile.metrics.Snapshot
Returns the standard deviation of the values in the snapshot.
getStyle() - Method in interface org.eclipse.microprofile.openapi.models.headers.Header
Returns the style property from a Header instance.
getStyle() - Method in interface org.eclipse.microprofile.openapi.models.media.Encoding
Style describes how the encoding value will be serialized depending on the type of the parameter value.
getStyle() - Method in interface org.eclipse.microprofile.openapi.models.parameters.Parameter
Returns the style property from a Parameter instance.
getSubject() - Method in interface org.eclipse.microprofile.jwt.JsonWebToken
The sub(Subject) claim identifies the principal that is the subject of the JWT.
getSummary() - Method in interface org.eclipse.microprofile.openapi.models.examples.Example
Returns the summary property from an Example instance.
getSummary() - Method in interface org.eclipse.microprofile.openapi.models.Operation
Returns the summary property from an Operation instance.
getSummary() - Method in interface org.eclipse.microprofile.openapi.models.PathItem
Returns the summary property from a PathItem instance.
getTags() - Method in class org.eclipse.microprofile.metrics.Metadata
Returns the underlying HashMap containing the tags.
getTags() - Method in interface org.eclipse.microprofile.openapi.models.OpenAPI
Returns the tags property from an OpenAPI instance.
getTags() - Method in interface org.eclipse.microprofile.openapi.models.Operation
Returns the tags property from an Operation instance.
getTagsAsString() - Method in class org.eclipse.microprofile.metrics.Metadata
Gets the list of tags as a single String in the format 'key="value",key2="value2",...'
getTermsOfService() - Method in interface org.eclipse.microprofile.openapi.models.info.Info
Returns the URL to the Terms of Service for the API for this instance of Info.
getTimers() - Method in class org.eclipse.microprofile.metrics.MetricRegistry
Returns a map of all the timers in the registry and their names.
getTimers(MetricFilter) - Method in class org.eclipse.microprofile.metrics.MetricRegistry
Returns a map of all the timers in the registry and their names which match the given filter.
getTitle() - Method in interface org.eclipse.microprofile.openapi.models.info.Info
Returns the title for the application for this instance of Info
getTitle() - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
Returns the title property from this Schema instance.
getTokenID() - Method in interface org.eclipse.microprofile.jwt.JsonWebToken
The jti(JWT ID) claim provides a unique identifier for the JWT.
getTokenUrl() - Method in interface org.eclipse.microprofile.openapi.models.security.OAuthFlow
The token URL to be used for this flow.
getTRACE() - Method in interface org.eclipse.microprofile.openapi.models.PathItem
Returns the trace property from a PathItem instance.
getType() - Method in enum org.eclipse.microprofile.jwt.Claims
The required type of the claim
getType() - Method in class org.eclipse.microprofile.metrics.Metadata
Returns the String representation of the MetricType.
getType() - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
Returns the type property from this Schema.
getType() - Method in interface org.eclipse.microprofile.openapi.models.security.SecurityScheme
Type is a REQUIRED property that specifies the type of SecurityScheme instance.
getTypeRaw() - Method in class org.eclipse.microprofile.metrics.Metadata
Returns the MetricType of the metric
getUniqueItems() - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
Returns the uniqueItems property from this Schema instance.
getUnit() - Method in class org.eclipse.microprofile.metrics.Metadata
Returns the unit of the metric.
getUrl() - Method in interface org.eclipse.microprofile.openapi.models.ExternalDocumentation
Returns the url property from an ExternalDocumentation instance.
getUrl() - Method in interface org.eclipse.microprofile.openapi.models.info.Contact
Returns the URL pointing to the contact information for this Contact instance.
getUrl() - Method in interface org.eclipse.microprofile.openapi.models.info.License
Returns the URL for this License instance that is used for the API.
getUrl() - Method in interface org.eclipse.microprofile.openapi.models.servers.Server
This method returns the url property of Server instance, which is a URL to the target host.
getValue(String, Class<T>) - Method in interface org.eclipse.microprofile.config.Config
Return the resolved property value with the specified type for the specified property name from the underlying ConfigSources.
getValue(String) - Method in interface org.eclipse.microprofile.config.spi.ConfigSource
Return the value for the specified property in this config source.
getValue() - Method in interface org.eclipse.microprofile.jwt.ClaimValue
Access the value of the claim.
getValue() - Method in interface org.eclipse.microprofile.metrics.Gauge
Returns the metric's current value.
getValue(double) - Method in class org.eclipse.microprofile.metrics.Snapshot
Returns the value at the given quantile.
getValue() - Method in interface org.eclipse.microprofile.openapi.models.examples.Example
Returns the value property from an Example instance.
getValues() - Method in class org.eclipse.microprofile.metrics.Snapshot
Returns the entire set of values in the snapshot.
getVariables() - Method in interface org.eclipse.microprofile.openapi.models.servers.Server
This method returns the variables property of Server instance.
getVersion() - Method in interface org.eclipse.microprofile.openapi.models.info.Info
Returns the version of the OpenAPI document for this Info instance.
getWrapped() - Method in interface org.eclipse.microprofile.openapi.models.media.XML
This method returns the wrapped property of XML instance.
getWriteOnly() - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
Returns the writeOnly property from this Schema instance.
getXml() - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
Returns the xml property from this Schema instance.
GIBIBITS - Static variable in class org.eclipse.microprofile.metrics.MetricUnits
GIGABITS - Static variable in class org.eclipse.microprofile.metrics.MetricUnits
GIGABYTES - Static variable in class org.eclipse.microprofile.metrics.MetricUnits
GLOBAL_TAGS_VARIABLE - Static variable in class org.eclipse.microprofile.metrics.Metadata
The environment variable used to pass in global tags.
GlobalTagsTest - Class in org.eclipse.microprofile.metrics.tck
Test for obtaining global tags from MP_METRICS_TAGS env variable.
GlobalTagsTest() - Constructor for class org.eclipse.microprofile.metrics.tck.GlobalTagsTest
 

H

handle(ExecutionContext) - Method in class org.eclipse.microprofile.faulttolerance.Fallback.DEFAULT
 
handle(ExecutionContext) - Method in interface org.eclipse.microprofile.faulttolerance.FallbackHandler
Handle the previous calling failure and then call alternative methods or perform any alternative operations.
handles(int, <any>) - Method in interface org.eclipse.microprofile.rest.client.ext.ResponseExceptionMapper
Whether or not this mapper will be used for the given response.
hashCode() - Method in class org.eclipse.microprofile.metrics.Metadata
 
HEAD(Operation) - Method in interface org.eclipse.microprofile.openapi.models.PathItem
Sets this PathItem's head property to the given operation.
Header - Annotation Type in org.eclipse.microprofile.openapi.annotations.headers
Describes a single header object
Header - Interface in org.eclipse.microprofile.openapi.models.headers
Header
Header.Style - Enum in org.eclipse.microprofile.openapi.models.headers
Controls the style of serialization.
headers(Map<String, Header>) - Method in interface org.eclipse.microprofile.openapi.models.Components
Sets this Components' headers property to the given Map containing keys and reusable header objects.
headers(Map<String, Header>) - Method in interface org.eclipse.microprofile.openapi.models.media.Encoding
Headers property of an Encoding is a map that allows additional information to be provided as headers
headers(Map<String, Header>) - Method in interface org.eclipse.microprofile.openapi.models.responses.APIResponse
Sets the Headers for this instance of ApiResponse with the given map of Headers and returns this instance of ApiResponse.
Health - Annotation Type in org.eclipse.microprofile.health
Created by hbraun on 24.08.17.
HealthCheck - Interface in org.eclipse.microprofile.health
The health check procedure interface.
HealthCheckResponse - Class in org.eclipse.microprofile.health
The response to a health check invocation.
HealthCheckResponse() - Constructor for class org.eclipse.microprofile.health.HealthCheckResponse
 
HealthCheckResponse.State - Enum in org.eclipse.microprofile.health
 
HealthCheckResponseBuilder - Class in org.eclipse.microprofile.health
A builder to construct a health procedure response.
HealthCheckResponseBuilder() - Constructor for class org.eclipse.microprofile.health.HealthCheckResponseBuilder
 
HealthCheckResponseProvider - Interface in org.eclipse.microprofile.health.spi
Reserved for implementors as means to supply their own HealthCheckResponseBuilder.
Histogram - Interface in org.eclipse.microprofile.metrics
A metric which calculates the distribution of a value.
histogram(String) - Method in class org.eclipse.microprofile.metrics.MetricRegistry
Return the Histogram registered under this name; or create and register a new Histogram if none is registered.
histogram(Metadata) - Method in class org.eclipse.microprofile.metrics.MetricRegistry
Return the Histogram registered under the Metadata's name; or create and register a new Histogram if none is registered.
HistogramTest - Class in org.eclipse.microprofile.metrics.tck
 
HistogramTest() - Constructor for class org.eclipse.microprofile.metrics.tck.HistogramTest
 
HOURS - Static variable in class org.eclipse.microprofile.metrics.MetricUnits

I

implicit(OAuthFlow) - Method in interface org.eclipse.microprofile.openapi.models.security.OAuthFlows
This method sets the implicit property of OAuthFlows instance to the given implicit argument and returns the modified instance.
in(Parameter.In) - Method in interface org.eclipse.microprofile.openapi.models.parameters.Parameter
Sets the in property of a Parameter instance to the given value.
in(SecurityScheme.In) - Method in interface org.eclipse.microprofile.openapi.models.security.SecurityScheme
In is a REQUIRED property that indicates the location of the API key.
inc() - Method in interface org.eclipse.microprofile.metrics.Counter
Increment the counter by one.
inc(long) - Method in interface org.eclipse.microprofile.metrics.Counter
Increment the counter by n.
incrementLongTest() - Method in class org.eclipse.microprofile.metrics.tck.CounterTest
 
incrementTest() - Method in class org.eclipse.microprofile.metrics.tck.CounterTest
 
Info - Annotation Type in org.eclipse.microprofile.openapi.annotations.info
This annotation provides metadata about the API, and maps to the Info object in OpenAPI Specification 3.
Info - Interface in org.eclipse.microprofile.openapi.models.info
This interface represents all the metadata about the API.
info(Info) - Method in interface org.eclipse.microprofile.openapi.models.OpenAPI
Sets this OpenAPI instance's info property to the given object.
initData() - Method in class org.eclipse.microprofile.metrics.tck.HistogramTest
 
initData() - Method in class org.eclipse.microprofile.metrics.tck.TimerTest
 
instance() - Static method in class org.eclipse.microprofile.config.spi.ConfigProviderResolver
Creates a ConfigProviderResolver object Only used internally from within ConfigProvider
instance() - Static method in class org.eclipse.microprofile.openapi.spi.OASFactoryResolver
Creates an OASFactoryResolver object.
instance() - Static method in class org.eclipse.microprofile.rest.client.spi.RestClientBuilderResolver
Gets or creates a RestClientBuilderResolver instance.
isReusable() - Method in class org.eclipse.microprofile.metrics.Metadata
Can the metric be reused (i.e.
ISSUER - Static variable in interface org.eclipse.microprofile.jwt.config.Names
The expected iss claim value to validate against an MP-JWT.
items(Schema) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
Set the Schema used for all the elements of an array typed Schema.

J

JsonWebToken - Interface in org.eclipse.microprofile.jwt
A read-only interface for the the claims required by Eclipse MicroProfile conforming tokens.

K

KIBIBITS - Static variable in class org.eclipse.microprofile.metrics.MetricUnits
KILOBITS - Static variable in class org.eclipse.microprofile.metrics.MetricUnits
KILOBYTES - Static variable in class org.eclipse.microprofile.metrics.MetricUnits

L

License - Annotation Type in org.eclipse.microprofile.openapi.annotations.info
License information for the exposed API.
license(License) - Method in interface org.eclipse.microprofile.openapi.models.info.Info
Sets this Info's license information for the exposed API and returns this instance of Info.
License - Interface in org.eclipse.microprofile.openapi.models.info
This interface represents the License information for the exposed API.
Link - Annotation Type in org.eclipse.microprofile.openapi.annotations.links
The Link object represents a possible design-time link for a response.
Link - Interface in org.eclipse.microprofile.openapi.models.links
Link
LinkParameter - Annotation Type in org.eclipse.microprofile.openapi.annotations.links
Represents a parameter to pass to an operation as specified with operationId or identified via operationRef.
links(Map<String, Link>) - Method in interface org.eclipse.microprofile.openapi.models.Components
Sets this Components' links property to the given Map containing keys and reusable link objects.
links(Map<String, Link>) - Method in interface org.eclipse.microprofile.openapi.models.responses.APIResponse
Sets the operations links that can be followed from this instance of ApiResponse.
LITERAL - Static variable in annotation type org.eclipse.microprofile.rest.client.inject.RestClient
 
LoginConfig - Annotation Type in org.eclipse.microprofile.auth
A security annotation describing the authentication method, and the associated realm name that should be used for this application.

M

mapping(Map<String, String>) - Method in interface org.eclipse.microprofile.openapi.models.media.Discriminator
Sets this Discriminator's mapping property to the given map object.
mark() - Method in interface org.eclipse.microprofile.metrics.Meter
Mark the occurrence of an event.
mark(long) - Method in interface org.eclipse.microprofile.metrics.Meter
Mark the occurrence of a given number of events.
matches(String, Metric) - Method in interface org.eclipse.microprofile.metrics.MetricFilter
Returns true if the metric matches the filter; false otherwise.
maximum(BigDecimal) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
Sets the maximum property of this Schema instance to the value given.
maxItems(Integer) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
Sets the maxItems property of this Schema instance to the value given.
maxLength(Integer) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
Sets the maxLength property of this Schema instance to the value given.
maxProperties(Integer) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
Sets the maxProperties property of this Schema instance to the value given.
MEBIBITS - Static variable in class org.eclipse.microprofile.metrics.MetricUnits
MediaType - Interface in org.eclipse.microprofile.openapi.models.media
MediaType
MEGABITS - Static variable in class org.eclipse.microprofile.metrics.MetricUnits
MEGABYTES - Static variable in class org.eclipse.microprofile.metrics.MetricUnits
Metadata - Class in org.eclipse.microprofile.metrics
Bean holding the metadata of one single metric.
Metadata(String, MetricType) - Constructor for class org.eclipse.microprofile.metrics.Metadata
Constructs a Metadata object with default units
Metadata(String, MetricType, String) - Constructor for class org.eclipse.microprofile.metrics.Metadata
Constructs a Metadata object
Metadata(String, String, String, MetricType, String) - Constructor for class org.eclipse.microprofile.metrics.Metadata
Constructs a Metadata object
Metadata(String, String, String, MetricType, String, String) - Constructor for class org.eclipse.microprofile.metrics.Metadata
Constructs a Metadata object
Metadata(Map<String, String>) - Constructor for class org.eclipse.microprofile.metrics.Metadata
Constructs a Metadata object from a map with the following keys name - The name of the metric displayName - The display (friendly) name of the metric description - The description of the metric type - The type of the metric unit - The units of the metric tags - The tags of the metric - cannot be null reusable - If true, this metric name is permitted to be used at multiple registration points.
Meter - Interface in org.eclipse.microprofile.metrics
A meter metric which measures mean throughput and one-, five-, and fifteen-minute exponentially-weighted moving average throughputs.
meter(String) - Method in class org.eclipse.microprofile.metrics.MetricRegistry
Return the Meter registered under this name; or create and register a new Meter if none is registered.
meter(Metadata) - Method in class org.eclipse.microprofile.metrics.MetricRegistry
Return the Meter registered under the Metadata's name; or create and register a new Meter if none is registered.
Metered - Annotation Type in org.eclipse.microprofile.metrics.annotation
An annotation for marking a method, constructor, or class as metered.
Metered - Interface in org.eclipse.microprofile.metrics
An object which maintains mean and exponentially-weighted rate.
MeterTest - Class in org.eclipse.microprofile.metrics.tck
 
MeterTest() - Constructor for class org.eclipse.microprofile.metrics.tck.MeterTest
 
Metric - Annotation Type in org.eclipse.microprofile.metrics.annotation
An annotation requesting that a metric be injected or registered.
Metric - Interface in org.eclipse.microprofile.metrics
A tag interface to indicate that a class is a metric.
MetricFilter - Interface in org.eclipse.microprofile.metrics
A filter used to determine whether or not a metric should be reported, among other things.
MetricFilterTest - Class in org.eclipse.microprofile.metrics.tck
 
MetricFilterTest() - Constructor for class org.eclipse.microprofile.metrics.tck.MetricFilterTest
 
MetricRegistry - Class in org.eclipse.microprofile.metrics
The registry that stores metrics and their metadata.
MetricRegistry() - Constructor for class org.eclipse.microprofile.metrics.MetricRegistry
 
MetricRegistry.Type - Enum in org.eclipse.microprofile.metrics
An enumeration representing the scopes of the MetricRegistry
MetricRegistryTest - Class in org.eclipse.microprofile.metrics.tck
 
MetricRegistryTest() - Constructor for class org.eclipse.microprofile.metrics.tck.MetricRegistryTest
 
MetricType - Enum in org.eclipse.microprofile.metrics
An enumeration representing the different types of metrics.
MetricUnits - Class in org.eclipse.microprofile.metrics
Standard units constants for metric's Metadata.
MICROSECONDS - Static variable in class org.eclipse.microprofile.metrics.MetricUnits
MILLISECONDS - Static variable in class org.eclipse.microprofile.metrics.MetricUnits
minimum(BigDecimal) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
Sets the minimum property of this Schema instance to the value given.
minItems(Integer) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
Sets the minItems property of this Schema instance to the value given.
minLength(Integer) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
Sets the minLength property of this Schema instance to the value given.
minProperties(Integer) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
Sets the minProperties property of this Schema instance to the value given.
MINUTES - Static variable in class org.eclipse.microprofile.metrics.MetricUnits
MODEL_READER - Static variable in class org.eclipse.microprofile.openapi.OASConfig
Configuration property to specify the fully qualified name of the OASModelReader implementation.
multipleOf(BigDecimal) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
Sets the multipleOf property of this Schema instance to the value given.

N

name(String) - Method in class org.eclipse.microprofile.health.HealthCheckResponseBuilder
 
name(String, String...) - Static method in class org.eclipse.microprofile.metrics.MetricRegistry
Concatenates elements to form a dotted name, eliding any null values or empty strings.
name(Class<?>, String...) - Static method in class org.eclipse.microprofile.metrics.MetricRegistry
Concatenates a class name and elements to form a dotted name, eliding any null values or empty strings.
name(String) - Method in interface org.eclipse.microprofile.openapi.models.info.Contact
Sets this Contact instance's identifying name to the given name and returns this instance of Contact.
name(String) - Method in interface org.eclipse.microprofile.openapi.models.info.License
Sets this License instance's name used for the API and returns this instance of License.
name(String) - Method in interface org.eclipse.microprofile.openapi.models.media.XML
This method sets the name property of XML instance to the given String argument and returns the modified instance.
name(String) - Method in interface org.eclipse.microprofile.openapi.models.parameters.Parameter
Sets the name property of a Parameter instance to the given string.
name(String) - Method in interface org.eclipse.microprofile.openapi.models.security.SecurityScheme
Name is a REQUIRED property - this is the name of the header, query or cookie parameter to be used.
name(String) - Method in interface org.eclipse.microprofile.openapi.models.tags.Tag
Sets the name property of a Tag instance to the given string.
named(String) - Static method in class org.eclipse.microprofile.health.HealthCheckResponse
 
Names - Interface in org.eclipse.microprofile.jwt.config
Constants for the names of the MP-config properties that MP-JWT implementations must support externalization of to ensure portable setup of MP-JWT implementations.
namespace(String) - Method in interface org.eclipse.microprofile.openapi.models.media.XML
This method sets the namespace property of XML instance to the given String argument and returns the modified instance.
nameTest() - Method in class org.eclipse.microprofile.metrics.tck.MetricRegistryTest
 
NANOSECONDS - Static variable in class org.eclipse.microprofile.metrics.MetricUnits
newBuilder() - Static method in interface org.eclipse.microprofile.rest.client.RestClientBuilder
 
newBuilder() - Method in class org.eclipse.microprofile.rest.client.spi.RestClientBuilderResolver
Creates a new RestClientBuilder instance.
newInterceptor() - Method in interface org.eclipse.microprofile.rest.client.ext.AsyncInvocationInterceptorFactory
Implementations of this method should return an implementation of the AsyncInvocationInterceptor interface.
NONE - Static variable in class org.eclipse.microprofile.metrics.MetricUnits
No unit
not(Schema) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
Sets the not property to a Schema which describes properties not allowed in objects defined by the current schema.
nullable(Boolean) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
Sets the nullable property of this Schema instance.

O

OASConfig - Class in org.eclipse.microprofile.openapi
Configurable properties in MicroProfile OpenAPI
OASFactory - Class in org.eclipse.microprofile.openapi
This class allows application developers to build new OpenAPI model elements.
OASFactoryResolver - Class in org.eclipse.microprofile.openapi.spi
This class is not intended to be used by end-users.
OASFactoryResolver() - Constructor for class org.eclipse.microprofile.openapi.spi.OASFactoryResolver
 
OASFilter - Interface in org.eclipse.microprofile.openapi
This interface allows application developers to filter different parts of the OpenAPI model tree.
OASModelReader - Interface in org.eclipse.microprofile.openapi
This interface allows application developers to programmatically contribute an OpenAPI model tree.
OAuthFlow - Annotation Type in org.eclipse.microprofile.openapi.annotations.security
Configuration details for a supported OAuth Flow.
OAuthFlow - Interface in org.eclipse.microprofile.openapi.models.security
Configuration details for a supportde OAuthFlow
OAuthFlows - Annotation Type in org.eclipse.microprofile.openapi.annotations.security
Allows configuration of the supported OAuth Flows.
OAuthFlows - Interface in org.eclipse.microprofile.openapi.models.security
Configuration of the supported OAuthFlows
OAuthScope - Annotation Type in org.eclipse.microprofile.openapi.annotations.security
Represents an OAuth scope.
oneOf(List<Schema>) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
Sets the schemas used by the oneOf property of this Schema.
onNewBuilder(RestClientBuilder) - Method in interface org.eclipse.microprofile.rest.client.spi.RestClientBuilderListener
 
OpenAPI - Interface in org.eclipse.microprofile.openapi.models
OpenAPI
openapi(String) - Method in interface org.eclipse.microprofile.openapi.models.OpenAPI
Sets this OpenAPI instance's openapi property to the given string.
OpenAPIDefinition - Annotation Type in org.eclipse.microprofile.openapi.annotations
OpenAPI
openIdConnectUrl(String) - Method in interface org.eclipse.microprofile.openapi.models.security.SecurityScheme
penIdConnectUrl is a REQUIRED property.
Operation - Annotation Type in org.eclipse.microprofile.openapi.annotations
Describes a single API operation on a path.
Operation - Interface in org.eclipse.microprofile.openapi.models
Operation
operationId(String) - Method in interface org.eclipse.microprofile.openapi.models.links.Link
Sets this Link's operationId property to the given string.
operationId(String) - Method in interface org.eclipse.microprofile.openapi.models.Operation
Sets this Operation's operationId property to the given string.
operationRef(String) - Method in interface org.eclipse.microprofile.openapi.models.links.Link
Sets this Link's operationRef property to the given string.
OPTIONS(Operation) - Method in interface org.eclipse.microprofile.openapi.models.PathItem
Sets this PathItem's options property to the given operation.
org.eclipse.microprofile.auth - package org.eclipse.microprofile.auth
Metadata for JWT RBAC for Microprofile
org.eclipse.microprofile.config - package org.eclipse.microprofile.config
Configuration for Java Microprofile
org.eclipse.microprofile.config.inject - package org.eclipse.microprofile.config.inject
CDI Support for Microprofile Config
org.eclipse.microprofile.config.spi - package org.eclipse.microprofile.config.spi
This package contains classes which are used to extend the standard functionality in a portable way.
org.eclipse.microprofile.faulttolerance - package org.eclipse.microprofile.faulttolerance
CDI Support for Microprofile Fault Tolerance
org.eclipse.microprofile.faulttolerance.exceptions - package org.eclipse.microprofile.faulttolerance.exceptions
Exceptions for Microprofile Fault Tolerance
org.eclipse.microprofile.health - package org.eclipse.microprofile.health
Microprofile Service Health Checks
org.eclipse.microprofile.health.spi - package org.eclipse.microprofile.health.spi
Microprofile Service Health Checks
org.eclipse.microprofile.jwt - package org.eclipse.microprofile.jwt
Interoperable JWT RBAC for Microprofile
org.eclipse.microprofile.jwt.config - package org.eclipse.microprofile.jwt.config
 
org.eclipse.microprofile.maven.pdf - package org.eclipse.microprofile.maven.pdf
 
org.eclipse.microprofile.metrics - package org.eclipse.microprofile.metrics
MicroProfile Metrics
org.eclipse.microprofile.metrics.annotation - package org.eclipse.microprofile.metrics.annotation
This package contains the annotations used for MicroProfile Metrics.
org.eclipse.microprofile.metrics.tck - package org.eclipse.microprofile.metrics.tck
 
org.eclipse.microprofile.openapi - package org.eclipse.microprofile.openapi
Copyright (c) 2017 Contributors to the Eclipse Foundation
org.eclipse.microprofile.openapi.annotations - package org.eclipse.microprofile.openapi.annotations
Copyright (c) 2017 Contributors to the Eclipse Foundation
org.eclipse.microprofile.openapi.annotations.callbacks - package org.eclipse.microprofile.openapi.annotations.callbacks
Copyright (c) 2017 Contributors to the Eclipse Foundation
org.eclipse.microprofile.openapi.annotations.enums - package org.eclipse.microprofile.openapi.annotations.enums
Copyright (c) 2017 Contributors to the Eclipse Foundation
org.eclipse.microprofile.openapi.annotations.extensions - package org.eclipse.microprofile.openapi.annotations.extensions
Copyright (c) 2017 Contributors to the Eclipse Foundation
org.eclipse.microprofile.openapi.annotations.headers - package org.eclipse.microprofile.openapi.annotations.headers
Copyright (c) 2017 Contributors to the Eclipse Foundation
org.eclipse.microprofile.openapi.annotations.info - package org.eclipse.microprofile.openapi.annotations.info
Copyright (c) 2017 Contributors to the Eclipse Foundation
org.eclipse.microprofile.openapi.annotations.links - package org.eclipse.microprofile.openapi.annotations.links
Copyright (c) 2017 Contributors to the Eclipse Foundation
org.eclipse.microprofile.openapi.annotations.media - package org.eclipse.microprofile.openapi.annotations.media
Copyright (c) 2017 Contributors to the Eclipse Foundation
org.eclipse.microprofile.openapi.annotations.parameters - package org.eclipse.microprofile.openapi.annotations.parameters
Copyright (c) 2017 Contributors to the Eclipse Foundation
org.eclipse.microprofile.openapi.annotations.responses - package org.eclipse.microprofile.openapi.annotations.responses
Copyright (c) 2017 Contributors to the Eclipse Foundation
org.eclipse.microprofile.openapi.annotations.security - package org.eclipse.microprofile.openapi.annotations.security
Copyright (c) 2017 Contributors to the Eclipse Foundation
org.eclipse.microprofile.openapi.annotations.servers - package org.eclipse.microprofile.openapi.annotations.servers
Copyright (c) 2017 Contributors to the Eclipse Foundation
org.eclipse.microprofile.openapi.annotations.tags - package org.eclipse.microprofile.openapi.annotations.tags
Copyright (c) 2017 Contributors to the Eclipse Foundation
org.eclipse.microprofile.openapi.models - package org.eclipse.microprofile.openapi.models
Copyright (c) 2017 Contributors to the Eclipse Foundation
org.eclipse.microprofile.openapi.models.callbacks - package org.eclipse.microprofile.openapi.models.callbacks
Copyright (c) 2017 Contributors to the Eclipse Foundation
org.eclipse.microprofile.openapi.models.examples - package org.eclipse.microprofile.openapi.models.examples
Copyright (c) 2017 Contributors to the Eclipse Foundation
org.eclipse.microprofile.openapi.models.headers - package org.eclipse.microprofile.openapi.models.headers
Copyright (c) 2017 Contributors to the Eclipse Foundation
org.eclipse.microprofile.openapi.models.info - package org.eclipse.microprofile.openapi.models.info
Copyright (c) 2017 Contributors to the Eclipse Foundation
org.eclipse.microprofile.openapi.models.links - package org.eclipse.microprofile.openapi.models.links
Copyright (c) 2017 Contributors to the Eclipse Foundation
org.eclipse.microprofile.openapi.models.media - package org.eclipse.microprofile.openapi.models.media
Copyright (c) 2017 Contributors to the Eclipse Foundation
org.eclipse.microprofile.openapi.models.parameters - package org.eclipse.microprofile.openapi.models.parameters
Copyright (c) 2017 Contributors to the Eclipse Foundation
org.eclipse.microprofile.openapi.models.responses - package org.eclipse.microprofile.openapi.models.responses
Copyright (c) 2017 Contributors to the Eclipse Foundation
org.eclipse.microprofile.openapi.models.security - package org.eclipse.microprofile.openapi.models.security
Copyright (c) 2017 Contributors to the Eclipse Foundation
org.eclipse.microprofile.openapi.models.servers - package org.eclipse.microprofile.openapi.models.servers
Copyright (c) 2017 Contributors to the Eclipse Foundation
org.eclipse.microprofile.openapi.models.tags - package org.eclipse.microprofile.openapi.models.tags
Copyright (c) 2017 Contributors to the Eclipse Foundation
org.eclipse.microprofile.openapi.spi - package org.eclipse.microprofile.openapi.spi
Copyright (c) 2017 Contributors to the Eclipse Foundation
org.eclipse.microprofile.opentracing - package org.eclipse.microprofile.opentracing
CDI Support for Microprofile OpenTracing.
org.eclipse.microprofile.rest.client - package org.eclipse.microprofile.rest.client
APIs for building a type-safe RESTful client leveraging existing JAX-RS APIs, for example:
org.eclipse.microprofile.rest.client.annotation - package org.eclipse.microprofile.rest.client.annotation
APIs for annotating MP Rest Client interfaces.
org.eclipse.microprofile.rest.client.ext - package org.eclipse.microprofile.rest.client.ext
APIs for extending MP Rest Client functionality - such as new providers.
org.eclipse.microprofile.rest.client.inject - package org.eclipse.microprofile.rest.client.inject
APIs to aid in CDI-based injection of MP Rest Client implementations.
org.eclipse.microprofile.rest.client.spi - package org.eclipse.microprofile.rest.client.spi
SPIs for MP Rest Client implementations or system-level components that provide additional functionality for MP Rest Clients.

P

Parameter - Annotation Type in org.eclipse.microprofile.openapi.annotations.parameters
Describes a single operation parameter
Parameter - Interface in org.eclipse.microprofile.openapi.models.parameters
Parameter
Parameter.In - Enum in org.eclipse.microprofile.openapi.models.parameters
The values allowed for the in field.
Parameter.Style - Enum in org.eclipse.microprofile.openapi.models.parameters
The values allowed for the style field.
ParameterIn - Enum in org.eclipse.microprofile.openapi.annotations.enums
 
Parameters - Annotation Type in org.eclipse.microprofile.openapi.annotations.parameters
This object encapsulates input parameters
parameters(Map<String, Parameter>) - Method in interface org.eclipse.microprofile.openapi.models.Components
Sets this Components' parameters property to the given Map containing keys and reusable parameter objects.
parameters(Map<String, Object>) - Method in interface org.eclipse.microprofile.openapi.models.links.Link
Sets this Link's parameters property to the given map and returns the modified Link instance.
parameters(List<Parameter>) - Method in interface org.eclipse.microprofile.openapi.models.Operation
Sets this Operation's parameters property to the given parameter list.
parameters(List<Parameter>) - Method in interface org.eclipse.microprofile.openapi.models.PathItem
Sets this PathItem's parameters property to the given list.
ParameterStyle - Enum in org.eclipse.microprofile.openapi.annotations.enums
 
password(OAuthFlow) - Method in interface org.eclipse.microprofile.openapi.models.security.OAuthFlows
OAuth Resource Owner Password flow
PATCH(Operation) - Method in interface org.eclipse.microprofile.openapi.models.PathItem
Sets this PathItem's patch property to the given operation.
path(String, PathItem) - Method in interface org.eclipse.microprofile.openapi.models.OpenAPI
Adds the given path item to this OpenAPI instance's list of paths
PathItem - Interface in org.eclipse.microprofile.openapi.models
PathItem
PathItem.HttpMethod - Enum in org.eclipse.microprofile.openapi.models
All of the possible types of HTTP operations for this path
paths(Paths) - Method in interface org.eclipse.microprofile.openapi.models.OpenAPI
Sets this OpenAPI instance's paths property to the given paths.
Paths - Interface in org.eclipse.microprofile.openapi.models
Paths
pattern(String) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
Sets the pattern property of this Schema instance to the string given.
PdfArtifactMojo - Class in org.eclipse.microprofile.maven.pdf
Turns existing PDF file into the main project artifact.
PdfArtifactMojo() - Constructor for class org.eclipse.microprofile.maven.pdf.PdfArtifactMojo
 
PER_SECOND - Static variable in class org.eclipse.microprofile.metrics.MetricUnits
Represent per second
PERCENT - Static variable in class org.eclipse.microprofile.metrics.MetricUnits
Represents percentage
POST(Operation) - Method in interface org.eclipse.microprofile.openapi.models.PathItem
Sets this PathItem's post property to the given operation.
prefix(String) - Method in interface org.eclipse.microprofile.openapi.models.media.XML
This method sets the prefix property of XML instance to the given String argument and returns the modified instance.
prepareContext() - Method in interface org.eclipse.microprofile.rest.client.ext.AsyncInvocationInterceptor
This method will be invoked by the MP Rest Client runtime on the "main" thread (i.e.
properties(Map<String, Schema>) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
Sets the properties of this Schema instance to the map provided.
propertyName(String) - Method in interface org.eclipse.microprofile.openapi.models.media.Discriminator
Sets this Discriminator's propertyName property to the given string.
PUT(Operation) - Method in interface org.eclipse.microprofile.openapi.models.PathItem
Sets this PathItem's put property to the given operation.

R

readOnly(Boolean) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
Sets the readOnly property of this Schema.
readOperations() - Method in interface org.eclipse.microprofile.openapi.models.PathItem
Returns a list of all the operations for this path item.
readOperationsMap() - Method in interface org.eclipse.microprofile.openapi.models.PathItem
Returns a map with all the operations for this path where the keys are HttpMethods.
ref(String) - Method in interface org.eclipse.microprofile.openapi.models.Reference
Sets this Reference's reference property to the given string.
Reference<T extends Reference<T>> - Interface in org.eclipse.microprofile.openapi.models
Base interface for OpenAPI model objects that can make reference to other objects.
refreshUrl(String) - Method in interface org.eclipse.microprofile.openapi.models.security.OAuthFlow
The URL to be used for obtaining refresh tokens.
register(String, T) - Method in class org.eclipse.microprofile.metrics.MetricRegistry
Given a Metric, registers it under the given name.
register(String, T, Metadata) - Method in class org.eclipse.microprofile.metrics.MetricRegistry
Deprecated.
As of version 1.1, use MetricRegistry.register(Metadata, Metric) instead
register(Metadata, T) - Method in class org.eclipse.microprofile.metrics.MetricRegistry
Given a Metric, registers it under the provided Metadata.
registerConfig(Config, ClassLoader) - Method in class org.eclipse.microprofile.config.spi.ConfigProviderResolver
Register a given Config within the Application (or Module) identified by the given ClassLoader.
RegisterProvider - Annotation Type in org.eclipse.microprofile.rest.client.annotation
When annotation is placed at the interface level of a REST API definition, the providers listed will be registered upon proxying.
RegisterProviders - Annotation Type in org.eclipse.microprofile.rest.client.annotation
When annotation is placed at the interface level of a REST API definition, the providers listed will be registered upon proxying.
RegisterRestClient - Annotation Type in org.eclipse.microprofile.rest.client.inject
A marker annotation to register a rest client at runtime.
registerTest() - Method in class org.eclipse.microprofile.metrics.tck.MetricRegistryTest
 
RegistryType - Annotation Type in org.eclipse.microprofile.metrics.annotation
Qualifies the type of Metric Registry to inject.
releaseConfig(Config) - Method in class org.eclipse.microprofile.config.spi.ConfigProviderResolver
A Config normally gets released if the Application it is associated with gets destroyed.
remove(String) - Method in class org.eclipse.microprofile.metrics.MetricRegistry
Removes the metric with the given name.
removeMatching(MetricFilter) - Method in class org.eclipse.microprofile.metrics.MetricRegistry
Removes all metrics which match the given filter.
removeTest() - Method in class org.eclipse.microprofile.metrics.tck.MetricRegistryTest
 
requestBodies(Map<String, RequestBody>) - Method in interface org.eclipse.microprofile.openapi.models.Components
Sets this Components' requestBodies property to the given Map containing keys and reusable request body objects.
RequestBody - Annotation Type in org.eclipse.microprofile.openapi.annotations.parameters
Describes a single request body.
requestBody(Object) - Method in interface org.eclipse.microprofile.openapi.models.links.Link
Sets this Link's requestBody property to the given object.
requestBody(RequestBody) - Method in interface org.eclipse.microprofile.openapi.models.Operation
Sets this Operation's requestBody property to the given object.
RequestBody - Interface in org.eclipse.microprofile.openapi.models.parameters
This interface represents the request body of an operation in which body parameters can be specified.
required(Boolean) - Method in interface org.eclipse.microprofile.openapi.models.headers.Header
Sets this Header's required property to the given value.
required(List<String>) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
Sets the list of fields required in objects defined by this Schema.
required(Boolean) - Method in interface org.eclipse.microprofile.openapi.models.parameters.Parameter
Sets the required property of a Parameter instance to the given value.
required(Boolean) - Method in interface org.eclipse.microprofile.openapi.models.parameters.RequestBody
Sets whether this instance of RequestBody is required or not and returns this instance of RequestBody
ResponseExceptionMapper<T extends java.lang.Throwable> - Interface in org.eclipse.microprofile.rest.client.ext
Converts an JAX-RS Response object into an Exception.
responses(Map<String, APIResponse>) - Method in interface org.eclipse.microprofile.openapi.models.Components
Sets this Components' responses property to the given Map containing keys and reusable response objects.
responses(APIResponses) - Method in interface org.eclipse.microprofile.openapi.models.Operation
Sets this Operation's responses property to the given responses.
RestClient - Annotation Type in org.eclipse.microprofile.rest.client.inject
Use the RestClient qualifier on an injection to point to indicate that this injection point is meant to use an instance of a Type-Safe Rest Client.
RestClient.RestClientLiteral - Class in org.eclipse.microprofile.rest.client.inject
 
RestClientBuilder - Interface in org.eclipse.microprofile.rest.client
This is the main entry point for creating a Type Safe Rest Client.
RestClientBuilderListener - Interface in org.eclipse.microprofile.rest.client.spi
Implementations of this interface will be notified when new RestClientBuilder instances are being constructed.
RestClientBuilderResolver - Class in org.eclipse.microprofile.rest.client.spi
Resolver for a RestClientBuilder implementation.
RestClientBuilderResolver() - Constructor for class org.eclipse.microprofile.rest.client.spi.RestClientBuilderResolver
 
RestClientDefinitionException - Exception in org.eclipse.microprofile.rest.client
This exception is thrown when the MicroProfile Rest Client implementation attempts to build a client using an invalid interface.
RestClientDefinitionException() - Constructor for exception org.eclipse.microprofile.rest.client.RestClientDefinitionException
 
RestClientDefinitionException(String) - Constructor for exception org.eclipse.microprofile.rest.client.RestClientDefinitionException
 
RestClientDefinitionException(String, Throwable) - Constructor for exception org.eclipse.microprofile.rest.client.RestClientDefinitionException
 
RestClientDefinitionException(Throwable) - Constructor for exception org.eclipse.microprofile.rest.client.RestClientDefinitionException
 
RestClientLiteral() - Constructor for class org.eclipse.microprofile.rest.client.inject.RestClient.RestClientLiteral
 
Retry - Annotation Type in org.eclipse.microprofile.faulttolerance
The Retry annotation to define the number of the retries and the fallback method on reaching the retry counts.

S

Sampling - Interface in org.eclipse.microprofile.metrics
An object which samples values.
SCAN_CLASSES - Static variable in class org.eclipse.microprofile.openapi.OASConfig
Configuration property to specify the list of classes to scan.
SCAN_DISABLE - Static variable in class org.eclipse.microprofile.openapi.OASConfig
Configuration property to disable annotation scanning.
SCAN_EXCLUDE_CLASSES - Static variable in class org.eclipse.microprofile.openapi.OASConfig
Configuration property to specify the list of classes to exclude from scans.
SCAN_EXCLUDE_PACKAGES - Static variable in class org.eclipse.microprofile.openapi.OASConfig
Configuration property to specify the list of packages to exclude from scans.
SCAN_PACKAGES - Static variable in class org.eclipse.microprofile.openapi.OASConfig
Configuration property to specify the list of packages to scan.
Schema - Annotation Type in org.eclipse.microprofile.openapi.annotations.media
The Schema Object allows the definition of input and output data types.
schema(Schema) - Method in interface org.eclipse.microprofile.openapi.models.headers.Header
Sets this Header's schema property to the given object.
schema(Schema) - Method in interface org.eclipse.microprofile.openapi.models.media.MediaType
Sets the schema field of a MediaType instance to the given schema object.
Schema - Interface in org.eclipse.microprofile.openapi.models.media
The Schema Object allows the definition of input and output data types.
schema(Schema) - Method in interface org.eclipse.microprofile.openapi.models.parameters.Parameter
Sets the schema property of a Parameter instance to the given value.
Schema.SchemaType - Enum in org.eclipse.microprofile.openapi.models.media
The values allowed for the in field.
schemas(Map<String, Schema>) - Method in interface org.eclipse.microprofile.openapi.models.Components
Sets this Components' schemas property to the given Map containing keys and reusable schemas.
SchemaType - Enum in org.eclipse.microprofile.openapi.annotations.enums
 
scheme(String) - Method in interface org.eclipse.microprofile.openapi.models.security.SecurityScheme
Schema is a REQUIRED property that is the name of the HTTP Authorization scheme to be used in the Authorization header as defined in RFC7235.
scopes(Scopes) - Method in interface org.eclipse.microprofile.openapi.models.security.OAuthFlow
The available scopes for the OAuth2 security scheme.
Scopes - Interface in org.eclipse.microprofile.openapi.models.security
Scopes is a property of OAuth Flow Object.
SECONDS - Static variable in class org.eclipse.microprofile.metrics.MetricUnits
Represents seconds
security(List<SecurityRequirement>) - Method in interface org.eclipse.microprofile.openapi.models.OpenAPI
Sets this OpenAPI instance's security property to the given list.
security(List<SecurityRequirement>) - Method in interface org.eclipse.microprofile.openapi.models.Operation
Sets this Operation's security property to the given list.
SecurityRequirement - Annotation Type in org.eclipse.microprofile.openapi.annotations.security
Specifies a security requirement for an operation.
SecurityRequirement - Interface in org.eclipse.microprofile.openapi.models.security
SecurityRequirement
SecurityRequirements - Annotation Type in org.eclipse.microprofile.openapi.annotations.security
This object represents an array of security requirements that can be specified for the operation or at definition level.
SecurityRequirementsSet - Annotation Type in org.eclipse.microprofile.openapi.annotations.security
This object represents a map of security requirements that can be specified for the operation or at definition level.
SecurityScheme - Annotation Type in org.eclipse.microprofile.openapi.annotations.security
Defines a security scheme that can be used by the operations.
SecurityScheme - Interface in org.eclipse.microprofile.openapi.models.security
SecurityScheme
SecurityScheme.In - Enum in org.eclipse.microprofile.openapi.models.security
In is a REQUIRED property that specifies the location of the API key.
SecurityScheme.Type - Enum in org.eclipse.microprofile.openapi.models.security
Type is a REQUIRED property that specifies the type of SecurityScheme instance.
SecuritySchemeIn - Enum in org.eclipse.microprofile.openapi.annotations.enums
 
SecuritySchemes - Annotation Type in org.eclipse.microprofile.openapi.annotations.security
This object represents an array of SecurityScheme annotations that can be specified at the definition level.
securitySchemes(Map<String, SecurityScheme>) - Method in interface org.eclipse.microprofile.openapi.models.Components
Sets this Components' securitySchemes property to the given Map containing keys and reusable security scheme objects.
SecuritySchemeType - Enum in org.eclipse.microprofile.openapi.annotations.enums
 
Server - Annotation Type in org.eclipse.microprofile.openapi.annotations.servers
This annotation represents a Server used in an operation or used by all operations in an OpenAPI document.
server(Server) - Method in interface org.eclipse.microprofile.openapi.models.links.Link
Sets this Link's server property to the given object.
Server - Interface in org.eclipse.microprofile.openapi.models.servers
An object representing a server.
Servers - Annotation Type in org.eclipse.microprofile.openapi.annotations.servers
The Servers annotation is a container for @Server annotations.
servers(List<Server>) - Method in interface org.eclipse.microprofile.openapi.models.OpenAPI
Sets this OpenAPI instance's servers property to the given servers.
servers(List<Server>) - Method in interface org.eclipse.microprofile.openapi.models.Operation
Sets this Operation's servers property to the given list.
servers(List<Server>) - Method in interface org.eclipse.microprofile.openapi.models.PathItem
Sets this PathItem's servers property to the given list.
SERVERS - Static variable in class org.eclipse.microprofile.openapi.OASConfig
Configuration property to specify the list of global servers that provide connectivity information.
SERVERS_OPERATION_PREFIX - Static variable in class org.eclipse.microprofile.openapi.OASConfig
Prefix of the configuration property to specify an alternative list of servers to service an operation.
SERVERS_PATH_PREFIX - Static variable in class org.eclipse.microprofile.openapi.OASConfig
Prefix of the configuration property to specify an alternative list of servers to service all operations in a path.
ServerVariable - Annotation Type in org.eclipse.microprofile.openapi.annotations.servers
An object representing a Server Variable for server URL template substitution.
ServerVariable - Interface in org.eclipse.microprofile.openapi.models.servers
An object representing a Server Variable for server URL template substitution.
ServerVariables - Interface in org.eclipse.microprofile.openapi.models.servers
ServerVariables
setAdditionalProperties(Schema) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
Sets the Schema which defines additional properties not defined by "properties" or "patternProperties".
setAdditionalProperties(Boolean) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
Sets the value of "additionalProperties" to either True or False.
setAllOf(List<Schema>) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
Sets the schemas used by the allOf property of this Schema.
setAllowEmptyValue(Boolean) - Method in interface org.eclipse.microprofile.openapi.models.headers.Header
Sets this Header's allowEmptyValue property to the given value.
setAllowEmptyValue(Boolean) - Method in interface org.eclipse.microprofile.openapi.models.parameters.Parameter
Sets the allowEmptyValue property of a Parameter instance to the given value.
setAllowReserved(Boolean) - Method in interface org.eclipse.microprofile.openapi.models.media.Encoding
AllowReserved determines whether the parameter value SHOULD allow reserved characters to be encoded without percent-encoding.
setAllowReserved(Boolean) - Method in interface org.eclipse.microprofile.openapi.models.parameters.Parameter
Sets the allowReserved property of a Parameter instance to the given value.
setAnyOf(List<Schema>) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
Sets the schemas used by the anyOf property of this Schema.
setAttribute(Boolean) - Method in interface org.eclipse.microprofile.openapi.models.media.XML
This method sets the attribute property of XML instance to the given Boolean argument.
setAuthorizationCode(OAuthFlow) - Method in interface org.eclipse.microprofile.openapi.models.security.OAuthFlows
OAuth Authorization Code flow; previously called accessCode in OpenAPI 2.0
setAuthorizationUrl(String) - Method in interface org.eclipse.microprofile.openapi.models.security.OAuthFlow
The authorization URL to be used for this flow.
setBearerFormat(String) - Method in interface org.eclipse.microprofile.openapi.models.security.SecurityScheme
bearerFormat is intended as a hint to the client to identify how the bearer token is formatted.
setCallbacks(Map<String, Callback>) - Method in interface org.eclipse.microprofile.openapi.models.Components
Sets this Components' callbacks property to the given Map containing keys and reusable callback objects.
setCallbacks(Map<String, Callback>) - Method in interface org.eclipse.microprofile.openapi.models.Operation
Sets this Operation's callbacks property to the given map.
setClientCredentials(OAuthFlow) - Method in interface org.eclipse.microprofile.openapi.models.security.OAuthFlows
OAuth Client Credential flow; previously called application in OpenAPI 2.0
setComponents(Components) - Method in interface org.eclipse.microprofile.openapi.models.OpenAPI
Sets this OpenAPI instance's components property to the given components.
setContact(Contact) - Method in interface org.eclipse.microprofile.openapi.models.info.Info
Sets this Info instance's contact information for the exposed API.
setContent(Content) - Method in interface org.eclipse.microprofile.openapi.models.headers.Header
Sets this Header's content property to the given object.
setContent(Content) - Method in interface org.eclipse.microprofile.openapi.models.parameters.Parameter
Sets the content property of a Parameter instance to the given object.
setContent(Content) - Method in interface org.eclipse.microprofile.openapi.models.parameters.RequestBody
Sets the content of this instance of RequestBody, where the keys in content are media type names and the values describe it.
setContent(Content) - Method in interface org.eclipse.microprofile.openapi.models.responses.APIResponse
Sets the map containing descriptions of potential response payload for this instance of ApiResponse.
setContentType(String) - Method in interface org.eclipse.microprofile.openapi.models.media.Encoding
The Content-Type for encoding a specific property.
setDefaultValue(Object) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
Set the default value property of this Schema instance to the value given.
setDefaultValue(APIResponse) - Method in interface org.eclipse.microprofile.openapi.models.responses.APIResponses
Sets the default documentation of responses for this instance of ApiResponses.
setDefaultValue(String) - Method in interface org.eclipse.microprofile.openapi.models.servers.ServerVariable
The default value to use for substitution, and to send, if an alternate value is not supplied.
setDELETE(Operation) - Method in interface org.eclipse.microprofile.openapi.models.PathItem
Sets this PathItem's delete property to the given operation.
setDeprecated(Boolean) - Method in interface org.eclipse.microprofile.openapi.models.headers.Header
Sets this Header's deprecated property to the given value.
setDeprecated(Boolean) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
Sets the deprecated property of this Schema.
setDeprecated(Boolean) - Method in interface org.eclipse.microprofile.openapi.models.Operation
Sets this Operation's deprecated property to the given value.
setDeprecated(Boolean) - Method in interface org.eclipse.microprofile.openapi.models.parameters.Parameter
Sets the deprecated property of a Parameter instance to the given value.
setDescription(String) - Method in class org.eclipse.microprofile.metrics.Metadata
Sets the description of the metric.
setDescription(String) - Method in interface org.eclipse.microprofile.openapi.models.examples.Example
Sets this Example's description property to the given string.
setDescription(String) - Method in interface org.eclipse.microprofile.openapi.models.ExternalDocumentation
Sets this ExternalDocumentation's description property to the given string.
setDescription(String) - Method in interface org.eclipse.microprofile.openapi.models.headers.Header
Sets this Header's description property to the given string.
setDescription(String) - Method in interface org.eclipse.microprofile.openapi.models.info.Info
Sets this Info instance's description for the application to the given description.
setDescription(String) - Method in interface org.eclipse.microprofile.openapi.models.links.Link
Sets this Link's description property to the given string.
setDescription(String) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
Sets the description property of this Schema to the given string.
setDescription(String) - Method in interface org.eclipse.microprofile.openapi.models.Operation
Sets this Operation's description property to the given string.
setDescription(String) - Method in interface org.eclipse.microprofile.openapi.models.parameters.Parameter
Sets the description property of a Parameter instance to the given string.
setDescription(String) - Method in interface org.eclipse.microprofile.openapi.models.parameters.RequestBody
Sets the description of this instance of RequestBody.
setDescription(String) - Method in interface org.eclipse.microprofile.openapi.models.PathItem
Sets this PathItem's description property to the given string.
setDescription(String) - Method in interface org.eclipse.microprofile.openapi.models.responses.APIResponse
Sets the description of this instance of ApiResponse.
setDescription(String) - Method in interface org.eclipse.microprofile.openapi.models.security.SecurityScheme
A short description for security schema.
setDescription(String) - Method in interface org.eclipse.microprofile.openapi.models.servers.Server
This method sets the description property of a Server instance to the given description parameter.
setDescription(String) - Method in interface org.eclipse.microprofile.openapi.models.servers.ServerVariable
This method sets the description property of ServerVariable instance to the given description argument.
setDescription(String) - Method in interface org.eclipse.microprofile.openapi.models.tags.Tag
Sets the description property of a Tag instance to the given string.
setDiscriminator(Discriminator) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
Sets the discriminator property of this Schema instance to the given object.
setDisplayName(String) - Method in class org.eclipse.microprofile.metrics.Metadata
Sets the display name.
setEmail(String) - Method in interface org.eclipse.microprofile.openapi.models.info.Contact
Sets the contact email of this instance of Contact.
setEncoding(Map<String, Encoding>) - Method in interface org.eclipse.microprofile.openapi.models.media.MediaType
Sets encoding property of a MediaType instance to the given map object.
setEnumeration(List<Object>) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
Sets the enumerated list of values allowed for objects defined by this Schema.
setEnumeration(List<String>) - Method in interface org.eclipse.microprofile.openapi.models.servers.ServerVariable
This method sets the enumeration property of ServerVariable instance to the given enumeration argument.
setExample(Object) - Method in interface org.eclipse.microprofile.openapi.models.headers.Header
Sets this Header's example property to the given object.
setExample(Object) - Method in interface org.eclipse.microprofile.openapi.models.media.MediaType
Sets the example property of a MediaType instance to the given value.
setExample(Object) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
Sets the example property of this Schema instance.
setExample(Object) - Method in interface org.eclipse.microprofile.openapi.models.parameters.Parameter
Sets the example property of a Parameter instance to the given object.
setExamples(Map<String, Example>) - Method in interface org.eclipse.microprofile.openapi.models.Components
Sets this Components' examples property to the given Map containing keys and reusable example objects.
setExamples(Map<String, Example>) - Method in interface org.eclipse.microprofile.openapi.models.headers.Header
Sets the examples property of this Header instance to the given map.
setExamples(Map<String, Example>) - Method in interface org.eclipse.microprofile.openapi.models.media.MediaType
Sets the examples field of a MediaType instance to the given map object.
setExamples(Map<String, Example>) - Method in interface org.eclipse.microprofile.openapi.models.parameters.Parameter
Sets the examples property of a Parameter instance to the given value.
setExclusiveMaximum(Boolean) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
Sets the exclusiveMaximum property of this Schema instance to the value given.
setExclusiveMinimum(Boolean) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
Sets the exclusiveMinimum property of this Schema instance to the value given.
setExplode(Boolean) - Method in interface org.eclipse.microprofile.openapi.models.headers.Header
Sets this Header's explode property to the given value.
setExplode(Boolean) - Method in interface org.eclipse.microprofile.openapi.models.media.Encoding
When this is true, property values of type array or object generate separate parameters for each value of the array, or key-value-pair of the map.
setExplode(Boolean) - Method in interface org.eclipse.microprofile.openapi.models.parameters.Parameter
Sets the explode property of a Parameter instance to the given value.
setExtensions(Map<String, Object>) - Method in interface org.eclipse.microprofile.openapi.models.Extensible
Sets this Extensible's extensions property to the given map of extensions.
setExternalDocs(ExternalDocumentation) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
Sets the externalDocs property of this Schema to the indicated value.
setExternalDocs(ExternalDocumentation) - Method in interface org.eclipse.microprofile.openapi.models.OpenAPI
Sets this OpenAPI instance's externalDocs property to the given object.
setExternalDocs(ExternalDocumentation) - Method in interface org.eclipse.microprofile.openapi.models.Operation
Sets this Operation's externalDocs property to the given object.
setExternalDocs(ExternalDocumentation) - Method in interface org.eclipse.microprofile.openapi.models.tags.Tag
Sets the externalDocs property of a Tag instance to the given object.
setExternalValue(String) - Method in interface org.eclipse.microprofile.openapi.models.examples.Example
Sets this Example's externalValue property to the given string.
setFlows(OAuthFlows) - Method in interface org.eclipse.microprofile.openapi.models.security.SecurityScheme
Flows is a REQUIRED property.
setFormat(String) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
Sets the format property of this Schema instance to the given string.
setGET(Operation) - Method in interface org.eclipse.microprofile.openapi.models.PathItem
Sets this PathItem's get property to the given operation.
setHEAD(Operation) - Method in interface org.eclipse.microprofile.openapi.models.PathItem
Sets this PathItem's head property to the given operation.
setHeaders(Map<String, Header>) - Method in interface org.eclipse.microprofile.openapi.models.Components
Sets this Components' headers property to the given Map containing keys and reusable header objects.
setHeaders(Map<String, Header>) - Method in interface org.eclipse.microprofile.openapi.models.media.Encoding
Headers property of an Encoding is a map that allows additional information to be provided as headers
setHeaders(Map<String, Header>) - Method in interface org.eclipse.microprofile.openapi.models.responses.APIResponse
Sets the Headers for this instance of ApiResponse with the given map of Headers.
setImplicit(OAuthFlow) - Method in interface org.eclipse.microprofile.openapi.models.security.OAuthFlows
This method sets the implicit property of OAuthFlows instance to the given implicit argument.
setIn(Parameter.In) - Method in interface org.eclipse.microprofile.openapi.models.parameters.Parameter
Sets the in property of a Parameter instance to the given value.
setIn(SecurityScheme.In) - Method in interface org.eclipse.microprofile.openapi.models.security.SecurityScheme
In is a REQUIRED property that indicates the location of the API key.
setInfo(Info) - Method in interface org.eclipse.microprofile.openapi.models.OpenAPI
Sets this OpenAPI instance's info property to the given object.
setInstance(ConfigProviderResolver) - Static method in class org.eclipse.microprofile.config.spi.ConfigProviderResolver
Set the instance.
setInstance(OASFactoryResolver) - Static method in class org.eclipse.microprofile.openapi.spi.OASFactoryResolver
Set the instance.
setInstance(RestClientBuilderResolver) - Static method in class org.eclipse.microprofile.rest.client.spi.RestClientBuilderResolver
Set the instance.
setItems(Schema) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
Set the Schema used for all the elements of an array typed Schema.
setLicense(License) - Method in interface org.eclipse.microprofile.openapi.models.info.Info
Sets this Info's license information for the exposed API.
setLinks(Map<String, Link>) - Method in interface org.eclipse.microprofile.openapi.models.Components
Sets this Components' links property to the given Map containing keys and reusable link objects.
setLinks(Map<String, Link>) - Method in interface org.eclipse.microprofile.openapi.models.responses.APIResponse
Sets the operations links that can be followed from this instance of ApiResponse.
setMapping(Map<String, String>) - Method in interface org.eclipse.microprofile.openapi.models.media.Discriminator
Sets this Discriminator's mapping property to the given map object.
setMaximum(BigDecimal) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
Sets the maximum property of this Schema instance to the value given.
setMaxItems(Integer) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
Sets the maxItems property of this Schema instance to the value given.
setMaxLength(Integer) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
Sets the maxLength property of this Schema instance to the value given.
setMaxProperties(Integer) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
Sets the maxProperties property of this Schema instance to the value given.
setMinimum(BigDecimal) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
Sets the minimum property of this Schema instance to the value given.
setMinItems(Integer) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
Sets the minItems property of this Schema instance to the value given.
setMinLength(Integer) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
Sets the minLength property of this Schema instance to the value given.
setMinProperties(Integer) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
Sets the minProperties property of this Schema instance to the value given.
setMultipleOf(BigDecimal) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
Sets the multipleOf property of this Schema instance to the value given.
setName(String) - Method in class org.eclipse.microprofile.metrics.Metadata
Sets the metric name.
setName(String) - Method in interface org.eclipse.microprofile.openapi.models.info.Contact
Sets the identifying name of this Contact instance.
setName(String) - Method in interface org.eclipse.microprofile.openapi.models.info.License
Sets the license name for this License instance that is used for the API.
setName(String) - Method in interface org.eclipse.microprofile.openapi.models.media.XML
This method sets the name property of XML instance to the given String argument.
setName(String) - Method in interface org.eclipse.microprofile.openapi.models.parameters.Parameter
Sets the name property of a Parameter instance to the given string.
setName(String) - Method in interface org.eclipse.microprofile.openapi.models.security.SecurityScheme
Name is a REQUIRED property - this is the name of the header, query or cookie parameter to be used.
setName(String) - Method in interface org.eclipse.microprofile.openapi.models.tags.Tag
Sets the name property of a Tag instance to the given string.
setNamespace(String) - Method in interface org.eclipse.microprofile.openapi.models.media.XML
This method sets the namespace property of XML instance to the given String argument.
setNot(Schema) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
Sets the not property to a Schema which describes properties not allowed in objects defined by the current schema.
setNullable(Boolean) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
Sets the nullable property of this Schema instance.
setOneOf(List<Schema>) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
Sets the schemas used by the oneOf property of this Schema.
setOpenapi(String) - Method in interface org.eclipse.microprofile.openapi.models.OpenAPI
Sets this OpenAPI instance's openapi property to the given string.
setOpenIdConnectUrl(String) - Method in interface org.eclipse.microprofile.openapi.models.security.SecurityScheme
openIdConnectUrl is a REQUIRED property.
setOperationId(String) - Method in interface org.eclipse.microprofile.openapi.models.links.Link
Sets this Link's operationId property to the given string.
setOperationId(String) - Method in interface org.eclipse.microprofile.openapi.models.Operation
Sets this Operation's operationId property to the given string.
setOperationRef(String) - Method in interface org.eclipse.microprofile.openapi.models.links.Link
Sets this Link's operationRef property to the given string.
setOPTIONS(Operation) - Method in interface org.eclipse.microprofile.openapi.models.PathItem
Sets this PathItem's options property to the given operation.
setParameters(Map<String, Parameter>) - Method in interface org.eclipse.microprofile.openapi.models.Components
Sets this Components' parameters property to the given Map containing keys and reusable parameter objects.
setParameters(Map<String, Object>) - Method in interface org.eclipse.microprofile.openapi.models.links.Link
Sets this Link's parameters property to the given map.
setParameters(List<Parameter>) - Method in interface org.eclipse.microprofile.openapi.models.Operation
Sets this Operation's parameters property to the given parameter list.
setParameters(List<Parameter>) - Method in interface org.eclipse.microprofile.openapi.models.PathItem
Sets this PathItem's parameters property to the given list.
setPassword(OAuthFlow) - Method in interface org.eclipse.microprofile.openapi.models.security.OAuthFlows
OAuth Resource Owner Password flow
setPATCH(Operation) - Method in interface org.eclipse.microprofile.openapi.models.PathItem
Sets this PathItem's patch property to the given operation.
setPaths(Paths) - Method in interface org.eclipse.microprofile.openapi.models.OpenAPI
Sets this OpenAPI instance's paths property to the given paths.
setPattern(String) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
Sets the pattern property of this Schema instance to the string given.
setPOST(Operation) - Method in interface org.eclipse.microprofile.openapi.models.PathItem
Sets this PathItem's post property to the given operation.
setPrefix(String) - Method in interface org.eclipse.microprofile.openapi.models.media.XML
This method sets the prefix property of XML instance to the given String argument.
setProperties(Map<String, Schema>) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
Sets the properties of this Schema instance to the map provided.
setPropertyName(String) - Method in interface org.eclipse.microprofile.openapi.models.media.Discriminator
Sets this Discriminator's propertyName property to the given propertyName.
setPUT(Operation) - Method in interface org.eclipse.microprofile.openapi.models.PathItem
Sets this PathItem's put property to the given operation.
setReadOnly(Boolean) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
Sets the readOnly property of this Schema.
setRef(String) - Method in interface org.eclipse.microprofile.openapi.models.Reference
Sets this Reference's reference property to the given string.
setRefreshUrl(String) - Method in interface org.eclipse.microprofile.openapi.models.security.OAuthFlow
The URL to be used for obtaining refresh tokens.
setRequestBodies(Map<String, RequestBody>) - Method in interface org.eclipse.microprofile.openapi.models.Components
Sets this Components' requestBodies property to the given Map containing keys and reusable request body objects.
setRequestBody(Object) - Method in interface org.eclipse.microprofile.openapi.models.links.Link
Sets this Link's requestBody property to the given object.
setRequestBody(RequestBody) - Method in interface org.eclipse.microprofile.openapi.models.Operation
Sets this Operation's requestBody property to the given object.
setRequired(Boolean) - Method in interface org.eclipse.microprofile.openapi.models.headers.Header
Sets this Header's required property to the given value.
setRequired(List<String>) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
Sets the list of fields required in objects defined by this Schema.
setRequired(Boolean) - Method in interface org.eclipse.microprofile.openapi.models.parameters.Parameter
Sets the required property of a Parameter instance to the given value.
setRequired(Boolean) - Method in interface org.eclipse.microprofile.openapi.models.parameters.RequestBody
Sets whether this instance of RequestBody is required or not.
setResponseProvider(HealthCheckResponseProvider) - Static method in class org.eclipse.microprofile.health.HealthCheckResponse
Used by OSGi environment while service loader pattern is not supported.
setResponses(Map<String, APIResponse>) - Method in interface org.eclipse.microprofile.openapi.models.Components
Sets this Components' responses property to the given Map containing keys and reusable response objects.
setResponses(APIResponses) - Method in interface org.eclipse.microprofile.openapi.models.Operation
Sets this Operation's responses property to the given responses.
setReusable(boolean) - Method in class org.eclipse.microprofile.metrics.Metadata
Set if the metric can be reusable (i.e.
setSchema(Schema) - Method in interface org.eclipse.microprofile.openapi.models.headers.Header
Sets this Header's schema property to the given object.
setSchema(Schema) - Method in interface org.eclipse.microprofile.openapi.models.media.MediaType
Sets the schema field of a MediaType instance to the given schema object.
setSchema(Schema) - Method in interface org.eclipse.microprofile.openapi.models.parameters.Parameter
Sets the schema property of a Parameter instance to the given value.
setSchemas(Map<String, Schema>) - Method in interface org.eclipse.microprofile.openapi.models.Components
Sets this Components' schemas property to the given Map containing keys and reusable schema objects.
setScheme(String) - Method in interface org.eclipse.microprofile.openapi.models.security.SecurityScheme
Schema is a REQUIRED property that is the name of the HTTP Authorization scheme to be used in the Authorization header as defined in RFC7235.
setScopes(Scopes) - Method in interface org.eclipse.microprofile.openapi.models.security.OAuthFlow
The available scopes for the OAuth2 security scheme.
setSecurity(List<SecurityRequirement>) - Method in interface org.eclipse.microprofile.openapi.models.OpenAPI
Sets this OpenAPI instance's security property to the given list.
setSecurity(List<SecurityRequirement>) - Method in interface org.eclipse.microprofile.openapi.models.Operation
Sets this Operation's security property to the given list.
setSecuritySchemes(Map<String, SecurityScheme>) - Method in interface org.eclipse.microprofile.openapi.models.Components
Sets this Components' securitySchemes property to the given Map containing keys and reusable security scheme objects.
setServer(Server) - Method in interface org.eclipse.microprofile.openapi.models.links.Link
Sets this Link's server property to the given object.
setServers(List<Server>) - Method in interface org.eclipse.microprofile.openapi.models.OpenAPI
Sets this OpenAPI instance's servers property to the given servers.
setServers(List<Server>) - Method in interface org.eclipse.microprofile.openapi.models.Operation
Sets this Operation's servers property to the given list.
setServers(List<Server>) - Method in interface org.eclipse.microprofile.openapi.models.PathItem
Sets this PathItem's servers property to the given list.
setStyle(Header.Style) - Method in interface org.eclipse.microprofile.openapi.models.headers.Header
Sets this Header's style property to the given style.
setStyle(Encoding.Style) - Method in interface org.eclipse.microprofile.openapi.models.media.Encoding
Style describes how the encoding value will be serialized depending on the type of the parameter value.
setStyle(Parameter.Style) - Method in interface org.eclipse.microprofile.openapi.models.parameters.Parameter
Sets the style property of a Parameter instance to the given value.
setSummary(String) - Method in interface org.eclipse.microprofile.openapi.models.examples.Example
Sets this Example's summary property to the given string.
setSummary(String) - Method in interface org.eclipse.microprofile.openapi.models.Operation
Sets this Operation's summary property to the given string.
setSummary(String) - Method in interface org.eclipse.microprofile.openapi.models.PathItem
Sets this PathItem's summary property to the given string.
setTags(HashMap<String, String>) - Method in class org.eclipse.microprofile.metrics.Metadata
Sets the tags hashmap.
setTags(List<Tag>) - Method in interface org.eclipse.microprofile.openapi.models.OpenAPI
Sets this OpenAPI instance's tags property to the given Tags.
setTags(List<String>) - Method in interface org.eclipse.microprofile.openapi.models.Operation
Sets this Operation's tags property to the given tags.
setTermsOfService(String) - Method in interface org.eclipse.microprofile.openapi.models.info.Info
Sets this Info instance's URL to the Terms of Service for the API to the given String.
setTitle(String) - Method in interface org.eclipse.microprofile.openapi.models.info.Info
Sets this Info instance's title for the application to the given title.
setTitle(String) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
Sets the title property of this Schema instance to the given string.
setTokenUrl(String) - Method in interface org.eclipse.microprofile.openapi.models.security.OAuthFlow
The token URL to be used for this flow.
setTRACE(Operation) - Method in interface org.eclipse.microprofile.openapi.models.PathItem
Sets this PathItem's trace property to the given operation.
setType(String) - Method in class org.eclipse.microprofile.metrics.Metadata
Sets the metric type using a String representation of MetricType.
setType(MetricType) - Method in class org.eclipse.microprofile.metrics.Metadata
Sets the type of the metric
setType(Schema.SchemaType) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
Sets the type used by this Schema to the string given.
setType(SecurityScheme.Type) - Method in interface org.eclipse.microprofile.openapi.models.security.SecurityScheme
Type is a REQUIRED property that specifies the type of SecurityScheme instance.
setUniqueItems(Boolean) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
Sets the uniqueItems property of this Schema instance to the value given.
setUnit(String) - Method in class org.eclipse.microprofile.metrics.Metadata
Sets the unit of the metric.
setUpMetadata() - Method in class org.eclipse.microprofile.metrics.tck.TagsTest
 
setUrl(String) - Method in interface org.eclipse.microprofile.openapi.models.ExternalDocumentation
Sets this ExternalDocumentation's url property to the given string.
setUrl(String) - Method in interface org.eclipse.microprofile.openapi.models.info.Contact
Sets this Contact instance's URL pointing to the contact information.
setUrl(String) - Method in interface org.eclipse.microprofile.openapi.models.info.License
Sets this URL for this License instance that is used for the API.
setUrl(String) - Method in interface org.eclipse.microprofile.openapi.models.servers.Server
This method sets the url property of Server instance to the given url argument, representing a URL to the target host.
setValue(Object) - Method in interface org.eclipse.microprofile.openapi.models.examples.Example
Sets this Example's value property to the given value.
setVariables(ServerVariables) - Method in interface org.eclipse.microprofile.openapi.models.servers.Server
This method sets the variables property of Server instance to the given variables argument.
setVersion(String) - Method in interface org.eclipse.microprofile.openapi.models.info.Info
Sets the version of the OpenAPI document for this instance of Info to the given version.
setWrapped(Boolean) - Method in interface org.eclipse.microprofile.openapi.models.media.XML
This method sets the wrapped property of XML instance to the given Boolean argument.
setWriteOnly(Boolean) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
Sets the writeOnly property of this Schema.
setXml(XML) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
Sets the xml property of this Schema instance.
size() - Method in class org.eclipse.microprofile.metrics.Snapshot
Returns the number of values in the snapshot.
Snapshot - Class in org.eclipse.microprofile.metrics
A statistical snapshot of a Snapshot.
Snapshot() - Constructor for class org.eclipse.microprofile.metrics.Snapshot
 
standard() - Method in class org.eclipse.microprofile.jwt.ClaimLiteral
 
state(boolean) - Method in class org.eclipse.microprofile.health.HealthCheckResponseBuilder
 
stop() - Method in interface org.eclipse.microprofile.metrics.Timer.Context
Updates the timer with the difference between current and start time.
style(Header.Style) - Method in interface org.eclipse.microprofile.openapi.models.headers.Header
Sets this Header's style property to the given style.
style(Encoding.Style) - Method in interface org.eclipse.microprofile.openapi.models.media.Encoding
Style describes how the encoding value will be serialized depending on the type of the parameter value.
style(Parameter.Style) - Method in interface org.eclipse.microprofile.openapi.models.parameters.Parameter
Sets the style property of a Parameter instance to the given value.
summary(String) - Method in interface org.eclipse.microprofile.openapi.models.examples.Example
Sets this Example's summary property to the given string.
summary(String) - Method in interface org.eclipse.microprofile.openapi.models.Operation
Sets this Operation's summary property to the given string.
summary(String) - Method in interface org.eclipse.microprofile.openapi.models.PathItem
Sets this PathItem's summary property to the given string.

T

Tag - Annotation Type in org.eclipse.microprofile.openapi.annotations.tags
This object represents a tag.
Tag - Interface in org.eclipse.microprofile.openapi.models.tags
Tag
Tags - Annotation Type in org.eclipse.microprofile.openapi.annotations.tags
The Tags annotation is a container for @Tag annotations.
tags(List<Tag>) - Method in interface org.eclipse.microprofile.openapi.models.OpenAPI
Sets this OpenAPI instance's tags property to the given tags.
tags(List<String>) - Method in interface org.eclipse.microprofile.openapi.models.Operation
Sets this Operation's tags property to the given tags.
TagsTest - Class in org.eclipse.microprofile.metrics.tck
 
TagsTest() - Constructor for class org.eclipse.microprofile.metrics.tck.TagsTest
 
tagsTest() - Method in class org.eclipse.microprofile.metrics.tck.TagsTest
 
termsOfService(String) - Method in interface org.eclipse.microprofile.openapi.models.info.Info
Sets this Info instance's URL to the Terms of Service for the API to the given String and returns this instance of Info.
testCount() - Method in class org.eclipse.microprofile.metrics.tck.HistogramTest
 
testCount() - Method in class org.eclipse.microprofile.metrics.tck.MeterTest
 
testManualGauge() - Method in class org.eclipse.microprofile.metrics.tck.GaugeTest
 
testMetricRegistry() - Method in class org.eclipse.microprofile.metrics.tck.HistogramTest
 
testRate() - Method in class org.eclipse.microprofile.metrics.tck.TimerTest
 
testRates() - Method in class org.eclipse.microprofile.metrics.tck.MeterTest
 
testSnapshot75thPercentile() - Method in class org.eclipse.microprofile.metrics.tck.HistogramTest
 
testSnapshot75thPercentile() - Method in class org.eclipse.microprofile.metrics.tck.TimerTest
 
testSnapshot95thPercentile() - Method in class org.eclipse.microprofile.metrics.tck.HistogramTest
 
testSnapshot95thPercentile() - Method in class org.eclipse.microprofile.metrics.tck.TimerTest
 
testSnapshot98thPercentile() - Method in class org.eclipse.microprofile.metrics.tck.HistogramTest
 
testSnapshot98thPercentile() - Method in class org.eclipse.microprofile.metrics.tck.TimerTest
 
testSnapshot999thPercentile() - Method in class org.eclipse.microprofile.metrics.tck.HistogramTest
 
testSnapshot999thPercentile() - Method in class org.eclipse.microprofile.metrics.tck.TimerTest
 
testSnapshot99thPercentile() - Method in class org.eclipse.microprofile.metrics.tck.HistogramTest
 
testSnapshot99thPercentile() - Method in class org.eclipse.microprofile.metrics.tck.TimerTest
 
testSnapshotMax() - Method in class org.eclipse.microprofile.metrics.tck.HistogramTest
 
testSnapshotMax() - Method in class org.eclipse.microprofile.metrics.tck.TimerTest
 
testSnapshotMean() - Method in class org.eclipse.microprofile.metrics.tck.HistogramTest
 
testSnapshotMean() - Method in class org.eclipse.microprofile.metrics.tck.TimerTest
 
testSnapshotMedian() - Method in class org.eclipse.microprofile.metrics.tck.HistogramTest
 
testSnapshotMedian() - Method in class org.eclipse.microprofile.metrics.tck.TimerTest
 
testSnapshotMin() - Method in class org.eclipse.microprofile.metrics.tck.HistogramTest
 
testSnapshotMin() - Method in class org.eclipse.microprofile.metrics.tck.TimerTest
 
testSnapshotSize() - Method in class org.eclipse.microprofile.metrics.tck.HistogramTest
 
testSnapshotSize() - Method in class org.eclipse.microprofile.metrics.tck.TimerTest
 
testSnapshotStdDev() - Method in class org.eclipse.microprofile.metrics.tck.HistogramTest
 
testSnapshotStdDev() - Method in class org.eclipse.microprofile.metrics.tck.TimerTest
 
testSnapshotValues() - Method in class org.eclipse.microprofile.metrics.tck.HistogramTest
 
testSnapshotValues() - Method in class org.eclipse.microprofile.metrics.tck.TimerTest
 
testTime() - Method in class org.eclipse.microprofile.metrics.tck.TimerTest
 
testTimerRegistry() - Method in class org.eclipse.microprofile.metrics.tck.TimerTest
 
TestUtils - Class in org.eclipse.microprofile.metrics.tck
 
theAllFilterMatchesAllMetrics() - Method in class org.eclipse.microprofile.metrics.tck.MetricFilterTest
 
time(Callable<T>) - Method in interface org.eclipse.microprofile.metrics.Timer
Times and records the duration of event.
time(Runnable) - Method in interface org.eclipse.microprofile.metrics.Timer
Times and records the duration of event.
time() - Method in interface org.eclipse.microprofile.metrics.Timer
Returns a new Timer.Context.
Timed - Annotation Type in org.eclipse.microprofile.metrics.annotation
An annotation for marking a method, constructor, or class as timed.
Timeout - Annotation Type in org.eclipse.microprofile.faulttolerance
The annotation to define a method execution timeout.
TimeoutException - Exception in org.eclipse.microprofile.faulttolerance.exceptions
The exception should be thrown when timeout is reached.
TimeoutException() - Constructor for exception org.eclipse.microprofile.faulttolerance.exceptions.TimeoutException
 
TimeoutException(Throwable) - Constructor for exception org.eclipse.microprofile.faulttolerance.exceptions.TimeoutException
 
TimeoutException(String) - Constructor for exception org.eclipse.microprofile.faulttolerance.exceptions.TimeoutException
 
TimeoutException(String, Throwable) - Constructor for exception org.eclipse.microprofile.faulttolerance.exceptions.TimeoutException
 
timer(String) - Method in class org.eclipse.microprofile.metrics.MetricRegistry
Return the Timer registered under this name; or create and register a new Timer if none is registered.
timer(Metadata) - Method in class org.eclipse.microprofile.metrics.MetricRegistry
Return the Timer registered under the Metadata's name; or create and register a new Timer if none is registered.
Timer - Interface in org.eclipse.microprofile.metrics
A timer metric which aggregates timing durations and provides duration statistics, plus throughput statistics via Meter.
Timer.Context - Interface in org.eclipse.microprofile.metrics
A timing context.
TimerTest - Class in org.eclipse.microprofile.metrics.tck
 
TimerTest() - Constructor for class org.eclipse.microprofile.metrics.tck.TimerTest
 
timesCallableInstances() - Method in class org.eclipse.microprofile.metrics.tck.TimerTest
 
timesRunnableInstances() - Method in class org.eclipse.microprofile.metrics.tck.TimerTest
 
title(String) - Method in interface org.eclipse.microprofile.openapi.models.info.Info
Sets this Info instance's title for the application to the given title and returns this instance of Info
title(String) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
Sets the title property of this Schema instance to the given string.
tokenUrl(String) - Method in interface org.eclipse.microprofile.openapi.models.security.OAuthFlow
The token URL to be used for this flow.
TOLERANCE - Static variable in class org.eclipse.microprofile.metrics.tck.TestUtils
 
toString() - Method in class org.eclipse.microprofile.metrics.Metadata
 
toString() - Method in enum org.eclipse.microprofile.metrics.MetricType
 
toString() - Method in enum org.eclipse.microprofile.openapi.annotations.enums.ParameterIn
 
toString() - Method in enum org.eclipse.microprofile.openapi.annotations.enums.ParameterStyle
 
toString() - Method in enum org.eclipse.microprofile.openapi.annotations.enums.SchemaType
 
toString() - Method in enum org.eclipse.microprofile.openapi.annotations.enums.SecuritySchemeIn
 
toString() - Method in enum org.eclipse.microprofile.openapi.annotations.enums.SecuritySchemeType
 
toString() - Method in enum org.eclipse.microprofile.openapi.models.headers.Header.Style
 
toString() - Method in enum org.eclipse.microprofile.openapi.models.media.Encoding.Style
 
toString() - Method in enum org.eclipse.microprofile.openapi.models.media.Schema.SchemaType
 
toString() - Method in enum org.eclipse.microprofile.openapi.models.parameters.Parameter.In
 
toString() - Method in enum org.eclipse.microprofile.openapi.models.parameters.Parameter.Style
 
toString() - Method in enum org.eclipse.microprofile.openapi.models.security.SecurityScheme.In
 
toString() - Method in enum org.eclipse.microprofile.openapi.models.security.SecurityScheme.Type
 
toThrowable(Response) - Method in interface org.eclipse.microprofile.rest.client.ext.ResponseExceptionMapper
Converts a given Response into a Throwable.
TRACE(Operation) - Method in interface org.eclipse.microprofile.openapi.models.PathItem
Sets this PathItem's trace property to the given operation.
Traced - Annotation Type in org.eclipse.microprofile.opentracing
This annotation allows fine-tuned control over which classes and methods create OpenTracing spans.
type(Schema.SchemaType) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
Sets the type used by this Schema to the string given.
type(SecurityScheme.Type) - Method in interface org.eclipse.microprofile.openapi.models.security.SecurityScheme
Type is a REQUIRED property that specifies the type of SecurityScheme instance.

U

UNCONFIGURED_VALUE - Static variable in annotation type org.eclipse.microprofile.config.inject.ConfigProperty
 
uniqueItems(Boolean) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
Sets the uniqueItems property of this Schema instance to the value given.
up() - Method in class org.eclipse.microprofile.health.HealthCheckResponseBuilder
 
update(int) - Method in interface org.eclipse.microprofile.metrics.Histogram
Adds a recorded value.
update(long) - Method in interface org.eclipse.microprofile.metrics.Histogram
Adds a recorded value.
update(long, TimeUnit) - Method in interface org.eclipse.microprofile.metrics.Timer
Adds a recorded duration.
url(String) - Method in interface org.eclipse.microprofile.openapi.models.ExternalDocumentation
Sets this ExternalDocumentation's url property to the given string.
url(String) - Method in interface org.eclipse.microprofile.openapi.models.info.Contact
Sets this Contact instance's URL pointing to the contact information and returns this instance of Contact.
url(String) - Method in interface org.eclipse.microprofile.openapi.models.info.License
Sets this License instance's URL used for the API and returns this instance of License.
url(String) - Method in interface org.eclipse.microprofile.openapi.models.servers.Server
This method sets the url property of Server instance to the given url argument, representing a URL to the target host, and returns the modified instance.

V

value() - Method in class org.eclipse.microprofile.jwt.ClaimLiteral
 
value(Object) - Method in interface org.eclipse.microprofile.openapi.models.examples.Example
Sets this Example's value property to the given value.
valueOf(String) - Static method in enum org.eclipse.microprofile.health.HealthCheckResponse.State
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.eclipse.microprofile.jwt.Claims
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.eclipse.microprofile.metrics.MetricRegistry.Type
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.eclipse.microprofile.metrics.MetricType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.eclipse.microprofile.openapi.annotations.enums.Explode
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.eclipse.microprofile.openapi.annotations.enums.ParameterIn
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.eclipse.microprofile.openapi.annotations.enums.ParameterStyle
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.eclipse.microprofile.openapi.annotations.enums.SchemaType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.eclipse.microprofile.openapi.annotations.enums.SecuritySchemeIn
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.eclipse.microprofile.openapi.annotations.enums.SecuritySchemeType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.eclipse.microprofile.openapi.models.headers.Header.Style
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.eclipse.microprofile.openapi.models.media.Encoding.Style
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.eclipse.microprofile.openapi.models.media.Schema.SchemaType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.eclipse.microprofile.openapi.models.parameters.Parameter.In
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.eclipse.microprofile.openapi.models.parameters.Parameter.Style
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.eclipse.microprofile.openapi.models.PathItem.HttpMethod
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.eclipse.microprofile.openapi.models.security.SecurityScheme.In
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.eclipse.microprofile.openapi.models.security.SecurityScheme.Type
Returns the enum constant of this type with the specified name.
values() - Static method in enum org.eclipse.microprofile.health.HealthCheckResponse.State
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.eclipse.microprofile.jwt.Claims
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.eclipse.microprofile.metrics.MetricRegistry.Type
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.eclipse.microprofile.metrics.MetricType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.eclipse.microprofile.openapi.annotations.enums.Explode
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.eclipse.microprofile.openapi.annotations.enums.ParameterIn
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.eclipse.microprofile.openapi.annotations.enums.ParameterStyle
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.eclipse.microprofile.openapi.annotations.enums.SchemaType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.eclipse.microprofile.openapi.annotations.enums.SecuritySchemeIn
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.eclipse.microprofile.openapi.annotations.enums.SecuritySchemeType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.eclipse.microprofile.openapi.models.headers.Header.Style
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.eclipse.microprofile.openapi.models.media.Encoding.Style
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.eclipse.microprofile.openapi.models.media.Schema.SchemaType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.eclipse.microprofile.openapi.models.parameters.Parameter.In
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.eclipse.microprofile.openapi.models.parameters.Parameter.Style
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.eclipse.microprofile.openapi.models.PathItem.HttpMethod
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.eclipse.microprofile.openapi.models.security.SecurityScheme.In
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.eclipse.microprofile.openapi.models.security.SecurityScheme.Type
Returns an array containing the constants of this enum type, in the order they are declared.
variables(ServerVariables) - Method in interface org.eclipse.microprofile.openapi.models.servers.Server
This method sets the variables property of Server instance to the given variables argument and returns the modified instance.
VERIFIER_PUBLIC_KEY - Static variable in interface org.eclipse.microprofile.jwt.config.Names
The embedded key material of the public key for the MP-JWT signer in PKCS8 PEM or JWK(S) format.
VERIFIER_PUBLIC_KEY_LOCATION - Static variable in interface org.eclipse.microprofile.jwt.config.Names
The relative path or full URL of the public key.
version(String) - Method in interface org.eclipse.microprofile.openapi.models.info.Info
Sets the version of the OpenAPI document for this instance of Info to the given version and returns this instance of Info

W

withConverter(Class<T>, int, Converter<T>) - Method in interface org.eclipse.microprofile.config.spi.ConfigBuilder
Add the specified Converter for the given type.
withConverters(Converter<?>...) - Method in interface org.eclipse.microprofile.config.spi.ConfigBuilder
Add the specified Converter.
withData(String, String) - Method in class org.eclipse.microprofile.health.HealthCheckResponseBuilder
 
withData(String, long) - Method in class org.eclipse.microprofile.health.HealthCheckResponseBuilder
 
withData(String, boolean) - Method in class org.eclipse.microprofile.health.HealthCheckResponseBuilder
 
withSources(ConfigSource...) - Method in interface org.eclipse.microprofile.config.spi.ConfigBuilder
Add the specified ConfigSource.
wrapped(Boolean) - Method in interface org.eclipse.microprofile.openapi.models.media.XML
This method sets the wrapped property of XML instance to the given Boolean argument and returns the modified instance.
writeOnly(Boolean) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
Sets the writeOnly property of this Schema.

X

xml(XML) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
Sets the xml property of this Schema instance.
XML - Interface in org.eclipse.microprofile.openapi.models.media
A metadata object that allows for more fine-tuned XML model definitions.
A B C D E F G H I J K L M N O P R S T U V W X 
Skip navigation links