Index (helix-api-contract 0.4.0-SNAPSHOT API)

A B C D E F G H I L M N O P R S T V W
All Classes and Interfaces|All Packages

A

addFailure(BatchFailure) - Method in class com.helixframework.api.contract.batch.BatchItems: Adds a failure to the list of failed items in the batch.
addFailure(Collection<BatchFailure>) - Method in class com.helixframework.api.contract.batch.BatchItems: Adds a collection of failures to the batch.
addLink(String, HalLink) - Method in class com.helixframework.api.contract.envelope.ResponseEnvelope.Builder: Adds a new link to the ResponseEnvelope builder.
addLink(String, HalLink) - Method in class com.helixframework.api.contract.HateoasResponse: Adds a new link to this response.
addLink(String, String) - Method in class com.helixframework.api.contract.HateoasResponse: Adds a new link with the specified name and href.
addLink(String, String, HalLink.HttpMethod) - Method in class com.helixframework.api.contract.HateoasResponse: Adds a new link with the specified name, href and HTTP method.
addLinks(Map<String, HalLink>) - Method in class com.helixframework.api.contract.HateoasResponse: Adds multiple links from the provided map to this response.
addSuccess(Collection<T>) - Method in class com.helixframework.api.contract.batch.BatchItems: Adds a collection of successful items to the batch.
addSuccess(T) - Method in class com.helixframework.api.contract.batch.BatchItems: Adds a successful item to the batch.
attributes(Map<String, Object>) - Method in class com.helixframework.api.contract.GenericMessageResponse.Builder

B

BatchFailure - Class in com.helixframework.api.contract.batch: Represents a failure in a batch operation.
BatchFailure.Builder - Class in com.helixframework.api.contract.batch: Represents a builder for creating instances of BatchFailure.
BatchItems<T> - Class in com.helixframework.api.contract.batch: Represents a batch of items, containing a list of successful items and a list of failed items.
BatchItems(List<T>, List<BatchFailure>) - Constructor for class com.helixframework.api.contract.batch.BatchItems: Initializes a new instance of the BatchItems class with the specified lists of successful items and failed items.
BatchResponse<T> - Class in com.helixframework.api.contract.batch: Represents a batch response for a collection of items.
BatchResponse.Builder<T> - Class in com.helixframework.api.contract.batch: Builder class for creating BatchResponse objects.
BatchStatus - Enum Class in com.helixframework.api.contract.batch: Enumeration representing the status of a batch operation.
BatchSummary - Class in com.helixframework.api.contract.batch: Represents a summary of a batch response.
BatchSummary(long, long, long) - Constructor for class com.helixframework.api.contract.batch.BatchSummary: Represents a summary of a batch response.
BidiCursorPaginatedResponse<T> - Class in com.helixframework.api.contract: API response that returns a collection with bi-directional cursor pagination.
BidiCursorPaginatedResponse() - Constructor for class com.helixframework.api.contract.BidiCursorPaginatedResponse: Creates a new instance of BidiCursorPaginatedResponse.
BidiCursorPaginatedResponse(String, String, Boolean, Boolean, Collection<T>) - Constructor for class com.helixframework.api.contract.BidiCursorPaginatedResponse: Creates a new instance of BidiCursorPaginatedResponse.
BidiCursorPaginatedResponse(String, String, Collection<T>) - Constructor for class com.helixframework.api.contract.BidiCursorPaginatedResponse: Creates a new instance of BidiCursorPaginatedResponse.
build() - Method in class com.helixframework.api.contract.batch.BatchFailure.Builder: Builds a new instance of BatchFailure.
build() - Method in class com.helixframework.api.contract.batch.BatchResponse.Builder: Builds a new instance of BatchResponse using the success and failure items added to the builder.
build() - Method in class com.helixframework.api.contract.envelope.ResponseEnvelope.Builder: Constructs a ResponseEnvelope object based on the builder settings.
build() - Method in class com.helixframework.api.contract.error.ErrorResponse.Builder: Builds a new instance of ErrorResponse.
build() - Method in class com.helixframework.api.contract.error.ErrorResponse.Debug.Builder: Builds a new instance of ErrorResponse.Debug.
build() - Method in class com.helixframework.api.contract.GenericMessageResponse.Builder
build() - Method in class com.helixframework.api.contract.HalLink.Builder: Builds and returns a new HalLink instance with the configured properties.
build() - Method in class com.helixframework.api.contract.HalLinks.Builder: Builds and returns a new immutable HalLinks instance.
builder() - Static method in class com.helixframework.api.contract.batch.BatchFailure: Returns a Builder object for creating an instance of BatchFailure.
builder() - Static method in class com.helixframework.api.contract.envelope.ResponseEnvelope: Creates a new instance of Builder for building ResponseEnvelope objects.
builder() - Static method in class com.helixframework.api.contract.error.ErrorResponse: Create a new ErrorResponse.Builder.
builder() - Static method in class com.helixframework.api.contract.error.ErrorResponse.Debug: Creates a new debug builder.
builder() - Static method in class com.helixframework.api.contract.GenericMessageResponse
builder() - Static method in class com.helixframework.api.contract.HalLinks: Creates a new empty builder for constructing HalLinks.
builder(HalLink) - Static method in class com.helixframework.api.contract.HalLink: Creates a new builder instance initialized with values from an existing HalLink.
builder(HalLinks) - Static method in class com.helixframework.api.contract.HalLinks: Creates a new builder initialized with the links of the given instance.
builder(Class<T>) - Static method in class com.helixframework.api.contract.batch.BatchResponse: Returns a new instance of Builder for creating BatchResponse objects.
builder(Class<T>) - Static method in class com.helixframework.api.contract.envelope.ResponseEnvelope: Creates a new instance of Builder for building ResponseEnvelope objects.
builder(String) - Static method in class com.helixframework.api.contract.HalLink: Creates a new builder instance with the specified href value.
builder(String, HalLink.HttpMethod) - Static method in class com.helixframework.api.contract.HalLink: Creates a new builder instance with the specified href and HTTP method.
builder(Throwable) - Static method in class com.helixframework.api.contract.error.ErrorResponse: Create a new ErrorResponse.Builder.
Builder() - Constructor for class com.helixframework.api.contract.batch.BatchFailure.Builder
Builder() - Constructor for class com.helixframework.api.contract.batch.BatchResponse.Builder
Builder() - Constructor for class com.helixframework.api.contract.envelope.ResponseEnvelope.Builder
Builder() - Constructor for class com.helixframework.api.contract.error.ErrorResponse.Debug.Builder
Builder() - Constructor for class com.helixframework.api.contract.GenericMessageResponse.Builder

