Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- abortOn() - Element in annotation interface org.eclipse.microprofile.faulttolerance.Retry
-
The list of exception types that should not trigger a retry.
- acr - Enum constant in enum class org.eclipse.microprofile.jwt.Claims
- 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.
- addCallback(String, Callback) - Method in interface org.eclipse.microprofile.openapi.models.Operation
-
Adds the given callback item to this Operation's map of callbacks.
- addDefaultSources() - Method in interface org.eclipse.microprofile.config.spi.ConfigBuilder
-
Add the default configuration sources to the configuration being built.
- addDependentRequired(String, List<String>) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Sets the list of additional property names that are required if a property named
propertyName
exists. - addDependentSchema(String, Schema) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Sets the dependent schema for a property name.
- addDiscoveredConverters() - Method in interface org.eclipse.microprofile.config.spi.ConfigBuilder
-
Add all configuration converters which can be discovered from this configuration builder's class loader.
- addDiscoveredSources() - Method in interface org.eclipse.microprofile.config.spi.ConfigBuilder
-
Add all configuration sources which can be discovered from this configuration builder's class loader.
- 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(Object) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Adds an example to the examples list.
- 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 header 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 parameter 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.media.Encoding
-
Adds the given header to this Encoding' list 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() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.media.Schema
-
Provides a Java class as implementation for additional properties that may be present in instances of this schema.
- additionalProperties() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.media.SchemaProperty
-
Provides a Java class as implementation for additional properties that may be present in instances of this schema.
- additionalPropertiesBoolean(Boolean) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Deprecated.
- additionalPropertiesSchema(Schema) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Sets the Schema which defines additional properties not defined by "properties" or "patternProperties".
- 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, 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(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(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.Components
-
Adds a path item.
- 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
- addPatternProperty(String, Schema) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Adds a regular expression and schema pair to the list of pattern properties.
- addPrefixItem(Schema) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Adds a schema to the end of the prefixItems list.
- 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.
- address - Enum constant in enum class org.eclipse.microprofile.jwt.Claims
- 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) - Method in interface org.eclipse.microprofile.openapi.models.security.SecurityRequirement
-
Adds a security scheme to the SecurityRequirement instance based on the scheme name.
- 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.
- addScope(String, String) - Method in interface org.eclipse.microprofile.openapi.models.security.OAuthFlow
-
Adds name of an existing scope object and item parameters to scopes 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.
- addTag(String) - Method in interface org.eclipse.microprofile.openapi.models.Operation
-
Adds the given tag to this Operation's list of tags.
- addTag(Tag) - Method in interface org.eclipse.microprofile.openapi.models.OpenAPI
-
Adds the given tag to this OpenAPI instance's list of tags.
- addType(Schema.SchemaType) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Adds a type to the type list.
- addVariable(String, ServerVariable) - Method in interface org.eclipse.microprofile.openapi.models.servers.Server
-
Adds the given server variable item to the Server's map of variables.
- addWebhook(String, PathItem) - Method in interface org.eclipse.microprofile.openapi.models.OpenAPI
-
Adds a webhook definition.
- allOf() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.media.Schema
-
Provides an array of java class implementations which can be used to describe multiple acceptable schemas.
- allOf() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.media.SchemaProperty
-
Provides an array of java class implementations which can be used to describe multiple acceptable schemas.
- 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() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.headers.Header
-
When true, allows sending an empty value.
- allowEmptyValue() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.parameters.Parameter
-
When true, allows sending an empty value.
- 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() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.media.Encoding
-
Determines whether the encoding instance value SHOULD allow reserved characters, as defined by RFC3986 to be included without percent-encoding.
- allowReserved() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.parameters.Parameter
-
Determines whether the parameter value SHOULD allow reserved characters, as defined by RFC3986.
- 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.
- amr - Enum constant in enum class org.eclipse.microprofile.jwt.Claims
- anyOf() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.media.Schema
-
Provides an array of java class implementations which can be used to describe multiple acceptable schemas.
- anyOf() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.media.SchemaProperty
-
Provides an array of java class implementations which can be used to describe multiple acceptable schemas.
- anyOf(List<Schema>) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Sets the schemas used by the anyOf property of this Schema.
- APIKEY - Enum constant in enum class org.eclipse.microprofile.openapi.annotations.enums.SecuritySchemeType
- APIKEY - Enum constant in enum class org.eclipse.microprofile.openapi.models.security.SecurityScheme.Type
- apiKeyName() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.security.SecurityScheme
-
Applies to and is REQUIRED for SecurityScheme of apiKey type.
- 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.
- APIResponse - Annotation Interface 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.
- APIResponses - Interface in org.eclipse.microprofile.openapi.models.responses
-
This interface represents the container for the expected responses of an operation.
- APIResponses - Annotation Interface in org.eclipse.microprofile.openapi.annotations.responses
-
The ApiResponses annotation is a container for @ApiResponse annotations.
- APIResponseSchema - Annotation Interface in org.eclipse.microprofile.openapi.annotations.responses
-
The APIResponseSchema annotation corresponds to an individual schema in the OpenAPI Response model object which describes a single response from an API 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.
- applyOn() - Element in annotation interface org.eclipse.microprofile.faulttolerance.Fallback
-
The list of exception types which should trigger Fallback
- ARRAY - Enum constant in enum class org.eclipse.microprofile.openapi.annotations.enums.SchemaType
- ARRAY - Enum constant in enum class org.eclipse.microprofile.openapi.models.media.Schema.SchemaType
- ARRAY_PAIRS - Enum constant in enum class org.eclipse.microprofile.rest.client.ext.QueryParamStyle
-
Multiple parameter instances with square brackets for each parameter, e.g.:
foo[]=v1&foo[]=v2&foo[]=v3
- Asynchronous - Annotation Interface 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.
- at_hash - Enum constant in enum class org.eclipse.microprofile.jwt.Claims
- 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.
- aud - Enum constant in enum class org.eclipse.microprofile.jwt.Claims
- AUDIENCES - Static variable in interface org.eclipse.microprofile.jwt.config.Names
-
The expected "aud" claim value(s), separated by commas.
- auth_time - Enum constant in enum class org.eclipse.microprofile.jwt.Claims
- authMethod() - Element in annotation interface org.eclipse.microprofile.auth.LoginConfig
-
The 'authMethod' is used to configure the "MP-JWT" authentication mechanism for the JAX-RS application.
- authorizationCode() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.security.OAuthFlows
-
Configuration for the OAuth Authorization Code flow.
- authorizationCode(OAuthFlow) - Method in interface org.eclipse.microprofile.openapi.models.security.OAuthFlows
-
OAuth Authorization Code flow; previously called accessCode in OpenAPI 2.0
- authorizationUrl() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.security.OAuthFlow
-
The authorization URL to be used for this flow.
- authorizationUrl(String) - Method in interface org.eclipse.microprofile.openapi.models.security.OAuthFlow
-
The authorization URL to be used for this flow.
- azp - Enum constant in enum class org.eclipse.microprofile.jwt.Claims
B
- baseUri() - Element in annotation interface org.eclipse.microprofile.rest.client.inject.RegisterRestClient
-
Sets the base URI for the rest client interface.
- baseUri(String) - Method in interface org.eclipse.microprofile.rest.client.RestClientBuilder
-
Specifies the base URI to be used when making requests.
- 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() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.security.SecurityScheme
-
Applies to http ("bearer") type.
- 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.
- birthdate - Enum constant in enum class org.eclipse.microprofile.jwt.Claims
- BOOLEAN - Enum constant in enum class org.eclipse.microprofile.openapi.annotations.enums.SchemaType
- BOOLEAN - Enum constant in enum class org.eclipse.microprofile.openapi.models.media.Schema.SchemaType
- booleanSchema(Boolean) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Sets this schema to a boolean value.
- build() - Method in interface org.eclipse.microprofile.config.spi.ConfigBuilder
-
Build a new
Config
instance based on this builder instance. - build() - Method in class org.eclipse.microprofile.health.HealthCheckResponseBuilder
-
Creates a
HealthCheckResponse
from the current builder. - 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
-
Creates an empty
HealthCheckResponseBuilder
. - buildModel() - Method in interface org.eclipse.microprofile.openapi.OASModelReader
-
This method is called by the vendor's OpenAPI processing framework.
- Bulkhead - Annotation Interface 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(String) - Constructor for exception org.eclipse.microprofile.faulttolerance.exceptions.BulkheadException
- BulkheadException(String, Throwable) - Constructor for exception org.eclipse.microprofile.faulttolerance.exceptions.BulkheadException
- BulkheadException(Throwable) - Constructor for exception org.eclipse.microprofile.faulttolerance.exceptions.BulkheadException
C
- c_hash - Enum constant in enum class org.eclipse.microprofile.jwt.Claims
- call() - Method in interface org.eclipse.microprofile.health.HealthCheck
-
Invokes the health check procedure provided by the implementation of this interface.
- Callback - Interface in org.eclipse.microprofile.openapi.models.callbacks
-
Callback
- Callback - Annotation Interface in org.eclipse.microprofile.openapi.annotations.callbacks
-
This object represents a callback URL that will be invoked.
- CallbackOperation - Annotation Interface in org.eclipse.microprofile.openapi.annotations.callbacks
-
Describes a single API callback operation.
- callbacks() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.Components
-
An object to hold reusable Callback Objects.
- callbacks() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.PathItemOperation
-
A list of possible out-of-band callbacks related to this operation.
- 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.
- Callbacks - Annotation Interface in org.eclipse.microprofile.openapi.annotations.callbacks
-
This object represents an array of Callback URLs that can be invoked.
- callbackUrlExpression() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.callbacks.Callback
-
An absolute URL which defines the destination which will be called with the supplied operation definition.
- CircuitBreaker - Annotation Interface in org.eclipse.microprofile.faulttolerance
-
Defines a circuit breaker policy to an individual method or a class.
- 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(String) - Constructor for exception org.eclipse.microprofile.faulttolerance.exceptions.CircuitBreakerOpenException
- CircuitBreakerOpenException(String, Throwable) - Constructor for exception org.eclipse.microprofile.faulttolerance.exceptions.CircuitBreakerOpenException
- CircuitBreakerOpenException(Throwable) - Constructor for exception org.eclipse.microprofile.faulttolerance.exceptions.CircuitBreakerOpenException
- claim(String) - Method in interface org.eclipse.microprofile.jwt.JsonWebToken
-
A utility method to access a claim value in an Optional wrapper
- claim(Claims) - Method in interface org.eclipse.microprofile.jwt.JsonWebToken
-
A utility method to access a claim value in an Optional wrapper
- Claim - Annotation Interface in org.eclipse.microprofile.jwt
-
Annotation used to signify an injection point for a
ClaimValue
from aJsonWebToken
- 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 Class 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
- clientCredentials() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.security.OAuthFlows
-
Configuration for the OAuth Client Credentials flow.
- clientCredentials(OAuthFlow) - Method in interface org.eclipse.microprofile.openapi.models.security.OAuthFlows
-
OAuth Client Credential flow; previously called application in OpenAPI 2.0
- ClientHeaderParam - Annotation Interface in org.eclipse.microprofile.rest.client.annotation
-
Used to specify an HTTP parameter that should be sent with the outbound request.
- ClientHeaderParams - Annotation Interface in org.eclipse.microprofile.rest.client.annotation
-
Used to specify HTTP parameters that should be sent with the outbound request.
- ClientHeadersFactory - Interface in org.eclipse.microprofile.rest.client.ext
-
This interface is intended for generating or propagating HTTP headers.
- CLOCK_SKEW - Static variable in interface org.eclipse.microprofile.jwt.config.Names
-
The clock skew in seconds used during the token expiry and age verification.
- cnf - Enum constant in enum class org.eclipse.microprofile.jwt.Claims
- COMMA_SEPARATED - Enum constant in enum class org.eclipse.microprofile.rest.client.ext.QueryParamStyle
-
A single parameter instance with multiple, comma-separated values, e.g.:
foo=v1,v2,v3
- comment() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.media.Schema
-
A comment to be included in the schema
- comment() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.media.SchemaProperty
-
A comment to be included in the schema
- comment(String) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Sets the comment to be included in the
$comment
property of the schema. - components() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.OpenAPIDefinition
-
An element to hold a set of reusable objects for different aspects of the OpenAPI Specification (OAS).
- components(Components) - Method in interface org.eclipse.microprofile.openapi.models.OpenAPI
-
Sets this OpenAPI instance's components property to the given components.
- Components - Interface in org.eclipse.microprofile.openapi.models
-
Components
- Components - Annotation Interface in org.eclipse.microprofile.openapi.annotations
-
Describes the Components object that holds various reusable objects for different aspects of the OpenAPI Specification (OAS).
- 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
-
The name of the configuration ordinal property, "
config_ordinal
". - ConfigBuilder - Interface in org.eclipse.microprofile.config.spi
-
A builder for manually creating a configuration instance.
- configKey() - Element in annotation interface org.eclipse.microprofile.rest.client.inject.RegisterRestClient
-
Associates the annotated rest client interface with this configuration key.
- ConfigProperties - Annotation Interface in org.eclipse.microprofile.config.inject
-
Retrieve a number of related configuration properties with the specified prefix into a property class.
- ConfigProperties.Literal - Class in org.eclipse.microprofile.config.inject
-
Support inline instantiation of the
ConfigProperties
qualifier. - ConfigProperty - Annotation Interface 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
-
The service provider for implementations of the MicroProfile Configuration specification.
- ConfigProviderResolver() - Constructor for class org.eclipse.microprofile.config.spi.ConfigProviderResolver
-
Construct a new instance.
- ConfigSource - Interface in org.eclipse.microprofile.config.spi
-
A configuration source which provides configuration values from a specific place.
- ConfigSourceProvider - Interface in org.eclipse.microprofile.config.spi
-
A provider for configuration source instances.
- ConfigValue - Interface in org.eclipse.microprofile.config
-
The ConfigValue holds additional information after the lookup of a configuration property and is itself immutable.
- connectTimeout(long, TimeUnit) - Method in interface org.eclipse.microprofile.rest.client.RestClientBuilder
-
Set the connect timeout.
- Constructible - Interface in org.eclipse.microprofile.openapi.models
-
Marker interface for OpenAPI model objects that can be constructed by the OASFactory.
- constValue() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.media.Schema
-
Requires that the instance must be a specific value.
- constValue() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.media.SchemaProperty
-
Requires that the instance must be a specific value.
- constValue(Object) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Sets the const property from this Schema instance.
- contact() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.info.Info
-
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.
- Contact - Interface in org.eclipse.microprofile.openapi.models.info
-
This interface represents the Contact information for the exposed API.
- Contact - Annotation Interface in org.eclipse.microprofile.openapi.annotations.info
-
Contact information for the exposed API.
- contains() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.media.Schema
-
A schema which at least one element of an array instance must validate against.
- contains() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.media.SchemaProperty
-
A schema which at least one element of an array instance must validate against.
- contains(Schema) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Sets the contains property of this Schema instance.
- containsClaim(String) - Method in interface org.eclipse.microprofile.jwt.JsonWebToken
-
Verify is a given claim exists
- content() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.parameters.Parameter
-
The representation of this parameter, for different media types.
- content() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.parameters.RequestBody
-
The content of the request body.
- content() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.responses.APIResponse
-
An array containing descriptions of potential response payloads for different media types.
- content(Content) - Method in interface org.eclipse.microprofile.openapi.models.headers.Header
-
Sets this Header's content property to the given object.
- 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.
- Content - Interface in org.eclipse.microprofile.openapi.models.media
-
Content
- Content - Annotation Interface in org.eclipse.microprofile.openapi.annotations.media
-
This object provides schema and examples for a particular media type.
- contentEncoding() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.media.Schema
-
The encoding used to allow binary data to be stored in a string.
- contentEncoding() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.media.SchemaProperty
-
The encoding used to allow binary data to be stored in a string.
- contentEncoding(String) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Sets the contentEncoding property from this Schema instance.
- contentMediaType() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.media.Schema
-
The media type of the data in a string.
- contentMediaType() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.media.SchemaProperty
-
The media type of the data in a string.
- contentMediaType(String) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Sets the contentMediaType property from this Schema instance.
- contentSchema() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.media.Schema
-
The schema that data in a string must validate against.
- contentSchema() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.media.SchemaProperty
-
The schema that data in a string must validate against.
- contentSchema(Schema) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Sets the contentSchema property from this Schema instance.
- contentType() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.media.Encoding
-
The Content-Type for encoding a specific property.
- 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
-
Convert the given string value to a specified type.
- Converter<T> - Interface in org.eclipse.microprofile.config.spi
-
A mechanism for converting configured values from
String
to any Java type. - COOKIE - Enum constant in enum class org.eclipse.microprofile.openapi.annotations.enums.ParameterIn
- COOKIE - Enum constant in enum class org.eclipse.microprofile.openapi.annotations.enums.SecuritySchemeIn
- COOKIE - Enum constant in enum class org.eclipse.microprofile.openapi.models.parameters.Parameter.In
- COOKIE - Enum constant in enum class org.eclipse.microprofile.openapi.models.security.SecurityScheme.In
- createAPIResponse() - Static method in class org.eclipse.microprofile.openapi.OASFactory
-
This method creates a new
APIResponse
instance. - createAPIResponses() - Static method in class org.eclipse.microprofile.openapi.OASFactory
-
This method creates a new
APIResponses
instance. - createCallback() - Static method in class org.eclipse.microprofile.openapi.OASFactory
-
This method creates a new
Callback
instance. - createComponents() - Static method in class org.eclipse.microprofile.openapi.OASFactory
-
This method creates a new
Components
instance. - createContact() - Static method in class org.eclipse.microprofile.openapi.OASFactory
-
This method creates a new
Contact
instance. - createContent() - Static method in class org.eclipse.microprofile.openapi.OASFactory
-
This method creates a new
Content
instance. - createDiscriminator() - Static method in class org.eclipse.microprofile.openapi.OASFactory
-
This method creates a new
Discriminator
instance. - createEncoding() - Static method in class org.eclipse.microprofile.openapi.OASFactory
-
This method creates a new
Encoding
instance. - createExample() - Static method in class org.eclipse.microprofile.openapi.OASFactory
-
This method creates a new
Example
instance. - createExternalDocumentation() - Static method in class org.eclipse.microprofile.openapi.OASFactory
-
This method creates a new
ExternalDocumentation
instance. - createHeader() - Static method in class org.eclipse.microprofile.openapi.OASFactory
-
This method creates a new
Header
instance. - createInfo() - Static method in class org.eclipse.microprofile.openapi.OASFactory
-
This method creates a new
Info
instance. - createLicense() - Static method in class org.eclipse.microprofile.openapi.OASFactory
-
This method creates a new
License
instance. - createLink() - Static method in class org.eclipse.microprofile.openapi.OASFactory
-
This method creates a new
Link
instance. - createMediaType() - Static method in class org.eclipse.microprofile.openapi.OASFactory
-
This method creates a new
MediaType
instance. - createOAuthFlow() - Static method in class org.eclipse.microprofile.openapi.OASFactory
-
This method creates a new
OAuthFlow
instance. - createOAuthFlows() - Static method in class org.eclipse.microprofile.openapi.OASFactory
-
This method creates a new
OAuthFlows
instance. - 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.
- createOpenAPI() - Static method in class org.eclipse.microprofile.openapi.OASFactory
-
This method creates a new
OpenAPI
instance. - createOperation() - Static method in class org.eclipse.microprofile.openapi.OASFactory
-
This method creates a new
Operation
instance. - createParameter() - Static method in class org.eclipse.microprofile.openapi.OASFactory
-
This method creates a new
Parameter
instance. - createPathItem() - Static method in class org.eclipse.microprofile.openapi.OASFactory
-
This method creates a new
PathItem
instance. - createPaths() - Static method in class org.eclipse.microprofile.openapi.OASFactory
-
This method creates a new
Paths
instance. - createRequestBody() - Static method in class org.eclipse.microprofile.openapi.OASFactory
-
This method creates a new
RequestBody
instance. - createResponseBuilder() - Method in interface org.eclipse.microprofile.health.spi.HealthCheckResponseProvider
-
Provides an implementation of
HealthCheckResponseBuilder
. - createSchema() - Static method in class org.eclipse.microprofile.openapi.OASFactory
-
This method creates a new
Schema
instance. - createSecurityRequirement() - Static method in class org.eclipse.microprofile.openapi.OASFactory
-
This method creates a new
SecurityRequirement
instance. - createSecurityScheme() - Static method in class org.eclipse.microprofile.openapi.OASFactory
-
This method creates a new
SecurityScheme
instance. - createServer() - Static method in class org.eclipse.microprofile.openapi.OASFactory
-
This method creates a new
Server
instance. - createServerVariable() - Static method in class org.eclipse.microprofile.openapi.OASFactory
-
This method creates a new
ServerVariable
instance. - createTag() - Static method in class org.eclipse.microprofile.openapi.OASFactory
-
This method creates a new
Tag
instance. - createXML() - Static method in class org.eclipse.microprofile.openapi.OASFactory
-
This method creates a new
XML
instance.
D
- DECRYPTOR_KEY_ALGORITHM - Static variable in interface org.eclipse.microprofile.jwt.config.Names
-
Key Management Algorithm property which can be set to either 'RSA-OAEP' or 'RSA-OAEP-256'
- DECRYPTOR_KEY_LOCATION - Static variable in interface org.eclipse.microprofile.jwt.config.Names
-
The relative path or full URL of the decryption key.
- DEEP_OBJECT - Enum constant in enum class org.eclipse.microprofile.openapi.models.media.Encoding.Style
- DEEPOBJECT - Enum constant in enum class org.eclipse.microprofile.openapi.annotations.enums.ParameterStyle
- DEEPOBJECT - Enum constant in enum class org.eclipse.microprofile.openapi.models.parameters.Parameter.Style
- DEFAULT - Enum constant in enum class org.eclipse.microprofile.openapi.annotations.enums.Explode
- DEFAULT - Enum constant in enum class org.eclipse.microprofile.openapi.annotations.enums.ParameterIn
- DEFAULT - Enum constant in enum class org.eclipse.microprofile.openapi.annotations.enums.ParameterStyle
- DEFAULT - Enum constant in enum class org.eclipse.microprofile.openapi.annotations.enums.SchemaType
- DEFAULT - Enum constant in enum class org.eclipse.microprofile.openapi.annotations.enums.SecuritySchemeIn
- DEFAULT - Enum constant in enum class org.eclipse.microprofile.openapi.annotations.enums.SecuritySchemeType
- DEFAULT - Static variable in interface org.eclipse.microprofile.openapi.models.responses.APIResponses
- DEFAULT() - Constructor for class org.eclipse.microprofile.faulttolerance.Fallback.DEFAULT
- DEFAULT_ORDINAL - Static variable in interface org.eclipse.microprofile.config.spi.ConfigSource
-
The default configuration ordinal value,
100
. - DEFAULT_PRIORITY - Static variable in interface org.eclipse.microprofile.rest.client.ext.ResponseExceptionMapper
- DefaultClientHeadersFactoryImpl - Class in org.eclipse.microprofile.rest.client.ext
-
This class propagates Jakarta RESTful Web Services headers whose names are specified using the MicroProfile Config property,
org.eclipse.microprofile.rest.client.propagateHeaders
. - DefaultClientHeadersFactoryImpl() - Constructor for class org.eclipse.microprofile.rest.client.ext.DefaultClientHeadersFactoryImpl
- defaultValue() - Element in annotation interface org.eclipse.microprofile.config.inject.ConfigProperty
-
The default value if the configured property does not exist.
- defaultValue() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.media.Schema
-
Provides a default value.
- defaultValue() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.media.SchemaProperty
-
Provides a default value.
- defaultValue() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.servers.ServerVariable
-
The default value of this server variable.
- 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(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.
- 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.
- delay() - Element in annotation interface org.eclipse.microprofile.faulttolerance.CircuitBreaker
-
The delay after which an open circuit will transitions to half-open state.
- delay() - Element in annotation interface org.eclipse.microprofile.faulttolerance.Retry
-
The delay between retries.
- delayUnit() - Element in annotation interface org.eclipse.microprofile.faulttolerance.CircuitBreaker
-
The unit of the delay after which an open circuit will transitions to half-open state.
- delayUnit() - Element in annotation interface org.eclipse.microprofile.faulttolerance.Retry
-
The unit for
Retry.delay()
. - DELETE - Enum constant in enum class org.eclipse.microprofile.openapi.models.PathItem.HttpMethod
- DELETE(Operation) - Method in interface org.eclipse.microprofile.openapi.models.PathItem
-
Sets this PathItem's delete property to the given operation.
- dependentRequired() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.media.Schema
-
Specifies that certain properties must be present if other properties are present.
- dependentRequired() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.media.SchemaProperty
-
Specifies that certain properties must be present if other properties are present.
- dependentRequired(Map<String, List<String>>) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Sets the dependentRequired property of this Schema instance.
- DependentRequired - Annotation Interface in org.eclipse.microprofile.openapi.annotations.media
-
A property name and an associated list of other property names.
- DependentSchema - Annotation Interface in org.eclipse.microprofile.openapi.annotations.media
-
A property name and an associated schema.
- dependentSchemas() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.media.Schema
-
Schemas which an instance must validate against if the instance has certain properties.
- dependentSchemas() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.media.SchemaProperty
-
Schemas which an instance must validate against if the instance has certain properties.
- dependentSchemas(Map<String, Schema>) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Sets the dependentSchemas property of this Schema instance.
- deprecated() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.headers.Header
-
Specifies that a header is deprecated and should be transitioned out of usage.
- deprecated() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.media.Schema
-
Specifies that a schema is deprecated and SHOULD be transitioned out of usage.
- deprecated() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.media.SchemaProperty
-
Specifies that a schema is deprecated and SHOULD be transitioned out of usage.
- deprecated() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.Operation
-
Allows an operation to be marked as deprecated.
- deprecated() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.parameters.Parameter
-
Specifies that a parameter is deprecated and SHOULD be transitioned out of usage.
- deprecated() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.PathItemOperation
-
Allows an operation to be marked as deprecated
- 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() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.callbacks.CallbackOperation
-
A verbose description of the callback operation behavior.
- description() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.ExternalDocumentation
-
A short description of the target documentation.
- description() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.headers.Header
-
Additional description data to provide on the purpose of the header
- description() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.info.Info
-
A short description of the application.
- description() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.links.Link
-
A description of the link.
- description() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.media.ExampleObject
-
Long description for the example.
- description() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.media.Schema
-
A description of the schema.
- description() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.media.SchemaProperty
-
A description of the schema.
- description() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.Operation
-
A verbose description of the operation behaviour.
- description() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.parameters.Parameter
-
A brief description of the parameter.
- description() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.parameters.RequestBody
-
A brief description of the request body.
- description() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.PathItem
-
The description of the path item.
- description() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.PathItemOperation
-
A verbose description of the operation behavior.
- description() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.responses.APIResponse
-
A short description of the response.
- description() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.security.OAuthScope
-
Short description of the scope.
- description() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.security.SecurityScheme
-
A short description for security scheme.
- description() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.servers.Server
-
An optional string describing the host designated by the URL.
- description() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.servers.ServerVariable
-
An optional description for the server variable.
- description() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.tags.Tag
-
A short description for this tag.
- 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.
- dest - Enum constant in enum class org.eclipse.microprofile.jwt.Claims
- discriminator(Discriminator) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Sets the discriminator property of this Schema instance to the given object.
- Discriminator - Interface in org.eclipse.microprofile.openapi.models.media
-
Discriminator
- discriminatorMapping() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.media.Schema
-
An array of discriminator mappings.
- discriminatorMapping() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.media.SchemaProperty
-
An array of discriminator mappings.
- DiscriminatorMapping - Annotation Interface in org.eclipse.microprofile.openapi.annotations.media
-
This object maps payload values to a particular Schema.
- discriminatorProperty() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.media.Schema
-
Provides a discriminator property value.
- discriminatorProperty() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.media.SchemaProperty
-
Provides a discriminator property value.
- down() - Method in class org.eclipse.microprofile.health.HealthCheckResponseBuilder
-
Sets the status of the health check response to
HealthCheckResponse.Status.DOWN
. - down(String) - Static method in class org.eclipse.microprofile.health.HealthCheckResponse
-
Creates a failed health check with a name.
- DOWN - Enum constant in enum class org.eclipse.microprofile.health.HealthCheckResponse.Status
- durationUnit() - Element in annotation interface org.eclipse.microprofile.faulttolerance.Retry
-
The duration unit for
Retry.maxDuration()
.
E
- elseSchema() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.media.Schema
-
A class used to create a schema that an instance must validate against if it does not validate against the
if
schema. - elseSchema() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.media.SchemaProperty
-
A class used to create a schema that an instance must validate against if it does not validate against the
if
schema. - elseSchema(Schema) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Sets the "else" schema.
- email - Enum constant in enum class org.eclipse.microprofile.jwt.Claims
- email() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.info.Contact
-
The email address of the contact person/organization.
- 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
- email_verified - Enum constant in enum class org.eclipse.microprofile.jwt.Claims
- encoding() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.media.Content
-
An array of encoding corresponding to a map of property name and its encoding information in MediaType model.
- 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 - Interface in org.eclipse.microprofile.openapi.models.media
-
Encoding
- Encoding - Annotation Interface in org.eclipse.microprofile.openapi.annotations.media
-
Single encoding definition to be applied to single Schema Object
- Encoding.Style - Enum Class in org.eclipse.microprofile.openapi.models.media
- enumeration() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.media.Schema
-
Provides a list of enum values.
- enumeration() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.media.SchemaProperty
-
Provides a list of enum values.
- enumeration() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.servers.ServerVariable
-
An array of enum values for this variable.
- 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() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.media.Content
-
A free-form property to include an example of an instance for this content.
- example() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.media.Schema
-
Deprecated.
- example() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.media.SchemaProperty
-
Deprecated.
- example() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.parameters.Parameter
-
Provides an example of the schema.
- 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
-
Deprecated.
- example(Object) - Method in interface org.eclipse.microprofile.openapi.models.parameters.Parameter
-
Sets the example property of a Parameter instance to the given object.
- Example - Interface in org.eclipse.microprofile.openapi.models.examples
-
Example
- ExampleObject - Annotation Interface in org.eclipse.microprofile.openapi.annotations.media
-
This object illustrates an example of a particular content
- examples() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.Components
-
An object to hold reusable Example Objects.
- examples() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.media.Content
-
An array of examples used to show the use of the associated schema.
- examples() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.media.Schema
-
A free-form property to include examples of an instance for this schema.
- examples() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.media.SchemaProperty
-
A free-form property to include examples of an instance for this schema.
- examples() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.parameters.Parameter
-
Provides an array examples of the schema.
- examples(List<Object>) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Sets the examples property of this Schema instance.
- 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() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.media.Schema
-
If true, makes the maximum value exclusive, or a less-than criteria.
- exclusiveMaximum() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.media.SchemaProperty
-
If true, makes the maximum value exclusive, or a less-than criteria.
- exclusiveMaximum(BigDecimal) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Sets the exclusiveMaximum property of this Schema instance to the value given.
- exclusiveMinimum() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.media.Schema
-
If true, makes the minimum value exclusive, or a greater-than criteria.
- exclusiveMinimum() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.media.SchemaProperty
-
If true, makes the minimum value exclusive, or a greater-than criteria.
- exclusiveMinimum(BigDecimal) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Sets the exclusiveMinimum property of this Schema instance to the value given.
- 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. - exp - Enum constant in enum class org.eclipse.microprofile.jwt.Claims
- explode() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.media.Encoding
-
When explode is set to 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() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.parameters.Parameter
-
When this is true, parameter 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.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.
- Explode - Enum Class in org.eclipse.microprofile.openapi.annotations.enums
-
Enumeration used to define the value of Explode property.
- expression() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.links.LinkParameter
-
A constant or an expression to be evaluated and passed to the linked operation.
- Extensible<T extends Extensible<T>> - Interface in org.eclipse.microprofile.openapi.models
-
The base interface for OpenAPI model objects that can contain extensions.
- Extension - Annotation Interface in org.eclipse.microprofile.openapi.annotations.extensions
-
A named extension that should be added to the OpenAPI definition.
- extensions() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.callbacks.Callback
-
List of extensions to be added to the
Callback
model corresponding to the containing annotation. - extensions() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.callbacks.CallbackOperation
-
List of extensions to be added to the
Operation
model corresponding to the containing annotation. - extensions() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.Components
-
List of extensions to be added to the
Components
model corresponding to the containing annotation. - extensions() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.ExternalDocumentation
-
List of extensions to be added to the
ExternalDocumentation
model corresponding to the containing annotation. - extensions() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.headers.Header
-
List of extensions to be added to the
Header
model corresponding to the containing annotation. - extensions() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.info.Contact
-
List of extensions to be added to the
Contact
model corresponding to the containing annotation. - extensions() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.info.Info
-
List of extensions to be added to the
Info
model corresponding to the containing annotation. - extensions() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.info.License
-
List of extensions to be added to the
License
model corresponding to the containing annotation. - extensions() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.links.Link
-
List of extensions to be added to the
Link
model corresponding to the containing annotation. - extensions() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.media.Content
-
List of extensions to be added to the
MediaType
model corresponding to the containing annotation. - extensions() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.media.Encoding
-
List of extensions to be added to the
Encoding
model corresponding to the containing annotation. - extensions() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.media.ExampleObject
-
List of extensions to be added to the
Example
model corresponding to the containing annotation. - extensions() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.media.Schema
-
List of extensions to be added to the
Schema
model corresponding to the containing annotation. - extensions() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.media.SchemaProperty
-
List of extensions to be added to the
Schema
model corresponding to the containing annotation. - extensions() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.OpenAPIDefinition
-
List of extensions to be added to the
OpenAPI
model corresponding to the containing annotation. - extensions() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.Operation
-
List of extensions to be added to the
Operation
model corresponding to the containing annotation. - extensions() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.parameters.Parameter
-
List of extensions to be added to the
Parameter
model corresponding to the containing annotation. - extensions() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.parameters.RequestBody
-
List of extensions to be added to the
RequestBody
model corresponding to the containing annotation. - extensions() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.PathItem
-
List of extensions to be added to the
PathItem
model corresponding to the containing annotation. - extensions() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.PathItemOperation
-
List of extensions to be added to the
Operation
model corresponding to the containing annotation. - extensions() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.responses.APIResponse
-
List of extensions to be added to the
APIResponse
model corresponding to the containing annotation. - extensions() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.responses.APIResponses
-
List of extensions to be added to the
APIResponses
model corresponding to the containing annotation. - extensions() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.security.OAuthFlow
-
List of extensions to be added to the
OAuthFlow
model corresponding to the containing annotation. - extensions() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.security.OAuthFlows
-
List of extensions to be added to the
OAuthFlows
model corresponding to the containing annotation. - extensions() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.security.SecurityScheme
-
List of extensions to be added to the
SecurityScheme
model corresponding to the containing annotation. - extensions() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.servers.Server
-
List of extensions to be added to the
Server
model corresponding to the containing annotation. - extensions() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.servers.ServerVariable
-
List of extensions to be added to the
ServerVariable
model corresponding to the containing annotation. - extensions() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.tags.Tag
-
List of extensions to be added to the
Tag
model corresponding to the containing annotation. - extensions(Map<String, Object>) - Method in interface org.eclipse.microprofile.openapi.models.Extensible
-
Sets this Extensible's extensions property to the given map of extensions.
- Extensions - Annotation Interface 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() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.callbacks.CallbackOperation
-
Additional external documentation for this callback operation.
- externalDocs() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.media.Schema
-
Additional external documentation for this schema.
- externalDocs() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.media.SchemaProperty
-
Additional external documentation for this schema.
- externalDocs() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.OpenAPIDefinition
-
Any additional external documentation for the API
- externalDocs() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.PathItemOperation
-
Additional external documentation for this operation.
- externalDocs() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.tags.Tag
-
Additional external documentation for this tag.
- 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 - Interface in org.eclipse.microprofile.openapi.models
-
ExternalDocumentation
- ExternalDocumentation - Annotation Interface in org.eclipse.microprofile.openapi.annotations
-
This annotation allows referencing an external resource for extended documentation.
- externalValue() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.media.ExampleObject
-
A URL to point to an external document to be used as an example.
- externalValue(String) - Method in interface org.eclipse.microprofile.openapi.models.examples.Example
-
Sets this Example's externalValue property to the given string.
F
- failOn() - Element in annotation interface org.eclipse.microprofile.faulttolerance.CircuitBreaker
-
The list of exception types which should be considered failures.
- failureRatio() - Element in annotation interface org.eclipse.microprofile.faulttolerance.CircuitBreaker
-
The ratio of failures within the rolling window that will trip the circuit to open.
- Fallback - Annotation Interface 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.
- fallbackMethod() - Element in annotation interface org.eclipse.microprofile.faulttolerance.Fallback
-
Specify the method name to fallback to.
- FALSE - Enum constant in enum class org.eclipse.microprofile.openapi.annotations.enums.Explode
- family_name - Enum constant in enum class org.eclipse.microprofile.jwt.Claims
- 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(String) - Constructor for exception org.eclipse.microprofile.faulttolerance.exceptions.FaultToleranceDefinitionException
- FaultToleranceDefinitionException(String, Throwable) - Constructor for exception org.eclipse.microprofile.faulttolerance.exceptions.FaultToleranceDefinitionException
- FaultToleranceDefinitionException(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(String) - Constructor for exception org.eclipse.microprofile.faulttolerance.exceptions.FaultToleranceException
- FaultToleranceException(String, Throwable) - Constructor for exception org.eclipse.microprofile.faulttolerance.exceptions.FaultToleranceException
- FaultToleranceException(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() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.security.SecurityScheme
-
Applies to and is REQUIRED for SecurityScheme of oauth2 type.
- flows(OAuthFlows) - Method in interface org.eclipse.microprofile.openapi.models.security.SecurityScheme
-
Flows is a REQUIRED property.
- followRedirects(boolean) - Method in interface org.eclipse.microprofile.rest.client.RestClientBuilder
-
Specifies whether client built by this builder should follow HTTP redirect responses (30x) or not.
- forClassLoader(ClassLoader) - Method in interface org.eclipse.microprofile.config.spi.ConfigBuilder
-
Specify the class loader for which this configuration is being built.
- FORM - Enum constant in enum class org.eclipse.microprofile.openapi.annotations.enums.ParameterStyle
- FORM - Enum constant in enum class org.eclipse.microprofile.openapi.models.media.Encoding.Style
- FORM - Enum constant in enum class org.eclipse.microprofile.openapi.models.parameters.Parameter.Style
- format() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.media.Schema
-
Provides an optional override for the format.
- format() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.media.SchemaProperty
-
Provides an optional override for the format.
- format(String) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Sets the format property of this Schema instance to the given string.
- full_name - Enum constant in enum class org.eclipse.microprofile.jwt.Claims
G
- gender - Enum constant in enum class org.eclipse.microprofile.jwt.Claims
- get(String) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Gets a schema property by name.
- GET - Enum constant in enum class org.eclipse.microprofile.openapi.models.PathItem.HttpMethod
- GET(Operation) - Method in interface org.eclipse.microprofile.openapi.models.PathItem
-
Sets this PathItem's get property to the given operation.
- getAdditionalPropertiesBoolean() - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Deprecated.use
Schema.getAdditionalPropertiesSchema()
which may return a boolean-valued schema - getAdditionalPropertiesSchema() - 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.
- getAll() - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Gets all properties of a schema.
- 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.
- getAPIResponse(String) - Method in interface org.eclipse.microprofile.openapi.models.responses.APIResponses
-
Returns a APIResponse for a given name.
- getAPIResponses() - Method in interface org.eclipse.microprofile.openapi.models.responses.APIResponses
-
Returns a copy map (potentially immutable) of the APIResponses.
- 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.
- getBooleanSchema() - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Returns whether this Schema is a boolean schema.
- getBuilder() - Method in class org.eclipse.microprofile.config.spi.ConfigProviderResolver
-
Create a
ConfigBuilder
instance for the current application. - 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.
- getClaim(Claims) - 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
- getComment() - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Returns the comment to be included in the
$comment
property of the schema. - 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
-
Get the configuration corresponding to the current application, as defined by the calling thread's context class loader.
- getConfig() - Method in class org.eclipse.microprofile.config.spi.ConfigProviderResolver
-
Get the configuration instance for the current application in the manner described by
ConfigProvider.getConfig()
. - getConfig(ClassLoader) - Static method in class org.eclipse.microprofile.config.ConfigProvider
-
Get the configuration for the application corresponding to the given class loader instance.
- getConfig(ClassLoader) - Method in class org.eclipse.microprofile.config.spi.ConfigProviderResolver
-
Get the configuration instance for the current application in the manner described by
ConfigProvider.getConfig(ClassLoader)
. - getConfigSources() - Method in interface org.eclipse.microprofile.config.Config
-
Return all of the currently registered configuration sources for this configuration.
- getConfigSources(ClassLoader) - Method in interface org.eclipse.microprofile.config.spi.ConfigSourceProvider
-
Return the
ConfigSource
instances that are provided by this provider. - getConfigValue(String) - Method in interface org.eclipse.microprofile.config.Config
-
Return the
ConfigValue
for the specified property name from the underlying configuration source. - getConstValue() - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Returns the const property from this Schema instance.
- getContact() - Method in interface org.eclipse.microprofile.openapi.models.info.Info
-
Returns the contact information for the exposed API from this Info instance.
- getContains() - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Returns the contains property of this Schema 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.
- getContentEncoding() - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Returns the contentEncoding property from this Schema instance.
- getContentMediaType() - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Returns the contentMediaType property from this Schema instance.
- getContentSchema() - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Returns the contentSchema property from this Schema instance.
- getContentType() - Method in interface org.eclipse.microprofile.openapi.models.media.Encoding
-
The Content-Type for encoding a specific property.
- getConverter(Class<T>) - Method in interface org.eclipse.microprofile.config.Config
-
Return the
Converter
used by this instance to produce instances of the specified type from string values. - getData() - Method in class org.eclipse.microprofile.health.HealthCheckResponse
- 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.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.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.
- getDependentRequired() - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Returns the dependentRequired property of this Schema instance.
- getDependentSchemas() - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Returns the dependentSchemas property of this Schema 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 class org.eclipse.microprofile.jwt.Claims
- 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.
- getElseSchema() - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Returns the "else" schema.
- 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
-
Deprecated.
- 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.media.Schema
-
Returns the examples property of this Schema 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.
- 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.
- 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.
- getIdentifier() - Method in interface org.eclipse.microprofile.openapi.models.info.License
-
Returns the license identifier for this License instance that is used for the API.
- getIfSchema() - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Returns the "if" schema.
- 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 this instance of ApiResponse.
- getMapping() - Method in interface org.eclipse.microprofile.openapi.models.media.Discriminator
-
Returns the mapping property from a Discriminator instance.
- getMaxContains() - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Returns the maxContains property from this Schema instance.
- 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.
- getMediaType(String) - Method in interface org.eclipse.microprofile.openapi.models.media.Content
-
Returns a media type for a given name.
- getMediaTypes() - Method in interface org.eclipse.microprofile.openapi.models.media.Content
-
Returns a copy map (potentially immutable) of media types.
- getMethod() - Method in interface org.eclipse.microprofile.faulttolerance.ExecutionContext
-
Returns the method being executed.
- getMinContains() - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Returns the minContains property from this Schema instance.
- 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.ConfigValue
-
The name of the property.
- getName() - Method in interface org.eclipse.microprofile.config.spi.ConfigSource
-
The name of the configuration source.
- 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 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.
- 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.
- 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.
- getOperations() - Method in interface org.eclipse.microprofile.openapi.models.PathItem
-
Returns a map with all the operations for this path where the keys are
PathItem.HttpMethod
items - 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 configuration sources.
- getOptionalValues(String, Class<T>) - Method in interface org.eclipse.microprofile.config.Config
-
Return the resolved property values with the specified type for the specified property name from the underlying configuration sources.
- 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 priority value of this configuration 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.
- getPathItem(String) - Method in interface org.eclipse.microprofile.openapi.models.callbacks.Callback
-
Returns a path item for a given name.
- getPathItem(String) - Method in interface org.eclipse.microprofile.openapi.models.Paths
-
Returns a path item for a given name.
- getPathItems() - Method in interface org.eclipse.microprofile.openapi.models.callbacks.Callback
-
Returns a copy map (potentially immutable) of the path items.
- getPathItems() - Method in interface org.eclipse.microprofile.openapi.models.Components
-
Returns the pathItems property of this Components instance.
- getPathItems() - Method in interface org.eclipse.microprofile.openapi.models.Paths
-
Returns a copy map (potentially immutable) of the path items.
- 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.
- getPatternProperties() - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Returns the patternProperties 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.
- getPrefixItems() - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Returns the prefixItems property of this Schema 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 configuration source as a map.
- 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
-
Returns a sequence of configuration property names.
- getPropertyNames() - Method in interface org.eclipse.microprofile.config.spi.ConfigSource
-
Gets all property names known to this configuration source, potentially without evaluating the values.
- getPropertyNames() - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Returns the propertyNames property from this Schema instance.
- 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
- getRawValue() - Method in interface org.eclipse.microprofile.config.ConfigValue
-
The value of the property lookup without any transformation (expanded , etc).
- 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.
- getSchemaDialect() - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Returns the schema dialect in use.
- 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.
- getScheme(String) - Method in interface org.eclipse.microprofile.openapi.models.security.SecurityRequirement
-
Returns a list of scopes for a given scheme name.
- getSchemes() - Method in interface org.eclipse.microprofile.openapi.models.security.SecurityRequirement
-
Returns a copy map (potentially immutable) of the schemes.
- 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.
- getSourceName() - Method in interface org.eclipse.microprofile.config.ConfigValue
-
The
ConfigSource
name that loaded the property lookup. - getSourceOrdinal() - Method in interface org.eclipse.microprofile.config.ConfigValue
-
The
ConfigSource
ordinal that loaded the property lookup. - getStatus() - Method in class org.eclipse.microprofile.health.HealthCheckResponse
- 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.info.Info
-
Returns the summary of the exposed API from this Info 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 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.
- 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.
- getThenSchema() - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Returns the "then" schema.
- 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 class org.eclipse.microprofile.jwt.Claims
-
The required type of the claim
- getType() - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Returns the type property of this Schema instance.
- getType() - Method in interface org.eclipse.microprofile.openapi.models.security.SecurityScheme
-
Type is a REQUIRED property that specifies the type of SecurityScheme instance.
- getUnevaluatedItems() - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Returns the unevaluatedItems property of this Schema instance.
- getUnevaluatedProperties() - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Returns the unevaluatedProperties property of this Schema instance.
- getUniqueItems() - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Returns the uniqueItems property from this Schema instance.
- 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() - Method in interface org.eclipse.microprofile.config.ConfigValue
-
The value of the property lookup with transformations (expanded, etc).
- getValue() - Method in interface org.eclipse.microprofile.jwt.ClaimValue
-
Access the value of the claim.
- getValue() - Method in interface org.eclipse.microprofile.openapi.models.examples.Example
-
Returns the value property from an Example instance.
- getValue(String) - Method in interface org.eclipse.microprofile.config.spi.ConfigSource
-
Return the value for the specified property in this configuration source.
- 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 configuration sources.
- getValues(String, Class<T>) - Method in interface org.eclipse.microprofile.config.Config
-
Return the resolved property values with the specified type for the specified property name from the underlying configuration sources.
- 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.
- getWebhooks() - Method in interface org.eclipse.microprofile.openapi.models.OpenAPI
-
Returns the webhooks property of this OpenAPI 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.
- given_name - Enum constant in enum class org.eclipse.microprofile.jwt.Claims
- groups - Enum constant in enum class org.eclipse.microprofile.jwt.Claims
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, MultivaluedMap<String, Object>) - Method in interface org.eclipse.microprofile.rest.client.ext.ResponseExceptionMapper
-
Whether or not this mapper will be used for the given response.
- hasAPIResponse(String) - Method in interface org.eclipse.microprofile.openapi.models.responses.APIResponses
-
Check whether a APIResponse is present in the map.
- hasMediaType(String) - Method in interface org.eclipse.microprofile.openapi.models.media.Content
-
Check whether a media type is present in the map.
- hasPathItem(String) - Method in interface org.eclipse.microprofile.openapi.models.callbacks.Callback
-
Check whether a path item is present to the map.
- hasPathItem(String) - Method in interface org.eclipse.microprofile.openapi.models.Paths
-
Check whether a path item is present in the map.
- hasScheme(String) - Method in interface org.eclipse.microprofile.openapi.models.security.SecurityRequirement
-
Check whether a scheme is present in the map.
- HEAD - Enum constant in enum class org.eclipse.microprofile.openapi.models.PathItem.HttpMethod
- HEAD(Operation) - Method in interface org.eclipse.microprofile.openapi.models.PathItem
-
Sets this PathItem's head property to the given operation.
- header(String, Object) - Method in interface org.eclipse.microprofile.rest.client.RestClientBuilder
-
Add an arbitrary header.
- Header - Interface in org.eclipse.microprofile.openapi.models.headers
-
Header
- Header - Annotation Interface in org.eclipse.microprofile.openapi.annotations.headers
-
Describes a single header object
- HEADER - Enum constant in enum class org.eclipse.microprofile.openapi.annotations.enums.ParameterIn
- HEADER - Enum constant in enum class org.eclipse.microprofile.openapi.annotations.enums.SecuritySchemeIn
- HEADER - Enum constant in enum class org.eclipse.microprofile.openapi.models.parameters.Parameter.In
- HEADER - Enum constant in enum class org.eclipse.microprofile.openapi.models.security.SecurityScheme.In
- Header.Style - Enum Class in org.eclipse.microprofile.openapi.models.headers
-
Controls the style of serialization.
- headers() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.Components
-
An object to hold reusable Header Objects.
- headers() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.media.Encoding
-
An array of headers that corresponds to a map of headers in the encoding model.
- headers() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.responses.APIResponse
-
An array of response headers.
- 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.
- 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
-
Default constructor
- HealthCheckResponse(String, HealthCheckResponse.Status, Optional<Map<String, Object>>) - Constructor for class org.eclipse.microprofile.health.HealthCheckResponse
-
Constructor allowing instantiation from 3rd party framework like MicroProfile Rest client
- HealthCheckResponse.Status - Enum Class in org.eclipse.microprofile.health
- HealthCheckResponseBuilder - Class in org.eclipse.microprofile.health
-
A builder to construct a health check 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.
- hidden() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.media.Schema
-
Allows schema to be marked as hidden.
- hidden() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.media.SchemaProperty
-
Allows schema to be marked as hidden.
- hidden() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.Operation
-
Allows this operation to be marked as hidden
- hidden() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.parameters.Parameter
-
Allows this parameter to be marked as hidden
- hostnameVerifier(HostnameVerifier) - Method in interface org.eclipse.microprofile.rest.client.RestClientBuilder
-
Set the hostname verifier to verify the endpoint's hostname
- HTTP - Enum constant in enum class org.eclipse.microprofile.openapi.annotations.enums.SecuritySchemeType
- HTTP - Enum constant in enum class org.eclipse.microprofile.openapi.models.security.SecurityScheme.Type
I
- iat - Enum constant in enum class org.eclipse.microprofile.jwt.Claims
- identifier() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.info.License
-
The license identifier used for the API.
- identifier(String) - Method in interface org.eclipse.microprofile.openapi.models.info.License
-
Sets this License instance's identifier used for the API and returns this instance of License.
- ifSchema() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.media.Schema
-
A class used to create a schema used to control conditional evaluation.
- ifSchema() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.media.SchemaProperty
-
A class used to create a schema used to control conditional evaluation.
- ifSchema(Schema) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Sets the "if" schema.
- implementation() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.media.Schema
-
Provides a java class as implementation for this schema.
- implementation() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.media.SchemaProperty
-
Provides a java class as implementation for this schema.
- implicit() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.security.OAuthFlows
-
Configuration for the OAuth Implicit flow.
- 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() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.parameters.Parameter
-
The location of the parameter.
- in() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.security.SecurityScheme
-
Applies to and is REQUIRED for SecurityScheme of apiKey type.
- 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.
- info() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.OpenAPIDefinition
-
Required: Provides 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.
- Info - Interface in org.eclipse.microprofile.openapi.models.info
-
This interface represents all the metadata about the API.
- Info - Annotation Interface in org.eclipse.microprofile.openapi.annotations.info
-
This annotation provides metadata about the API, and maps to the Info object in OpenAPI Specification 3.
- instance() - Static method in class org.eclipse.microprofile.config.spi.ConfigProviderResolver
-
Find and return the provider resolver instance.
- 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.
- INSTANCE - Static variable in class org.eclipse.microprofile.health.Liveness.Literal
- INSTANCE - Static variable in class org.eclipse.microprofile.health.Readiness.Literal
- INSTANCE - Static variable in class org.eclipse.microprofile.health.Startup.Literal
- INTEGER - Enum constant in enum class org.eclipse.microprofile.openapi.annotations.enums.SchemaType
- INTEGER - Enum constant in enum class org.eclipse.microprofile.openapi.models.media.Schema.SchemaType
- iss - Enum constant in enum class org.eclipse.microprofile.jwt.Claims
- 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
- jitter() - Element in annotation interface org.eclipse.microprofile.faulttolerance.Retry
-
Set the jitter to randomly vary retry delays for.
- jitterDelayUnit() - Element in annotation interface org.eclipse.microprofile.faulttolerance.Retry
-
The delay unit for
Retry.jitter()
. - jku - Enum constant in enum class org.eclipse.microprofile.jwt.Claims
- JsonWebToken - Interface in org.eclipse.microprofile.jwt
-
A read-only interface for the the claims required by Eclipse MicroProfile conforming tokens.
- jti - Enum constant in enum class org.eclipse.microprofile.jwt.Claims
- jwe - Enum constant in enum class org.eclipse.microprofile.jwt.Claims
- jwk - Enum constant in enum class org.eclipse.microprofile.jwt.Claims
K
- keyStore(KeyStore, String) - Method in interface org.eclipse.microprofile.rest.client.RestClientBuilder
-
Set the client-side key store.
- kid - Enum constant in enum class org.eclipse.microprofile.jwt.Claims
L
- LABEL - Enum constant in enum class org.eclipse.microprofile.openapi.annotations.enums.ParameterStyle
- LABEL - Enum constant in enum class org.eclipse.microprofile.openapi.models.parameters.Parameter.Style
- license() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.info.Info
-
The 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.
- License - Annotation Interface in org.eclipse.microprofile.openapi.annotations.info
-
License information for the exposed API.
- Link - Interface in org.eclipse.microprofile.openapi.models.links
-
Link
- Link - Annotation Interface in org.eclipse.microprofile.openapi.annotations.links
-
The Link object represents a possible design-time link for a response.
- LinkParameter - Annotation Interface in org.eclipse.microprofile.openapi.annotations.links
-
Represents a parameter to pass to an operation as specified with operationId or identified via operationRef.
- links() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.Components
-
An object to hold reusable Link Objects.
- links() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.responses.APIResponse
-
An array of operation links that can be followed from the response.
- 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() - Constructor for class org.eclipse.microprofile.health.Liveness.Literal
- Literal() - Constructor for class org.eclipse.microprofile.health.Readiness.Literal
- Literal() - Constructor for class org.eclipse.microprofile.health.Startup.Literal
- LITERAL - Static variable in annotation interface org.eclipse.microprofile.rest.client.inject.RestClient
- Liveness - Annotation Interface in org.eclipse.microprofile.health
-
This qualifier is used to define a liveness Health Check procedure
- Liveness.Literal - Class in org.eclipse.microprofile.health
-
Support inline instantiation of the
Liveness
qualifier. - locale - Enum constant in enum class org.eclipse.microprofile.jwt.Claims
- LoginConfig - Annotation Interface 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.
- MATRIX - Enum constant in enum class org.eclipse.microprofile.openapi.annotations.enums.ParameterStyle
- MATRIX - Enum constant in enum class org.eclipse.microprofile.openapi.models.parameters.Parameter.Style
- maxContains() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.media.Schema
-
Specifies the maximum number of elements which may validate against the
Schema.contains()
schema. - maxContains() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.media.SchemaProperty
-
Specifies the maximum number of elements which may validate against the
SchemaProperty.contains()
schema. - maxContains(Integer) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Sets the maxContains property from this Schema instance.
- maxDuration() - Element in annotation interface org.eclipse.microprofile.faulttolerance.Retry
-
The max duration.
- maximum() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.media.Schema
-
Sets the maximum numeric value for a property.
- maximum() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.media.SchemaProperty
-
Sets the maximum numeric value for a property.
- 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() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.media.Schema
-
Only applicable if type=array.
- maxItems() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.media.SchemaProperty
-
Only applicable if type=array.
- 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() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.media.Schema
-
Sets the maximum length of a string value.
- maxLength() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.media.SchemaProperty
-
Sets the maximum length of a string value.
- 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() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.media.Schema
-
Constrains the number of arbitrary properties when additionalProperties is defined.
- maxProperties() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.media.SchemaProperty
-
Constrains the number of arbitrary properties when additionalProperties is defined.
- maxProperties(Integer) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Sets the maxProperties property of this Schema instance to the value given.
- maxRetries() - Element in annotation interface org.eclipse.microprofile.faulttolerance.Retry
-
The max number of the retries.
- mediaType() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.media.Content
-
The media type that this object applies to.
- MediaType - Interface in org.eclipse.microprofile.openapi.models.media
-
MediaType
- method() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.callbacks.CallbackOperation
-
The HTTP method for this callback operation.
- method() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.PathItemOperation
-
The HTTP method for this operation.
- middle_name - Enum constant in enum class org.eclipse.microprofile.jwt.Claims
- minContains() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.media.Schema
-
Specifies the minimum number of elements which must validate against the
Schema.contains()
schema. - minContains() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.media.SchemaProperty
-
Specifies the minimum number of elements which must validate against the
SchemaProperty.contains()
schema. - minContains(Integer) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Sets the minContains property from this Schema instance.
- minimum() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.media.Schema
-
Sets the minimum numeric value for a property.
- minimum() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.media.SchemaProperty
-
Sets the minimum numeric value for a property.
- 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() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.media.Schema
-
Only applicable if type=array.
- minItems() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.media.SchemaProperty
-
Only applicable if type=array.
- 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() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.media.Schema
-
Sets the minimum length of a string value.
- minLength() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.media.SchemaProperty
-
Sets the minimum length of a string value.
- 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() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.media.Schema
-
Constrains the number of arbitrary properties when additionalProperties is defined.
- minProperties() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.media.SchemaProperty
-
Constrains the number of arbitrary properties when additionalProperties is defined.
- minProperties(Integer) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Sets the minProperties property of this Schema instance to the value given.
- mky - Enum constant in enum class org.eclipse.microprofile.jwt.Claims
- MODEL_READER - Static variable in class org.eclipse.microprofile.openapi.OASConfig
-
Configuration property to specify the fully qualified name of the OASModelReader implementation.
- MULTI_PAIRS - Enum constant in enum class org.eclipse.microprofile.rest.client.ext.QueryParamStyle
-
Multiple parameter instances, e.g.:
foo=v1&foot=v2&foo=v3
This is the default if no style is configured. - multipleOf() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.media.Schema
-
Constrains a value such that when divided by the multipleOf, the result must be an integer.
- multipleOf() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.media.SchemaProperty
-
Constrains a value such that when divided by the multipleOf, the result must be an integer.
- multipleOf(BigDecimal) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Sets the multipleOf property of this Schema instance to the value given.
- MUTUALTLS - Enum constant in enum class org.eclipse.microprofile.openapi.annotations.enums.SecuritySchemeType
- MUTUALTLS - Enum constant in enum class org.eclipse.microprofile.openapi.models.security.SecurityScheme.Type
N
- name() - Element in annotation interface org.eclipse.microprofile.config.inject.ConfigProperty
-
The key of the config property used to look up the configuration value.
- name() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.callbacks.Callback
-
The friendly name used to refer to this callback.
- name() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.extensions.Extension
-
A name for the extension.
- name() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.headers.Header
-
The name of the header.
- name() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.info.Contact
-
The identifying name of the contact person/organization.
- name() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.info.License
-
The license name used for the API.
- name() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.links.Link
-
The name of this link.
- name() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.links.LinkParameter
-
The name of this link parameter.
- name() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.media.DependentRequired
-
The property name to look for
- name() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.media.DependentSchema
-
A property name
- name() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.media.Encoding
-
The name of this encoding object instance.
- name() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.media.ExampleObject
-
A unique name to identify this particular example in a map.
- name() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.media.Schema
-
The name of the schema or property.
- name() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.media.SchemaProperty
-
The name of the property.
- name() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.parameters.Parameter
-
The name of the parameter.
- name() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.parameters.RequestBody
-
The unique name to identify this request body.
- name() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.PathItem
-
The name of the Path Item object, used as the map key when the path item is used under
Components.pathItems()
orOpenAPIDefinition.webhooks()
- name() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.responses.APIResponse
-
The unique name to identify this response.
- name() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.security.OAuthScope
-
Name of the scope.
- name() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.security.SecurityRequirement
-
Name MUST correspond to a security scheme which is declared in the Security Schemes under the Components Object.
- name() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.servers.ServerVariable
-
The name of this server variable.
- name() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.tags.Tag
-
The name of this tag.
- name() - Element in annotation interface org.eclipse.microprofile.rest.client.annotation.ClientHeaderParam
- name(String) - Method in class org.eclipse.microprofile.health.HealthCheckResponseBuilder
-
Sets the name of the health check response.
- 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
-
Creates a
HealthCheckResponseBuilder
with a name. - 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.
- nbf - Enum constant in enum class org.eclipse.microprofile.jwt.Claims
- 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. - nickname - Enum constant in enum class org.eclipse.microprofile.jwt.Claims
- NO_PREFIX - Static variable in class org.eclipse.microprofile.config.inject.ConfigProperties.Literal
- nonce - Enum constant in enum class org.eclipse.microprofile.jwt.Claims
- not() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.media.Schema
-
Provides a java class to be used to disallow matching properties.
- not() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.media.SchemaProperty
-
Provides a java class to be used to disallow matching properties.
- 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.
- NULL - Enum constant in enum class org.eclipse.microprofile.openapi.models.media.Schema.SchemaType
- nullable() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.media.Schema
-
Allows sending a null value for the defined schema.
- nullable() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.media.SchemaProperty
-
Allows sending a null value for the defined schema.
- NUMBER - Enum constant in enum class org.eclipse.microprofile.openapi.annotations.enums.SchemaType
- NUMBER - Enum constant in enum class org.eclipse.microprofile.openapi.models.media.Schema.SchemaType
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.
- OAUTH2 - Enum constant in enum class org.eclipse.microprofile.openapi.annotations.enums.SecuritySchemeType
- OAUTH2 - Enum constant in enum class org.eclipse.microprofile.openapi.models.security.SecurityScheme.Type
- OAuthFlow - Interface in org.eclipse.microprofile.openapi.models.security
-
Configuration details for a supportde OAuthFlow
- OAuthFlow - Annotation Interface in org.eclipse.microprofile.openapi.annotations.security
-
Configuration details for a supported OAuth Flow.
- OAuthFlows - Interface in org.eclipse.microprofile.openapi.models.security
-
Configuration of the supported OAuthFlows
- OAuthFlows - Annotation Interface in org.eclipse.microprofile.openapi.annotations.security
-
Allows configuration of the supported OAuth Flows.
- OAuthScope - Annotation Interface in org.eclipse.microprofile.openapi.annotations.security
-
Represents an OAuth scope.
- OBJECT - Enum constant in enum class org.eclipse.microprofile.openapi.annotations.enums.SchemaType
- OBJECT - Enum constant in enum class org.eclipse.microprofile.openapi.models.media.Schema.SchemaType
- of(String) - Static method in class org.eclipse.microprofile.config.inject.ConfigProperties.Literal
- oneOf() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.media.Schema
-
Provides an array of java class implementations which can be used to describe multiple acceptable schemas.
- oneOf() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.media.SchemaProperty
-
Provides an array of java class implementations which can be used to describe multiple acceptable schemas.
- 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
- onNewClient(Class<?>, RestClientBuilder) - Method in interface org.eclipse.microprofile.rest.client.spi.RestClientListener
- openapi(String) - Method in interface org.eclipse.microprofile.openapi.models.OpenAPI
-
Sets this OpenAPI instance's openapi property to the given string.
- OpenAPI - Interface in org.eclipse.microprofile.openapi.models
-
OpenAPI
- OpenAPIDefinition - Annotation Interface in org.eclipse.microprofile.openapi.annotations
-
OpenAPI
- OPENIDCONNECT - Enum constant in enum class org.eclipse.microprofile.openapi.annotations.enums.SecuritySchemeType
- OPENIDCONNECT - Enum constant in enum class org.eclipse.microprofile.openapi.models.security.SecurityScheme.Type
- openIdConnectUrl() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.security.SecurityScheme
-
Applies to and is REQUIRED for SecurityScheme of openIdConnect type.
- openIdConnectUrl(String) - Method in interface org.eclipse.microprofile.openapi.models.security.SecurityScheme
-
penIdConnectUrl is a REQUIRED property.
- Operation - Interface in org.eclipse.microprofile.openapi.models
-
Operation
- Operation - Annotation Interface in org.eclipse.microprofile.openapi.annotations
-
Describes a single API operation on a path.
- operationId() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.links.Link
-
The name of an existing, resolvable OAS operation, as defined with a unique operationId.
- operationId() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.Operation
-
Unique string used to identify the operation.
- operationId() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.PathItemOperation
-
Unique string used to identify the 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() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.links.Link
-
A relative or absolute reference to an OAS operation.
- operationRef(String) - Method in interface org.eclipse.microprofile.openapi.models.links.Link
-
Sets this Link's operationRef property to the given string.
- operations() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.callbacks.Callback
-
The array of operations that will be called out-of band
- operations() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.PathItem
-
The operations available under this Path Item.
- OPTIONS - Enum constant in enum class org.eclipse.microprofile.openapi.models.PathItem.HttpMethod
- 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 implement the configuration API, and to extend the standard configuration 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 Health
- 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.openapi - package org.eclipse.microprofile.openapi
-
A set of Java interfaces, annotations and programming models which allow Java developers to natively produce OpenAPI v3.1 documents from their Jakarta REST applications.
- org.eclipse.microprofile.openapi.annotations - package org.eclipse.microprofile.openapi.annotations
-
A set of annotations, many derived from Swagger Core library.
- org.eclipse.microprofile.openapi.annotations.callbacks - package org.eclipse.microprofile.openapi.annotations.callbacks
-
A set of annotations to represent callback URL or an array of relevant callback URLs that can be invoked for a particular HTTP operation as well as the HTTP operation that will be invoked with the callback.
- org.eclipse.microprofile.openapi.annotations.enums - package org.eclipse.microprofile.openapi.annotations.enums
-
A set of parameters used by other annotations to represent their enumerable properties.
- org.eclipse.microprofile.openapi.annotations.extensions - package org.eclipse.microprofile.openapi.annotations.extensions
-
Annotations to represent additional data to extend existing OpenAPI specifications.
- org.eclipse.microprofile.openapi.annotations.headers - package org.eclipse.microprofile.openapi.annotations.headers
-
An annotation to describe a single header object.
- org.eclipse.microprofile.openapi.annotations.info - package org.eclipse.microprofile.openapi.annotations.info
-
A set of annotations to represent metadata about the API, including license information and contact information of the exposed API.
- org.eclipse.microprofile.openapi.annotations.links - package org.eclipse.microprofile.openapi.annotations.links
-
Annotations to represent a design-time link for a response and the corresponding parameter to be passed to the linked operation.
- org.eclipse.microprofile.openapi.annotations.media - package org.eclipse.microprofile.openapi.annotations.media
-
A set of annotations to represent input and output data type, media type and relevant examples.
- org.eclipse.microprofile.openapi.annotations.parameters - package org.eclipse.microprofile.openapi.annotations.parameters
-
A set of annotations to describe and encapsulate operation parameters and operation's request body.
- org.eclipse.microprofile.openapi.annotations.responses - package org.eclipse.microprofile.openapi.annotations.responses
-
Contains annotation to describe a single response from an API operation, and an annotation to encapsulate multiple responses from an API operation.
- org.eclipse.microprofile.openapi.annotations.security - package org.eclipse.microprofile.openapi.annotations.security
-
A set of annotations to represent various security components of an OpenAPI app.
- org.eclipse.microprofile.openapi.annotations.servers - package org.eclipse.microprofile.openapi.annotations.servers
-
Annotations to represent servers used for a single API operation or for all operations in an OpenAPI document, as well as a way to represent variables for server URL template substitution.
- org.eclipse.microprofile.openapi.annotations.tags - package org.eclipse.microprofile.openapi.annotations.tags
-
A set of annotations to represent a tag for an API endpoint and a container that encapsulates multiple such tags.
- org.eclipse.microprofile.openapi.models - package org.eclipse.microprofile.openapi.models
-
A set of interfaces for programmable models and their helper classes, many derived from Swagger Core library.
- org.eclipse.microprofile.openapi.models.callbacks - package org.eclipse.microprofile.openapi.models.callbacks
-
An interface to represent callback URL.
- org.eclipse.microprofile.openapi.models.examples - package org.eclipse.microprofile.openapi.models.examples
-
An interface to represent a programmable model of an example of a data type or a media type.
- org.eclipse.microprofile.openapi.models.headers - package org.eclipse.microprofile.openapi.models.headers
-
An interface of a programmable model to represent a single header object.
- org.eclipse.microprofile.openapi.models.info - package org.eclipse.microprofile.openapi.models.info
-
A set of interfaces of programmable models to represent metadata about the API, including license information and contact information of the exposed API.
- org.eclipse.microprofile.openapi.models.links - package org.eclipse.microprofile.openapi.models.links
-
An interface of a model to represent a design-time link for a response.
- org.eclipse.microprofile.openapi.models.media - package org.eclipse.microprofile.openapi.models.media
-
A set of interfaces for programmable models to represent input and output data types and media types.
- org.eclipse.microprofile.openapi.models.parameters - package org.eclipse.microprofile.openapi.models.parameters
-
A set of model interfaces to describe operation parameters and operation's request body.
- org.eclipse.microprofile.openapi.models.responses - package org.eclipse.microprofile.openapi.models.responses
-
Model interfaces to describe a single response from an API operation, and an annotation to encapsulate multiple responses from an API operation.
- org.eclipse.microprofile.openapi.models.security - package org.eclipse.microprofile.openapi.models.security
-
A set of model interfaces to represent various security components of an OpenAPI app.
- org.eclipse.microprofile.openapi.models.servers - package org.eclipse.microprofile.openapi.models.servers
-
Model interfaces to represent servers used for a single API operation or for all operations in an OpenAPI document, as well as a way to represent variables for server URL template substitution.
- org.eclipse.microprofile.openapi.models.tags - package org.eclipse.microprofile.openapi.models.tags
-
Model interface to represent a tag of an API endpoint.
- org.eclipse.microprofile.openapi.spi - package org.eclipse.microprofile.openapi.spi
-
Service provider interface which allows vendors to set their implementations of OASFactoryResolver.
- org.eclipse.microprofile.rest.client - package org.eclipse.microprofile.rest.client
-
APIs for building a type-safe RESTful client leveraging existing Jakarta RESTful Web Services 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.
- orig - Enum constant in enum class org.eclipse.microprofile.jwt.Claims
P
- Parameter - Interface in org.eclipse.microprofile.openapi.models.parameters
-
Parameter
- Parameter - Annotation Interface in org.eclipse.microprofile.openapi.annotations.parameters
-
Describes a single operation parameter
- Parameter.In - Enum Class in org.eclipse.microprofile.openapi.models.parameters
-
The values allowed for the in field.
- Parameter.Style - Enum Class in org.eclipse.microprofile.openapi.models.parameters
-
The values allowed for the style field.
- ParameterIn - Enum Class in org.eclipse.microprofile.openapi.annotations.enums
- parameters() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.callbacks.CallbackOperation
-
An array of parameters applicable for this callback operation, which will be added to any automatically detected parameters in the method itself.
- parameters() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.Components
-
An object to hold reusable Parameter Objects.
- parameters() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.links.Link
-
Array of parameters to pass to an operation as specified with operationId or identified via operationRef.
- parameters() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.PathItem
-
A list of parameters which apply to all operations under this path item.
- parameters() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.PathItemOperation
-
An array of parameters applicable for this operation.
- 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.
- 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(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 - Annotation Interface in org.eclipse.microprofile.openapi.annotations.parameters
-
This object encapsulates input parameters
- ParameterStyle - Enum Class in org.eclipse.microprofile.openapi.annotations.enums
- parseValue() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.extensions.Extension
-
Should the value be parsed into an object/array or other simple type (number, boolean, etc) or left as a simple String.
- password() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.security.OAuthFlows
-
Configuration for the OAuth Resource Owner Password flow.
- password(OAuthFlow) - Method in interface org.eclipse.microprofile.openapi.models.security.OAuthFlows
-
OAuth Resource Owner Password flow
- PATCH - Enum constant in enum class org.eclipse.microprofile.openapi.models.PathItem.HttpMethod
- PATCH(Operation) - Method in interface org.eclipse.microprofile.openapi.models.PathItem
-
Sets this PathItem's patch property to the given operation.
- PATH - Enum constant in enum class org.eclipse.microprofile.openapi.annotations.enums.ParameterIn
- PATH - Enum constant in enum class org.eclipse.microprofile.openapi.models.parameters.Parameter.In
- PathItem - Interface in org.eclipse.microprofile.openapi.models
-
PathItem
- PathItem - Annotation Interface in org.eclipse.microprofile.openapi.annotations
-
Describes a set of operations available on a single path.
- PathItem.HttpMethod - Enum Class in org.eclipse.microprofile.openapi.models
-
All of the possible types of HTTP operations for this path
- PathItemOperation - Annotation Interface in org.eclipse.microprofile.openapi.annotations
-
Describes an Operation
- pathItemRef() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.callbacks.Callback
-
Reference value to a Path Item object, to be referenced by the Callback object.
- pathItems() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.Components
-
An object to hold reusable Path Item Objects.
- pathItems(Map<String, PathItem>) - Method in interface org.eclipse.microprofile.openapi.models.Components
-
Sets the pathItems property of this Components instance.
- 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() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.media.Schema
-
A regular expression that the value must satisfy.
- pattern() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.media.SchemaProperty
-
A regular expression that the value must satisfy.
- pattern(String) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Sets the pattern property of this Schema instance to the string given.
- patternProperties() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.media.Schema
-
Applies subschemas against properties matched by regular expressions.
- patternProperties() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.media.SchemaProperty
-
Applies subschemas against properties matched by regular expressions.
- patternProperties(Map<String, Schema>) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Sets the patternProperties property from this Schema instance.
- PatternProperty - Annotation Interface in org.eclipse.microprofile.openapi.annotations.media
-
A regular expression and an associated schema.
- phone_number - Enum constant in enum class org.eclipse.microprofile.jwt.Claims
- phone_number_verified - Enum constant in enum class org.eclipse.microprofile.jwt.Claims
- PIPE_DELIMITED - Enum constant in enum class org.eclipse.microprofile.openapi.models.media.Encoding.Style
- PIPEDELIMITED - Enum constant in enum class org.eclipse.microprofile.openapi.annotations.enums.ParameterStyle
- PIPEDELIMITED - Enum constant in enum class org.eclipse.microprofile.openapi.models.parameters.Parameter.Style
- POST - Enum constant in enum class org.eclipse.microprofile.openapi.models.PathItem.HttpMethod
- POST(Operation) - Method in interface org.eclipse.microprofile.openapi.models.PathItem
-
Sets this PathItem's post property to the given operation.
- preferred_username - Enum constant in enum class org.eclipse.microprofile.jwt.Claims
- prefix() - Method in class org.eclipse.microprofile.config.inject.ConfigProperties.Literal
- prefix() - Element in annotation interface org.eclipse.microprofile.config.inject.ConfigProperties
-
The prefix of the configuration properties.
- 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.
- prefixItems() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.media.Schema
-
Schemas which the leading elements of an array instance must validate against.
- prefixItems() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.media.SchemaProperty
-
Schemas which the leading elements of an array instance must validate against.
- prefixItems(List<Schema>) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Sets the prefixItems property of this Schema 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.
- priority() - Element in annotation interface org.eclipse.microprofile.rest.client.annotation.RegisterProvider
- PROFILE - Static variable in interface org.eclipse.microprofile.config.Config
-
The value of the property specifies a single active profile.
- PROPAGATE_PROPERTY - Static variable in class org.eclipse.microprofile.rest.client.ext.DefaultClientHeadersFactoryImpl
- properties() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.media.Schema
-
Provides a list of properties present in this schema.
- 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.
- PROPERTY_EXPRESSIONS_ENABLED - Static variable in interface org.eclipse.microprofile.config.Config
-
The value of the property determines whether the property expression is enabled or disabled.
- propertyName(String) - Method in interface org.eclipse.microprofile.openapi.models.media.Discriminator
-
Sets this Discriminator's propertyName property to the given string.
- propertyNames() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.media.Schema
-
A schema which the names of properties of an object instance must validate against.
- propertyNames() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.media.SchemaProperty
-
A schema which the names of properties of an object instance must validate against.
- propertyNames(Schema) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Sets the propertyNames property from this Schema instance.
- proxyAddress(String, int) - Method in interface org.eclipse.microprofile.rest.client.RestClientBuilder
-
Specifies the HTTP proxy hostname/IP address and port to use for requests from client instances.
- PUT - Enum constant in enum class org.eclipse.microprofile.openapi.models.PathItem.HttpMethod
- PUT(Operation) - Method in interface org.eclipse.microprofile.openapi.models.PathItem
-
Sets this PathItem's put property to the given operation.
Q
- QUERY - Enum constant in enum class org.eclipse.microprofile.openapi.annotations.enums.ParameterIn
- QUERY - Enum constant in enum class org.eclipse.microprofile.openapi.annotations.enums.SecuritySchemeIn
- QUERY - Enum constant in enum class org.eclipse.microprofile.openapi.models.parameters.Parameter.In
- QUERY - Enum constant in enum class org.eclipse.microprofile.openapi.models.security.SecurityScheme.In
- queryParamStyle(QueryParamStyle) - Method in interface org.eclipse.microprofile.rest.client.RestClientBuilder
-
Specifies the URI formatting style to use when multiple query parameter values are passed to the client.
- QueryParamStyle - Enum Class in org.eclipse.microprofile.rest.client.ext
-
A QueryParamStyle enum is used to specify how multiple values are handled when constructing the query portion of the URI.
R
- raw_token - Enum constant in enum class org.eclipse.microprofile.jwt.Claims
- Readiness - Annotation Interface in org.eclipse.microprofile.health
-
This qualifier is used to define a readiness Health Check procedure
- Readiness.Literal - Class in org.eclipse.microprofile.health
-
Support inline instantiation of the
Readiness
qualifier. - readOnly() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.media.Schema
-
Declares the property as "read only".
- readOnly() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.media.SchemaProperty
-
Declares the property as "read only".
- readOnly(Boolean) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Sets the readOnly property of this Schema.
- readTimeout(long, TimeUnit) - Method in interface org.eclipse.microprofile.rest.client.RestClientBuilder
-
Set the read timeout.
- realmName() - Element in annotation interface org.eclipse.microprofile.auth.LoginConfig
-
The realm name
- ref() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.callbacks.Callback
-
Reference value to a Callback object.
- ref() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.headers.Header
-
Reference value to a Header object.
- ref() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.links.Link
-
Reference value to a Link object.
- ref() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.media.ExampleObject
-
Reference value to an Example object.
- ref() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.media.Schema
-
Reference value to a Schema definition.
- ref() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.media.SchemaProperty
-
Reference value to a Schema definition.
- ref() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.parameters.Parameter
-
Reference value to a Parameter object.
- ref() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.parameters.RequestBody
-
Reference value to a RequestBody object.
- ref() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.PathItem
-
Reference value to a PathItem object.
- ref() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.responses.APIResponse
-
Reference value to a Response object.
- ref() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.security.SecurityScheme
-
Reference value to a SecurityScheme object.
- ref() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.tags.Tag
-
Reference value to a Tag object.
- 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() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.security.OAuthFlow
-
The URL to be used for obtaining refresh tokens.
- refreshUrl(String) - Method in interface org.eclipse.microprofile.openapi.models.security.OAuthFlow
-
The URL to be used for obtaining refresh tokens.
- refs() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.tags.Tags
-
An array of referenced Tag objects which hold metadata for the API
- regex() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.media.PatternProperty
-
A regular expression to match against property names.
- RegisterClientHeaders - Annotation Interface in org.eclipse.microprofile.rest.client.annotation
-
Used to specify that a
ClientHeadersFactory
should be used to generate or propagate HTTP headers on the outbound request. - registerConfig(Config, ClassLoader) - Method in class org.eclipse.microprofile.config.spi.ConfigProviderResolver
-
Register the given
Config
instance to the application identified by the given class loader. - RegisterProvider - Annotation Interface 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 Interface 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 Interface in org.eclipse.microprofile.rest.client.inject
-
A marker annotation to register a rest client at runtime.
- 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. - removeAllOf(Schema) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Removes the given Schema to the list of schemas used by the allOf property.
- removeAnyOf(Schema) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Removes the given Schema to the list of schemas used by the anyOf property.
- removeAPIResponse(String) - Method in interface org.eclipse.microprofile.openapi.models.responses.APIResponses
-
Removes the given APIResponse to this APIResponses.
- removeCallback(String) - Method in interface org.eclipse.microprofile.openapi.models.Components
-
Removes the given callback to this Components' map of callbacks with the given string as its key.
- removeCallback(String) - Method in interface org.eclipse.microprofile.openapi.models.Operation
-
Removes the given callback item to this Operation's map of callbacks.
- removeContext() - 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.
- removeDependentRequired(String) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Removes the list of additional property names that are required if a property named
propertyName
exists. - removeDependentSchema(String) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Removes the dependent schema for a property name.
- removeEncoding(String) - Method in interface org.eclipse.microprofile.openapi.models.media.MediaType
-
Removes an Encoding item to the encoding property of a MediaType instance.
- removeEnumeration(Object) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Removes an item of the appropriate type to the enumerated list of values allowed.
- removeEnumeration(String) - Method in interface org.eclipse.microprofile.openapi.models.servers.ServerVariable
-
This method removes a string item to enumeration list of a ServerVariable instance.
- removeExample(Object) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Removes an example from the examples list.
- removeExample(String) - Method in interface org.eclipse.microprofile.openapi.models.Components
-
Removes the given example to this Components' map of examples with the given string as its key.
- removeExample(String) - Method in interface org.eclipse.microprofile.openapi.models.headers.Header
-
Removes an example of the header using the specified key to this Header instance.
- removeExample(String) - Method in interface org.eclipse.microprofile.openapi.models.media.MediaType
-
Removes an example item to the examples map of a MediaType instance.
- removeExample(String) - Method in interface org.eclipse.microprofile.openapi.models.parameters.Parameter
-
Removes an example of the parameter using the specified key.
- removeExtension(String) - Method in interface org.eclipse.microprofile.openapi.models.Extensible
-
Removes the given object to this Extensible's map of extensions, with the given name as its key.
- removeHeader(String) - Method in interface org.eclipse.microprofile.openapi.models.Components
-
Removes the given header to this Components' map of headers with the given string as its key.
- removeHeader(String) - Method in interface org.eclipse.microprofile.openapi.models.media.Encoding
-
Removes the given header to this Encoding' list of headers with the given string as its key.
- removeHeader(String) - Method in interface org.eclipse.microprofile.openapi.models.responses.APIResponse
-
Removes the given Header to this ApiResponse instance's map of Headers with the given name and return this instance of ApiResponse.
- removeLink(String) - Method in interface org.eclipse.microprofile.openapi.models.Components
-
Removes the given link to this Components' map of links with the given string as its key.
- removeLink(String) - Method in interface org.eclipse.microprofile.openapi.models.responses.APIResponse
-
Removes a link to this instance of ApiResponse using the given name and Link.
- removeMapping(String) - Method in interface org.eclipse.microprofile.openapi.models.media.Discriminator
-
Remove the given name to the given value and stores it in this Discriminator's mapping property.
- removeMediaType(String) - Method in interface org.eclipse.microprofile.openapi.models.media.Content
-
Removes the given MediaType for this Content by its name.
- removeOneOf(Schema) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Removes the given Schema to the list of schemas used by the oneOf property.
- removeParameter(String) - Method in interface org.eclipse.microprofile.openapi.models.Components
-
Removes the given parameter to this Components' map of parameters with the given string as its key.
- removeParameter(String) - Method in interface org.eclipse.microprofile.openapi.models.links.Link
-
Remove a new parameter to the parameters property of this instance of Link.
- removeParameter(Parameter) - Method in interface org.eclipse.microprofile.openapi.models.Operation
-
Removes the given parameter item to this Operation's list of parameters.
- removeParameter(Parameter) - Method in interface org.eclipse.microprofile.openapi.models.PathItem
-
Removes the given parameter to this PathItem's list of parameters.
- removePathItem(String) - Method in interface org.eclipse.microprofile.openapi.models.callbacks.Callback
-
Removes the given path item of the Callback PathItems.
- removePathItem(String) - Method in interface org.eclipse.microprofile.openapi.models.Components
-
Removes a path item.
- removePathItem(String) - Method in interface org.eclipse.microprofile.openapi.models.Paths
-
Removes the given path item to this Paths.
- removePatternProperty(String) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Removes a regular expression and its corresponding schema pair from the list of pattern properties.
- removePrefixItem(Schema) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Removes a schema from the prefixItems list.
- removeProperty(String) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Removes a Schema property of the provided name using the given schema.
- removeRequestBody(String) - Method in interface org.eclipse.microprofile.openapi.models.Components
-
Removes the given request body to this Components' map of request bodies with the given string as its key.
- removeRequired(String) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Removes the name of an item to the list of fields required in objects defined by this Schema.
- removeResponse(String) - Method in interface org.eclipse.microprofile.openapi.models.Components
-
Removes the given response to this Components' map of responses with the given string as its key.
- removeSchema(String) - Method in interface org.eclipse.microprofile.openapi.models.Components
-
Removes the given schema to this Components' list of schemas with the given string as its key.
- removeScheme(String) - Method in interface org.eclipse.microprofile.openapi.models.security.SecurityRequirement
-
Removes a security scheme to the SecurityRequirement instance based on the scheme name.
- removeScope(String) - Method in interface org.eclipse.microprofile.openapi.models.security.OAuthFlow
-
Removes the given scope item to this scope mapping.
- removeSecurityRequirement(SecurityRequirement) - Method in interface org.eclipse.microprofile.openapi.models.OpenAPI
-
Removes the given security requirement to this OpenAPI instance's list of security requirements.
- removeSecurityRequirement(SecurityRequirement) - Method in interface org.eclipse.microprofile.openapi.models.Operation
-
Removes the given security requirement item to this Operation's list of security mechanisms.
- removeSecurityScheme(String) - Method in interface org.eclipse.microprofile.openapi.models.Components
-
Removes the given security scheme to this Components' map of security schemes with the given string as its key.
- removeServer(Server) - Method in interface org.eclipse.microprofile.openapi.models.OpenAPI
-
Removes the given server to this OpenAPI instance's list of servers.
- removeServer(Server) - Method in interface org.eclipse.microprofile.openapi.models.Operation
-
Removes the given server to this Operation's list of servers.
- removeServer(Server) - Method in interface org.eclipse.microprofile.openapi.models.PathItem
-
Removes the given server to this PathItem's list of servers.
- removeTag(String) - Method in interface org.eclipse.microprofile.openapi.models.Operation
-
Removes the given tag to this Operation's list of tags.
- removeTag(Tag) - Method in interface org.eclipse.microprofile.openapi.models.OpenAPI
-
Removes the given tag to this OpenAPI instance's list of tags.
- removeType(Schema.SchemaType) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Removes a type from the type list.
- removeVariable(String) - Method in interface org.eclipse.microprofile.openapi.models.servers.Server
-
Removes the given server variable item from the Server's map of variables
- removeWebhook(String) - Method in interface org.eclipse.microprofile.openapi.models.OpenAPI
-
Removes a webhook definition.
- requestBodies() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.Components
-
An object to hold reusable Request Body Objects.
- 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() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.callbacks.CallbackOperation
-
The request body applicable for this callback operation.
- requestBody() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.links.Link
-
A literal value or {expression} to use as a request body when calling the target operation.
- requestBody() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.PathItemOperation
-
The request body for this operation.
- 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.
- RequestBody - Annotation Interface in org.eclipse.microprofile.openapi.annotations.parameters
-
Describes a single request body.
- RequestBodySchema - Annotation Interface in org.eclipse.microprofile.openapi.annotations.parameters
-
Provides a reference to a class that (after introspection) describes the schema for a single request body.
- requestVolumeThreshold() - Element in annotation interface org.eclipse.microprofile.faulttolerance.CircuitBreaker
-
The number of consecutive requests in a rolling window.
- required() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.headers.Header
-
Determines whether this header is mandatory.
- required() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.media.Schema
-
Specifies whether the annotated item is required or not.
- required() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.parameters.Parameter
-
Determines whether this parameter is mandatory.
- required() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.parameters.RequestBody
-
Determines if the request body is required in the request.
- required() - Element in annotation interface org.eclipse.microprofile.rest.client.annotation.ClientHeaderParam
- required(Boolean) - Method in interface org.eclipse.microprofile.openapi.models.headers.Header
-
Sets this Header's required property to the given value.
- 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
- 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.
- requiredProperties() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.media.Schema
-
Allows multiple properties in an object to be marked as required.
- requiredProperties() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.media.SchemaProperty
-
Allows multiple properties in an object to be marked as required.
- requires() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.media.DependentRequired
-
The property names that an object is required to have, if it has a property named
DependentRequired.name()
- responseCode() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.responses.APIResponse
-
The HTTP response code, or 'default', for the supplied response.
- responseCode() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.responses.APIResponseSchema
-
The HTTP response code, or 'default', for the supplied response.
- responseDescription() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.responses.APIResponseSchema
-
A short description of the response.
- ResponseExceptionMapper<T extends Throwable> - Interface in org.eclipse.microprofile.rest.client.ext
-
Converts an Jakarta RESTful Web Services Response object into an Exception.
- responses() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.callbacks.CallbackOperation
-
This is a REQUIRED property of an callback operation instance.
- responses() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.Components
-
An object to hold reusable Response Objects.
- responses() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.PathItemOperation
-
The list of possible responses that can be returned when executing this operation.
- 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 Interface 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
- RestClientListener - Interface in org.eclipse.microprofile.rest.client.spi
-
Implementations of this interface will be notified when new Rest Client instances are being constructed.
- RestClientLiteral() - Constructor for class org.eclipse.microprofile.rest.client.inject.RestClient.RestClientLiteral
- Retry - Annotation Interface in org.eclipse.microprofile.faulttolerance
-
The retry annotation to define the number of retries.
- retryOn() - Element in annotation interface org.eclipse.microprofile.faulttolerance.Retry
-
The list of exception types that should trigger a retry.
S
- SCAN_BEANVALIDATION - Static variable in class org.eclipse.microprofile.openapi.OASConfig
-
Configuration property to enable or disable scanning Jakarta Bean Validation annotations
- 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() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.headers.Header
-
The schema defining the type used for the header.
- schema() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.media.Content
-
The schema defining the type used for the request body.
- schema() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.media.DependentSchema
-
The schema that an instance must validate against if it has a property named
DependentSchema.name()
. - schema() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.media.DiscriminatorMapping
-
The schema that is being mapped to a property value
- schema() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.media.PatternProperty
-
A schema that a property value must validate against
- schema() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.parameters.Parameter
-
The schema defining the type used for the parameter.
- 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(Schema) - Method in interface org.eclipse.microprofile.openapi.models.parameters.Parameter
-
Sets the schema property of a Parameter instance to the given value.
- Schema - Interface in org.eclipse.microprofile.openapi.models.media
-
The Schema Object allows the definition of input and output data types.
- Schema - Annotation Interface in org.eclipse.microprofile.openapi.annotations.media
-
The Schema Object allows the definition of input and output data types.
- SCHEMA_PREFIX - Static variable in class org.eclipse.microprofile.openapi.OASConfig
-
Prefix of the configuration property to specify a schema for a specific class, in JSON format.
- Schema.False - Class in org.eclipse.microprofile.openapi.annotations.media
-
Marker class to indicate that a boolean
false
schema should be used. - Schema.SchemaType - Enum Class in org.eclipse.microprofile.openapi.models.media
-
The values allowed for the
type
field. - Schema.True - Class in org.eclipse.microprofile.openapi.annotations.media
-
Marker class to indicate that a boolean
true
schema should be used. - schemaDialect(String) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Sets the schema dialect in use.
- SchemaProperty - Annotation Interface in org.eclipse.microprofile.openapi.annotations.media
-
The SchemaProperty Object allows the definition of input and output data types nested within the
properties
attribute of aSchema
annotation. - schemas() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.Components
-
An object to hold reusable Schema Objects.
- 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 Class in org.eclipse.microprofile.openapi.annotations.enums
- scheme() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.security.SecurityScheme
-
Applies to and is REQUIRED for SecurityScheme of http type.
- 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() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.security.OAuthFlow
-
This is a REQUIRED property.
- scopes() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.security.SecurityRequirement
-
If the security scheme referred by the name property is of type "oauth2" or "openIdConnect", then the scopes array is a list of scope names required for the execution.
- scopes(Map<String, String>) - Method in interface org.eclipse.microprofile.openapi.models.security.OAuthFlow
-
The available scopes for the OAuth2 security scheme.
- security() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.callbacks.CallbackOperation
-
A declaration of which security mechanisms can be used for this callback operation.
- security() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.OpenAPIDefinition
-
A declaration of which security mechanisms can be used across the API.
- security() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.PathItemOperation
-
A declaration of which security mechanisms can be used for this callback operation.
- 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 - Interface in org.eclipse.microprofile.openapi.models.security
-
SecurityRequirement
- SecurityRequirement - Annotation Interface in org.eclipse.microprofile.openapi.annotations.security
-
Specifies a security requirement for an operation.
- SecurityRequirements - Annotation Interface in org.eclipse.microprofile.openapi.annotations.security
-
Container annotation for repeated
SecurityRequirement
annotations. - SecurityRequirementsSet - Annotation Interface in org.eclipse.microprofile.openapi.annotations.security
-
This annotation represents a set of security requirements which permit access to an operation if all of them are satisfied.
- SecurityRequirementsSets - Annotation Interface in org.eclipse.microprofile.openapi.annotations.security
-
Represents an array of security requirement sets that apply to an operation.
- SecurityScheme - Interface in org.eclipse.microprofile.openapi.models.security
-
SecurityScheme
- SecurityScheme - Annotation Interface in org.eclipse.microprofile.openapi.annotations.security
-
Defines a security scheme that can be used by the operations.
- SecurityScheme.In - Enum Class in org.eclipse.microprofile.openapi.models.security
-
In is a REQUIRED property that specifies the location of the API key.
- SecurityScheme.Type - Enum Class in org.eclipse.microprofile.openapi.models.security
-
Type is a REQUIRED property that specifies the type of SecurityScheme instance.
- SecuritySchemeIn - Enum Class in org.eclipse.microprofile.openapi.annotations.enums
- securitySchemeName() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.security.SecurityScheme
-
The name of this SecurityScheme.
- securitySchemes() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.Components
-
An object to hold reusable Security Scheme Objects.
- 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.
- SecuritySchemes - Annotation Interface in org.eclipse.microprofile.openapi.annotations.security
-
This object represents an array of SecurityScheme annotations that can be specified at the definition level.
- SecuritySchemeType - Enum Class in org.eclipse.microprofile.openapi.annotations.enums
- securitySets() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.callbacks.CallbackOperation
-
A declaration of which security mechanisms can be used for this callback operation.
- securitySets() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.OpenAPIDefinition
-
A declaration of which security mechanisms can be used across the API.
- securitySets() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.PathItemOperation
-
A declaration of which security mechanisms can be used for this callback operation.
- server() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.links.Link
-
An alternative server to service this operation.
- 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.
- Server - Annotation Interface 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.
- servers() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.OpenAPIDefinition
-
An array of Server Objects, which provide connectivity information to a target server.
- servers() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.PathItem
-
A list of servers to be used for this Path Item, overriding those defined for the whole API.
- servers() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.PathItemOperation
-
A list of servers to be used for this operation, overriding those defined for the parent path item or for the whole API.
- 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 - Annotation Interface in org.eclipse.microprofile.openapi.annotations.servers
-
The Servers annotation is a container for @Server annotations.
- 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 - Interface in org.eclipse.microprofile.openapi.models.servers
-
An object representing a Server Variable for server URL template substitution.
- ServerVariable - Annotation Interface in org.eclipse.microprofile.openapi.annotations.servers
-
An object representing a Server Variable for server URL template substitution.
- set(String, Object) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Sets a schema property.
- setAdditionalPropertiesBoolean(Boolean) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Deprecated.use
Schema.setAdditionalPropertiesSchema(Schema)
with a boolean-valued schema - setAdditionalPropertiesSchema(Schema) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Sets the Schema which defines additional properties not defined by "properties" or "patternProperties".
- setAll(Map<String, ?>) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Sets all properties of a schema.
- 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.
- setAPIResponses(Map<String, APIResponse>) - Method in interface org.eclipse.microprofile.openapi.models.responses.APIResponses
-
Set the APIResponses map to this APIResponses
- 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.
- setBooleanSchema(Boolean) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Sets this schema to a boolean value.
- 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
- setComment(String) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Sets the comment to be included in the
$comment
property of the schema. - setComponents(Components) - Method in interface org.eclipse.microprofile.openapi.models.OpenAPI
-
Sets this OpenAPI instance's components property to the given components.
- setConstValue(Object) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Sets the const property from this Schema instance.
- setContact(Contact) - Method in interface org.eclipse.microprofile.openapi.models.info.Info
-
Sets this Info instance's contact information for the exposed API.
- setContains(Schema) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Sets the contains property of this Schema instance.
- 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.
- setContentEncoding(String) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Sets the contentEncoding property from this Schema instance.
- setContentMediaType(String) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Sets the contentMediaType property from this Schema instance.
- setContentSchema(Schema) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Sets the contentSchema property from this Schema instance.
- 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(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.
- setDefaultValue(APIResponse) - Method in interface org.eclipse.microprofile.openapi.models.responses.APIResponses
-
Sets the default documentation of responses for this instance of ApiResponses.
- setDELETE(Operation) - Method in interface org.eclipse.microprofile.openapi.models.PathItem
-
Sets this PathItem's delete property to the given operation.
- setDependentRequired(Map<String, List<String>>) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Sets the dependentRequired property of this Schema instance.
- setDependentSchemas(Map<String, Schema>) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Sets the dependentSchemas property of this Schema instance.
- 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 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.
- setElseSchema(Schema) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Sets the "else" schema.
- 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
-
Deprecated.
- 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(List<Object>) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Sets the examples property of this Schema instance.
- 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(BigDecimal) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Sets the exclusiveMaximum property of this Schema instance to the value given.
- setExclusiveMinimum(BigDecimal) - 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.
- setIdentifier(String) - Method in interface org.eclipse.microprofile.openapi.models.info.License
-
Sets the license identifier for this License instance that is used for the API.
- setIfSchema(Schema) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Sets the "if" schema.
- 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.
- setMaxContains(Integer) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Sets the maxContains property from this Schema instance.
- 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.
- setMediaTypes(Map<String, MediaType>) - Method in interface org.eclipse.microprofile.openapi.models.media.Content
-
Set the media types map to this Content
- setMinContains(Integer) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Sets the minContains property from this Schema instance.
- 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 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.
- 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.
- setOperation(PathItem.HttpMethod, Operation) - Method in interface org.eclipse.microprofile.openapi.models.PathItem
-
Sets an operation for a given http method.
- 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(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.
- 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(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.
- 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.
- setPathItems(Map<String, PathItem>) - Method in interface org.eclipse.microprofile.openapi.models.callbacks.Callback
-
Set the path items map to this Callback.
- setPathItems(Map<String, PathItem>) - Method in interface org.eclipse.microprofile.openapi.models.Components
-
Sets the pathItems property of this Components instance.
- setPathItems(Map<String, PathItem>) - Method in interface org.eclipse.microprofile.openapi.models.Paths
-
Set the path items map to this Paths
- 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.
- setPatternProperties(Map<String, Schema>) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Sets the patternProperties property from this Schema instance.
- 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.
- setPrefixItems(List<Schema>) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Sets the prefixItems property of this Schema instance.
- 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.
- setPropertyNames(Schema) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Sets the propertyNames property from this Schema instance.
- 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(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.
- 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.
- setResponseProvider(HealthCheckResponseProvider) - Static method in class org.eclipse.microprofile.health.HealthCheckResponse
-
Used by OSGi environment where the 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.
- 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.
- setSchemaDialect(String) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Sets the schema dialect in use.
- 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.
- setSchemes(Map<String, List<String>>) - Method in interface org.eclipse.microprofile.openapi.models.security.SecurityRequirement
-
Set all security schemes to the SecurityRequirement instance.
- setScopes(Map<String, String>) - 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.info.Info
-
Sets this Info instance's summary information for the exposed API.
- 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(List<String>) - Method in interface org.eclipse.microprofile.openapi.models.Operation
-
Sets this Operation's tags property to the given tags.
- setTags(List<Tag>) - Method in interface org.eclipse.microprofile.openapi.models.OpenAPI
-
Sets this OpenAPI instance'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.
- setThenSchema(Schema) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Sets the "then" schema.
- 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(List<Schema.SchemaType>) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Sets the type property of this Schema instance.
- 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.
- setUnevaluatedItems(Schema) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Sets the unevaluatedItems property of this Schema instance.
- setUnevaluatedProperties(Schema) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Sets the unevaluatedProperties property of this Schema 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.
- 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(Map<String, ServerVariable>) - 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.
- setWebhooks(Map<String, PathItem>) - Method in interface org.eclipse.microprofile.openapi.models.OpenAPI
-
Sets the webhooks property of this OpenAPI instance.
- 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.
- SIMPLE - Enum constant in enum class org.eclipse.microprofile.openapi.annotations.enums.ParameterStyle
- SIMPLE - Enum constant in enum class org.eclipse.microprofile.openapi.models.headers.Header.Style
- SIMPLE - Enum constant in enum class org.eclipse.microprofile.openapi.models.parameters.Parameter.Style
- sip_callid - Enum constant in enum class org.eclipse.microprofile.jwt.Claims
- sip_cseq_num - Enum constant in enum class org.eclipse.microprofile.jwt.Claims
- sip_date - Enum constant in enum class org.eclipse.microprofile.jwt.Claims
- sip_from_tag - Enum constant in enum class org.eclipse.microprofile.jwt.Claims
- sip_via_branch - Enum constant in enum class org.eclipse.microprofile.jwt.Claims
- skipOn() - Element in annotation interface org.eclipse.microprofile.faulttolerance.CircuitBreaker
-
The list of exception types which should not be considered failures.
- skipOn() - Element in annotation interface org.eclipse.microprofile.faulttolerance.Fallback
-
The list of exception types which should not trigger Fallback
- SPACE_DELIMITED - Enum constant in enum class org.eclipse.microprofile.openapi.models.media.Encoding.Style
- SPACEDELIMITED - Enum constant in enum class org.eclipse.microprofile.openapi.annotations.enums.ParameterStyle
- SPACEDELIMITED - Enum constant in enum class org.eclipse.microprofile.openapi.models.parameters.Parameter.Style
- sslContext(SSLContext) - Method in interface org.eclipse.microprofile.rest.client.RestClientBuilder
-
Specifies the SSL context to use when creating secured transport connections to server endpoints from web targets created by the client instance that is using this SSL context.
- standard() - Element in annotation interface org.eclipse.microprofile.jwt.Claim
-
An alternate way of specifying a claim name using the Claims enum
- standard() - Method in class org.eclipse.microprofile.jwt.ClaimLiteral
- Startup - Annotation Interface in org.eclipse.microprofile.health
-
This qualifier is used to define a Startup Health Check procedure mapped to the Startup Kubernetes probes.
- Startup.Literal - Class in org.eclipse.microprofile.health
-
Support inline instantiation of the
Startup
qualifier. - status(boolean) - Method in class org.eclipse.microprofile.health.HealthCheckResponseBuilder
-
Sets the status of the health check response according to the boolean value
up
. - STRING - Enum constant in enum class org.eclipse.microprofile.openapi.annotations.enums.SchemaType
- STRING - Enum constant in enum class org.eclipse.microprofile.openapi.models.media.Schema.SchemaType
- style() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.media.Encoding
-
Style describes how the encoding value will be serialized depending on the type of the parameter value.
- style() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.parameters.Parameter
-
Describes how the parameter value will be serialized depending on the type of the parameter value.
- 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.
- sub - Enum constant in enum class org.eclipse.microprofile.jwt.Claims
- sub_jwk - Enum constant in enum class org.eclipse.microprofile.jwt.Claims
- successThreshold() - Element in annotation interface org.eclipse.microprofile.faulttolerance.CircuitBreaker
-
The number of successful executions, before a half-open circuit is closed again.
- summary() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.callbacks.CallbackOperation
-
Provides a brief description of what this callback operation does.
- summary() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.info.Info
-
The summary of the API.
- summary() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.media.ExampleObject
-
A brief summary of the purpose or context of the example
- summary() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.Operation
-
Provides a brief description of what this operation does.
- summary() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.PathItem
-
The summary of the path item.
- summary() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.PathItemOperation
-
Provides a brief description of what this operation does.
- 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.info.Info
-
Sets this Info instance's summary of the API to the given summary and returns this instance of Info.
- 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 - Interface in org.eclipse.microprofile.openapi.models.tags
-
Tag
- Tag - Annotation Interface in org.eclipse.microprofile.openapi.annotations.tags
-
This object represents a tag.
- tags() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.OpenAPIDefinition
-
A list of tags used by the specification with additional metadata.
- tags() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.PathItemOperation
-
The tags which apply to this operation.
- tags(List<String>) - Method in interface org.eclipse.microprofile.openapi.models.Operation
-
Sets this Operation's tags property to the given tags.
- tags(List<Tag>) - Method in interface org.eclipse.microprofile.openapi.models.OpenAPI
-
Sets this OpenAPI instance's tags property to the given tags.
- Tags - Annotation Interface in org.eclipse.microprofile.openapi.annotations.tags
-
The Tags annotation is a container for @Tag annotations.
- termsOfService() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.info.Info
-
A URL to the Terms of Service for the API.
- 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.
- thenSchema() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.media.Schema
-
A class used to create a schema that an instance must validate against if it validates against the
if
schema. - thenSchema() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.media.SchemaProperty
-
A class used to create a schema that an instance must validate against if it validates against the
if
schema. - thenSchema(Schema) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Sets the "then" schema.
- Timeout - Annotation Interface 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(String) - Constructor for exception org.eclipse.microprofile.faulttolerance.exceptions.TimeoutException
- TimeoutException(String, Throwable) - Constructor for exception org.eclipse.microprofile.faulttolerance.exceptions.TimeoutException
- TimeoutException(Throwable) - Constructor for exception org.eclipse.microprofile.faulttolerance.exceptions.TimeoutException
- title() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.info.Info
-
The title of the application.
- title() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.media.Schema
-
A title to explain the purpose of the schema.
- title() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.media.SchemaProperty
-
A title to explain the purpose of the schema.
- 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.
- TOKEN_AGE - Static variable in interface org.eclipse.microprofile.jwt.config.Names
-
The number of seconds since 'iat' after which the token must be considered invalid.
- TOKEN_COOKIE - Static variable in interface org.eclipse.microprofile.jwt.config.Names
-
The Cookie name expected to containe the JWT token (default is Bearer).
- TOKEN_HEADER - Static variable in interface org.eclipse.microprofile.jwt.config.Names
-
The HTTP header name expected to contain the JWT token.
- tokenUrl() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.security.OAuthFlow
-
The token URL to be used for this flow.
- tokenUrl(String) - Method in interface org.eclipse.microprofile.openapi.models.security.OAuthFlow
-
The token URL to be used for this flow.
- toString() - Method in enum class org.eclipse.microprofile.openapi.annotations.enums.ParameterIn
- toString() - Method in enum class org.eclipse.microprofile.openapi.annotations.enums.ParameterStyle
- toString() - Method in enum class org.eclipse.microprofile.openapi.annotations.enums.SchemaType
- toString() - Method in enum class org.eclipse.microprofile.openapi.annotations.enums.SecuritySchemeIn
- toString() - Method in enum class org.eclipse.microprofile.openapi.annotations.enums.SecuritySchemeType
- toString() - Method in enum class org.eclipse.microprofile.openapi.models.headers.Header.Style
- toString() - Method in enum class org.eclipse.microprofile.openapi.models.media.Encoding.Style
- toString() - Method in enum class org.eclipse.microprofile.openapi.models.media.Schema.SchemaType
- toString() - Method in enum class org.eclipse.microprofile.openapi.models.parameters.Parameter.In
- toString() - Method in enum class org.eclipse.microprofile.openapi.models.parameters.Parameter.Style
- toString() - Method in enum class org.eclipse.microprofile.openapi.models.security.SecurityScheme.In
- toString() - Method in enum class 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 - Enum constant in enum class org.eclipse.microprofile.openapi.models.PathItem.HttpMethod
- TRACE(Operation) - Method in interface org.eclipse.microprofile.openapi.models.PathItem
-
Sets this PathItem's trace property to the given operation.
- TRUE - Enum constant in enum class org.eclipse.microprofile.openapi.annotations.enums.Explode
- trustStore(KeyStore) - Method in interface org.eclipse.microprofile.rest.client.RestClientBuilder
-
Set the client-side trust store.
- type() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.media.Schema
-
Provides an override for the basic type of the schema.
- type() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.media.SchemaProperty
-
Provides an override for the basic type of the schema.
- type() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.security.SecurityScheme
-
The type of the security scheme.
- type(List<Schema.SchemaType>) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Sets the type property of this Schema instance.
- 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_PREFIX - Static variable in annotation interface org.eclipse.microprofile.config.inject.ConfigProperties
- UNCONFIGURED_VALUE - Static variable in annotation interface org.eclipse.microprofile.config.inject.ConfigProperty
- unevaluatedItems(Schema) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Sets the unevaluatedItems property of this Schema instance.
- unevaluatedProperties(Schema) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Sets the unevaluatedProperties property of this Schema instance.
- uniqueItems() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.media.Schema
-
Only applicable if type=array.
- uniqueItems() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.media.SchemaProperty
-
Only applicable if type=array.
- uniqueItems(Boolean) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Sets the uniqueItems property of this Schema instance to the value given.
- unit() - Element in annotation interface org.eclipse.microprofile.faulttolerance.Timeout
-
The timeout unit.
- UNKNOWN - Enum constant in enum class org.eclipse.microprofile.jwt.Claims
- unwrap(Class<T>) - Method in interface org.eclipse.microprofile.config.Config
-
Returns an instance of the specific class, to allow access to the provider specific API.
- up() - Method in class org.eclipse.microprofile.health.HealthCheckResponseBuilder
-
Sets the status of the health check response to
HealthCheckResponse.Status.UP
. - up(String) - Static method in class org.eclipse.microprofile.health.HealthCheckResponse
-
Creates a successful health check with a name.
- UP - Enum constant in enum class org.eclipse.microprofile.health.HealthCheckResponse.Status
- update(MultivaluedMap<String, String>, MultivaluedMap<String, String>) - Method in interface org.eclipse.microprofile.rest.client.ext.ClientHeadersFactory
-
Updates the HTTP headers to send to the remote service.
- update(MultivaluedMap<String, String>, MultivaluedMap<String, String>) - Method in class org.eclipse.microprofile.rest.client.ext.DefaultClientHeadersFactoryImpl
- updated_at - Enum constant in enum class org.eclipse.microprofile.jwt.Claims
- upn - Enum constant in enum class org.eclipse.microprofile.jwt.Claims
- url() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.ExternalDocumentation
-
The URL for the target documentation.
- url() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.info.Contact
-
The URL pointing to the contact information.
- url() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.info.License
-
A URL to the license used for the API.
- url() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.servers.Server
-
A URL to the target host.
- 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() - Element in annotation interface org.eclipse.microprofile.faulttolerance.Bulkhead
-
Specify the maximum number of concurrent calls to an instance.
- value() - Element in annotation interface org.eclipse.microprofile.faulttolerance.Fallback
-
Specify the fallback class to be used.
- value() - Element in annotation interface org.eclipse.microprofile.faulttolerance.Timeout
-
The timeout value.
- value() - Element in annotation interface org.eclipse.microprofile.jwt.Claim
-
The value specifies the id name the claim to inject
- value() - Method in class org.eclipse.microprofile.jwt.ClaimLiteral
- value() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.callbacks.Callbacks
-
An array of Callback annotations which are a map of possible out-of band callbacks related to the parent operation
- value() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.extensions.Extension
-
The extension value.
- value() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.extensions.Extensions
-
An array of Extension annotations
- value() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.media.DiscriminatorMapping
-
The property value that will be mapped to a Schema
- value() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.media.ExampleObject
-
A string representation of the example.
- value() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.parameters.Parameters
-
An array of Parameter Objects for the operation
- value() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.parameters.RequestBodySchema
-
Provides a Java class as implementation for this schema.
- value() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.responses.APIResponses
-
An array of APIResponse annotations
- value() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.responses.APIResponseSchema
-
Provides a Java class as implementation for this schema.
- value() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.security.SecurityRequirements
-
An array of SecurityRequirement annotations
- value() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.security.SecurityRequirementsSet
-
The security requirements which make up the set
- value() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.security.SecurityRequirementsSets
-
An array of SecurityRequirementSet annotations
- value() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.security.SecuritySchemes
-
An array of SecurityScheme annotations that can be specified at definition level.
- value() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.servers.Servers
-
An array of Server objects which is used to provide connectivity information to a target server.
- value() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.tags.Tags
-
An array of Tag annotation objects which hold metadata for the API
- value() - Element in annotation interface org.eclipse.microprofile.rest.client.annotation.ClientHeaderParam
- value() - Element in annotation interface org.eclipse.microprofile.rest.client.annotation.ClientHeaderParams
- value() - Element in annotation interface org.eclipse.microprofile.rest.client.annotation.RegisterClientHeaders
- value() - Element in annotation interface org.eclipse.microprofile.rest.client.annotation.RegisterProvider
- value() - Element in annotation interface org.eclipse.microprofile.rest.client.annotation.RegisterProviders
- 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 class org.eclipse.microprofile.health.HealthCheckResponse.Status
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.eclipse.microprofile.jwt.Claims
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.eclipse.microprofile.openapi.annotations.enums.Explode
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.eclipse.microprofile.openapi.annotations.enums.ParameterIn
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.eclipse.microprofile.openapi.annotations.enums.ParameterStyle
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.eclipse.microprofile.openapi.annotations.enums.SchemaType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.eclipse.microprofile.openapi.annotations.enums.SecuritySchemeIn
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.eclipse.microprofile.openapi.annotations.enums.SecuritySchemeType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.eclipse.microprofile.openapi.models.headers.Header.Style
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.eclipse.microprofile.openapi.models.media.Encoding.Style
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.eclipse.microprofile.openapi.models.media.Schema.SchemaType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.eclipse.microprofile.openapi.models.parameters.Parameter.In
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.eclipse.microprofile.openapi.models.parameters.Parameter.Style
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.eclipse.microprofile.openapi.models.PathItem.HttpMethod
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.eclipse.microprofile.openapi.models.security.SecurityScheme.In
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.eclipse.microprofile.openapi.models.security.SecurityScheme.Type
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.eclipse.microprofile.rest.client.ext.QueryParamStyle
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class org.eclipse.microprofile.health.HealthCheckResponse.Status
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.eclipse.microprofile.jwt.Claims
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.eclipse.microprofile.openapi.annotations.enums.Explode
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.eclipse.microprofile.openapi.annotations.enums.ParameterIn
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.eclipse.microprofile.openapi.annotations.enums.ParameterStyle
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.eclipse.microprofile.openapi.annotations.enums.SchemaType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.eclipse.microprofile.openapi.annotations.enums.SecuritySchemeIn
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.eclipse.microprofile.openapi.annotations.enums.SecuritySchemeType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.eclipse.microprofile.openapi.models.headers.Header.Style
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.eclipse.microprofile.openapi.models.media.Encoding.Style
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.eclipse.microprofile.openapi.models.media.Schema.SchemaType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.eclipse.microprofile.openapi.models.parameters.Parameter.In
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.eclipse.microprofile.openapi.models.parameters.Parameter.Style
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.eclipse.microprofile.openapi.models.PathItem.HttpMethod
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.eclipse.microprofile.openapi.models.security.SecurityScheme.In
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.eclipse.microprofile.openapi.models.security.SecurityScheme.Type
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.eclipse.microprofile.rest.client.ext.QueryParamStyle
-
Returns an array containing the constants of this enum class, in the order they are declared.
- variables() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.servers.Server
-
An array of variables used for substitution in the server's URL template.
- variables(Map<String, ServerVariable>) - 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 verification public key for the MP-JWT signer in PKCS8 PEM or JWK(S) format.
- VERIFIER_PUBLIC_KEY_ALGORITHM - Static variable in interface org.eclipse.microprofile.jwt.config.Names
-
Public Key Signature Algorithm property which can be set to either 'RS256' or 'ES256'.
- VERIFIER_PUBLIC_KEY_LOCATION - Static variable in interface org.eclipse.microprofile.jwt.config.Names
-
The relative path or full URL of the verification public key.
- version() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.info.Info
-
The version of the API definition.
- 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
- waitingTaskQueue() - Element in annotation interface org.eclipse.microprofile.faulttolerance.Bulkhead
-
Specify the waiting task queue.
- webhooks() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.OpenAPIDefinition
-
An array of webhook definitions which the API may be instructed to call using out-of-band mechanisms.
- webhooks(Map<String, PathItem>) - Method in interface org.eclipse.microprofile.openapi.models.OpenAPI
-
Sets the webhooks property of this OpenAPI instance.
- withConverter(Class<T>, int, Converter<T>) - Method in interface org.eclipse.microprofile.config.spi.ConfigBuilder
-
Add the specified
Converter
instance for the given type to the configuration being built. - withConverters(Converter<?>...) - Method in interface org.eclipse.microprofile.config.spi.ConfigBuilder
-
Add the specified
Converter
instances to the configuration being built. - withData(String, boolean) - Method in class org.eclipse.microprofile.health.HealthCheckResponseBuilder
-
Adds additional boolean data to the health check response.
- withData(String, long) - Method in class org.eclipse.microprofile.health.HealthCheckResponseBuilder
-
Adds additional numeric data to the health check response.
- withData(String, String) - Method in class org.eclipse.microprofile.health.HealthCheckResponseBuilder
-
Adds additional string data to the health check response.
- withSources(ConfigSource...) - Method in interface org.eclipse.microprofile.config.spi.ConfigBuilder
-
Add the specified
ConfigSource
instances to the configuration being built. - 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() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.media.Schema
-
Declares the property as "write only".
- writeOnly() - Element in annotation interface org.eclipse.microprofile.openapi.annotations.media.SchemaProperty
-
Declares the property as "write only".
- 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.
Z
A B C D E F G H I J K L M N O P Q R S T U V W X ZAll Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
Schema.additionalPropertiesSchema(Schema)
with a boolean-valued schema