A B C D E F G H I K L M N P Q R S T W
All Classes All Packages

A

AbstractResponseContext - Class in io.nitric.faas

ResponseContext

AbstractResponseContext() - Constructor for class io.nitric.faas.AbstractResponseContext

AbstractTriggerContext - Class in io.nitric.faas

Abstract representation of NitricTrigger context

AbstractTriggerContext() - Constructor for class io.nitric.faas.AbstractTriggerContext

addHeader(String, String) - Method in class io.nitric.faas.HttpResponseContext

asHttp() - Method in class io.nitric.faas.AbstractResponseContext

asHttp() - Method in class io.nitric.faas.AbstractTriggerContext

asTopic() - Method in class io.nitric.faas.AbstractResponseContext

asTopic() - Method in class io.nitric.faas.AbstractTriggerContext

B

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.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.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.http.HttpResponse

Return a new HTTP response object from the given status.

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.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.

buildResponse() - Method in class io.nitric.faas.Trigger

Creates a default response object dependent on the context of the request

buildResponse(byte[]) - Method in class io.nitric.faas.Trigger

Creates a default response object dependent on the context of the request

buildResponse(String) - Method in class io.nitric.faas.Trigger

Creates a default response object dependent on the context of the request

buildTrigger(TriggerRequest) - Static method in class io.nitric.faas.Trigger

Translates on on-wire trigger request to a Trigger to be passed to a NitricFunction.

buildTriggerContext(TriggerRequest) - Static method in class io.nitric.faas.AbstractTriggerContext

Create a new TriggerContext from the on-wire TriggerRequest from the Nitric membrane

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.http.HttpRequest

getBody() - Method in class io.nitric.http.HttpResponse

getBodyLength() - Method in class io.nitric.http.HttpResponse

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.Response

Gets the context for this response

getContext() - Method in class io.nitric.faas.Trigger

getData() - Method in class io.nitric.faas.Response

Retrieve the data contained in the response

getData() - Method in class io.nitric.faas.Trigger

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.HttpResponseContext

getHeaders() - Method in class io.nitric.faas.HttpTriggerContext

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.faas.HttpTriggerContext

getMethod() - Method in class io.nitric.http.HttpRequest

getMimeType() - Method in class io.nitric.faas.Trigger

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.faas.HttpTriggerContext

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

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

getQueryParams() - Method in class io.nitric.faas.HttpTriggerContext

getStatus() - Method in class io.nitric.faas.HttpResponseContext

getStatus() - Method in class io.nitric.http.HttpResponse

getTask() - Method in class io.nitric.api.queue.FailedTask

getTopic() - Method in class io.nitric.faas.TopicTriggerContext

Retrieve the topic name for this trigger

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(Trigger) - 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.http.HttpResponse.Builder

Set the response header name and value.

headers - Variable in class io.nitric.faas.HttpResponseContext

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.

HttpResponseContext - Class in io.nitric.faas

Provides contextual response metadata for triggers raised by HTTP Requests

HttpResponseContext() - Constructor for class io.nitric.faas.HttpResponseContext

HttpServer - Class in io.nitric.http

Provides a Nitric HTTP Handler server.

HttpServer() - Constructor for class io.nitric.http.HttpServer

HttpTriggerContext - Class in io.nitric.faas

Provides contextual metadata for a trigger raised by a HTTP request

HttpTriggerContext(String, String, Map<String, String>, Map<String, String>) - Constructor for class io.nitric.faas.HttpTriggerContext

Create a new HttpRequestTriggerContext

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.

isHttp() - Method in class io.nitric.faas.AbstractResponseContext

isHttp() - Method in class io.nitric.faas.AbstractTriggerContext

isSuccess() - Method in class io.nitric.faas.TopicResponseContext

isTopic() - Method in class io.nitric.faas.AbstractResponseContext

isTopic() - Method in class io.nitric.faas.AbstractTriggerContext

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.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

NitricFunction - Interface in io.nitric.faas

Provides a Nitric function handler.

P

path(String) - Method in class io.nitric.http.HttpRequest.Builder

Set the request path.

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(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.

Response - Class in io.nitric.faas

Response model for a NitricFunction

Response(byte[], AbstractResponseContext) - Constructor for class io.nitric.faas.Response

Create a new Nitric Response

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.

setData(byte[]) - Method in class io.nitric.faas.Response

Set the data for this response

setHeaders(Map<String, String>) - Method in class io.nitric.faas.HttpResponseContext

setStatus(int) - Method in class io.nitric.faas.HttpResponseContext

setSuccess(boolean) - Method in class io.nitric.faas.TopicResponseContext

start() - Method in class io.nitric.http.HttpServer

Start the function server.

start(NitricFunction) - Static method in class io.nitric.faas.Faas

Quick Start a Nitric Function with defaults

start(HttpHandler) - Method in class io.nitric.http.HttpServer

Start the FaaS server after configuring the given function to the path "/".

startFunction(NitricFunction) - Method in class io.nitric.faas.Faas

Start the FaaS server after configuring the given function.

status - Variable in class io.nitric.faas.HttpResponseContext

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.

toGrpcTriggerResponse() - Method in class io.nitric.faas.Response

Translates a Response for on-wire transport to the membrane

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.

TopicResponseContext - Class in io.nitric.faas

TopicResponseContext

TopicResponseContext() - Constructor for class io.nitric.faas.TopicResponseContext

TopicTriggerContext - Class in io.nitric.faas

Provides contextual response metadata for triggers raised by Topic events

TopicTriggerContext(String) - Constructor for class io.nitric.faas.TopicTriggerContext

Creates a new TopicTriggerContext

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.HttpResponseContext

toString() - Method in class io.nitric.faas.HttpTriggerContext

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.

Trigger - Class in io.nitric.faas

NitricTrigger

W

write(String, byte[]) - Method in class io.nitric.api.storage.StorageClient

Store an item to a bucket with the given key.

A B C D E F G H I K L M N P Q R S T W
All Classes All Packages