C

code(String) - Method in class com.helixframework.api.contract.batch.BatchFailure.Builder: Sets the code for the BatchFailure.
CollectionResponse<T> - Class in com.helixframework.api.contract: API response that returns a collection without pagination.
CollectionResponse() - Constructor for class com.helixframework.api.contract.CollectionResponse: Creates an instance of CollectionResponse.
CollectionResponse(Collection<T>) - Constructor for class com.helixframework.api.contract.CollectionResponse: Creates an instance of CollectionResponse containing items.
com.helixframework.api.contract - package com.helixframework.api.contract
com.helixframework.api.contract.batch - package com.helixframework.api.contract.batch
com.helixframework.api.contract.envelope - package com.helixframework.api.contract.envelope
com.helixframework.api.contract.error - package com.helixframework.api.contract.error
CursorPaginatedResponse<T> - Class in com.helixframework.api.contract: API response that returns a collection with cursor pagination.
CursorPaginatedResponse() - Constructor for class com.helixframework.api.contract.CursorPaginatedResponse: Creates an instance of CursorPaginatedResponse.
CursorPaginatedResponse(String, Collection<T>) - Constructor for class com.helixframework.api.contract.CursorPaginatedResponse: Creates an instance of CursorPaginatedResponse that has a next page.
CursorPaginatedResponse(Collection<T>) - Constructor for class com.helixframework.api.contract.CursorPaginatedResponse: Creates an instance of CursorPaginatedResponse without a next page.

D

DELETE - Enum constant in enum class com.helixframework.api.contract.HalLink.HttpMethod
deprecation(String) - Method in class com.helixframework.api.contract.HalLink.Builder: Sets the deprecation URL that provides information about why the link is deprecated.

E

