Index (dialogue-target 6.28.0 API)

A B C D E F G H I O P Q R S T U V W
All Classes and Interfaces|All Packages|Serialized Form

A

accepts() - Method in interface com.palantir.dialogue.Deserializer: Returns the content types this deserializer accepts, if any.
attachments() - Method in class com.palantir.dialogue.Request: The mutable request attachments for this request.
attachments() - Method in interface com.palantir.dialogue.Response: The mutable response attachments.

B

Behavior - Section in interface com.palantir.dialogue.Channel
BinaryRequestBody - Interface in com.palantir.dialogue: Streamed binary request data with Content-Type application/octet-stream.
bind(Channel, Endpoint) - Method in interface com.palantir.dialogue.Clients
block(ListenableFuture) - Method in interface com.palantir.dialogue.Clients: Similar to Futures.getUnchecked(Future), except with custom handling for conjure exceptions and cancellation on interruption.
body() - Method in class com.palantir.dialogue.Request: The HTTP request body for this request or empty if this request does not contain a body.
body() - Method in interface com.palantir.dialogue.Response: The HTTP body for this response.
body(RequestBody) - Method in class com.palantir.dialogue.Request.Builder
body(Optional) - Method in class com.palantir.dialogue.Request.Builder
bodySerDe() - Method in interface com.palantir.dialogue.ConjureRuntime: Provides the BodySerDe used to deserialize and serialize request and response bodies respectively.
BodySerDe - Interface in com.palantir.dialogue: Request and response Deserialization and Serialization functionality used by generated code.
build() - Method in class com.palantir.dialogue.ExceptionDeserializerArgs.Builder
build() - Method in class com.palantir.dialogue.PathTemplate.PathTemplateBuilder
build() - Method in class com.palantir.dialogue.Request.Builder
builder() - Static method in class com.palantir.dialogue.ExceptionDeserializerArgs
builder() - Static method in class com.palantir.dialogue.PathTemplate
builder() - Static method in class com.palantir.dialogue.Request

C

call(Channel, Endpoint, Request, Deserializer) - Method in interface com.palantir.dialogue.Clients: Makes a request to the specified Endpoint and deserializes the response using a provided deserializer.
call(EndpointChannel, Request, Deserializer) - Method in interface com.palantir.dialogue.Clients: Makes a request to the specified EndpointChannel and deserializes the response using a provided deserializer.
callBlocking(EndpointChannel, Request, Deserializer) - Method in interface com.palantir.dialogue.Clients: Blocking version of Clients.call(EndpointChannel, Request, Deserializer).
Channel - Interface in com.palantir.dialogue: A channel is an abstraction of a transport layer (e.g., HTTP) that is consumed by server and client stubs.
clients() - Method in interface com.palantir.dialogue.ConjureRuntime: Provides the Clients used to facilitate making requests.
Clients - Interface in com.palantir.dialogue: Provides functionality for generated code to make both blocking and asynchronous calls without duplicating logic.
close() - Method in interface com.palantir.dialogue.BinaryRequestBody: This method may be overridden to return resources.
close() - Method in interface com.palantir.dialogue.RequestBody: Closes this RequestBody and releases all resources.
close() - Method in interface com.palantir.dialogue.Response: Releases all resources associated with this response.
code() - Method in interface com.palantir.dialogue.Response: The HTTP response code for this response.
com.palantir.dialogue - package com.palantir.dialogue
ConjureRuntime - Interface in com.palantir.dialogue: ConjureRuntime is the anchor for all non-generated logic used by generated clients.
contentLength() - Method in interface com.palantir.dialogue.RequestBody: Returns the content length, if known.
contentType() - Method in interface com.palantir.dialogue.RequestBody: A HTTP/Conjure content type (e.g., "application/json") indicating the type of content.
create() - Static method in class com.palantir.dialogue.ResponseAttachments
create(EndpointChannelFactory, ConjureRuntime) - Method in interface com.palantir.dialogue.DialogueServiceFactory: Create a dialogue service.
create(Class) - Static method in class com.palantir.dialogue.RequestAttachmentKey
create(Class) - Static method in class com.palantir.dialogue.ResponseAttachmentKey

