B C D E F G H I K L M N P Q R S T W
All Classes All Packages
All Classes All Packages
All Classes All Packages
B
- body(byte[]) - Method in class io.nitric.faas.NitricResponse.Builder
-
Set the function response body.
- body(byte[]) - Method in class io.nitric.http.HttpRequest.Builder
-
Set the request body.
- body(byte[]) - Method in class io.nitric.http.HttpResponse.Builder
-
Set the HTTP response body.
- bodyText(String) - Method in class io.nitric.faas.NitricResponse.Builder
-
Set the function response body text (UTF-8) encoded.
- bodyText(String) - Method in class io.nitric.http.HttpResponse.Builder
-
Set the HTTP response body text (UTF-8) encoded.
- bucket(String) - Method in class io.nitric.api.storage.StorageClient.Builder
-
Set the bucket name.
- build() - Method in class io.nitric.api.event.Event.Builder
- build() - Method in class io.nitric.api.event.EventClient.Builder
- build() - Method in class io.nitric.api.event.Topic.Builder
- build() - Method in class io.nitric.api.event.TopicClient.Builder
- build() - Method in class io.nitric.api.kv.KeyValueClient.Builder
- build() - Method in class io.nitric.api.queue.FailedTask.Builder
- build() - Method in class io.nitric.api.queue.QueueClient.Builder
- build() - Method in class io.nitric.api.queue.Task.Builder
- build() - Method in class io.nitric.api.storage.StorageClient.Builder
- build() - Method in class io.nitric.faas.NitricEvent.Builder
- build() - Method in class io.nitric.faas.NitricResponse.Builder
- build() - Method in class io.nitric.http.HttpRequest.Builder
- build() - Method in class io.nitric.http.HttpResponse.Builder
-
Return a new HTTP response object.
- build(int) - Static method in class io.nitric.faas.NitricResponse
-
Return a new function response object from the given status.
- build(int) - Static method in class io.nitric.http.HttpResponse
-
Return a new HTTP response object from the given status.
- build(int, String) - Static method in class io.nitric.faas.NitricResponse
-
Return a new NitricResponse object from the given Nitric status and body text.
- build(int, String) - Static method in class io.nitric.http.HttpResponse
-
Return a new HttpResponse object from the given Nitric status and body text.
- build(Class<T>, String) - Static method in class io.nitric.api.kv.KeyValueClient
-
Return a new KeyValueClient for the given type and collection.
- build(String) - Static method in class io.nitric.api.event.Topic
-
Create a new Topic for the given name.
- build(String) - Static method in class io.nitric.api.queue.QueueClient
-
Return a new QueueClient with the specified queue name.
- build(String) - Static method in class io.nitric.api.storage.StorageClient
-
Return a new StorageClient with the specified bucket name.
- build(String) - Static method in class io.nitric.faas.NitricResponse
-
Return a new function response object from the given body text.
- build(String) - Static method in class io.nitric.http.HttpResponse
-
Return a new HTTP response object from the given body text.
- build(Map<String, Object>) - Static method in class io.nitric.api.event.Event
-
Create a new Event from the given payload.
C
- channel - Static variable in class io.nitric.util.GrpcChannelProvider
- collection(String) - Method in class io.nitric.api.kv.KeyValueClient.Builder
-
Set the collection name.
- complete(String) - Method in class io.nitric.api.queue.QueueClient
-
Complete the task specified by the given lease id.
D
- delete(Object) - Method in class io.nitric.api.kv.KeyValueClient
-
Delete the collection value with the given key.
- delete(String) - Method in class io.nitric.api.storage.StorageClient
-
Delete an item from a bucket with the given key if it exists.
E
- Event - Class in io.nitric.api.event
-
Provides an Event message class.
- Event.Builder - Class in io.nitric.api.event
-
Provides a Event builder.
- EventClient - Class in io.nitric.api.event
-
Provides a Event API client.
- EventClient(EventClient.Builder) - Constructor for class io.nitric.api.event.EventClient
- EventClient.Builder - Class in io.nitric.api.event
-
Provides a EventClient Builder.
F
- Faas - Class in io.nitric.faas
-
Provides a Nitric FaaS (Function as a Service) server.
- Faas() - Constructor for class io.nitric.faas.Faas
- FailedTask - Class in io.nitric.api.queue
-
Provides a Queue API failed task class.
- FailedTask.Builder - Class in io.nitric.api.queue
-
Provides a FailedTask builder class.
G
- get(Object) - Method in class io.nitric.api.kv.KeyValueClient
-
Return the collection value for the given key.
- getBody() - Method in class io.nitric.faas.NitricResponse
- getBody() - Method in class io.nitric.http.HttpRequest
- getBody() - Method in class io.nitric.http.HttpResponse
- getBodyLength() - Method in class io.nitric.faas.NitricResponse
- getBodyLength() - Method in class io.nitric.http.HttpResponse
- getBodyText() - Method in class io.nitric.faas.NitricResponse
- getBodyText() - Method in class io.nitric.http.HttpRequest
- getBodyText() - Method in class io.nitric.http.HttpResponse
- getChannel() - Static method in class io.nitric.util.GrpcChannelProvider
- getContentType() - Method in class io.nitric.http.HttpRequest
-
Return the 'Content-Type' header value, or the MIME type of the request body.
- getContext() - Method in class io.nitric.faas.NitricEvent
- getEnvVar(String, String) - Static method in class io.nitric.util.GrpcChannelProvider
-
Return the environment variable value if defined or the default value otherwise.
- getHeader(String) - Method in class io.nitric.http.HttpRequest
-
Return the named HTTP header or null if not found.
- getHeader(String) - Method in class io.nitric.http.HttpResponse
-
Return the named response header or null if not found.
- getHeaders() - Method in class io.nitric.faas.NitricResponse
- getHeaders() - Method in class io.nitric.http.HttpRequest
- getHeaders() - Method in class io.nitric.http.HttpResponse
- getId() - Method in class io.nitric.api.event.Event
- getId() - Method in class io.nitric.api.queue.Task
- getLeaseId() - Method in class io.nitric.api.queue.Task
-
Return the lease id unique to the pop request, this must be used to complete, extend the lease or release the task.
- getMessage() - Method in class io.nitric.api.queue.FailedTask
- getMethod() - Method in class io.nitric.http.HttpRequest
- getName() - Method in class io.nitric.api.event.Topic
- getParameter(String) - Method in class io.nitric.http.HttpRequest
-
Return the first parameter value defined for the given name, or null if not found.
- getParameters() - Method in class io.nitric.http.HttpRequest
-
Return map of request parameter values, parsed from GET URL query or POST form encoded values Note an empty empty map will be returned if there are no headers.
- getPath() - Method in class io.nitric.http.HttpRequest
- getPayload() - Method in class io.nitric.api.event.Event
- getPayload() - Method in class io.nitric.api.queue.Task
- getPayload() - Method in class io.nitric.faas.NitricEvent
- getPayloadText() - Method in class io.nitric.faas.NitricEvent
- getPayloadType() - Method in class io.nitric.api.event.Event
- getPayloadType() - Method in class io.nitric.api.queue.Task
- getQuery() - Method in class io.nitric.http.HttpRequest
- getStatus() - Method in class io.nitric.faas.NitricResponse
- getStatus() - Method in class io.nitric.http.HttpResponse
- getTask() - Method in class io.nitric.api.queue.FailedTask
- GrpcChannelProvider - Class in io.nitric.util
-
Provides a gRPC Managed Channel object by use by Nitric Service Clients.
- GrpcChannelProvider() - Constructor for class io.nitric.util.GrpcChannelProvider
H
- handle(NitricEvent) - Method in interface io.nitric.faas.NitricFunction
-
Handle the function request.
- handle(HttpRequest) - Method in interface io.nitric.http.HttpHandler
-
Handle the HTTP request.
- header(String, String) - Method in class io.nitric.faas.NitricResponse.Builder
-
Set the response header name and value.
- header(String, String) - Method in class io.nitric.http.HttpResponse.Builder
-
Set the response header name and value.
- headers(Map<String, String>) - Method in class io.nitric.faas.NitricResponse.Builder
-
Set the function response headers.
- headers(Map<String, List<String>>) - Method in class io.nitric.faas.NitricEvent.Builder
-
Set the event headers.
- headers(Map<String, List<String>>) - Method in class io.nitric.http.HttpRequest.Builder
-
Set the request headers.
- headers(Map<String, List<String>>) - Method in class io.nitric.http.HttpResponse.Builder
-
Set the function response headers.
- hostname(String) - Method in class io.nitric.faas.Faas
-
Set the server hostname.
- hostname(String) - Method in class io.nitric.http.HttpServer
-
Set the server hostname.
- HttpHandler - Interface in io.nitric.http
-
Provides a Nitric HTTP function handler.
- HttpRequest - Class in io.nitric.http
-
Provides an immutable HTTP request class.
- HttpRequest.Builder - Class in io.nitric.http
-
Provides a Nitric request builder class.
- HttpResponse - Class in io.nitric.http
-
Provides an immutable HTTP response class.
- HttpResponse.Builder - Class in io.nitric.http
-
Provides a HTTP response builder class.
- HttpServer - Class in io.nitric.http
-
Provides a Nitric HTTP Handler server.
- HttpServer() - Constructor for class io.nitric.http.HttpServer
I
- id(String) - Method in class io.nitric.api.event.Event.Builder
-
Set the event id.
- id(String) - Method in class io.nitric.api.queue.Task.Builder
-
Set the task id.
- io.nitric.api.event - package io.nitric.api.event
-
Provides the Event Service API.
- io.nitric.api.kv - package io.nitric.api.kv
-
Provides the Key Value Service API.
- io.nitric.api.queue - package io.nitric.api.queue
-
Provides the Queue Service API.
- io.nitric.api.storage - package io.nitric.api.storage
-
Provides the Storage Service API.
- io.nitric.faas - package io.nitric.faas
-
Provides the Function as a Service (FaaS) classes.
- io.nitric.http - package io.nitric.http
-
Provides the HTTP Server (FaaS) classes.
- io.nitric.util - package io.nitric.util
-
Provides the Utility and Helper classes.
K
- KeyValueClient<T> - Class in io.nitric.api.kv
-
Provides a Key Value API client.
- KeyValueClient.Builder<K> - Class in io.nitric.api.kv
-
Provides a KeyValueClient Builder.
L
- leaseId(String) - Method in class io.nitric.api.queue.Task.Builder
-
Set the task lease id.
- list() - Method in class io.nitric.api.event.TopicClient
-
List the available event topics.
M
- message(String) - Method in class io.nitric.api.queue.FailedTask.Builder
-
Set the task failure message.
- method(String) - Method in class io.nitric.http.HttpRequest.Builder
-
Set the request method, for example with HTTP this would be ["GET" | "POST" | "PUT" | "DELETE" ].
N
- name(String) - Method in class io.nitric.api.event.Topic.Builder
-
Set the topic name.
- newBuilder() - Static method in class io.nitric.api.event.Event
- newBuilder() - Static method in class io.nitric.api.event.EventClient
-
Create an new EventClient builder.
- newBuilder() - Static method in class io.nitric.api.event.Topic
- newBuilder() - Static method in class io.nitric.api.event.TopicClient
-
Create an new TopicClient builder.
- newBuilder() - Static method in class io.nitric.api.queue.FailedTask
- newBuilder() - Static method in class io.nitric.api.queue.QueueClient
-
Create an new QueueClient builder.
- newBuilder() - Static method in class io.nitric.api.queue.Task
- newBuilder() - Static method in class io.nitric.api.storage.StorageClient
-
Create an new StorageClient builder.
- newBuilder() - Static method in class io.nitric.faas.NitricEvent
- newBuilder() - Static method in class io.nitric.faas.NitricResponse
- newBuilder() - Static method in class io.nitric.http.HttpRequest
- newBuilder() - Static method in class io.nitric.http.HttpResponse
- newBuilder(Class<T>) - Static method in class io.nitric.api.kv.KeyValueClient
-
Return a new KeyValueClient Builder for the given type.
- NITRIC_SERVICE_HOST_DEFAULT - Static variable in class io.nitric.util.GrpcChannelProvider
- NITRIC_SERVICE_HOST_ENV_VAR_NAME - Static variable in class io.nitric.util.GrpcChannelProvider
- NITRIC_SERVICE_PORT_DEFAULT - Static variable in class io.nitric.util.GrpcChannelProvider
- NITRIC_SERVICE_PORT_ENV_VAR_NAME - Static variable in class io.nitric.util.GrpcChannelProvider
- NitricContext(String, String, String, String) - Constructor for class io.nitric.faas.NitricEvent.NitricContext
-
Create a new Nitric Event Context object.
- NitricEvent - Class in io.nitric.faas
-
Provides an immutable FaaS Nitric Event class.
- NitricEvent.Builder - Class in io.nitric.faas
-
Provides a Event builder class.
- NitricEvent.NitricContext - Class in io.nitric.faas
-
Provides the Nitric event context.
- NitricFunction - Interface in io.nitric.faas
-
Provides a Nitric function handler.
- NitricResponse - Class in io.nitric.faas
-
Provides an immutable function response class.
- NitricResponse.Builder - Class in io.nitric.faas
-
Provides a Nitric function response builder class.
P
- path(String) - Method in class io.nitric.http.HttpRequest.Builder
-
Set the request path.
- payload(byte[]) - Method in class io.nitric.faas.NitricEvent.Builder
-
Set the event payload.
- payload(Map<String, Object>) - Method in class io.nitric.api.event.Event.Builder
-
Set the event payload.
- payload(Map<String, Object>) - Method in class io.nitric.api.queue.Task.Builder
-
Set the task payload.
- payloadType - Variable in class io.nitric.faas.NitricEvent.NitricContext
-
The event payload type.
- payloadType(String) - Method in class io.nitric.api.event.Event.Builder
-
Set the event payload type.
- payloadType(String) - Method in class io.nitric.api.queue.Task.Builder
-
Set the task payload type.
- port(int) - Method in class io.nitric.faas.Faas
-
Set the server port.
- port(int) - Method in class io.nitric.http.HttpServer
-
Set the server port.
- ProtoUtils - Class in io.nitric.util
-
Provides protobuf utility functions.
- publish(String, Event) - Method in class io.nitric.api.event.EventClient
-
Publish the Event to the given topic.
- put(Object, T) - Method in class io.nitric.api.kv.KeyValueClient
-
Store the value in the collection with the given key.
Q
- query(String) - Method in class io.nitric.http.HttpRequest.Builder
-
Set the request URL query.
- queue(String) - Method in class io.nitric.api.queue.QueueClient.Builder
-
Set the queue name.
- QueueClient - Class in io.nitric.api.queue
-
Provides a Queue API client.
- QueueClient.Builder - Class in io.nitric.api.queue
-
Provides a QueueClient Builder.
R
- read(String) - Method in class io.nitric.api.storage.StorageClient
-
Retrieve an item from a bucket with the given key if it exists.
- receive(int) - Method in class io.nitric.api.queue.QueueClient
-
Return receive a maximum specified number of tasks from the queue.
- register(String, HttpHandler) - Method in class io.nitric.http.HttpServer
-
Register the function for the given path.
- requestID - Variable in class io.nitric.faas.NitricEvent.NitricContext
-
The event requestId.
S
- send(Task) - Method in class io.nitric.api.queue.QueueClient
-
Send the given task to the client queue.
- sendBatch(List<Task>) - Method in class io.nitric.api.queue.QueueClient
-
Send the given tasks to the client queue in a batch, and return any tasks which failed to send.
- serviceStub(EventGrpc.EventBlockingStub) - Method in class io.nitric.api.event.EventClient.Builder
-
Set the GRPC service stub.
- serviceStub(TopicGrpc.TopicBlockingStub) - Method in class io.nitric.api.event.TopicClient.Builder
-
Set the GRPC service stub.
- serviceStub(KeyValueGrpc.KeyValueBlockingStub) - Method in class io.nitric.api.kv.KeyValueClient.Builder
-
Set the GRPC service stub.
- serviceStub(QueueGrpc.QueueBlockingStub) - Method in class io.nitric.api.queue.QueueClient.Builder
-
Set the GRPC service stub.
- serviceStub(StorageGrpc.StorageBlockingStub) - Method in class io.nitric.api.storage.StorageClient.Builder
-
Set the GRPC service stub.
- source - Variable in class io.nitric.faas.NitricEvent.NitricContext
-
The event source.
- sourceType - Variable in class io.nitric.faas.NitricEvent.NitricContext
-
The event source type.
- start() - Method in class io.nitric.http.HttpServer
-
Start the function server.
- start(NitricFunction) - Method in class io.nitric.faas.Faas
-
Start the FaaS server after configuring the given function.
- start(HttpHandler) - Method in class io.nitric.http.HttpServer
-
Start the FaaS server after configuring the given function to the path "/".
- status(int) - Method in class io.nitric.faas.NitricResponse.Builder
-
Set the function response status.
- status(int) - Method in class io.nitric.http.HttpResponse.Builder
-
Set the HTTP response status, e.g.
- StorageClient - Class in io.nitric.api.storage
-
Provides a Storage API client.
- StorageClient.Builder - Class in io.nitric.api.storage
-
Provides a StorageClient Builder.
T
- task(Task) - Method in class io.nitric.api.queue.FailedTask.Builder
-
Set the task which failed.
- Task - Class in io.nitric.api.queue
-
Provides a Queue API task class.
- Task.Builder - Class in io.nitric.api.queue
-
Provides a Task builder class.
- toMap(Struct) - Static method in class io.nitric.util.ProtoUtils
-
Return a new Map built from the given struct.
- Topic - Class in io.nitric.api.event
-
Provides an Topic class.
- Topic.Builder - Class in io.nitric.api.event
-
Provides a Topic builder.
- TopicClient - Class in io.nitric.api.event
-
Provides an Event API Topic client.
- TopicClient.Builder - Class in io.nitric.api.event
-
Provides a TopicClient Builder.
- toString() - Method in class io.nitric.api.event.Event
- toString() - Method in class io.nitric.api.event.EventClient
- toString() - Method in class io.nitric.api.event.Topic
- toString() - Method in class io.nitric.api.event.TopicClient
- toString() - Method in class io.nitric.api.kv.KeyValueClient
- toString() - Method in class io.nitric.api.queue.FailedTask
- toString() - Method in class io.nitric.api.queue.QueueClient
- toString() - Method in class io.nitric.api.queue.Task
- toString() - Method in class io.nitric.api.storage.StorageClient
- toString() - Method in class io.nitric.faas.NitricEvent.NitricContext
- toString() - Method in class io.nitric.faas.NitricEvent
- toString() - Method in class io.nitric.faas.NitricResponse
- toString() - Method in class io.nitric.http.HttpRequest
- toString() - Method in class io.nitric.http.HttpResponse
- toString() - Method in class io.nitric.util.GrpcChannelProvider
- toStruct(Map<String, Object>) - Static method in class io.nitric.util.ProtoUtils
-
Return a new Struct built from the given Map.
W
- write(String, byte[]) - Method in class io.nitric.api.storage.StorageClient
-
Store an item to a bucket with the given key.
All Classes All Packages