equals(Object) - Method in class com.helixframework.api.contract.HalLink
equals(Object) - Method in class com.helixframework.api.contract.HalLinks
ErrorResponse - Class in com.helixframework.api.contract.error: Standard error response.
ErrorResponse.Builder - Class in com.helixframework.api.contract.error: Builds instances of ErrorResponse.
ErrorResponse.Debug - Class in com.helixframework.api.contract.error: Debug information.
ErrorResponse.Debug.Builder - Class in com.helixframework.api.contract.error: Builds instances of ErrorResponse.Debug.
ErrorResponse.SubError - Class in com.helixframework.api.contract.error: Sub-level error.
ErrorResponseMessageResolver - Class in com.helixframework.api.contract.error: Resolves placeholders in ErrorResponse messages.

F

FAILED - Enum constant in enum class com.helixframework.api.contract.envelope.ResponseStatus
failure(BatchFailure) - Method in class com.helixframework.api.contract.batch.BatchResponse.Builder: Adds a failure item to the batch response.
failure(Collection<BatchFailure>) - Method in class com.helixframework.api.contract.batch.BatchResponse.Builder: Adds a collection of failure items to the batch response builder.
FAILURE - Enum constant in enum class com.helixframework.api.contract.batch.BatchStatus: Failed batch.

G