D

DELETE - Enum constant in enum class com.palantir.dialogue.HttpMethod
deserialize(Response) - Method in interface com.palantir.dialogue.Deserializer: Deserializes the response body into a useful type.
deserializer(ExceptionDeserializerArgs) - Method in interface com.palantir.dialogue.BodySerDe: Creates a Deserializer for the base type T specified in the ExceptionDeserializerArgs.
deserializer(TypeMarker) - Method in interface com.palantir.dialogue.BodySerDe: Creates a Deserializer for the requested type.
Deserializer<T> - Interface in com.palantir.dialogue: Reads objects from a response.
DialogueException - Exception Class in com.palantir.dialogue: Internal marker type for Dialogue network layer failures where no response is returned.
DialogueException(Throwable) - Constructor for exception class com.palantir.dialogue.DialogueException
DialogueImmutablesStyle - Annotation Interface in com.palantir.dialogue
DialogueService - Annotation Interface in com.palantir.dialogue
DialogueServiceFactory<T> - Interface in com.palantir.dialogue: DialogueServiceFactory creates a DialogueService of type T.

E

emptyBodyDeserializer() - Method in interface com.palantir.dialogue.BodySerDe: Returns a Deserializer that fails if a non-empty reponse body is presented and returns null otherwise.
emptyBodyDeserializer(ExceptionDeserializerArgs) - Method in interface com.palantir.dialogue.BodySerDe: Similar to BodySerDe.emptyBodyDeserializer() but allows for specifying error type to exception mapping.
endpoint(Endpoint) - Method in interface com.palantir.dialogue.EndpointChannelFactory: Construct a new EndpointChannel which will send all requests to the given Endpoint.
Endpoint - Interface in com.palantir.dialogue: Defines a single HTTP-based RPC endpoint in terms of a path and HTTP method, as well as the types of the request and response body.
EndpointChannel - Interface in com.palantir.dialogue: EndpointChannel is an abstraction of a transport layer (e.g., HTTP) that is used client stubs.
EndpointChannelFactory - Interface in com.palantir.dialogue: A 'staged' version of Channel, that allows implementors to precompute necessary objects (e.g.
endpointName() - Method in interface com.palantir.dialogue.Endpoint
equals(Object) - Method in class com.palantir.dialogue.ExceptionDeserializerArgs
equals(Object) - Method in record class com.palantir.dialogue.ExceptionDeserializerArgs.ErrorExceptionPair: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in class com.palantir.dialogue.Request
equals(Object) - Method in class com.palantir.dialogue.TypeMarker
ErrorExceptionPair(TypeMarker, TypeMarker) - Constructor for record class com.palantir.dialogue.ExceptionDeserializerArgs.ErrorExceptionPair: Creates an instance of a ErrorExceptionPair record class.
errorNameToExceptionTypeMarkers() - Method in class com.palantir.dialogue.ExceptionDeserializerArgs
errorParameterFormat() - Method in interface com.palantir.dialogue.BodySerDe: Specifies the expected error parameter format for deserialization.
errorType() - Method in record class com.palantir.dialogue.ExceptionDeserializerArgs.ErrorExceptionPair: Returns the value of the errorType record component.
exception(String, TypeMarker, TypeMarker) - Method in class com.palantir.dialogue.ExceptionDeserializerArgs.Builder: Registers an error name with its corresponding error type and exception type.
ExceptionDeserializerArgs<T> - Class in com.palantir.dialogue: Arguments for deserializing exceptions from error responses.
ExceptionDeserializerArgs.Builder<T> - Class in com.palantir.dialogue
ExceptionDeserializerArgs.ErrorExceptionPair<U,V> - Record Class in com.palantir.dialogue: This record is used in the implementation of Dialogue's error decoder.
exceptionType() - Method in record class com.palantir.dialogue.ExceptionDeserializerArgs.ErrorExceptionPair: Returns the value of the exceptionType record component.
execute(Endpoint, Request) - Method in interface com.palantir.dialogue.Channel
execute(Request) - Method in interface com.palantir.dialogue.EndpointChannel

F

fill(ListMultimap, UrlBuilder) - Method in class com.palantir.dialogue.PathTemplate: Populates this template with the given named parameters.
fill(Map, UrlBuilder) - Method in class com.palantir.dialogue.PathTemplate: Populates this template with the given named parameters.
fixed(String) - Method in class com.palantir.dialogue.PathTemplate.PathTemplateBuilder
fixed(String) - Static method in class com.palantir.dialogue.PathTemplate.Segment
from(Request) - Method in class com.palantir.dialogue.Request.Builder

G

GET - Enum constant in enum class com.palantir.dialogue.HttpMethod
getArgs() - Method in exception class com.palantir.dialogue.DialogueException
getExceptionFromSerializableError(U, TypeMarker, int) - Static method in record class com.palantir.dialogue.ExceptionDeserializerArgs.ErrorExceptionPair
getFirstHeader(String) - Method in interface com.palantir.dialogue.Response: Retrieves the first value from the header map for the given key.
getLogMessage() - Method in exception class com.palantir.dialogue.DialogueException
getOrDefault(RequestAttachmentKey, V) - Method in class com.palantir.dialogue.RequestAttachments
getOrDefault(ResponseAttachmentKey, V) - Method in class com.palantir.dialogue.ResponseAttachments
getType() - Method in class com.palantir.dialogue.TypeMarker

H

hashCode() - Method in record class com.palantir.dialogue.ExceptionDeserializerArgs.ErrorExceptionPair: Returns a hash code value for this object.
hashCode() - Method in class com.palantir.dialogue.ExceptionDeserializerArgs
hashCode() - Method in class com.palantir.dialogue.Request
hashCode() - Method in class com.palantir.dialogue.TypeMarker
HEAD - Enum constant in enum class com.palantir.dialogue.HttpMethod
headerParams() - Method in class com.palantir.dialogue.Request: The HTTP headers for this request, encoded as a map of header-name: header-value.
headerParams(Multimap) - Method in class com.palantir.dialogue.Request.Builder
headers() - Method in interface com.palantir.dialogue.Response: The HTTP headers for this response.
httpMethod() - Method in interface com.palantir.dialogue.Endpoint
HttpMethod - Enum Class in com.palantir.dialogue: The HTTP methods supported by Dialogue.

I

inputStreamDeserializer() - Method in interface com.palantir.dialogue.BodySerDe: Returns a Deserializer that reads an InputStream from the Response body.
inputStreamDeserializer(ExceptionDeserializerArgs) - Method in interface com.palantir.dialogue.BodySerDe: Creates a Deserializer for input streams and with error types specified in the ExceptionDeserializerArgs.

O

of(InputStream) - Static method in interface com.palantir.dialogue.BinaryRequestBody: Create a BinaryRequestBody from an InputStream instance.
of(Type) - Static method in class com.palantir.dialogue.TypeMarker: Create a new TypeMarker instance wrapping the provided Type.
optionalInputStreamDeserializer() - Method in interface com.palantir.dialogue.BodySerDe: Same as BodySerDe.inputStreamDeserializer() with support for 204 responses.
optionalInputStreamDeserializer(ExceptionDeserializerArgs) - Method in interface com.palantir.dialogue.BodySerDe: Same as BodySerDe.inputStreamDeserializer(ExceptionDeserializerArgs) with support for 204 responses.
OPTIONS - Enum constant in enum class com.palantir.dialogue.HttpMethod

P

PATCH - Enum constant in enum class com.palantir.dialogue.HttpMethod
pathParameters() - Method in class com.palantir.dialogue.Request: The HTTP path parameters for this request, encoded as a multimap of param-name: param-value.
pathParams() - Method in class com.palantir.dialogue.Request: Deprecated.
in favor of Request.pathParameters() which returns a multimap
pathParams(Map) - Method in class com.palantir.dialogue.Request.Builder
pathSegment(String) - Method in interface com.palantir.dialogue.UrlBuilder: URL-encodes the given path segment and adds it to the list of segments.
pathSegments(Collection) - Method in interface com.palantir.dialogue.UrlBuilder
PathTemplate - Class in com.palantir.dialogue
PathTemplate.PathTemplateBuilder - Class in com.palantir.dialogue
PathTemplate.Segment - Class in com.palantir.dialogue
PathTemplateBuilder() - Constructor for class com.palantir.dialogue.PathTemplate.PathTemplateBuilder
plainSerDe() - Method in interface com.palantir.dialogue.ConjureRuntime: Provides the PlainSerDe used to parse request path, query, and header parameters.
PlainSerDe - Interface in com.palantir.dialogue: Provides functionality for serializing supported types using the Conjure PLAIN format.
POST - Enum constant in enum class com.palantir.dialogue.HttpMethod
put(RequestAttachmentKey, V) - Method in class com.palantir.dialogue.RequestAttachments
put(ResponseAttachmentKey, V) - Method in class com.palantir.dialogue.ResponseAttachments
PUT - Enum constant in enum class com.palantir.dialogue.HttpMethod
putAllHeaderParams(Multimap) - Method in class com.palantir.dialogue.Request.Builder
putAllHeaderParams(String, Iterable) - Method in class com.palantir.dialogue.Request.Builder
putAllPathParams(Multimap) - Method in class com.palantir.dialogue.Request.Builder
putAllPathParams(String, Iterable) - Method in class com.palantir.dialogue.Request.Builder
putAllPathParams(Map) - Method in class com.palantir.dialogue.Request.Builder
putAllQueryParams(Multimap) - Method in class com.palantir.dialogue.Request.Builder
putAllQueryParams(String, Iterable) - Method in class com.palantir.dialogue.Request.Builder
putHeaderParams(String, String) - Method in class com.palantir.dialogue.Request.Builder
putHeaderParams(String, String...) - Method in class com.palantir.dialogue.Request.Builder
putIfAbsent(RequestAttachmentKey, V) - Method in class com.palantir.dialogue.RequestAttachments
putPathParams(String, String) - Method in class com.palantir.dialogue.Request.Builder
putPathParams(Map.Entry) - Method in class com.palantir.dialogue.Request.Builder
putQueryParams(String, String) - Method in class com.palantir.dialogue.Request.Builder
putQueryParams(String, String...) - Method in class com.palantir.dialogue.Request.Builder
putQueryParams(Map.Entry) - Method in class com.palantir.dialogue.Request.Builder

Q

queryParam(String, String) - Method in interface com.palantir.dialogue.UrlBuilder: URL-encodes the given query parameter name and value and adds them to the list of query parameters.
queryParams() - Method in class com.palantir.dialogue.Request: The URL query parameters headers for this request.
queryParams(Multimap) - Method in class com.palantir.dialogue.Request.Builder

R

remove(RequestAttachmentKey) - Method in class com.palantir.dialogue.RequestAttachments
renderPath(ListMultimap, UrlBuilder) - Method in interface com.palantir.dialogue.Endpoint
renderPath(Map, UrlBuilder) - Method in interface com.palantir.dialogue.Endpoint: Endpoint.renderPath(ListMultimap, UrlBuilder) is preferred, however at least one renderPath must be implemented to avoid infinite recursion.
repeatable() - Method in interface com.palantir.dialogue.BinaryRequestBody: Returns
repeatable() - Method in interface com.palantir.dialogue.RequestBody: Returns
Request - Class in com.palantir.dialogue: Defines the parameters of a single call to an Endpoint.
Request.Builder - Class in com.palantir.dialogue
RequestAttachmentKey<V> - Class in com.palantir.dialogue
RequestAttachments - Class in com.palantir.dialogue
RequestBody - Interface in com.palantir.dialogue
Response - Interface in com.palantir.dialogue
ResponseAttachmentKey<V> - Class in com.palantir.dialogue
ResponseAttachments - Class in com.palantir.dialogue
returnType() - Method in class com.palantir.dialogue.ExceptionDeserializerArgs
returnType(TypeMarker) - Method in class com.palantir.dialogue.ExceptionDeserializerArgs.Builder

S

serialize(BinaryRequestBody) - Method in interface com.palantir.dialogue.BodySerDe: Serializes a BinaryRequestBody to
serialize(T) - Method in interface com.palantir.dialogue.Serializer: Serializes a value to a provided request using the Conjure wire format.
serializeBearerToken(BearerToken) - Method in interface com.palantir.dialogue.PlainSerDe
serializeBoolean(boolean) - Method in interface com.palantir.dialogue.PlainSerDe
serializeDateTime(OffsetDateTime) - Method in interface com.palantir.dialogue.PlainSerDe
serializeDouble(double) - Method in interface com.palantir.dialogue.PlainSerDe
serializeInteger(int) - Method in interface com.palantir.dialogue.PlainSerDe
serializer(TypeMarker) - Method in interface com.palantir.dialogue.BodySerDe: Creates a Serializer for the requested type.
Serializer<T> - Interface in com.palantir.dialogue: Writes objects to a request.
serializeRid(ResourceIdentifier) - Method in interface com.palantir.dialogue.PlainSerDe
serializeSafeLong(SafeLong) - Method in interface com.palantir.dialogue.PlainSerDe
serializeString(String) - Method in interface com.palantir.dialogue.PlainSerDe
serializeUuid(UUID) - Method in interface com.palantir.dialogue.PlainSerDe
serviceName() - Method in interface com.palantir.dialogue.Endpoint

T

tags() - Method in interface com.palantir.dialogue.Endpoint
Threading Model - Section in interface com.palantir.dialogue.Channel
toString() - Method in record class com.palantir.dialogue.ExceptionDeserializerArgs.ErrorExceptionPair: Returns a string representation of this record class.
toString() - Method in class com.palantir.dialogue.ExceptionDeserializerArgs
toString() - Method in class com.palantir.dialogue.Request
toString() - Method in class com.palantir.dialogue.TypeMarker
TypeMarker<T> - Class in com.palantir.dialogue: Captures generic type information.
TypeMarker() - Constructor for class com.palantir.dialogue.TypeMarker

U

UrlBuilder - Interface in com.palantir.dialogue

V

value() - Element in annotation interface com.palantir.dialogue.DialogueService: Factory used to create an instance of the annotated class.
valueOf(String) - Static method in enum class com.palantir.dialogue.HttpMethod: Returns the enum constant of this class with the specified name.
values() - Static method in enum class com.palantir.dialogue.HttpMethod: Returns an array containing the constants of this enum class, in the order they are declared.
variable(String) - Method in class com.palantir.dialogue.PathTemplate.PathTemplateBuilder
variable(String) - Static method in class com.palantir.dialogue.PathTemplate.Segment
version() - Method in interface com.palantir.dialogue.Endpoint

W

write(OutputStream) - Method in interface com.palantir.dialogue.BinaryRequestBody: Invoked to write data to the request stream.
writeTo(OutputStream) - Method in interface com.palantir.dialogue.RequestBody: The content of this request body, possibly empty.

A B C D E F G H I O P Q R S T U V W
All Classes and Interfaces|All Packages|Serialized Form