- addAllOf(Schema) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Adds the given Schema to the list of schemas used by the allOf property.
- addAnyOf(Schema) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Adds the given Schema to the list of schemas used by the anyOf property.
- addApiResponse(String, APIResponse) - Method in interface org.eclipse.microprofile.openapi.models.responses.APIResponses
-
Adds an ApiResponse in the format of the name as a key and the item as the value to ApiResponses map
- addCallback(String, Callback) - Method in interface org.eclipse.microprofile.openapi.models.Components
-
Adds the given callback to this Components' map of callbacks with the given string as its key.
- addDefaultSources() - Method in interface org.eclipse.microprofile.config.spi.ConfigBuilder
-
Add the default config sources appearing on the builder's classpath
including:
System properties
Environment properties
/META-INF/microprofile-config.properties
- addDiscoveredConverters() - Method in interface org.eclipse.microprofile.config.spi.ConfigBuilder
-
Add the converters to be loaded via service loader pattern
- addDiscoveredSources() - Method in interface org.eclipse.microprofile.config.spi.ConfigBuilder
-
Add the config sources appearing to be loaded via service loader pattern
- addEncoding(String, Encoding) - Method in interface org.eclipse.microprofile.openapi.models.media.MediaType
-
Adds an Encoding item to the encoding property of a MediaType instance.
- addEnumeration(Object) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Adds an item of the appropriate type to the enumerated list of values allowed.
- addEnumeration(String) - Method in interface org.eclipse.microprofile.openapi.models.servers.ServerVariable
-
This method adds a string item to enumeration list of a ServerVariable instance and returns the instance.
- addExample(String, Example) - Method in interface org.eclipse.microprofile.openapi.models.Components
-
Adds the given example to this Components' map of examples with the given string as its key.
- addExample(String, Example) - Method in interface org.eclipse.microprofile.openapi.models.headers.Header
-
Adds an example of the media type using the specified key to this Header instance.
- addExample(String, Example) - Method in interface org.eclipse.microprofile.openapi.models.media.MediaType
-
Adds an example item to the examples map of a MediaType instance.
- addExample(String, Example) - Method in interface org.eclipse.microprofile.openapi.models.parameters.Parameter
-
Adds an example of the media type using the specified key.
- addExtension(String, Object) - Method in interface org.eclipse.microprofile.openapi.models.Extensible
-
Adds the given object to this Extensible's map of extensions, with the given name as its key.
- addHeader(String, Header) - Method in interface org.eclipse.microprofile.openapi.models.Components
-
Adds the given header to this Components' map of headers with the given string as its key.
- addHeader(String, Header) - Method in interface org.eclipse.microprofile.openapi.models.responses.APIResponse
-
Adds the given Header to this ApiResponse instance's map of Headers with the given name and return this instance of ApiResponse.
- additionalProperties(Schema) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Sets the Schema which defines additional properties not defined by "properties" or "patternProperties".
- additionalProperties(Boolean) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Sets the value of "additionalProperties" to either True or False.
- addLink(String, Link) - Method in interface org.eclipse.microprofile.openapi.models.Components
-
Adds the given link to this Components' map of links with the given string as its key.
- addLink(String, Link) - Method in interface org.eclipse.microprofile.openapi.models.responses.APIResponse
-
Adds a link to this instance of ApiResponse using the given name and Link, and returns this ApiResponse instance.
- addMapping(String, String) - Method in interface org.eclipse.microprofile.openapi.models.media.Discriminator
-
Maps the given name to the given value and stores it in this Discriminator's mapping property.
- addMediaType(String, MediaType) - Method in interface org.eclipse.microprofile.openapi.models.media.Content
-
Adds the MediaType for this Content, where the key is the name of the MediaType and the value is the object that describes the content passed
into or returned from an operation.
- addOneOf(Schema) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Adds the given Schema to the list of schemas used by the oneOf property.
- addParameter(String, Parameter) - Method in interface org.eclipse.microprofile.openapi.models.Components
-
Adds the given parameter to this Components' map of parameters with the given string as its key.
- addParameter(String, Object) - Method in interface org.eclipse.microprofile.openapi.models.links.Link
-
Add a new parameter to the parameters property of this instance of Link.
- addParameter(Parameter) - Method in interface org.eclipse.microprofile.openapi.models.Operation
-
Adds the given parameter item to this Operation's list of parameters.
- addParameter(Parameter) - Method in interface org.eclipse.microprofile.openapi.models.PathItem
-
Adds the given parameter to this PathItem's list of parameters.
- addPathItem(String, PathItem) - Method in interface org.eclipse.microprofile.openapi.models.callbacks.Callback
-
Adds the given PathItem to this Callback's list of PathItems using the string as its key.
- addPathItem(String, PathItem) - Method in interface org.eclipse.microprofile.openapi.models.Paths
-
Adds the given path item to this Paths and return this instance of Paths
- addProperty(String, Schema) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Adds a Schema property of the provided name using the given schema.
- addRequestBody(String, RequestBody) - Method in interface org.eclipse.microprofile.openapi.models.Components
-
Adds the given request body to this Components' map of request bodies with the given string as its key.
- addRequired(String) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Adds the name of an item to the list of fields required in objects defined by this Schema.
- addResponse(String, APIResponse) - Method in interface org.eclipse.microprofile.openapi.models.Components
-
Adds the given response to this Components' map of responses with the given string as its key.
- addSchema(String, Schema) - Method in interface org.eclipse.microprofile.openapi.models.Components
-
Adds the given schema to this Components' list of schemas with the given string as its key.
- addScheme(String, String) - Method in interface org.eclipse.microprofile.openapi.models.security.SecurityRequirement
-
Adds a security scheme to the SecurityRequirement instance based on the scheme name and
required scope (optional) provided.
- addScheme(String, List<String>) - Method in interface org.eclipse.microprofile.openapi.models.security.SecurityRequirement
-
Adds a security scheme to the SecurityRequirement instance based on the scheme name and
required scopes (optional) provided.
- addScheme(String) - Method in interface org.eclipse.microprofile.openapi.models.security.SecurityRequirement
-
Adds a security scheme to the SecurityRequirement instance based on the scheme name.
- addScope(String, String) - Method in interface org.eclipse.microprofile.openapi.models.security.Scopes
-
Adds name of an existing scope object and item parameters to a Scopes instance as a key-value pair in a map.
- addSecurityRequirement(SecurityRequirement) - Method in interface org.eclipse.microprofile.openapi.models.OpenAPI
-
Adds the given security requirement to this OpenAPI instance's list of security requirements.
- addSecurityRequirement(SecurityRequirement) - Method in interface org.eclipse.microprofile.openapi.models.Operation
-
Adds the given security requirement item to this Operation's list of security mechanisms.
- addSecurityScheme(String, SecurityScheme) - Method in interface org.eclipse.microprofile.openapi.models.Components
-
Adds the given security scheme to this Components' map of security schemes with the given string as its key.
- addServer(Server) - Method in interface org.eclipse.microprofile.openapi.models.OpenAPI
-
Adds the given server to this OpenAPI instance's list of servers.
- addServer(Server) - Method in interface org.eclipse.microprofile.openapi.models.Operation
-
Adds the given server to this Operation's list of servers.
- addServer(Server) - Method in interface org.eclipse.microprofile.openapi.models.PathItem
-
Adds the given server to this PathItem's list of servers.
- addServerVariable(String, ServerVariable) - Method in interface org.eclipse.microprofile.openapi.models.servers.ServerVariables
-
This method adds a key-value item to a ServerVariables instance from the name-item parameter pair and returns the modified instance.
- addTag(String) - Method in class org.eclipse.microprofile.metrics.Metadata
-
Add one single tag with the format: 'key=value'.
- addTag(Tag) - Method in interface org.eclipse.microprofile.openapi.models.OpenAPI
-
Adds the given tag to this OpenAPI instance's list of tags.
- addTag(String) - Method in interface org.eclipse.microprofile.openapi.models.Operation
-
Adds the given tag to this Operation's list of tags.
- addTags(String) - Method in class org.eclipse.microprofile.metrics.Metadata
-
Add multiple tags delimited by commas.
- addTagsTest() - Method in class org.eclipse.microprofile.metrics.tck.TagsTest
-
- ALL - Static variable in interface org.eclipse.microprofile.metrics.MetricFilter
-
Matches all metrics, regardless of type or name.
- allOf(List<Schema>) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Sets the schemas used by the allOf property of this Schema.
- allowEmptyValue(Boolean) - Method in interface org.eclipse.microprofile.openapi.models.headers.Header
-
Sets this Header's allowEmptyValue property to the given value.
- allowEmptyValue(Boolean) - Method in interface org.eclipse.microprofile.openapi.models.parameters.Parameter
-
Sets the allowEmptyValue property of a Parameter instance to the given value.
- allowReserved(Boolean) - Method in interface org.eclipse.microprofile.openapi.models.media.Encoding
-
AllowReserved determines whether the parameter value SHOULD allow reserved characters to be encoded without percent-encoding.
- allowReserved(Boolean) - Method in interface org.eclipse.microprofile.openapi.models.parameters.Parameter
-
Sets the allowReserved property of a Parameter instance to the given value.
- anyOf(List<Schema>) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Sets the schemas used by the anyOf property of this Schema.
- APIResponse - Annotation Type in org.eclipse.microprofile.openapi.annotations.responses
-
The ApiResponse annotation corresponds to the OpenAPI Response model object which
describes a single response from an API Operation, including design-time,
static links to operations based on the response.
- APIResponse - Interface in org.eclipse.microprofile.openapi.models.responses
-
This interface represents a single response from an API Operation, including design-time, static links to operations based on the response.
- APIResponses - Annotation Type in org.eclipse.microprofile.openapi.annotations.responses
-
The ApiResponses annotation is a container for @ApiResponse annotations.
- APIResponses - Interface in org.eclipse.microprofile.openapi.models.responses
-
This interface represents the container for the expected responses of an operation.
- applyContext() - Method in interface org.eclipse.microprofile.rest.client.ext.AsyncInvocationInterceptor
-
This method will be invoked by the MP Rest Client runtime on the "async"
thread (i.e.
- assertEqualsWithTolerance(double, double) - Static method in class org.eclipse.microprofile.metrics.tck.TestUtils
-
- Asynchronous - Annotation Type in org.eclipse.microprofile.faulttolerance
-
Wrap the execution and invoke it asynchronously.
- AsyncInvocationInterceptor - Interface in org.eclipse.microprofile.rest.client.ext
-
Implementations of this interface can intercept asynchronous method
invocations.
- AsyncInvocationInterceptorFactory - Interface in org.eclipse.microprofile.rest.client.ext
-
This is a provider interface intended for intercepting asynchronous method
invocations.
- attribute(Boolean) - Method in interface org.eclipse.microprofile.openapi.models.media.XML
-
This method sets the attribute property of XML instance to the given Boolean argument and returns the modified instance.
- authorizationCode(OAuthFlow) - Method in interface org.eclipse.microprofile.openapi.models.security.OAuthFlows
-
OAuth Authorization Code flow; previously called accessCode in OpenAPI 2.0
- authorizationUrl(String) - Method in interface org.eclipse.microprofile.openapi.models.security.OAuthFlow
-
The authorization URL to be used for this flow.
- Gauge - Annotation Type in org.eclipse.microprofile.metrics.annotation
-
An annotation for marking a method or field as a gauge.
- Gauge<T> - Interface in org.eclipse.microprofile.metrics
-
A gauge metric is an instantaneous reading of a particular value.
- gaugeMe() - Method in class org.eclipse.microprofile.metrics.tck.GaugeTest
-
- GaugeTest - Class in org.eclipse.microprofile.metrics.tck
-
- GaugeTest() - Constructor for class org.eclipse.microprofile.metrics.tck.GaugeTest
-
- GET(Operation) - Method in interface org.eclipse.microprofile.openapi.models.PathItem
-
Sets this PathItem's get property to the given operation.
- get75thPercentile() - Method in class org.eclipse.microprofile.metrics.Snapshot
-
Returns the value at the 75th percentile in the distribution.
- get95thPercentile() - Method in class org.eclipse.microprofile.metrics.Snapshot
-
Returns the value at the 95th percentile in the distribution.
- get98thPercentile() - Method in class org.eclipse.microprofile.metrics.Snapshot
-
Returns the value at the 98th percentile in the distribution.
- get999thPercentile() - Method in class org.eclipse.microprofile.metrics.Snapshot
-
Returns the value at the 99.9th percentile in the distribution.
- get99thPercentile() - Method in class org.eclipse.microprofile.metrics.Snapshot
-
Returns the value at the 99th percentile in the distribution.
- getAdditionalProperties() - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Returns the value of the "additionalProperties" setting, which indicates whether
properties not otherwise defined are allowed.
- getAllOf() - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Returns the schemas used by the allOf property.
- getAllowEmptyValue() - Method in interface org.eclipse.microprofile.openapi.models.headers.Header
-
Returns the allowEmptyValue property from a Header instance.
- getAllowEmptyValue() - Method in interface org.eclipse.microprofile.openapi.models.parameters.Parameter
-
Returns the allowEmptyValue property from a Parameter instance.
- getAllowReserved() - Method in interface org.eclipse.microprofile.openapi.models.media.Encoding
-
AllowReserved determines whether the parameter value SHOULD allow reserved characters to be encoded without percent-encoding.
- getAllowReserved() - Method in interface org.eclipse.microprofile.openapi.models.parameters.Parameter
-
Returns the allowReserved property from a Parameter instance.
- getAnyOf() - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Returns the schemas used by the anyOf property.
- getAttribute() - Method in interface org.eclipse.microprofile.openapi.models.media.XML
-
This method returns the attribute property of XML instance.
- getAudience() - Method in interface org.eclipse.microprofile.jwt.JsonWebToken
-
The aud(Audience) claim identifies the recipients that the JWT is
intended for.
- getAuthorizationCode() - Method in interface org.eclipse.microprofile.openapi.models.security.OAuthFlows
-
OAuth Authorization Code flow; previously called accessCode in OpenAPI 2.0
- getAuthorizationUrl() - Method in interface org.eclipse.microprofile.openapi.models.security.OAuthFlow
-
The authorization URL to be used for this flow.
- getBearerFormat() - Method in interface org.eclipse.microprofile.openapi.models.security.SecurityScheme
-
bearerFormat is intended as a hint to the client to identify how the bearer token is formatted.
- getBuilder() - Method in class org.eclipse.microprofile.config.spi.ConfigProviderResolver
-
- getCallbacks() - Method in interface org.eclipse.microprofile.openapi.models.Components
-
Returns the callbacks property from a Components instance.
- getCallbacks() - Method in interface org.eclipse.microprofile.openapi.models.Operation
-
Returns the callbacks property from an Operation instance.
- getClaim(String) - Method in interface org.eclipse.microprofile.jwt.JsonWebToken
-
Access the value of the indicated claim.
- getClaimNames() - Method in interface org.eclipse.microprofile.jwt.JsonWebToken
-
Access the names of all claims are associated with this token.
- getClientCredentials() - Method in interface org.eclipse.microprofile.openapi.models.security.OAuthFlows
-
OAuth Client Credential flow; previously called application in OpenAPI 2.0
- getComponents() - Method in interface org.eclipse.microprofile.openapi.models.OpenAPI
-
Returns the components property from an OpenAPI instance.
- getConfig() - Static method in class org.eclipse.microprofile.config.ConfigProvider
-
- getConfig(ClassLoader) - Static method in class org.eclipse.microprofile.config.ConfigProvider
-
- getConfig() - Method in class org.eclipse.microprofile.config.spi.ConfigProviderResolver
-
- getConfig(ClassLoader) - Method in class org.eclipse.microprofile.config.spi.ConfigProviderResolver
-
- getConfigSources() - Method in interface org.eclipse.microprofile.config.Config
-
- getConfigSources(ClassLoader) - Method in interface org.eclipse.microprofile.config.spi.ConfigSourceProvider
-
- getContact() - Method in interface org.eclipse.microprofile.openapi.models.info.Info
-
Returns the contact information for the exposed API from this Info instance.
- getContent() - Method in interface org.eclipse.microprofile.openapi.models.headers.Header
-
Returns the content property from a Header instance.
- getContent() - Method in interface org.eclipse.microprofile.openapi.models.parameters.Parameter
-
Returns the content property from a Parameter instance.
- getContent() - Method in interface org.eclipse.microprofile.openapi.models.parameters.RequestBody
-
Returns the content of this instance of RequestBody, where the keys in content are media type names and the values describe it.
- getContent() - Method in interface org.eclipse.microprofile.openapi.models.responses.APIResponse
-
Returns the map containing descriptions of potential response payload for this instance of ApiResponse.
- getContentType() - Method in interface org.eclipse.microprofile.openapi.models.media.Encoding
-
The Content-Type for encoding a specific property.
- getCount() - Method in interface org.eclipse.microprofile.metrics.Counter
-
Returns the counter's current value.
- getCount() - Method in interface org.eclipse.microprofile.metrics.Counting
-
Returns the current count.
- getCount() - Method in interface org.eclipse.microprofile.metrics.Histogram
-
Returns the number of values recorded.
- getCount() - Method in interface org.eclipse.microprofile.metrics.Meter
-
- getCount() - Method in interface org.eclipse.microprofile.metrics.Metered
-
Returns the number of events which have been marked.
- getCount() - Method in interface org.eclipse.microprofile.metrics.Timer
-
- getCounters() - Method in class org.eclipse.microprofile.metrics.MetricRegistry
-
Returns a map of all the counters in the registry and their names.
- getCounters(MetricFilter) - Method in class org.eclipse.microprofile.metrics.MetricRegistry
-
Returns a map of all the counters in the registry and their names which match the given
filter.
- getCountTest() - Method in class org.eclipse.microprofile.metrics.tck.CounterTest
-
- getData() - Method in class org.eclipse.microprofile.health.HealthCheckResponse
-
- getDefault() - Method in interface org.eclipse.microprofile.openapi.models.responses.APIResponses
-
Returns the default documentation of responses other than the ones declared for specific HTTP response codes in this instance of ApiResponses.
- getDefaultValue() - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Returns the default value property from this Schema instance.
- getDefaultValue() - Method in interface org.eclipse.microprofile.openapi.models.servers.ServerVariable
-
The default value to use for substitution, and to send, if an alternate value is not supplied.
- getDELETE() - Method in interface org.eclipse.microprofile.openapi.models.PathItem
-
Returns the delete property from a PathItem instance.
- getDeprecated() - Method in interface org.eclipse.microprofile.openapi.models.headers.Header
-
Returns the deprecated property from a Header instance.
- getDeprecated() - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Returns the deprecated property from this Schema instance.
- getDeprecated() - Method in interface org.eclipse.microprofile.openapi.models.Operation
-
Returns the deprecated property from an Operation instance.
- getDeprecated() - Method in interface org.eclipse.microprofile.openapi.models.parameters.Parameter
-
Returns the deprecated property from a Parameter instance.
- getDescription() - Method in enum org.eclipse.microprofile.jwt.Claims
-
- getDescription() - Method in class org.eclipse.microprofile.metrics.Metadata
-
Returns the description of the metric.
- getDescription() - Method in interface org.eclipse.microprofile.openapi.models.examples.Example
-
Returns the description property from an Example instance.
- getDescription() - Method in interface org.eclipse.microprofile.openapi.models.ExternalDocumentation
-
Returns the description property from an ExternalDocumentation instance.
- getDescription() - Method in interface org.eclipse.microprofile.openapi.models.headers.Header
-
Returns the description property from a Header instance.
- getDescription() - Method in interface org.eclipse.microprofile.openapi.models.info.Info
-
Returns a short description for the application for this Info instance.
- getDescription() - Method in interface org.eclipse.microprofile.openapi.models.links.Link
-
Returns the description property from a Link instance.
- getDescription() - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Returns a description of the purpose of this Schema.
- getDescription() - Method in interface org.eclipse.microprofile.openapi.models.Operation
-
Returns the description property from an Operation instance.
- getDescription() - Method in interface org.eclipse.microprofile.openapi.models.parameters.Parameter
-
Returns the description property from a Parameter instance.
- getDescription() - Method in interface org.eclipse.microprofile.openapi.models.parameters.RequestBody
-
Returns the description of this instance of RequestBody.
- getDescription() - Method in interface org.eclipse.microprofile.openapi.models.PathItem
-
Returns the description property from a PathItem instance.
- getDescription() - Method in interface org.eclipse.microprofile.openapi.models.responses.APIResponse
-
Returns a short description of this instance of ApiResponse.
- getDescription() - Method in interface org.eclipse.microprofile.openapi.models.security.SecurityScheme
-
A short description for security schema.
- getDescription() - Method in interface org.eclipse.microprofile.openapi.models.servers.Server
-
This method returns the description property of Server instance.
- getDescription() - Method in interface org.eclipse.microprofile.openapi.models.servers.ServerVariable
-
This method returns the description property of ServerVariable instance.
- getDescription() - Method in interface org.eclipse.microprofile.openapi.models.tags.Tag
-
Returns the description property from a Tag instance.
- getDiscriminator() - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Returns the discriminator property from this Schema instance.
- getDisplayName() - Method in class org.eclipse.microprofile.metrics.Metadata
-
Returns the display name if set, otherwise this method returns the metric name.
- getEmail() - Method in interface org.eclipse.microprofile.openapi.models.info.Contact
-
Returns the contact email of this Contact instance.
- getEncoding() - Method in interface org.eclipse.microprofile.openapi.models.media.MediaType
-
Returns the encoding property from a MediaType instance.
- getEnumeration() - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Returns the enumerated list of values allowed for objects defined by this Schema.
- getEnumeration() - Method in interface org.eclipse.microprofile.openapi.models.servers.ServerVariable
-
This method returns the enumeration property of ServerVariable instance.
- getExample() - Method in interface org.eclipse.microprofile.openapi.models.headers.Header
-
Returns the example property from a Header instance.
- getExample() - Method in interface org.eclipse.microprofile.openapi.models.media.MediaType
-
Returns the example property from a MediaType instance.
- getExample() - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Returns the example property from this Schema instance.
- getExample() - Method in interface org.eclipse.microprofile.openapi.models.parameters.Parameter
-
Returns the example property from a Parameter instance.
- getExamples() - Method in interface org.eclipse.microprofile.openapi.models.Components
-
Returns the examples property from a Components instance.
- getExamples() - Method in interface org.eclipse.microprofile.openapi.models.headers.Header
-
Returns the examples property from a Header instance.
- getExamples() - Method in interface org.eclipse.microprofile.openapi.models.media.MediaType
-
Returns the collection of examples from a MediaType instance.
- getExamples() - Method in interface org.eclipse.microprofile.openapi.models.parameters.Parameter
-
Returns the examples property from a Parameter instance.
- getExclusiveMaximum() - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Returns the exclusiveMaximum property from this Schema instance.
- getExclusiveMinimum() - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Returns the exclusiveMinimum property from this Schema instance.
- getExpirationTime() - Method in interface org.eclipse.microprofile.jwt.JsonWebToken
-
The exp (Expiration time) claim identifies the expiration time on or
after which the JWT MUST NOT be accepted
for processing in seconds since 1970-01-01T00:00:00Z UTC
- getExplode() - Method in interface org.eclipse.microprofile.openapi.models.headers.Header
-
Returns the explode property from a Header instance.
- getExplode() - Method in interface org.eclipse.microprofile.openapi.models.media.Encoding
-
When this is true, property values of type array or object generate separate parameters for each value of the array, or key-value-pair of the
map.
- getExplode() - Method in interface org.eclipse.microprofile.openapi.models.parameters.Parameter
-
Returns the explode property from a Parameter instance.
- getExtensions() - Method in interface org.eclipse.microprofile.openapi.models.Extensible
-
Returns the extensions property from an Extensible instance.
- getExternalDocs() - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Returns the externalDocs property from this Schema instance.
- getExternalDocs() - Method in interface org.eclipse.microprofile.openapi.models.OpenAPI
-
Returns the externalDocs property from an OpenAPI instance.
- getExternalDocs() - Method in interface org.eclipse.microprofile.openapi.models.Operation
-
Returns the externalDocs property from an Operation instance.
- getExternalDocs() - Method in interface org.eclipse.microprofile.openapi.models.tags.Tag
-
Returns the externalDocs property from a Tag instance.
- getExternalValue() - Method in interface org.eclipse.microprofile.openapi.models.examples.Example
-
Returns the externalValue property from an Example instance.
- getFailure() - Method in interface org.eclipse.microprofile.faulttolerance.ExecutionContext
-
Returns the failure of the method execution
- getFifteenMinuteRate() - Method in interface org.eclipse.microprofile.metrics.Meter
-
- getFifteenMinuteRate() - Method in interface org.eclipse.microprofile.metrics.Metered
-
Returns the fifteen-minute exponentially-weighted moving average rate at which events have
occurred since the meter was created.
- getFifteenMinuteRate() - Method in interface org.eclipse.microprofile.metrics.Timer
-
- getFiveMinuteRate() - Method in interface org.eclipse.microprofile.metrics.Meter
-
- getFiveMinuteRate() - Method in interface org.eclipse.microprofile.metrics.Metered
-
Returns the five-minute exponentially-weighted moving average rate at which events have
occurred since the meter was created.
- getFiveMinuteRate() - Method in interface org.eclipse.microprofile.metrics.Timer
-
- getFlows() - Method in interface org.eclipse.microprofile.openapi.models.security.SecurityScheme
-
Flows is a REQUIRED property.
- getFormat() - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Returns the format property from this Schema instance.
- getGauges() - Method in class org.eclipse.microprofile.metrics.MetricRegistry
-
Returns a map of all the gauges in the registry and their names.
- getGauges(MetricFilter) - Method in class org.eclipse.microprofile.metrics.MetricRegistry
-
Returns a map of all the gauges in the registry and their names which match the given filter.
- getGET() - Method in interface org.eclipse.microprofile.openapi.models.PathItem
-
Returns the get property from a PathItem instance.
- getGroups() - Method in interface org.eclipse.microprofile.jwt.JsonWebToken
-
The groups claim provides the group names the JWT principal has been
granted.
- getHEAD() - Method in interface org.eclipse.microprofile.openapi.models.PathItem
-
Returns the head property from a PathItem instance.
- getHeaders() - Method in interface org.eclipse.microprofile.openapi.models.Components
-
Returns the headers property from a Components instance.
- getHeaders() - Method in interface org.eclipse.microprofile.openapi.models.media.Encoding
-
Headers property of an Encoding is a map that allows additional information to be provided as headers
- getHeaders() - Method in interface org.eclipse.microprofile.openapi.models.responses.APIResponse
-
Returns the map of Headers in this instance of ApiResponse.
- getHistograms() - Method in class org.eclipse.microprofile.metrics.MetricRegistry
-
Returns a map of all the histograms in the registry and their names.
- getHistograms(MetricFilter) - Method in class org.eclipse.microprofile.metrics.MetricRegistry
-
Returns a map of all the histograms in the registry and their names which match the given
filter.
- getImplicit() - Method in interface org.eclipse.microprofile.openapi.models.security.OAuthFlows
-
This method returns the implicit property from OAuthFlows instance.
- getIn() - Method in interface org.eclipse.microprofile.openapi.models.parameters.Parameter
-
Returns the in property from a Parameter instance.
- getIn() - Method in interface org.eclipse.microprofile.openapi.models.security.SecurityScheme
-
In is a REQUIRED property that indicates the location of the API key.
- getInfo() - Method in interface org.eclipse.microprofile.openapi.models.OpenAPI
-
Returns the info property from an OpenAPI instance.
- getIssuedAtTime() - Method in interface org.eclipse.microprofile.jwt.JsonWebToken
-
The iat(Issued at time) claim identifies the time at which the JWT was
issued in seconds since 1970-01-01T00:00:00Z UTC
- getIssuer() - Method in interface org.eclipse.microprofile.jwt.JsonWebToken
-
The iss(Issuer) claim identifies the principal that issued the JWT
- getItems() - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Returns the Schema used for all the elements of an array typed Schema.
- getLicense() - Method in interface org.eclipse.microprofile.openapi.models.info.Info
-
Returns the license information for the exposed API from this Info instance.
- getLinks() - Method in interface org.eclipse.microprofile.openapi.models.Components
-
Returns the links property from a Components instance.
- getLinks() - Method in interface org.eclipse.microprofile.openapi.models.responses.APIResponse
-
Returns the operations links that can be followed from tis instance of ApiResponse.
- getMapping() - Method in interface org.eclipse.microprofile.openapi.models.media.Discriminator
-
Returns the mapping property from a Discriminator instance.
- getMax() - Method in class org.eclipse.microprofile.metrics.Snapshot
-
Returns the highest value in the snapshot.
- getMaximum() - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Returns the maximum property from this Schema instance.
- getMaxItems() - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Returns the maxItems property from this Schema instance.
- getMaxLength() - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Returns the maxLength property from this Schema instance.
- getMaxProperties() - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Returns the maxProperties property from this Schema instance.
- getMean() - Method in class org.eclipse.microprofile.metrics.Snapshot
-
Returns the arithmetic mean of the values in the snapshot.
- getMeanRate() - Method in interface org.eclipse.microprofile.metrics.Meter
-
- getMeanRate() - Method in interface org.eclipse.microprofile.metrics.Metered
-
Returns the mean rate at which events have occurred since the meter was created.
- getMeanRate() - Method in interface org.eclipse.microprofile.metrics.Timer
-
- getMedian() - Method in class org.eclipse.microprofile.metrics.Snapshot
-
Returns the median value in the distribution.
- getMetadata() - Method in class org.eclipse.microprofile.metrics.MetricRegistry
-
Returns a map of all the metadata in the registry and their names.
- getMeters() - Method in class org.eclipse.microprofile.metrics.MetricRegistry
-
Returns a map of all the meters in the registry and their names.
- getMeters(MetricFilter) - Method in class org.eclipse.microprofile.metrics.MetricRegistry
-
Returns a map of all the meters in the registry and their names which match the given filter.
- getMethod() - Method in interface org.eclipse.microprofile.faulttolerance.ExecutionContext
-
Returns the method being executed
- getMetrics() - Method in class org.eclipse.microprofile.metrics.MetricRegistry
-
Returns a map of all the metrics in the registry and their names.
- getMin() - Method in class org.eclipse.microprofile.metrics.Snapshot
-
Returns the lowest value in the snapshot.
- getMinimum() - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Returns the minimum property from this Schema instance.
- getMinItems() - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Returns the minItems property from this Schema instance.
- getMinLength() - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Returns the minLength property from this Schema instance.
- getMinProperties() - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Returns the minProperties property from this Schema instance.
- getMultipleOf() - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Returns the multipleOf property from this Schema instance.
- getName() - Method in interface org.eclipse.microprofile.config.spi.ConfigSource
-
The name of the config might be used for logging or analysis of configured values.
- getName() - Method in class org.eclipse.microprofile.health.HealthCheckResponse
-
- getName() - Method in interface org.eclipse.microprofile.jwt.ClaimValue
-
Access the name of the claim.
- getName() - Method in interface org.eclipse.microprofile.jwt.JsonWebToken
-
Returns the unique name of this principal.
- getName() - Method in class org.eclipse.microprofile.metrics.Metadata
-
Returns the metric name.
- getName() - Method in enum org.eclipse.microprofile.metrics.MetricRegistry.Type
-
Returns the name of the MetricRegistry scope.
- getName() - Method in interface org.eclipse.microprofile.openapi.models.info.Contact
-
Returns the identifying name of this Contact instance.
- getName() - Method in interface org.eclipse.microprofile.openapi.models.info.License
-
Returns the license name for this License instance that is used for the API.
- getName() - Method in interface org.eclipse.microprofile.openapi.models.media.XML
-
This method returns the name property from XML instance.
- getName() - Method in interface org.eclipse.microprofile.openapi.models.parameters.Parameter
-
Returns the name property from a Parameter instance.
- getName() - Method in interface org.eclipse.microprofile.openapi.models.security.SecurityScheme
-
Name is a REQUIRED property - this is the name of the header, query or cookie parameter to be used.
- getName() - Method in interface org.eclipse.microprofile.openapi.models.tags.Tag
-
Returns the name property from a Tag instance.
- getNames() - Method in class org.eclipse.microprofile.metrics.MetricRegistry
-
Returns a set of the names of all the metrics in the registry.
- getNamespace() - Method in interface org.eclipse.microprofile.openapi.models.media.XML
-
This method returns the namespace property of XML instance.
- getNot() - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Returns a Schema which describes properties not allowed in objects defined by the current schema.
- getNullable() - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Returns the nullable property from this Schema instance which indicates whether null is a valid value.
- getOneMinuteRate() - Method in interface org.eclipse.microprofile.metrics.Meter
-
- getOneMinuteRate() - Method in interface org.eclipse.microprofile.metrics.Metered
-
Returns the one-minute exponentially-weighted moving average rate at which events have
occurred since the meter was created.
- getOneMinuteRate() - Method in interface org.eclipse.microprofile.metrics.Timer
-
- getOneOf() - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Returns the schemas used by the oneOf property.
- getOpenapi() - Method in interface org.eclipse.microprofile.openapi.models.OpenAPI
-
Returns the openapi property from an OpenAPI instance.
- getOpenIdConnectUrl() - Method in interface org.eclipse.microprofile.openapi.models.security.SecurityScheme
-
openIdConnectUrl is a REQUIRED property.
- getOperationId() - Method in interface org.eclipse.microprofile.openapi.models.links.Link
-
Returns the operationId property for this instance of Link.
- getOperationId() - Method in interface org.eclipse.microprofile.openapi.models.Operation
-
Returns the operationId property from an Operation instance.
- getOperationRef() - Method in interface org.eclipse.microprofile.openapi.models.links.Link
-
Returns the operationRef property from a Link instance.
- getOptionalValue(String, Class<T>) - Method in interface org.eclipse.microprofile.config.Config
-
Return the resolved property value with the specified type for the
specified property name from the underlying
ConfigSources
.
- getOPTIONS() - Method in interface org.eclipse.microprofile.openapi.models.PathItem
-
Returns the options property from a PathItem instance.
- getOrdinal() - Method in interface org.eclipse.microprofile.config.spi.ConfigSource
-
Return the ordinal for this config source.
- getParameters() - Method in interface org.eclipse.microprofile.faulttolerance.ExecutionContext
-
Returns the parameter values being passed to the method
- getParameters() - Method in interface org.eclipse.microprofile.openapi.models.Components
-
Returns the parameters property from a Components instance.
- getParameters() - Method in interface org.eclipse.microprofile.openapi.models.links.Link
-
Returns the parameters property from this instance of Link.
- getParameters() - Method in interface org.eclipse.microprofile.openapi.models.Operation
-
Returns the parameters property from an Operation instance.
- getParameters() - Method in interface org.eclipse.microprofile.openapi.models.PathItem
-
Returns the parameters property from this PathItem instance.
- getPassword() - Method in interface org.eclipse.microprofile.openapi.models.security.OAuthFlows
-
OAuth Resource Owner Password flow
- getPATCH() - Method in interface org.eclipse.microprofile.openapi.models.PathItem
-
Returns the patch property from a PathItem instance.
- getPaths() - Method in interface org.eclipse.microprofile.openapi.models.OpenAPI
-
Returns the paths property from an OpenAPI instance.
- getPattern() - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Returns the pattern property from this Schema instance.
- getPOST() - Method in interface org.eclipse.microprofile.openapi.models.PathItem
-
Returns the post property from a PathItem instance.
- getPrefix() - Method in interface org.eclipse.microprofile.openapi.models.media.XML
-
This method returns the prefix property of XML instance.
- getPriority() - Method in interface org.eclipse.microprofile.rest.client.ext.ResponseExceptionMapper
-
The priority of this mapper.
- getProperties() - Method in interface org.eclipse.microprofile.config.spi.ConfigSource
-
Return the properties in this config source
- getProperties() - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Returns the properties defined in this Schema.
- getPropertyName() - Method in interface org.eclipse.microprofile.openapi.models.media.Discriminator
-
Returns the propertyName property from a Discriminator instance.
- getPropertyNames() - Method in interface org.eclipse.microprofile.config.Config
-
Return a collection of property names.
- getPropertyNames() - Method in interface org.eclipse.microprofile.config.spi.ConfigSource
-
Gets all property names known to this config source, without evaluating the values.
- getPUT() - Method in interface org.eclipse.microprofile.openapi.models.PathItem
-
Returns the put property from a PathItem instance.
- getRawToken() - Method in interface org.eclipse.microprofile.jwt.JsonWebToken
-
Get the raw bearer token string originally passed in the authentication
header
- getReadOnly() - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Returns the readOnly property from this Schema instance.
- getRef() - Method in interface org.eclipse.microprofile.openapi.models.Reference
-
Returns the reference property from this Reference instance.
- getRefreshUrl() - Method in interface org.eclipse.microprofile.openapi.models.security.OAuthFlow
-
The URL to be used for obtaining refresh tokens.
- getRequestBodies() - Method in interface org.eclipse.microprofile.openapi.models.Components
-
Returns the requestBodies property from a Components instance.
- getRequestBody() - Method in interface org.eclipse.microprofile.openapi.models.links.Link
-
Returns the requestBody property from a Link instance.
- getRequestBody() - Method in interface org.eclipse.microprofile.openapi.models.Operation
-
Returns the requestBody property from an Operation instance.
- getRequired() - Method in interface org.eclipse.microprofile.openapi.models.headers.Header
-
Returns the required property from a Header instance.
- getRequired() - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Returns the required property from this Schema instance.
- getRequired() - Method in interface org.eclipse.microprofile.openapi.models.parameters.Parameter
-
Returns the required property from a Parameter instance.
- getRequired() - Method in interface org.eclipse.microprofile.openapi.models.parameters.RequestBody
-
Returns whether this instance of RequestBody is required for the operation.
- getResponses() - Method in interface org.eclipse.microprofile.openapi.models.Components
-
Returns the responses property from a Components instance.
- getResponses() - Method in interface org.eclipse.microprofile.openapi.models.Operation
-
Returns the responses property from an Operation instance.
- getSchema() - Method in interface org.eclipse.microprofile.openapi.models.headers.Header
-
Returns the schema property from a Header instance.
- getSchema() - Method in interface org.eclipse.microprofile.openapi.models.media.MediaType
-
Returns the schema property from a MediaType instance.
- getSchema() - Method in interface org.eclipse.microprofile.openapi.models.parameters.Parameter
-
Returns the schema property from a Parameter instance.
- getSchemas() - Method in interface org.eclipse.microprofile.openapi.models.Components
-
Returns the schemas property from a Components instance.
- getScheme() - Method in interface org.eclipse.microprofile.openapi.models.security.SecurityScheme
-
Schema is a REQUIRED property that is the name of the HTTP Authorization scheme to be used in the Authorization header as defined in RFC7235.
- getScopes() - Method in interface org.eclipse.microprofile.openapi.models.security.OAuthFlow
-
The available scopes for the OAuth2 security scheme.
- getSecurity() - Method in interface org.eclipse.microprofile.openapi.models.OpenAPI
-
Returns the security property from an OpenAPI instance.
- getSecurity() - Method in interface org.eclipse.microprofile.openapi.models.Operation
-
Returns the security property from an Operation instance.
- getSecuritySchemes() - Method in interface org.eclipse.microprofile.openapi.models.Components
-
Returns the securitySchemes property from a Components instance.
- getServer() - Method in interface org.eclipse.microprofile.openapi.models.links.Link
-
Returns the server property from a Link instance.
- getServers() - Method in interface org.eclipse.microprofile.openapi.models.OpenAPI
-
Returns the Servers defined in the API
- getServers() - Method in interface org.eclipse.microprofile.openapi.models.Operation
-
Returns the servers property from an Operation instance.
- getServers() - Method in interface org.eclipse.microprofile.openapi.models.PathItem
-
Returns the servers property from a PathItem instance.
- getSnapshot() - Method in interface org.eclipse.microprofile.metrics.Histogram
-
- getSnapshot() - Method in interface org.eclipse.microprofile.metrics.Sampling
-
Returns a snapshot of the values.
- getSnapshot() - Method in interface org.eclipse.microprofile.metrics.Timer
-
- getState() - Method in class org.eclipse.microprofile.health.HealthCheckResponse
-
- getStdDev() - Method in class org.eclipse.microprofile.metrics.Snapshot
-
Returns the standard deviation of the values in the snapshot.
- getStyle() - Method in interface org.eclipse.microprofile.openapi.models.headers.Header
-
Returns the style property from a Header instance.
- getStyle() - Method in interface org.eclipse.microprofile.openapi.models.media.Encoding
-
Style describes how the encoding value will be serialized depending on the type of the parameter value.
- getStyle() - Method in interface org.eclipse.microprofile.openapi.models.parameters.Parameter
-
Returns the style property from a Parameter instance.
- getSubject() - Method in interface org.eclipse.microprofile.jwt.JsonWebToken
-
The sub(Subject) claim identifies the principal that is the subject of
the JWT.
- getSummary() - Method in interface org.eclipse.microprofile.openapi.models.examples.Example
-
Returns the summary property from an Example instance.
- getSummary() - Method in interface org.eclipse.microprofile.openapi.models.Operation
-
Returns the summary property from an Operation instance.
- getSummary() - Method in interface org.eclipse.microprofile.openapi.models.PathItem
-
Returns the summary property from a PathItem instance.
- getTags() - Method in class org.eclipse.microprofile.metrics.Metadata
-
Returns the underlying HashMap containing the tags.
- getTags() - Method in interface org.eclipse.microprofile.openapi.models.OpenAPI
-
Returns the tags property from an OpenAPI instance.
- getTags() - Method in interface org.eclipse.microprofile.openapi.models.Operation
-
Returns the tags property from an Operation instance.
- getTagsAsString() - Method in class org.eclipse.microprofile.metrics.Metadata
-
Gets the list of tags as a single String in the format 'key="value",key2="value2",...'
- getTermsOfService() - Method in interface org.eclipse.microprofile.openapi.models.info.Info
-
Returns the URL to the Terms of Service for the API for this instance of Info.
- getTimers() - Method in class org.eclipse.microprofile.metrics.MetricRegistry
-
Returns a map of all the timers in the registry and their names.
- getTimers(MetricFilter) - Method in class org.eclipse.microprofile.metrics.MetricRegistry
-
Returns a map of all the timers in the registry and their names which match the given filter.
- getTitle() - Method in interface org.eclipse.microprofile.openapi.models.info.Info
-
Returns the title for the application for this instance of Info
- getTitle() - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Returns the title property from this Schema instance.
- getTokenID() - Method in interface org.eclipse.microprofile.jwt.JsonWebToken
-
The jti(JWT ID) claim provides a unique identifier for the JWT.
- getTokenUrl() - Method in interface org.eclipse.microprofile.openapi.models.security.OAuthFlow
-
The token URL to be used for this flow.
- getTRACE() - Method in interface org.eclipse.microprofile.openapi.models.PathItem
-
Returns the trace property from a PathItem instance.
- getType() - Method in enum org.eclipse.microprofile.jwt.Claims
-
The required type of the claim
- getType() - Method in class org.eclipse.microprofile.metrics.Metadata
-
Returns the String representation of the
MetricType
.
- getType() - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Returns the type property from this Schema.
- getType() - Method in interface org.eclipse.microprofile.openapi.models.security.SecurityScheme
-
Type is a REQUIRED property that specifies the type of SecurityScheme instance.
- getTypeRaw() - Method in class org.eclipse.microprofile.metrics.Metadata
-
- getUniqueItems() - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Returns the uniqueItems property from this Schema instance.
- getUnit() - Method in class org.eclipse.microprofile.metrics.Metadata
-
Returns the unit of the metric.
- getUrl() - Method in interface org.eclipse.microprofile.openapi.models.ExternalDocumentation
-
Returns the url property from an ExternalDocumentation instance.
- getUrl() - Method in interface org.eclipse.microprofile.openapi.models.info.Contact
-
Returns the URL pointing to the contact information for this Contact instance.
- getUrl() - Method in interface org.eclipse.microprofile.openapi.models.info.License
-
Returns the URL for this License instance that is used for the API.
- getUrl() - Method in interface org.eclipse.microprofile.openapi.models.servers.Server
-
This method returns the url property of Server instance, which is a URL to the target host.
- getValue(String, Class<T>) - Method in interface org.eclipse.microprofile.config.Config
-
Return the resolved property value with the specified type for the
specified property name from the underlying
ConfigSources
.
- getValue(String) - Method in interface org.eclipse.microprofile.config.spi.ConfigSource
-
Return the value for the specified property in this config source.
- getValue() - Method in interface org.eclipse.microprofile.jwt.ClaimValue
-
Access the value of the claim.
- getValue() - Method in interface org.eclipse.microprofile.metrics.Gauge
-
Returns the metric's current value.
- getValue(double) - Method in class org.eclipse.microprofile.metrics.Snapshot
-
Returns the value at the given quantile.
- getValue() - Method in interface org.eclipse.microprofile.openapi.models.examples.Example
-
Returns the value property from an Example instance.
- getValues() - Method in class org.eclipse.microprofile.metrics.Snapshot
-
Returns the entire set of values in the snapshot.
- getVariables() - Method in interface org.eclipse.microprofile.openapi.models.servers.Server
-
This method returns the variables property of Server instance.
- getVersion() - Method in interface org.eclipse.microprofile.openapi.models.info.Info
-
Returns the version of the OpenAPI document for this Info instance.
- getWrapped() - Method in interface org.eclipse.microprofile.openapi.models.media.XML
-
This method returns the wrapped property of XML instance.
- getWriteOnly() - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Returns the writeOnly property from this Schema instance.
- getXml() - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Returns the xml property from this Schema instance.
- GIBIBITS - Static variable in class org.eclipse.microprofile.metrics.MetricUnits
-
- GIGABITS - Static variable in class org.eclipse.microprofile.metrics.MetricUnits
-
- GIGABYTES - Static variable in class org.eclipse.microprofile.metrics.MetricUnits
-
- GLOBAL_TAGS_VARIABLE - Static variable in class org.eclipse.microprofile.metrics.Metadata
-
The environment variable used to pass in global tags.
- GlobalTagsTest - Class in org.eclipse.microprofile.metrics.tck
-
Test for obtaining global tags from MP_METRICS_TAGS env variable.
- GlobalTagsTest() - Constructor for class org.eclipse.microprofile.metrics.tck.GlobalTagsTest
-
- Sampling - Interface in org.eclipse.microprofile.metrics
-
An object which samples values.
- SCAN_CLASSES - Static variable in class org.eclipse.microprofile.openapi.OASConfig
-
Configuration property to specify the list of classes to scan.
- SCAN_DISABLE - Static variable in class org.eclipse.microprofile.openapi.OASConfig
-
Configuration property to disable annotation scanning.
- SCAN_EXCLUDE_CLASSES - Static variable in class org.eclipse.microprofile.openapi.OASConfig
-
Configuration property to specify the list of classes to exclude from scans.
- SCAN_EXCLUDE_PACKAGES - Static variable in class org.eclipse.microprofile.openapi.OASConfig
-
Configuration property to specify the list of packages to exclude from scans.
- SCAN_PACKAGES - Static variable in class org.eclipse.microprofile.openapi.OASConfig
-
Configuration property to specify the list of packages to scan.
- Schema - Annotation Type in org.eclipse.microprofile.openapi.annotations.media
-
The Schema Object allows the definition of input and output data types.
- schema(Schema) - Method in interface org.eclipse.microprofile.openapi.models.headers.Header
-
Sets this Header's schema property to the given object.
- schema(Schema) - Method in interface org.eclipse.microprofile.openapi.models.media.MediaType
-
Sets the schema field of a MediaType instance to the given schema object.
- Schema - Interface in org.eclipse.microprofile.openapi.models.media
-
The Schema Object allows the definition of input and output data types.
- schema(Schema) - Method in interface org.eclipse.microprofile.openapi.models.parameters.Parameter
-
Sets the schema property of a Parameter instance to the given value.
- Schema.SchemaType - Enum in org.eclipse.microprofile.openapi.models.media
-
The values allowed for the in field.
- schemas(Map<String, Schema>) - Method in interface org.eclipse.microprofile.openapi.models.Components
-
Sets this Components' schemas property to the given Map containing keys and reusable schemas.
- SchemaType - Enum in org.eclipse.microprofile.openapi.annotations.enums
-
- scheme(String) - Method in interface org.eclipse.microprofile.openapi.models.security.SecurityScheme
-
Schema is a REQUIRED property that is the name of the HTTP Authorization scheme to be used in the Authorization header as defined in RFC7235.
- scopes(Scopes) - Method in interface org.eclipse.microprofile.openapi.models.security.OAuthFlow
-
The available scopes for the OAuth2 security scheme.
- Scopes - Interface in org.eclipse.microprofile.openapi.models.security
-
Scopes is a property of OAuth Flow Object.
- SECONDS - Static variable in class org.eclipse.microprofile.metrics.MetricUnits
-
Represents seconds
- security(List<SecurityRequirement>) - Method in interface org.eclipse.microprofile.openapi.models.OpenAPI
-
Sets this OpenAPI instance's security property to the given list.
- security(List<SecurityRequirement>) - Method in interface org.eclipse.microprofile.openapi.models.Operation
-
Sets this Operation's security property to the given list.
- SecurityRequirement - Annotation Type in org.eclipse.microprofile.openapi.annotations.security
-
Specifies a security requirement for an operation.
- SecurityRequirement - Interface in org.eclipse.microprofile.openapi.models.security
-
SecurityRequirement
- SecurityRequirements - Annotation Type in org.eclipse.microprofile.openapi.annotations.security
-
This object represents an array of security requirements that can be specified for the operation or at definition level.
- SecurityRequirementsSet - Annotation Type in org.eclipse.microprofile.openapi.annotations.security
-
This object represents a map of security requirements that can be specified for the operation or at definition level.
- SecurityScheme - Annotation Type in org.eclipse.microprofile.openapi.annotations.security
-
Defines a security scheme that can be used by the operations.
- SecurityScheme - Interface in org.eclipse.microprofile.openapi.models.security
-
SecurityScheme
- SecurityScheme.In - Enum in org.eclipse.microprofile.openapi.models.security
-
In is a REQUIRED property that specifies the location of the API key.
- SecurityScheme.Type - Enum in org.eclipse.microprofile.openapi.models.security
-
Type is a REQUIRED property that specifies the type of SecurityScheme instance.
- SecuritySchemeIn - Enum in org.eclipse.microprofile.openapi.annotations.enums
-
- SecuritySchemes - Annotation Type in org.eclipse.microprofile.openapi.annotations.security
-
This object represents an array of SecurityScheme annotations that can be specified at the definition level.
- securitySchemes(Map<String, SecurityScheme>) - Method in interface org.eclipse.microprofile.openapi.models.Components
-
Sets this Components' securitySchemes property to the given Map containing keys and reusable security scheme objects.
- SecuritySchemeType - Enum in org.eclipse.microprofile.openapi.annotations.enums
-
- Server - Annotation Type in org.eclipse.microprofile.openapi.annotations.servers
-
This annotation represents a Server used in an operation or used by all operations in an
OpenAPI document.
- server(Server) - Method in interface org.eclipse.microprofile.openapi.models.links.Link
-
Sets this Link's server property to the given object.
- Server - Interface in org.eclipse.microprofile.openapi.models.servers
-
An object representing a server.
- Servers - Annotation Type in org.eclipse.microprofile.openapi.annotations.servers
-
The Servers annotation is a container for @Server annotations.
- servers(List<Server>) - Method in interface org.eclipse.microprofile.openapi.models.OpenAPI
-
Sets this OpenAPI instance's servers property to the given servers.
- servers(List<Server>) - Method in interface org.eclipse.microprofile.openapi.models.Operation
-
Sets this Operation's servers property to the given list.
- servers(List<Server>) - Method in interface org.eclipse.microprofile.openapi.models.PathItem
-
Sets this PathItem's servers property to the given list.
- SERVERS - Static variable in class org.eclipse.microprofile.openapi.OASConfig
-
Configuration property to specify the list of global servers that provide connectivity information.
- SERVERS_OPERATION_PREFIX - Static variable in class org.eclipse.microprofile.openapi.OASConfig
-
Prefix of the configuration property to specify an alternative list of servers to service an operation.
- SERVERS_PATH_PREFIX - Static variable in class org.eclipse.microprofile.openapi.OASConfig
-
Prefix of the configuration property to specify an alternative list of servers to service all operations in a path.
- ServerVariable - Annotation Type in org.eclipse.microprofile.openapi.annotations.servers
-
An object representing a Server Variable for server URL template substitution.
- ServerVariable - Interface in org.eclipse.microprofile.openapi.models.servers
-
An object representing a Server Variable for server URL template substitution.
- ServerVariables - Interface in org.eclipse.microprofile.openapi.models.servers
-
ServerVariables
- setAdditionalProperties(Schema) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Sets the Schema which defines additional properties not defined by "properties" or "patternProperties".
- setAdditionalProperties(Boolean) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Sets the value of "additionalProperties" to either True or False.
- setAllOf(List<Schema>) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Sets the schemas used by the allOf property of this Schema.
- setAllowEmptyValue(Boolean) - Method in interface org.eclipse.microprofile.openapi.models.headers.Header
-
Sets this Header's allowEmptyValue property to the given value.
- setAllowEmptyValue(Boolean) - Method in interface org.eclipse.microprofile.openapi.models.parameters.Parameter
-
Sets the allowEmptyValue property of a Parameter instance to the given value.
- setAllowReserved(Boolean) - Method in interface org.eclipse.microprofile.openapi.models.media.Encoding
-
AllowReserved determines whether the parameter value SHOULD allow reserved characters to be encoded without percent-encoding.
- setAllowReserved(Boolean) - Method in interface org.eclipse.microprofile.openapi.models.parameters.Parameter
-
Sets the allowReserved property of a Parameter instance to the given value.
- setAnyOf(List<Schema>) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Sets the schemas used by the anyOf property of this Schema.
- setAttribute(Boolean) - Method in interface org.eclipse.microprofile.openapi.models.media.XML
-
This method sets the attribute property of XML instance to the given Boolean argument.
- setAuthorizationCode(OAuthFlow) - Method in interface org.eclipse.microprofile.openapi.models.security.OAuthFlows
-
OAuth Authorization Code flow; previously called accessCode in OpenAPI 2.0
- setAuthorizationUrl(String) - Method in interface org.eclipse.microprofile.openapi.models.security.OAuthFlow
-
The authorization URL to be used for this flow.
- setBearerFormat(String) - Method in interface org.eclipse.microprofile.openapi.models.security.SecurityScheme
-
bearerFormat is intended as a hint to the client to identify how the bearer token is formatted.
- setCallbacks(Map<String, Callback>) - Method in interface org.eclipse.microprofile.openapi.models.Components
-
Sets this Components' callbacks property to the given Map containing keys and reusable callback objects.
- setCallbacks(Map<String, Callback>) - Method in interface org.eclipse.microprofile.openapi.models.Operation
-
Sets this Operation's callbacks property to the given map.
- setClientCredentials(OAuthFlow) - Method in interface org.eclipse.microprofile.openapi.models.security.OAuthFlows
-
OAuth Client Credential flow; previously called application in OpenAPI 2.0
- setComponents(Components) - Method in interface org.eclipse.microprofile.openapi.models.OpenAPI
-
Sets this OpenAPI instance's components property to the given components.
- setContact(Contact) - Method in interface org.eclipse.microprofile.openapi.models.info.Info
-
Sets this Info instance's contact information for the exposed API.
- setContent(Content) - Method in interface org.eclipse.microprofile.openapi.models.headers.Header
-
Sets this Header's content property to the given object.
- setContent(Content) - Method in interface org.eclipse.microprofile.openapi.models.parameters.Parameter
-
Sets the content property of a Parameter instance to the given object.
- setContent(Content) - Method in interface org.eclipse.microprofile.openapi.models.parameters.RequestBody
-
Sets the content of this instance of RequestBody, where the keys in content are media type names and the values describe it.
- setContent(Content) - Method in interface org.eclipse.microprofile.openapi.models.responses.APIResponse
-
Sets the map containing descriptions of potential response payload for this instance of ApiResponse.
- setContentType(String) - Method in interface org.eclipse.microprofile.openapi.models.media.Encoding
-
The Content-Type for encoding a specific property.
- setDefaultValue(Object) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Set the default value property of this Schema instance to the value given.
- setDefaultValue(APIResponse) - Method in interface org.eclipse.microprofile.openapi.models.responses.APIResponses
-
Sets the default documentation of responses for this instance of ApiResponses.
- setDefaultValue(String) - Method in interface org.eclipse.microprofile.openapi.models.servers.ServerVariable
-
The default value to use for substitution, and to send, if an alternate value is not supplied.
- setDELETE(Operation) - Method in interface org.eclipse.microprofile.openapi.models.PathItem
-
Sets this PathItem's delete property to the given operation.
- setDeprecated(Boolean) - Method in interface org.eclipse.microprofile.openapi.models.headers.Header
-
Sets this Header's deprecated property to the given value.
- setDeprecated(Boolean) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Sets the deprecated property of this Schema.
- setDeprecated(Boolean) - Method in interface org.eclipse.microprofile.openapi.models.Operation
-
Sets this Operation's deprecated property to the given value.
- setDeprecated(Boolean) - Method in interface org.eclipse.microprofile.openapi.models.parameters.Parameter
-
Sets the deprecated property of a Parameter instance to the given value.
- setDescription(String) - Method in class org.eclipse.microprofile.metrics.Metadata
-
Sets the description of the metric.
- setDescription(String) - Method in interface org.eclipse.microprofile.openapi.models.examples.Example
-
Sets this Example's description property to the given string.
- setDescription(String) - Method in interface org.eclipse.microprofile.openapi.models.ExternalDocumentation
-
Sets this ExternalDocumentation's description property to the given string.
- setDescription(String) - Method in interface org.eclipse.microprofile.openapi.models.headers.Header
-
Sets this Header's description property to the given string.
- setDescription(String) - Method in interface org.eclipse.microprofile.openapi.models.info.Info
-
Sets this Info instance's description for the application to the given description.
- setDescription(String) - Method in interface org.eclipse.microprofile.openapi.models.links.Link
-
Sets this Link's description property to the given string.
- setDescription(String) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Sets the description property of this Schema to the given string.
- setDescription(String) - Method in interface org.eclipse.microprofile.openapi.models.Operation
-
Sets this Operation's description property to the given string.
- setDescription(String) - Method in interface org.eclipse.microprofile.openapi.models.parameters.Parameter
-
Sets the description property of a Parameter instance to the given string.
- setDescription(String) - Method in interface org.eclipse.microprofile.openapi.models.parameters.RequestBody
-
Sets the description of this instance of RequestBody.
- setDescription(String) - Method in interface org.eclipse.microprofile.openapi.models.PathItem
-
Sets this PathItem's description property to the given string.
- setDescription(String) - Method in interface org.eclipse.microprofile.openapi.models.responses.APIResponse
-
Sets the description of this instance of ApiResponse.
- setDescription(String) - Method in interface org.eclipse.microprofile.openapi.models.security.SecurityScheme
-
A short description for security schema.
- setDescription(String) - Method in interface org.eclipse.microprofile.openapi.models.servers.Server
-
This method sets the description property of a Server instance to the given description parameter.
- setDescription(String) - Method in interface org.eclipse.microprofile.openapi.models.servers.ServerVariable
-
This method sets the description property of ServerVariable instance to the given description argument.
- setDescription(String) - Method in interface org.eclipse.microprofile.openapi.models.tags.Tag
-
Sets the description property of a Tag instance to the given string.
- setDiscriminator(Discriminator) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Sets the discriminator property of this Schema instance to the given object.
- setDisplayName(String) - Method in class org.eclipse.microprofile.metrics.Metadata
-
Sets the display name.
- setEmail(String) - Method in interface org.eclipse.microprofile.openapi.models.info.Contact
-
Sets the contact email of this instance of Contact.
- setEncoding(Map<String, Encoding>) - Method in interface org.eclipse.microprofile.openapi.models.media.MediaType
-
Sets encoding property of a MediaType instance to the given map object.
- setEnumeration(List<Object>) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Sets the enumerated list of values allowed for objects defined by this Schema.
- setEnumeration(List<String>) - Method in interface org.eclipse.microprofile.openapi.models.servers.ServerVariable
-
This method sets the enumeration property of ServerVariable instance to the given enumeration argument.
- setExample(Object) - Method in interface org.eclipse.microprofile.openapi.models.headers.Header
-
Sets this Header's example property to the given object.
- setExample(Object) - Method in interface org.eclipse.microprofile.openapi.models.media.MediaType
-
Sets the example property of a MediaType instance to the given value.
- setExample(Object) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Sets the example property of this Schema instance.
- setExample(Object) - Method in interface org.eclipse.microprofile.openapi.models.parameters.Parameter
-
Sets the example property of a Parameter instance to the given object.
- setExamples(Map<String, Example>) - Method in interface org.eclipse.microprofile.openapi.models.Components
-
Sets this Components' examples property to the given Map containing keys and reusable example objects.
- setExamples(Map<String, Example>) - Method in interface org.eclipse.microprofile.openapi.models.headers.Header
-
Sets the examples property of this Header instance to the given map.
- setExamples(Map<String, Example>) - Method in interface org.eclipse.microprofile.openapi.models.media.MediaType
-
Sets the examples field of a MediaType instance to the given map object.
- setExamples(Map<String, Example>) - Method in interface org.eclipse.microprofile.openapi.models.parameters.Parameter
-
Sets the examples property of a Parameter instance to the given value.
- setExclusiveMaximum(Boolean) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Sets the exclusiveMaximum property of this Schema instance to the value given.
- setExclusiveMinimum(Boolean) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Sets the exclusiveMinimum property of this Schema instance to the value given.
- setExplode(Boolean) - Method in interface org.eclipse.microprofile.openapi.models.headers.Header
-
Sets this Header's explode property to the given value.
- setExplode(Boolean) - Method in interface org.eclipse.microprofile.openapi.models.media.Encoding
-
When this is true, property values of type array or object generate separate parameters for each value of the array, or key-value-pair of the
map.
- setExplode(Boolean) - Method in interface org.eclipse.microprofile.openapi.models.parameters.Parameter
-
Sets the explode property of a Parameter instance to the given value.
- setExtensions(Map<String, Object>) - Method in interface org.eclipse.microprofile.openapi.models.Extensible
-
Sets this Extensible's extensions property to the given map of extensions.
- setExternalDocs(ExternalDocumentation) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Sets the externalDocs property of this Schema to the indicated value.
- setExternalDocs(ExternalDocumentation) - Method in interface org.eclipse.microprofile.openapi.models.OpenAPI
-
Sets this OpenAPI instance's externalDocs property to the given object.
- setExternalDocs(ExternalDocumentation) - Method in interface org.eclipse.microprofile.openapi.models.Operation
-
Sets this Operation's externalDocs property to the given object.
- setExternalDocs(ExternalDocumentation) - Method in interface org.eclipse.microprofile.openapi.models.tags.Tag
-
Sets the externalDocs property of a Tag instance to the given object.
- setExternalValue(String) - Method in interface org.eclipse.microprofile.openapi.models.examples.Example
-
Sets this Example's externalValue property to the given string.
- setFlows(OAuthFlows) - Method in interface org.eclipse.microprofile.openapi.models.security.SecurityScheme
-
Flows is a REQUIRED property.
- setFormat(String) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Sets the format property of this Schema instance to the given string.
- setGET(Operation) - Method in interface org.eclipse.microprofile.openapi.models.PathItem
-
Sets this PathItem's get property to the given operation.
- setHEAD(Operation) - Method in interface org.eclipse.microprofile.openapi.models.PathItem
-
Sets this PathItem's head property to the given operation.
- setHeaders(Map<String, Header>) - Method in interface org.eclipse.microprofile.openapi.models.Components
-
Sets this Components' headers property to the given Map containing keys and reusable header objects.
- setHeaders(Map<String, Header>) - Method in interface org.eclipse.microprofile.openapi.models.media.Encoding
-
Headers property of an Encoding is a map that allows additional information to be provided as headers
- setHeaders(Map<String, Header>) - Method in interface org.eclipse.microprofile.openapi.models.responses.APIResponse
-
Sets the Headers for this instance of ApiResponse with the given map of Headers.
- setImplicit(OAuthFlow) - Method in interface org.eclipse.microprofile.openapi.models.security.OAuthFlows
-
This method sets the implicit property of OAuthFlows instance to the given implicit argument.
- setIn(Parameter.In) - Method in interface org.eclipse.microprofile.openapi.models.parameters.Parameter
-
Sets the in property of a Parameter instance to the given value.
- setIn(SecurityScheme.In) - Method in interface org.eclipse.microprofile.openapi.models.security.SecurityScheme
-
In is a REQUIRED property that indicates the location of the API key.
- setInfo(Info) - Method in interface org.eclipse.microprofile.openapi.models.OpenAPI
-
Sets this OpenAPI instance's info property to the given object.
- setInstance(ConfigProviderResolver) - Static method in class org.eclipse.microprofile.config.spi.ConfigProviderResolver
-
Set the instance.
- setInstance(OASFactoryResolver) - Static method in class org.eclipse.microprofile.openapi.spi.OASFactoryResolver
-
Set the instance.
- setInstance(RestClientBuilderResolver) - Static method in class org.eclipse.microprofile.rest.client.spi.RestClientBuilderResolver
-
Set the instance.
- setItems(Schema) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Set the Schema used for all the elements of an array typed Schema.
- setLicense(License) - Method in interface org.eclipse.microprofile.openapi.models.info.Info
-
Sets this Info's license information for the exposed API.
- setLinks(Map<String, Link>) - Method in interface org.eclipse.microprofile.openapi.models.Components
-
Sets this Components' links property to the given Map containing keys and reusable link objects.
- setLinks(Map<String, Link>) - Method in interface org.eclipse.microprofile.openapi.models.responses.APIResponse
-
Sets the operations links that can be followed from this instance of ApiResponse.
- setMapping(Map<String, String>) - Method in interface org.eclipse.microprofile.openapi.models.media.Discriminator
-
Sets this Discriminator's mapping property to the given map object.
- setMaximum(BigDecimal) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Sets the maximum property of this Schema instance to the value given.
- setMaxItems(Integer) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Sets the maxItems property of this Schema instance to the value given.
- setMaxLength(Integer) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Sets the maxLength property of this Schema instance to the value given.
- setMaxProperties(Integer) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Sets the maxProperties property of this Schema instance to the value given.
- setMinimum(BigDecimal) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Sets the minimum property of this Schema instance to the value given.
- setMinItems(Integer) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Sets the minItems property of this Schema instance to the value given.
- setMinLength(Integer) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Sets the minLength property of this Schema instance to the value given.
- setMinProperties(Integer) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Sets the minProperties property of this Schema instance to the value given.
- setMultipleOf(BigDecimal) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Sets the multipleOf property of this Schema instance to the value given.
- setName(String) - Method in class org.eclipse.microprofile.metrics.Metadata
-
Sets the metric name.
- setName(String) - Method in interface org.eclipse.microprofile.openapi.models.info.Contact
-
Sets the identifying name of this Contact instance.
- setName(String) - Method in interface org.eclipse.microprofile.openapi.models.info.License
-
Sets the license name for this License instance that is used for the API.
- setName(String) - Method in interface org.eclipse.microprofile.openapi.models.media.XML
-
This method sets the name property of XML instance to the given String argument.
- setName(String) - Method in interface org.eclipse.microprofile.openapi.models.parameters.Parameter
-
Sets the name property of a Parameter instance to the given string.
- setName(String) - Method in interface org.eclipse.microprofile.openapi.models.security.SecurityScheme
-
Name is a REQUIRED property - this is the name of the header, query or cookie parameter to be used.
- setName(String) - Method in interface org.eclipse.microprofile.openapi.models.tags.Tag
-
Sets the name property of a Tag instance to the given string.
- setNamespace(String) - Method in interface org.eclipse.microprofile.openapi.models.media.XML
-
This method sets the namespace property of XML instance to the given String argument.
- setNot(Schema) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Sets the not property to a Schema which describes properties not allowed in objects defined by the current schema.
- setNullable(Boolean) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Sets the nullable property of this Schema instance.
- setOneOf(List<Schema>) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Sets the schemas used by the oneOf property of this Schema.
- setOpenapi(String) - Method in interface org.eclipse.microprofile.openapi.models.OpenAPI
-
Sets this OpenAPI instance's openapi property to the given string.
- setOpenIdConnectUrl(String) - Method in interface org.eclipse.microprofile.openapi.models.security.SecurityScheme
-
openIdConnectUrl is a REQUIRED property.
- setOperationId(String) - Method in interface org.eclipse.microprofile.openapi.models.links.Link
-
Sets this Link's operationId property to the given string.
- setOperationId(String) - Method in interface org.eclipse.microprofile.openapi.models.Operation
-
Sets this Operation's operationId property to the given string.
- setOperationRef(String) - Method in interface org.eclipse.microprofile.openapi.models.links.Link
-
Sets this Link's operationRef property to the given string.
- setOPTIONS(Operation) - Method in interface org.eclipse.microprofile.openapi.models.PathItem
-
Sets this PathItem's options property to the given operation.
- setParameters(Map<String, Parameter>) - Method in interface org.eclipse.microprofile.openapi.models.Components
-
Sets this Components' parameters property to the given Map containing keys and reusable parameter objects.
- setParameters(Map<String, Object>) - Method in interface org.eclipse.microprofile.openapi.models.links.Link
-
Sets this Link's parameters property to the given map.
- setParameters(List<Parameter>) - Method in interface org.eclipse.microprofile.openapi.models.Operation
-
Sets this Operation's parameters property to the given parameter list.
- setParameters(List<Parameter>) - Method in interface org.eclipse.microprofile.openapi.models.PathItem
-
Sets this PathItem's parameters property to the given list.
- setPassword(OAuthFlow) - Method in interface org.eclipse.microprofile.openapi.models.security.OAuthFlows
-
OAuth Resource Owner Password flow
- setPATCH(Operation) - Method in interface org.eclipse.microprofile.openapi.models.PathItem
-
Sets this PathItem's patch property to the given operation.
- setPaths(Paths) - Method in interface org.eclipse.microprofile.openapi.models.OpenAPI
-
Sets this OpenAPI instance's paths property to the given paths.
- setPattern(String) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Sets the pattern property of this Schema instance to the string given.
- setPOST(Operation) - Method in interface org.eclipse.microprofile.openapi.models.PathItem
-
Sets this PathItem's post property to the given operation.
- setPrefix(String) - Method in interface org.eclipse.microprofile.openapi.models.media.XML
-
This method sets the prefix property of XML instance to the given String argument.
- setProperties(Map<String, Schema>) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Sets the properties of this Schema instance to the map provided.
- setPropertyName(String) - Method in interface org.eclipse.microprofile.openapi.models.media.Discriminator
-
Sets this Discriminator's propertyName property to the given propertyName.
- setPUT(Operation) - Method in interface org.eclipse.microprofile.openapi.models.PathItem
-
Sets this PathItem's put property to the given operation.
- setReadOnly(Boolean) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Sets the readOnly property of this Schema.
- setRef(String) - Method in interface org.eclipse.microprofile.openapi.models.Reference
-
Sets this Reference's reference property to the given string.
- setRefreshUrl(String) - Method in interface org.eclipse.microprofile.openapi.models.security.OAuthFlow
-
The URL to be used for obtaining refresh tokens.
- setRequestBodies(Map<String, RequestBody>) - Method in interface org.eclipse.microprofile.openapi.models.Components
-
Sets this Components' requestBodies property to the given Map containing keys and reusable request body objects.
- setRequestBody(Object) - Method in interface org.eclipse.microprofile.openapi.models.links.Link
-
Sets this Link's requestBody property to the given object.
- setRequestBody(RequestBody) - Method in interface org.eclipse.microprofile.openapi.models.Operation
-
Sets this Operation's requestBody property to the given object.
- setRequired(Boolean) - Method in interface org.eclipse.microprofile.openapi.models.headers.Header
-
Sets this Header's required property to the given value.
- setRequired(List<String>) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Sets the list of fields required in objects defined by this Schema.
- setRequired(Boolean) - Method in interface org.eclipse.microprofile.openapi.models.parameters.Parameter
-
Sets the required property of a Parameter instance to the given value.
- setRequired(Boolean) - Method in interface org.eclipse.microprofile.openapi.models.parameters.RequestBody
-
Sets whether this instance of RequestBody is required or not.
- setResponseProvider(HealthCheckResponseProvider) - Static method in class org.eclipse.microprofile.health.HealthCheckResponse
-
Used by OSGi environment while service loader pattern is not supported.
- setResponses(Map<String, APIResponse>) - Method in interface org.eclipse.microprofile.openapi.models.Components
-
Sets this Components' responses property to the given Map containing keys and reusable response objects.
- setResponses(APIResponses) - Method in interface org.eclipse.microprofile.openapi.models.Operation
-
Sets this Operation's responses property to the given responses.
- setReusable(boolean) - Method in class org.eclipse.microprofile.metrics.Metadata
-
Set if the metric can be reusable (i.e.
- setSchema(Schema) - Method in interface org.eclipse.microprofile.openapi.models.headers.Header
-
Sets this Header's schema property to the given object.
- setSchema(Schema) - Method in interface org.eclipse.microprofile.openapi.models.media.MediaType
-
Sets the schema field of a MediaType instance to the given schema object.
- setSchema(Schema) - Method in interface org.eclipse.microprofile.openapi.models.parameters.Parameter
-
Sets the schema property of a Parameter instance to the given value.
- setSchemas(Map<String, Schema>) - Method in interface org.eclipse.microprofile.openapi.models.Components
-
Sets this Components' schemas property to the given Map containing keys and reusable schema objects.
- setScheme(String) - Method in interface org.eclipse.microprofile.openapi.models.security.SecurityScheme
-
Schema is a REQUIRED property that is the name of the HTTP Authorization scheme to be used in the Authorization header as defined in RFC7235.
- setScopes(Scopes) - Method in interface org.eclipse.microprofile.openapi.models.security.OAuthFlow
-
The available scopes for the OAuth2 security scheme.
- setSecurity(List<SecurityRequirement>) - Method in interface org.eclipse.microprofile.openapi.models.OpenAPI
-
Sets this OpenAPI instance's security property to the given list.
- setSecurity(List<SecurityRequirement>) - Method in interface org.eclipse.microprofile.openapi.models.Operation
-
Sets this Operation's security property to the given list.
- setSecuritySchemes(Map<String, SecurityScheme>) - Method in interface org.eclipse.microprofile.openapi.models.Components
-
Sets this Components' securitySchemes property to the given Map containing keys and reusable security scheme objects.
- setServer(Server) - Method in interface org.eclipse.microprofile.openapi.models.links.Link
-
Sets this Link's server property to the given object.
- setServers(List<Server>) - Method in interface org.eclipse.microprofile.openapi.models.OpenAPI
-
Sets this OpenAPI instance's servers property to the given servers.
- setServers(List<Server>) - Method in interface org.eclipse.microprofile.openapi.models.Operation
-
Sets this Operation's servers property to the given list.
- setServers(List<Server>) - Method in interface org.eclipse.microprofile.openapi.models.PathItem
-
Sets this PathItem's servers property to the given list.
- setStyle(Header.Style) - Method in interface org.eclipse.microprofile.openapi.models.headers.Header
-
Sets this Header's style property to the given style.
- setStyle(Encoding.Style) - Method in interface org.eclipse.microprofile.openapi.models.media.Encoding
-
Style describes how the encoding value will be serialized depending on the type of the parameter value.
- setStyle(Parameter.Style) - Method in interface org.eclipse.microprofile.openapi.models.parameters.Parameter
-
Sets the style property of a Parameter instance to the given value.
- setSummary(String) - Method in interface org.eclipse.microprofile.openapi.models.examples.Example
-
Sets this Example's summary property to the given string.
- setSummary(String) - Method in interface org.eclipse.microprofile.openapi.models.Operation
-
Sets this Operation's summary property to the given string.
- setSummary(String) - Method in interface org.eclipse.microprofile.openapi.models.PathItem
-
Sets this PathItem's summary property to the given string.
- setTags(HashMap<String, String>) - Method in class org.eclipse.microprofile.metrics.Metadata
-
Sets the tags hashmap.
- setTags(List<Tag>) - Method in interface org.eclipse.microprofile.openapi.models.OpenAPI
-
Sets this OpenAPI instance's tags property to the given Tags.
- setTags(List<String>) - Method in interface org.eclipse.microprofile.openapi.models.Operation
-
Sets this Operation's tags property to the given tags.
- setTermsOfService(String) - Method in interface org.eclipse.microprofile.openapi.models.info.Info
-
Sets this Info instance's URL to the Terms of Service for the API to the given String.
- setTitle(String) - Method in interface org.eclipse.microprofile.openapi.models.info.Info
-
Sets this Info instance's title for the application to the given title.
- setTitle(String) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Sets the title property of this Schema instance to the given string.
- setTokenUrl(String) - Method in interface org.eclipse.microprofile.openapi.models.security.OAuthFlow
-
The token URL to be used for this flow.
- setTRACE(Operation) - Method in interface org.eclipse.microprofile.openapi.models.PathItem
-
Sets this PathItem's trace property to the given operation.
- setType(String) - Method in class org.eclipse.microprofile.metrics.Metadata
-
Sets the metric type using a String representation of
MetricType
.
- setType(MetricType) - Method in class org.eclipse.microprofile.metrics.Metadata
-
Sets the type of the metric
- setType(Schema.SchemaType) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Sets the type used by this Schema to the string given.
- setType(SecurityScheme.Type) - Method in interface org.eclipse.microprofile.openapi.models.security.SecurityScheme
-
Type is a REQUIRED property that specifies the type of SecurityScheme instance.
- setUniqueItems(Boolean) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Sets the uniqueItems property of this Schema instance to the value given.
- setUnit(String) - Method in class org.eclipse.microprofile.metrics.Metadata
-
Sets the unit of the metric.
- setUpMetadata() - Method in class org.eclipse.microprofile.metrics.tck.TagsTest
-
- setUrl(String) - Method in interface org.eclipse.microprofile.openapi.models.ExternalDocumentation
-
Sets this ExternalDocumentation's url property to the given string.
- setUrl(String) - Method in interface org.eclipse.microprofile.openapi.models.info.Contact
-
Sets this Contact instance's URL pointing to the contact information.
- setUrl(String) - Method in interface org.eclipse.microprofile.openapi.models.info.License
-
Sets this URL for this License instance that is used for the API.
- setUrl(String) - Method in interface org.eclipse.microprofile.openapi.models.servers.Server
-
This method sets the url property of Server instance to the given url argument, representing a URL to the target host.
- setValue(Object) - Method in interface org.eclipse.microprofile.openapi.models.examples.Example
-
Sets this Example's value property to the given value.
- setVariables(ServerVariables) - Method in interface org.eclipse.microprofile.openapi.models.servers.Server
-
This method sets the variables property of Server instance to the given variables argument.
- setVersion(String) - Method in interface org.eclipse.microprofile.openapi.models.info.Info
-
Sets the version of the OpenAPI document for this instance of Info to the given version.
- setWrapped(Boolean) - Method in interface org.eclipse.microprofile.openapi.models.media.XML
-
This method sets the wrapped property of XML instance to the given Boolean argument.
- setWriteOnly(Boolean) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Sets the writeOnly property of this Schema.
- setXml(XML) - Method in interface org.eclipse.microprofile.openapi.models.media.Schema
-
Sets the xml property of this Schema instance.
- size() - Method in class org.eclipse.microprofile.metrics.Snapshot
-
Returns the number of values in the snapshot.
- Snapshot - Class in org.eclipse.microprofile.metrics
-
- Snapshot() - Constructor for class org.eclipse.microprofile.metrics.Snapshot
-
- standard() - Method in class org.eclipse.microprofile.jwt.ClaimLiteral
-
- state(boolean) - Method in class org.eclipse.microprofile.health.HealthCheckResponseBuilder
-
- stop() - Method in interface org.eclipse.microprofile.metrics.Timer.Context
-
Updates the timer with the difference between current and start time.
- style(Header.Style) - Method in interface org.eclipse.microprofile.openapi.models.headers.Header
-
Sets this Header's style property to the given style.
- style(Encoding.Style) - Method in interface org.eclipse.microprofile.openapi.models.media.Encoding
-
Style describes how the encoding value will be serialized depending on the type of the parameter value.
- style(Parameter.Style) - Method in interface org.eclipse.microprofile.openapi.models.parameters.Parameter
-
Sets the style property of a Parameter instance to the given value.
- summary(String) - Method in interface org.eclipse.microprofile.openapi.models.examples.Example
-
Sets this Example's summary property to the given string.
- summary(String) - Method in interface org.eclipse.microprofile.openapi.models.Operation
-
Sets this Operation's summary property to the given string.
- summary(String) - Method in interface org.eclipse.microprofile.openapi.models.PathItem
-
Sets this PathItem's summary property to the given string.