GenericMessageResponse - Class in com.helixframework.api.contract: Represents a generic response message used in API interactions, extending the base class HateoasResponse.
GenericMessageResponse.Builder - Class in com.helixframework.api.contract
get(String) - Static method in enum class com.helixframework.api.contract.envelope.ResponseStatus: Gets the ResponseStatus enum value for the given string value.
GET - Enum constant in enum class com.helixframework.api.contract.HalLink.HttpMethod
getAttributes() - Method in class com.helixframework.api.contract.error.ErrorResponse.Debug
getAttributes() - Method in class com.helixframework.api.contract.error.ErrorResponse
getAttributes() - Method in class com.helixframework.api.contract.GenericMessageResponse
getCode() - Method in class com.helixframework.api.contract.batch.BatchFailure: Retrieves the code associated with a BatchFailure.
getCode() - Method in class com.helixframework.api.contract.error.ErrorResponse
getCode() - Method in class com.helixframework.api.contract.error.ErrorResponse.SubError
getCount() - Method in class com.helixframework.api.contract.BidiCursorPaginatedResponse: Gets the number of items in the collection.
getCount() - Method in class com.helixframework.api.contract.CollectionResponse: Gets the number of items in the collection.
getCount() - Method in class com.helixframework.api.contract.CursorPaginatedResponse: Gets the number of items in the collection.
getCount() - Method in class com.helixframework.api.contract.HateoasBidiCursorPaginatedResponse: Gets the number of items in the collection.
getCount() - Method in class com.helixframework.api.contract.HateoasCollectionResponse: Gets the number of items in the collection.
getCount() - Method in class com.helixframework.api.contract.HateoasCursorPaginatedResponse: Gets the number of items in the collection.
getCount() - Method in class com.helixframework.api.contract.HateoasOffsetPaginatedResponse: Gets the number of items in the collection.
getCount() - Method in class com.helixframework.api.contract.OffsetPaginatedResponse: Gets the number of items in the collection.
getCursor() - Method in class com.helixframework.api.contract.CursorPaginatedResponse: Gets the next page cursor.
getCursor() - Method in class com.helixframework.api.contract.HateoasCursorPaginatedResponse: Gets the next page cursor.
getData() - Method in class com.helixframework.api.contract.envelope.ResponseEnvelope: Retrieves the data contained in the response.
getDebug() - Method in class com.helixframework.api.contract.error.ErrorResponse
getDeprecation() - Method in class com.helixframework.api.contract.HalLink: Gets the deprecation URL that provides information about why the link is deprecated.
getFailed() - Method in class com.helixframework.api.contract.batch.BatchSummary: Returns the number of failed items in the batch summary.
getFailures() - Method in class com.helixframework.api.contract.batch.BatchItems: Retrieves a list of failed items from the batch.
getFailureTotal() - Method in class com.helixframework.api.contract.batch.BatchItems: Returns the total number of failed items in the batch.
getHref() - Method in class com.helixframework.api.contract.HalLink: Gets the href (URL) of the link.
getHreflang() - Method in class com.helixframework.api.contract.HalLink: Gets the language tag of the target resource.
getId() - Method in class com.helixframework.api.contract.batch.BatchFailure: Returns the identifier of this BatchFailure.
getId() - Method in class com.helixframework.api.contract.error.ErrorResponse
getItems() - Method in class com.helixframework.api.contract.batch.BatchResponse: Retrieves the batch items from the BatchResponse.
getItems() - Method in class com.helixframework.api.contract.BidiCursorPaginatedResponse: Gets the items.
getItems() - Method in class com.helixframework.api.contract.CollectionResponse: Gets the items.
getItems() - Method in class com.helixframework.api.contract.CursorPaginatedResponse: Gets the items.
getItems() - Method in class com.helixframework.api.contract.HateoasBidiCursorPaginatedResponse: Gets the items.
getItems() - Method in class com.helixframework.api.contract.HateoasCollectionResponse: Gets the items.
getItems() - Method in class com.helixframework.api.contract.HateoasCursorPaginatedResponse: Gets the items.
getItems() - Method in class com.helixframework.api.contract.HateoasOffsetPaginatedResponse: Gets the items.
getItems() - Method in class com.helixframework.api.contract.OffsetPaginatedResponse: Gets the items.
getLimit() - Method in class com.helixframework.api.contract.HateoasOffsetPaginatedResponse: Gets the page limit.
getLimit() - Method in class com.helixframework.api.contract.OffsetPaginatedResponse: Gets the page limit.
getLinks() - Method in class com.helixframework.api.contract.HalLinks: Returns the internal map of rel → HalLink entries.
getLinks() - Method in class com.helixframework.api.contract.HateoasResponse: Gets the links associated with this response.
getMessage() - Method in class com.helixframework.api.contract.batch.BatchFailure: Gets the message associated with the BatchFailure.
getMessage() - Method in class com.helixframework.api.contract.error.ErrorResponse
getMessage() - Method in class com.helixframework.api.contract.error.ErrorResponse.SubError
getMessage() - Method in class com.helixframework.api.contract.GenericMessageResponse
getMeta() - Method in class com.helixframework.api.contract.HalLink: Gets the additional metadata associated with the link.
getMetadata() - Method in class com.helixframework.api.contract.envelope.ResponseEnvelope: Retrieves the metadata of the response.
getName() - Method in class com.helixframework.api.contract.error.ErrorResponse.SubError
getName() - Method in class com.helixframework.api.contract.HalLink: Gets the name of the link.
getNextCursor() - Method in class com.helixframework.api.contract.BidiCursorPaginatedResponse: Gets the next page cursor.
getNextCursor() - Method in class com.helixframework.api.contract.HateoasBidiCursorPaginatedResponse: Gets the next page cursor.
getObject() - Method in class com.helixframework.api.contract.error.ErrorResponse.SubError
getOffset() - Method in class com.helixframework.api.contract.HateoasOffsetPaginatedResponse: Gets the pagination offset.
getOffset() - Method in class com.helixframework.api.contract.OffsetPaginatedResponse: Gets the pagination offset.
getPreviousCursor() - Method in class com.helixframework.api.contract.BidiCursorPaginatedResponse: Gets the previous page cursor.
getPreviousCursor() - Method in class com.helixframework.api.contract.HateoasBidiCursorPaginatedResponse: Gets the previous page cursor.
getProfile() - Method in class com.helixframework.api.contract.HalLink: Gets the profile URL that provides documentation about the link relation type.
getRejectedValue() - Method in class com.helixframework.api.contract.error.ErrorResponse.SubError
getRequestId() - Method in class com.helixframework.api.contract.envelope.ResponseEnvelope: Retrieves the unique identifier of the request.
getStacktrace() - Method in class com.helixframework.api.contract.error.ErrorResponse.Debug
getStatus() - Method in class com.helixframework.api.contract.batch.BatchFailure: Retrieves the status of the BatchFailure.
getStatus() - Method in class com.helixframework.api.contract.batch.BatchResponse: Returns the status of the batch operation.
getStatus() - Method in class com.helixframework.api.contract.envelope.ResponseEnvelope: Retrieves the current response status of the response.
getStatus() - Method in class com.helixframework.api.contract.error.ErrorResponse
getStatus() - Method in class com.helixframework.api.contract.GenericMessageResponse
getSubErrors() - Method in class com.helixframework.api.contract.error.ErrorResponse
getSuccess() - Method in class com.helixframework.api.contract.batch.BatchSummary: Returns the number of successful items in a batch response summary.
getSuccesses() - Method in class com.helixframework.api.contract.batch.BatchItems: Retrieves a list of successful items from the batch.
getSuccessTotal() - Method in class com.helixframework.api.contract.batch.BatchItems: Retrieves the total number of successful items in the batch.
getSummary() - Method in class com.helixframework.api.contract.batch.BatchResponse: Returns a BatchSummary object that contains the total number of items, the number of successful items, and the number of failed items.
getTemplated() - Method in class com.helixframework.api.contract.HalLink: Indicates whether the href is a URI template.
getTimestamp() - Method in class com.helixframework.api.contract.envelope.ResponseEnvelope: Retrieves the timestamp of the response.
getTimestamp() - Method in class com.helixframework.api.contract.error.ErrorResponse
getTitle() - Method in class com.helixframework.api.contract.HalLink: Gets the human-readable title of the link.
getTotal() - Method in class com.helixframework.api.contract.batch.BatchItems: Returns the total count of items in the batch response.
getTotal() - Method in class com.helixframework.api.contract.batch.BatchSummary: Returns the total count of items.
getType() - Method in class com.helixframework.api.contract.HalLink: Gets the media type of the target resource.
getValue() - Method in enum class com.helixframework.api.contract.envelope.ResponseStatus: Gets the string value of the ResponseStatus.

H

HalLink - Class in com.helixframework.api.contract: Represents a hypermedia link in the HAL (Hypertext Application Language) format.
HalLink.Builder - Class in com.helixframework.api.contract
HalLink.HttpMethod - Enum Class in com.helixframework.api.contract: Represents the HTTP methods typically used in RESTful APIs.
HalLinks - Class in com.helixframework.api.contract: Represents a collection of HAL (Hypertext Application Language) links.
HalLinks.Builder - Class in com.helixframework.api.contract
hasAttributes() - Method in class com.helixframework.api.contract.error.ErrorResponse.Debug
hasAttributes() - Method in class com.helixframework.api.contract.error.ErrorResponse
hashCode() - Method in class com.helixframework.api.contract.HalLink
hashCode() - Method in class com.helixframework.api.contract.HalLinks
hasNext() - Method in class com.helixframework.api.contract.BidiCursorPaginatedResponse: Optional flag indicating whether there are more items after the current cursor.
hasNext() - Method in class com.helixframework.api.contract.HateoasBidiCursorPaginatedResponse: Optional flag indicating whether there are more items after the current cursor.
hasPrevious() - Method in class com.helixframework.api.contract.BidiCursorPaginatedResponse: Optional flag indicating whether there are more items before the current cursor.
hasPrevious() - Method in class com.helixframework.api.contract.HateoasBidiCursorPaginatedResponse: Optional flag indicating whether there are more items before the current cursor.
hasSubErrors() - Method in class com.helixframework.api.contract.error.ErrorResponse
HateoasBidiCursorPaginatedResponse<T> - Class in com.helixframework.api.contract: API response that returns a collection with bi-directional cursor pagination and HATEOAS links.
HateoasBidiCursorPaginatedResponse() - Constructor for class com.helixframework.api.contract.HateoasBidiCursorPaginatedResponse: Creates a new instance of HateoasBidiCursorPaginatedResponse.
HateoasBidiCursorPaginatedResponse(String, String, Boolean, Boolean, Collection<T>) - Constructor for class com.helixframework.api.contract.HateoasBidiCursorPaginatedResponse: Creates a new instance of HateoasBidiCursorPaginatedResponse.
HateoasBidiCursorPaginatedResponse(String, String, Collection<T>) - Constructor for class com.helixframework.api.contract.HateoasBidiCursorPaginatedResponse: Creates a new instance of HateoasBidiCursorPaginatedResponse.
HateoasCollectionResponse<T> - Class in com.helixframework.api.contract: API response that returns a collection with HATEOS links.
HateoasCollectionResponse() - Constructor for class com.helixframework.api.contract.HateoasCollectionResponse: Creates an instance of HateoasCollectionResponse.
HateoasCollectionResponse(Collection<T>) - Constructor for class com.helixframework.api.contract.HateoasCollectionResponse: Creates an instance of HateoasCollectionResponse without links.
HateoasCollectionResponse(Collection<T>, Map<String, HalLink>) - Constructor for class com.helixframework.api.contract.HateoasCollectionResponse: Creates an instance of HateoasCollectionResponse with links.
HateoasCursorPaginatedResponse<T> - Class in com.helixframework.api.contract: API response that returns a collection with cursor pagination and HATEOS links.
HateoasCursorPaginatedResponse() - Constructor for class com.helixframework.api.contract.HateoasCursorPaginatedResponse: Creates an instance of HateoasCursorPaginatedResponse.
HateoasCursorPaginatedResponse(String, Collection<T>) - Constructor for class com.helixframework.api.contract.HateoasCursorPaginatedResponse: Creates an instance of HateoasCursorPaginatedResponse without links.
HateoasCursorPaginatedResponse(String, Collection<T>, Map<String, HalLink>) - Constructor for class com.helixframework.api.contract.HateoasCursorPaginatedResponse: Creates an instance of HateoasCursorPaginatedResponse with links.
HateoasOffsetPaginatedResponse<T> - Class in com.helixframework.api.contract: API response that returns a collection with offset pagination and HATEOS links.
HateoasOffsetPaginatedResponse() - Constructor for class com.helixframework.api.contract.HateoasOffsetPaginatedResponse: Creates an instance of HateoasOffsetPaginatedResponse.
HateoasOffsetPaginatedResponse(long, long, Collection<T>) - Constructor for class com.helixframework.api.contract.HateoasOffsetPaginatedResponse: Creates an instance of HateoasOffsetPaginatedResponse without links.
HateoasOffsetPaginatedResponse(long, long, Collection<T>, Map<String, HalLink>) - Constructor for class com.helixframework.api.contract.HateoasOffsetPaginatedResponse: Creates an instance of HateoasOffsetPaginatedResponse with links.
HateoasResponse - Class in com.helixframework.api.contract: Represents a base class for creating HATEOAS (Hypermedia as the Engine of Application State) compliant responses.
HateoasResponse() - Constructor for class com.helixframework.api.contract.HateoasResponse: Constructs a new HATEOAS response with no links.
HateoasResponse(HalLinks) - Constructor for class com.helixframework.api.contract.HateoasResponse: Constructs a new HATEOAS response with the specified HAL links.
HateoasResponse(Map<String, HalLink>) - Constructor for class com.helixframework.api.contract.HateoasResponse: Constructs a new HATEOAS response with the specified map of links.
HEAD - Enum constant in enum class com.helixframework.api.contract.HalLink.HttpMethod
href(String) - Method in class com.helixframework.api.contract.HalLink.Builder: Sets the href (URL) for the link.
hreflang(String) - Method in class com.helixframework.api.contract.HalLink.Builder: Sets the language tag of the target resource.
hreflang(String, String) - Method in class com.helixframework.api.contract.HalLink.Builder: Sets the language tag of the target resource using language and country codes.
hreflang(Locale) - Method in class com.helixframework.api.contract.HalLink.Builder: Sets the language tag of the target resource using a Locale object.

I

id(String) - Method in class com.helixframework.api.contract.batch.BatchFailure.Builder: Sets the ID of the Builder object.
isDebug() - Method in class com.helixframework.api.contract.error.ErrorResponse

L

link(String, HalLink) - Method in class com.helixframework.api.contract.HalLinks.Builder: Adds a link with the given relation.
link(String, String) - Method in class com.helixframework.api.contract.HalLinks.Builder: Convenience overload for directly creating a link by href.
link(String, String, HalLink.HttpMethod) - Method in class com.helixframework.api.contract.HalLinks.Builder: Convenience overload for href + method.
link(String, String, String) - Method in class com.helixframework.api.contract.HalLinks.Builder: Convenience overload for href + method.

M

message(String) - Method in class com.helixframework.api.contract.batch.BatchFailure.Builder: Sets the message for the BatchFailure being built.
message(String) - Method in class com.helixframework.api.contract.GenericMessageResponse.Builder
meta(String, Object) - Method in class com.helixframework.api.contract.HalLink.Builder: Adds a key-value pair to the metadata map.
meta(Map<String, Object>) - Method in class com.helixframework.api.contract.HalLink.Builder: Sets the metadata map for this link.
method(HalLink.HttpMethod) - Method in class com.helixframework.api.contract.HalLink.Builder: Sets the HTTP method for this link in the metadata.
method(String) - Method in class com.helixframework.api.contract.HalLink.Builder: Sets the HTTP method for this link in the metadata.

N

name(String) - Method in class com.helixframework.api.contract.HalLink.Builder: Sets the name of the link.

O

of(String) - Static method in class com.helixframework.api.contract.HalLink: Creates a new HalLink instance with the specified href.
of(String, HalLink.HttpMethod) - Static method in class com.helixframework.api.contract.HalLink: Creates a new HalLink instance with the specified href and HTTP method.
of(Map<String, HalLink>) - Static method in class com.helixframework.api.contract.HalLinks: Creates a new HalLinks instance with the given links.
OffsetPaginatedResponse<T> - Class in com.helixframework.api.contract: API response that returns a collection with offset pagination.
OffsetPaginatedResponse() - Constructor for class com.helixframework.api.contract.OffsetPaginatedResponse: Creates an instance of OffsetPaginatedResponse.
OffsetPaginatedResponse(long, long, Collection<T>) - Constructor for class com.helixframework.api.contract.OffsetPaginatedResponse: Creates an instance of OffsetPaginatedResponse.
OPTIONS - Enum constant in enum class com.helixframework.api.contract.HalLink.HttpMethod

P

PARTIAL_SUCCESS - Enum constant in enum class com.helixframework.api.contract.batch.BatchStatus: Partially successful batch.
PATCH - Enum constant in enum class com.helixframework.api.contract.HalLink.HttpMethod
POST - Enum constant in enum class com.helixframework.api.contract.HalLink.HttpMethod
profile(String) - Method in class com.helixframework.api.contract.HalLink.Builder: Sets the profile URL that provides documentation about the link relation type.
PUT - Enum constant in enum class com.helixframework.api.contract.HalLink.HttpMethod

R

resolve(Throwable, String) - Static method in class com.helixframework.api.contract.error.ErrorResponseMessageResolver: Resolve placeholders in the supplied message using properties of the supplied Throwable.
ResponseEnvelope<T> - Class in com.helixframework.api.contract.envelope: Represents a response envelope.
ResponseEnvelope.Builder<T> - Class in com.helixframework.api.contract.envelope: Represents a builder for constructing ResponseEnvelope objects.
ResponseStatus - Enum Class in com.helixframework.api.contract.envelope: Enum for representing response status as either SUCCESS or FAILED.

S

self(HalLink) - Static method in class com.helixframework.api.contract.HalLinks: Convenience factory for a single self link.
self(String) - Method in class com.helixframework.api.contract.HateoasResponse: Adds a "self" link to this response.
setData(T) - Method in class com.helixframework.api.contract.envelope.ResponseEnvelope.Builder: Sets the data for the ResponseEnvelope builder.
setLinks(Map<String, HalLink>) - Method in class com.helixframework.api.contract.envelope.ResponseEnvelope.Builder: Sets the links for the ResponseEnvelope builder.
setMetadata(String, Object) - Method in class com.helixframework.api.contract.envelope.ResponseEnvelope.Builder: Sets a metadata key-value pair for the ResponseEnvelope builder.
setMetadata(Map<String, Object>) - Method in class com.helixframework.api.contract.envelope.ResponseEnvelope.Builder: Sets the metadata for the ResponseEnvelope builder.
setRequestId(String) - Method in class com.helixframework.api.contract.envelope.ResponseEnvelope.Builder: Sets the request ID for the ResponseEnvelope builder.
setStatus(ResponseStatus) - Method in class com.helixframework.api.contract.envelope.ResponseEnvelope.Builder: Sets the status for the ResponseEnvelope builder.
setTimestamp(ZonedDateTime) - Method in class com.helixframework.api.contract.envelope.ResponseEnvelope.Builder: Sets the timestamp for the ResponseEnvelope builder.
status(String) - Method in class com.helixframework.api.contract.batch.BatchFailure.Builder: Sets the status of the BatchFailure being built.
status(String) - Method in class com.helixframework.api.contract.GenericMessageResponse.Builder
success(Collection<T>) - Method in class com.helixframework.api.contract.batch.BatchResponse.Builder: Adds a collection of success items to the batch response builder.
success(T) - Method in class com.helixframework.api.contract.batch.BatchResponse.Builder: Adds a success item to the batch response.
SUCCESS - Enum constant in enum class com.helixframework.api.contract.batch.BatchStatus: Successful batch.
SUCCESS - Enum constant in enum class com.helixframework.api.contract.envelope.ResponseStatus

T

templated() - Method in class com.helixframework.api.contract.HalLink.Builder: Marks the href as a URI template.
templated(boolean) - Method in class com.helixframework.api.contract.HalLink.Builder: Marks the href as a URI template.
title(String) - Method in class com.helixframework.api.contract.HalLink.Builder: Sets the human-readable title of the link.
toString() - Method in class com.helixframework.api.contract.error.ErrorResponse.Debug
toString() - Method in class com.helixframework.api.contract.error.ErrorResponse.SubError
toString() - Method in class com.helixframework.api.contract.error.ErrorResponse
toString() - Method in class com.helixframework.api.contract.HalLink
toString() - Method in class com.helixframework.api.contract.HalLinks
type(String) - Method in class com.helixframework.api.contract.HalLink.Builder: Sets the media type of the target resource.

V

valueOf(String) - Static method in enum class com.helixframework.api.contract.batch.BatchStatus: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.helixframework.api.contract.envelope.ResponseStatus: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.helixframework.api.contract.HalLink.HttpMethod: Returns the enum constant of this class with the specified name.
values() - Static method in enum class com.helixframework.api.contract.batch.BatchStatus: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.helixframework.api.contract.envelope.ResponseStatus: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.helixframework.api.contract.HalLink.HttpMethod: Returns an array containing the constants of this enum class, in the order they are declared.

W

withAttribute(String, Object) - Method in class com.helixframework.api.contract.error.ErrorResponse.Builder: Adds the supplied attribute to the error.
withAttribute(String, Object) - Method in class com.helixframework.api.contract.error.ErrorResponse.Debug.Builder: Adds the supplied attribute to the debug info.
withAttributes(Map<String, Object>) - Method in class com.helixframework.api.contract.error.ErrorResponse.Builder: Adds the supplied attributes to the error.
withAttributes(Map<String, Object>) - Method in class com.helixframework.api.contract.error.ErrorResponse.Debug.Builder: Adds the supplied attributes to the debug info.
withCode(String) - Method in class com.helixframework.api.contract.error.ErrorResponse.Builder: Sets the application error code.
withDebug(ErrorResponse.Debug) - Method in class com.helixframework.api.contract.error.ErrorResponse.Builder: Adds debug information to the error.
withId(String) - Method in class com.helixframework.api.contract.error.ErrorResponse.Builder: Sets the error identifier.
withMessage(String) - Method in class com.helixframework.api.contract.error.ErrorResponse.Builder: Sets the error message.
withStacktrace(String) - Method in class com.helixframework.api.contract.error.ErrorResponse.Debug.Builder: Sets the stacktrace on the debug info.
withStatus(int) - Method in class com.helixframework.api.contract.error.ErrorResponse.Builder: Sets the HTTP status.
withSubError(String) - Method in class com.helixframework.api.contract.error.ErrorResponse.Builder: Adds a sub-level error message to the error.
withSubError(String, String) - Method in class com.helixframework.api.contract.error.ErrorResponse.Builder: Adds a sub-level error message to the error.
withSubError(String, String, Object, String) - Method in class com.helixframework.api.contract.error.ErrorResponse.Builder: Adds a sub-level error message to the error.
withSubError(String, String, String) - Method in class com.helixframework.api.contract.error.ErrorResponse.Builder: Adds a sub-level error message to the error.
withSubError(String, String, String, Object, String) - Method in class com.helixframework.api.contract.error.ErrorResponse.Builder: Adds a sub-level error message to the error.
withSubErrors(List<ErrorResponse.SubError>) - Method in class com.helixframework.api.contract.error.ErrorResponse.Builder: Adds a collection of sub-level error messages to the error.
withTimestamp(String) - Method in class com.helixframework.api.contract.error.ErrorResponse.Builder: Sets the timestamp of when the error occurred.

A B C D E F G H I L M N O P R S T V W
All Classes and Interfaces|All Packages