Index (Nitric Java SDK 0.12.3 API)

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

A

ABORTED - io.nitric.api.NitricException.Code: Operation was aborted.
AbstractCollection - Class in io.nitric.api.document: Provides an abstract Collection class.
access() - Method in class io.nitric.api.secret.SecretVersion: Return the version's secret value if found, or throws an exception otherwise.
addExtras(String, Object) - Method in class io.nitric.faas.event.EventContext.Builder: Add an event extras attribute value with the given key.
addExtras(String, Object) - Method in class io.nitric.faas.http.HttpContext.Builder: Add a request extras attribute value with the given key.
addHeader(String, String) - Method in class io.nitric.faas.http.HttpContext.Builder: Add a header with the given name and value.
addHeader(String, String) - Method in class io.nitric.faas.http.HttpContext.Response: Add an HTTP header with the given name and value.
addPathParam(String, String) - Method in class io.nitric.faas.http.HttpContext.Builder: Add a URL path parameter with the given name and value.
addQueryParam(String, String) - Method in class io.nitric.faas.http.HttpContext.Builder: Add a query parameter with the given name and value.
ALREADY_EXISTS - io.nitric.api.NitricException.Code: Create an entity failed because one already exists.

B

bucket(String) - Method in class io.nitric.api.storage.Storage: Create a new storage bucket with the given name.
Bucket - Class in io.nitric.api.storage: Provides a Storage API bucket class.
build() - Method in class io.nitric.api.event.Event.Builder
build() - Method in class io.nitric.api.queue.FailedTask.Builder
build() - Method in class io.nitric.api.queue.ReceivedTask.ReceivedTaskBuilder
build() - Method in class io.nitric.api.queue.Task.Builder
build() - Method in class io.nitric.faas.event.EventContext.Builder: Build a new EventContext object.
build() - Method in class io.nitric.faas.http.HttpContext.Builder: Build a new HttpContext object.
build(StatusRuntimeException) - Static method in exception io.nitric.api.NitricException: Create a new Nitric API Exception from the GRPC StatusRuntimeException.
build(Map<String, Object>) - Static method in class io.nitric.api.event.Event: Create a new Event from the given payload.
buildDocQueryRequest(List<Query.Expression>) - Method in class io.nitric.api.document.QueryResults
Builder() - Constructor for class io.nitric.faas.event.EventContext.Builder
Builder() - Constructor for class io.nitric.faas.http.HttpContext.Builder
buildEventMiddlewareChain() - Method in class io.nitric.faas.TriggerProcessor: Build a EventMiddleware chain from the configured eventMiddlewares, or null if none defined.
buildHttpMiddlewareChain() - Method in class io.nitric.faas.TriggerProcessor: Build a HttpMiddleware chain from the configured eventMiddlewares, or null if none defined.

C

CANCELLED - io.nitric.api.NitricException.Code: Operation was cancelled (typically by the caller).
channel - Static variable in class io.nitric.util.GrpcChannelProvider
collection(String) - Method in class io.nitric.api.document.Collection: Create a new sub collection query group for this collection.
collection(String) - Method in class io.nitric.api.document.DocumentRef: Create a new sub collection under this document.
collection(String) - Method in class io.nitric.api.document.Documents: Create a new document collection with the given collection name.
Collection - Class in io.nitric.api.document: Provides a Collection class.
CollectionGroup - Class in io.nitric.api.document: Provides a query sub CollectionGroup class.
complete() - Method in class io.nitric.api.queue.ReceivedTask: Complete the received task using its lease id.
contentType(String) - Method in class io.nitric.faas.http.HttpContext.Builder: Set the HTTP request 'Content-Type' header value and mime-type.
contentType(String) - Method in class io.nitric.faas.http.HttpContext.Response: Set the HTTP request 'Content-Type' header value.
Contracts - Class in io.nitric.util: Provides 'Design by Contract' utility functions class.

D

data(byte[]) - Method in class io.nitric.faas.event.EventContext.Builder: Set the Event request body data.
data(byte[]) - Method in class io.nitric.faas.event.EventContext.Response: Set the data for this response.
data(byte[]) - Method in class io.nitric.faas.http.HttpContext.Builder: Set the HTTP request body data.
data(byte[]) - Method in class io.nitric.faas.http.HttpContext.Response: Set the HTTP response body data.
DATA_LOSS - io.nitric.api.NitricException.Code: Indicates unrecoverable data loss or corruption.
DEADLINE_EXCEEDED - io.nitric.api.NitricException.Code: Operation expired before completion.
delete() - Method in class io.nitric.api.document.DocumentRef: Delete this document reference from the database if it exists.
delete() - Method in class io.nitric.api.storage.File: Delete an item from a bucket with the given key if it exists.
doc(String) - Method in class io.nitric.api.document.Collection: Create a new collection Document Reference object for given document id and Map value type.
doc(String, Class<T>) - Method in class io.nitric.api.document.Collection: Create a new collection Document Reference object for given document id and value type.
DocumentRef<T> - Class in io.nitric.api.document: Provides an Document Reference class.
Documents - Class in io.nitric.api.document: Provides the Document API client.
Documents() - Constructor for class io.nitric.api.document.Documents

E

error(String, Object...) - Method in class io.nitric.faas.logger.JUtilLogger: Log the given error message and arguments.
error(String, Object...) - Method in interface io.nitric.faas.logger.Logger: Log the given error message and arguments.
error(Throwable, String, Object...) - Method in class io.nitric.faas.logger.JUtilLogger: Log the given exception, error message and arguments.
error(Throwable, String, Object...) - Method in interface io.nitric.faas.logger.Logger: Log the given exception, error message and arguments.
event(EventHandler) - Method in class io.nitric.faas.Faas: Add an Event handler function.
event(EventMiddleware) - Method in class io.nitric.faas.Faas: Add an Event processing middleware.
Event - Class in io.nitric.api.event: Provides an Event message class.
Event.Builder - Class in io.nitric.api.event: Provides a Event builder.
EventContext - Class in io.nitric.faas.event: Provides an Event Context class.
EventContext(EventContext) - Constructor for class io.nitric.faas.event.EventContext: Provides a copy construct creating a new Event context object from the given context parameter.
EventContext(EventContext.Request, EventContext.Response) - Constructor for class io.nitric.faas.event.EventContext: Provides a Event context object.
EventContext.Builder - Class in io.nitric.faas.event: Provides an Event Builder class.
EventContext.Request - Class in io.nitric.faas.event: Provides a Event request object.
EventContext.Response - Class in io.nitric.faas.event: Provides a Event response class.
EventHandler - Interface in io.nitric.faas.event: Provides an Event Handler interface.
EventMiddleware - Class in io.nitric.faas.event: Provides a Event Handler middleware class.
EventMiddleware() - Constructor for class io.nitric.faas.event.EventMiddleware
EventMiddleware.FinalMiddleware - Class in io.nitric.faas.event: Provides the final EventMiddleware in the chain.
EventMiddleware.HandlerAdapter - Class in io.nitric.faas.event: Provides a EventHandler to EventMiddleware adapter class.
EventMiddlewareWrapper(EventMiddleware) - Constructor for class io.nitric.faas.TriggerProcessor.EventMiddlewareWrapper: Create new EventMiddleware wrapper object with given target.
Events - Class in io.nitric.api.event: Provides an Event API client.
Events() - Constructor for class io.nitric.api.event.Events

F

Faas - Class in io.nitric.faas: Provides a Nitric FaaS (Function as a Service) server for Event and HTTP handler functions and middleware.
Faas() - Constructor for class io.nitric.faas.Faas
FAILED_PRECONDITION - io.nitric.api.NitricException.Code: Operation was rejected because the system is not in a state required.
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.
fetch() - Method in class io.nitric.api.document.Query: Perform the Query operation and return the fetched results.
file(String) - Method in class io.nitric.api.storage.Bucket: Create a storage file object with the given key.
File - Class in io.nitric.api.storage: Provides a Storage API bucket class.
FINAL_MIDDLEWARE - Static variable in class io.nitric.faas.event.EventMiddleware: The final middleware in the chain.
FINAL_MIDDLEWARE - Static variable in class io.nitric.faas.http.HttpMiddleware: The final middleware in the chain.
FinalMiddleware() - Constructor for class io.nitric.faas.event.EventMiddleware.FinalMiddleware
FinalMiddleware() - Constructor for class io.nitric.faas.http.HttpMiddleware.FinalMiddleware

G

get() - Method in class io.nitric.api.document.DocumentRef: Return the document reference content value.
get() - Method in class io.nitric.api.secret.SecretValue: Return the secret value data.
getArgs() - Method in exception io.nitric.api.NitricException: Return the plugin method arguments.
getAsText() - Method in class io.nitric.api.secret.SecretValue: Return the secret value as UTF-8 encoded text.
getBucket() - Method in class io.nitric.api.storage.File: Return the storage bucket name.
getChannel() - Static method in class io.nitric.util.GrpcChannelProvider
getCode() - Method in exception io.nitric.api.NitricException: Return the GRPC error code.
getCollection() - Method in class io.nitric.api.document.Key: Return the document collection.
getContent() - Method in class io.nitric.api.document.ResultDoc
getData() - Method in class io.nitric.faas.event.EventContext.Request: Get the trigger data.
getData() - Method in class io.nitric.faas.event.EventContext.Response: Return the response data, or null if not defined.
getData() - Method in class io.nitric.faas.http.HttpContext.Request: Return the HTTP request body data.
getData() - Method in class io.nitric.faas.http.HttpContext.Response: Return the response data, or null if not defined.
getDataAsText() - Method in class io.nitric.faas.event.EventContext.Request: Get the trigger data as UTF-8 encode text, or an empty string if not defined.
getDataAsText() - Method in class io.nitric.faas.event.EventContext.Response: Get the data contained in the response as UTF-8 encode text, or null if not define.
getDataAsText() - Method in class io.nitric.faas.http.HttpContext.Request: Return the HTTP request body data (UTF-8 encoded) as text, or an empty string if not defined.
getDataAsText() - Method in class io.nitric.faas.http.HttpContext.Response: Get the data (UTF-8 encoded) contained in the response as text, or null if not define.
getEnvVar(String, String) - Static method in class io.nitric.util.GrpcChannelProvider: Return the environment variable value if defined or the default value otherwise.
getEventServiceStub() - Static method in class io.nitric.api.event.Events: Return the Membrane GRPC Event Service stub.
getExtras() - Method in class io.nitric.faas.event.EventContext.Request: Return the request extras map.
getExtras() - Method in class io.nitric.faas.http.HttpContext.Request: Return the request extras map.
getHandler() - Method in class io.nitric.faas.event.EventMiddleware.HandlerAdapter: Return the wrapped EventHandler object.
getHandler() - Method in class io.nitric.faas.http.HttpMiddleware.HandlerAdapter: Return the wrapped HttpHandler object.
getHeader(String) - Method in class io.nitric.faas.http.HttpContext.Request: Return the first HTTP header value for the given name, or null not found.
getHeaders() - Method in class io.nitric.faas.http.HttpContext.Request: Return an immutable map of HTTP request header values.
getHeaders() - Method in class io.nitric.faas.http.HttpContext.Response: Return the map of HTTP response headers.
getId() - Method in class io.nitric.api.document.Key: Return the unique collection document id.
getId() - Method in class io.nitric.api.event.Event: Return the event id.
getId() - Method in class io.nitric.api.queue.Task: Return the task id.
getKey() - Method in class io.nitric.api.document.DocumentRef: Return the document's key.
getKey() - Method in class io.nitric.api.document.ResultDoc
getKey() - Method in class io.nitric.api.storage.File: Return the storage file key.
getLeaseId() - Method in class io.nitric.api.queue.ReceivedTask: Return the lease id unique to the pop request, this is used to complete, extend the lease or release the task.
getMessage() - Method in exception io.nitric.api.NitricException: Return the error message.
getMessage() - Method in class io.nitric.api.queue.FailedTask
getMethod() - Method in class io.nitric.faas.http.HttpContext.Request: Return the HTTP request method [ GET | POST | PUT | DELETE ].
getMimeType() - Method in class io.nitric.faas.event.EventContext.Request: Return the trigger mime type, or an empty string if not defined.
getMimeType() - Method in class io.nitric.faas.http.HttpContext.Request: Return the HTTP request MIME Type or "Content-Type" header value, or an empty string if not defined.
getName() - Method in class io.nitric.api.document.AbstractCollection: Return the collection name.
getName() - Method in class io.nitric.api.event.Topic: Return the topic name.
getName() - Method in class io.nitric.api.queue.Queue: Return the queue name.
getName() - Method in class io.nitric.api.secret.Secret: Return the secret name.
getName() - Method in class io.nitric.api.storage.Bucket: Return the bucket name.
getNext() - Method in class io.nitric.faas.event.EventMiddleware: Return the next EventMiddleware to process request context.
getNext() - Method in class io.nitric.faas.http.HttpMiddleware: Return the next HttpMiddleware to process request context.
getPagingToken() - Method in class io.nitric.api.document.QueryResults: Return the query paging continuation token if there are more items available.
getParent() - Method in class io.nitric.api.document.AbstractCollection: Return the collection parent key.
getPath() - Method in class io.nitric.faas.http.HttpContext.Request: Return HTTP request path, or an empty string if not defined.
getPathParams() - Method in class io.nitric.faas.http.HttpContext.Request: Return the request URL path params map.
getPayload() - Method in class io.nitric.api.event.Event: Return the event payload.
getPayload() - Method in class io.nitric.api.queue.Task: Return the task payload.
getPayloadType() - Method in class io.nitric.api.event.Event: Return the event payload type.
getPayloadType() - Method in class io.nitric.api.queue.Task: Return the task payload type.
getPlugin() - Method in exception io.nitric.api.NitricException: Return the name of the service plugin invoked, e.g.
getQueryParam(String) - Method in class io.nitric.faas.http.HttpContext.Request: Return the first HTTP query parameter value for the given name, or null not found.
getQueryParams() - Method in class io.nitric.faas.http.HttpContext.Request: Return an immutable map of HTTP request query parameters.
getQueue() - Method in class io.nitric.api.queue.ReceivedTask: Return the name of the received task queue.
getRequest() - Method in class io.nitric.faas.event.EventContext: Return the Event request object.
getRequest() - Method in class io.nitric.faas.http.HttpContext: Return the HTTP request object.
getResponse() - Method in class io.nitric.faas.event.EventContext: Return the Event response object.
getResponse() - Method in class io.nitric.faas.http.HttpContext: Return the HTTP response object.
getRootCause() - Method in exception io.nitric.api.NitricException: Return the root cause of the error.
getSecret() - Method in class io.nitric.api.secret.SecretVersion: Return the version secret.
getSecretVersion() - Method in class io.nitric.api.secret.SecretValue: Return the secret version.
getService() - Method in exception io.nitric.api.NitricException: Return the API service invoked, e.g.
getServiceStub() - Static method in class io.nitric.api.document.Documents: Return the Membrane GRPC Document Service Stub.
getServiceStub() - Static method in class io.nitric.api.queue.Queues: Return the Membrane GRPC Queue Service Stub.
getServiceStub() - Static method in class io.nitric.api.secret.Secrets: Return the Membrane GRPC Secret Service Stub.
getStatus() - Method in class io.nitric.faas.http.HttpContext.Response: Return the HTTP response status code.
getTarget() - Method in class io.nitric.faas.TriggerProcessor.EventMiddlewareWrapper: Return the wrapped target middleware.
getTarget() - Method in class io.nitric.faas.TriggerProcessor.HttpMiddlewareWrapper: Return the wrapped target middleware.
getTarget() - Static method in class io.nitric.util.GrpcChannelProvider: Return the Membrane Server connection target.
getTask() - Method in class io.nitric.api.queue.FailedTask
getTopic() - Method in class io.nitric.faas.event.EventContext.Request: Retrieve the topic name for this trigger
getTopicServiceStub() - Static method in class io.nitric.api.event.Events: Return the Membrane GRPC Topic Service stub.
getVersion() - Method in class io.nitric.api.secret.SecretVersion: Return the secret version.
GrpcChannelProvider - Class in io.nitric.util: Provides Nitric Membrane GRPC Channel objects by use by Nitric clients.

H

handle(EventContext) - Method in interface io.nitric.faas.event.EventHandler: Handle the topic subscription event.
handle(EventContext, EventMiddleware) - Method in class io.nitric.faas.event.EventMiddleware.FinalMiddleware: This method will simply return the context and not invoke the next middleware.
handle(EventContext, EventMiddleware) - Method in class io.nitric.faas.event.EventMiddleware: Handle the Event Request and invoke the next handler in the chain.
handle(EventContext, EventMiddleware) - Method in class io.nitric.faas.event.EventMiddleware.HandlerAdapter: Handle the Event Request and invoke the next handler in the chain.
handle(EventContext, EventMiddleware) - Method in class io.nitric.faas.TriggerProcessor.EventMiddlewareWrapper: Handle the Event request delegating to the target middleware.
handle(HttpContext) - Method in interface io.nitric.faas.http.HttpHandler: Handle the HTTP request.
handle(HttpContext, HttpMiddleware) - Method in class io.nitric.faas.http.HttpMiddleware.FinalMiddleware: This method will simply return the context and not invoke the next middleware.
handle(HttpContext, HttpMiddleware) - Method in class io.nitric.faas.http.HttpMiddleware: Handle the Http Request and invoke the next handler in the chain.
handle(HttpContext, HttpMiddleware) - Method in class io.nitric.faas.http.HttpMiddleware.HandlerAdapter: Handle the Http Request and invoke the next handler in the chain.
handle(HttpContext, HttpMiddleware) - Method in class io.nitric.faas.TriggerProcessor.HttpMiddlewareWrapper: Handle the HTTP request delegating to the target middleware.
handler - Variable in class io.nitric.faas.event.EventMiddleware.HandlerAdapter: The EventHandler to adapt.
handler - Variable in class io.nitric.faas.http.HttpMiddleware.HandlerAdapter: The HttpHandler to adapt.
HandlerAdapter(EventHandler) - Constructor for class io.nitric.faas.event.EventMiddleware.HandlerAdapter: Create a new EventMiddleware adapter from the given EventHandler object.
HandlerAdapter(HttpHandler) - Constructor for class io.nitric.faas.http.HttpMiddleware.HandlerAdapter: Create a new HttpMiddleware adapter from the given HttpHandler object.
headers(Map<String, List<String>>) - Method in class io.nitric.faas.http.HttpContext.Response: Set the HTTP response headers.
http(HttpHandler) - Method in class io.nitric.faas.Faas: Add an HTTP handler function.
http(HttpMiddleware) - Method in class io.nitric.faas.Faas: Add an HTTP request processing middleware.
HttpContext - Class in io.nitric.faas.http: Provides an HTTP Context class.
HttpContext(HttpContext) - Constructor for class io.nitric.faas.http.HttpContext: Provides a copy construct creating a new Event context object from the given context parameter.
HttpContext(HttpContext.Request, HttpContext.Response) - Constructor for class io.nitric.faas.http.HttpContext: Provides a HTTP context object.
HttpContext.Builder - Class in io.nitric.faas.http: Provides a HttpContext builder class.
HttpContext.Request - Class in io.nitric.faas.http: Provides a HTTP request object.
HttpContext.Response - Class in io.nitric.faas.http: Provides a HTTP response class.
HttpHandler - Interface in io.nitric.faas.http: Provides an HTTP Handler interface.
HttpMiddleware - Class in io.nitric.faas.http: Provides a HTTP Middleware handler class.
HttpMiddleware() - Constructor for class io.nitric.faas.http.HttpMiddleware
HttpMiddleware.FinalMiddleware - Class in io.nitric.faas.http: Provides the final HttpMiddleware in the chain.
HttpMiddleware.HandlerAdapter - Class in io.nitric.faas.http: Provides a HttpHandler to HttpMiddleware adapter class.
HttpMiddlewareWrapper(HttpMiddleware) - Constructor for class io.nitric.faas.TriggerProcessor.HttpMiddlewareWrapper: Create new HttpMiddleware wrapper object with given target.

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.ReceivedTask.ReceivedTaskBuilder: Set the task id.
id(String) - Method in class io.nitric.api.queue.Task.Builder: Set the task id.
info(String, Object...) - Method in class io.nitric.faas.logger.JUtilLogger: Log the given info level message and arguments.
info(String, Object...) - Method in interface io.nitric.faas.logger.Logger: Log the given information level message and arguments.
INTERNAL - io.nitric.api.NitricException.Code: Underlying system is broken.
INVALID_ARGUMENT - io.nitric.api.NitricException.Code: Indicates client specified an invalid argument.
InvalidArgumentException - Exception in io.nitric.api: Provides a Nitric service InvalidArgument exception class.
InvalidArgumentException(NitricException.Code, String, StatusRuntimeException, ErrorDetails) - Constructor for exception io.nitric.api.InvalidArgumentException: Create a new service InvalidArgumentException with the given information.
io.nitric.api - package io.nitric.api: Provides the API exception classes.
io.nitric.api.document - package io.nitric.api.document: Provides the Document Service API.
io.nitric.api.event - package io.nitric.api.event: Provides the Event Service API.
io.nitric.api.queue - package io.nitric.api.queue: Provides the Queue Service API.
io.nitric.api.secret - package io.nitric.api.secret: Provides the Secret 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 FaaS server and micro-framework classes.
io.nitric.faas.event - package io.nitric.faas.event: Provides the FaaS Event context and middleware classes.
io.nitric.faas.http - package io.nitric.faas.http: Provides the FaaS HTTP context and middleware classes.
io.nitric.faas.logger - package io.nitric.faas.logger: Provides pluggable Logger support for Faas.
io.nitric.util - package io.nitric.util: Provides the Utility and Helper classes.
isSuccess() - Method in class io.nitric.faas.event.EventContext.Response
iterator() - Method in class io.nitric.api.document.QueryResults: Return a typed query results iterator.

J

JUtilLogger - Class in io.nitric.faas.logger: Provides a Java Util based Logger class.
JUtilLogger(String) - Constructor for class io.nitric.faas.logger.JUtilLogger: Create a new Java Util based Logger with the given name.

K

Key - Class in io.nitric.api.document: Provides a Document Key class.

L

latest() - Method in class io.nitric.api.secret.Secret: Return the latest SecretVersion alias.
LATEST - Static variable in class io.nitric.api.secret.SecretVersion: The "latest" secret version number.
leaseId(String) - Method in class io.nitric.api.queue.ReceivedTask.ReceivedTaskBuilder: Set the received task leaseId.
limit(int) - Method in class io.nitric.api.document.Query: Set the query fetch limit.
loadPageData(DocumentQueryResponse) - Method in class io.nitric.api.document.QueryResults
logger(Logger) - Method in class io.nitric.faas.Faas: Configure the Faas server logger.
Logger - Interface in io.nitric.faas.logger: Provides a pluggable Logger interface for the Faas server.

M

Marshaller - Class in io.nitric.faas: Provides GRPC, Event and HTTP object marshalling functions.
message(String) - Method in class io.nitric.api.queue.FailedTask.Builder: Set the task failure message.
method(String) - Method in class io.nitric.faas.http.HttpContext.Builder: Set the HTTP request method [ GET | POST | DELETE | PUT ].
mimeType(String) - Method in class io.nitric.faas.event.EventContext.Builder: Set the Event request mime-type.

N

newBuilder() - Static method in class io.nitric.api.event.Event: Return a new Event builder object.
newBuilder() - Static method in class io.nitric.api.queue.FailedTask
newBuilder() - Static method in class io.nitric.api.queue.Task: Return a new Task builder.
newBuilder() - Static method in class io.nitric.faas.event.EventContext: Create a new EventContext builder object.
newBuilder() - Static method in class io.nitric.faas.http.HttpContext: Return a new HttpContext builder.
newReceivedTaskBuilder() - Static method in class io.nitric.api.queue.ReceivedTask: Return a new ReceivedTask builder.
next - Variable in class io.nitric.faas.event.EventMiddleware: The next EventMiddleware to execute.
next - Variable in class io.nitric.faas.http.HttpMiddleware: The next HttpMiddleware to execute.
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
NitricException - Exception in io.nitric.api: Provides a Nitric Service API exception class.
NitricException(NitricException.Code, String, StatusRuntimeException, ErrorDetails) - Constructor for exception io.nitric.api.NitricException: Create a new NitricException with the given information.
NitricException.Code - Enum in io.nitric.api: The gRPC status error codes.
NOT_FOUND - io.nitric.api.NitricException.Code: Requested entity was not found.
NotFoundException - Exception in io.nitric.api: Provides a Nitric service resource NotFound exception class.
NotFoundException(NitricException.Code, String, StatusRuntimeException, ErrorDetails) - Constructor for exception io.nitric.api.NotFoundException: Create a new resource NotFoundException with the given information.

O

objectMapper(ObjectMapper) - Method in class io.nitric.api.document.DocumentRef: Set the Document content object marshalling ObjectMapper.
objectMapper(ObjectMapper) - Method in class io.nitric.api.document.Query: Set the ResultDoc content object marshalling ObjectMapper.
OUT_OF_RANGE - io.nitric.api.NitricException.Code: Operation was attempted past the valid range.

P

pagingFrom(Map<String, String>) - Method in class io.nitric.api.document.Query: Set the query paging continuation token.
path(String) - Method in class io.nitric.faas.http.HttpContext.Builder: Set the HTTP 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.ReceivedTask.ReceivedTaskBuilder: Set the task 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.ReceivedTask.ReceivedTaskBuilder: Set the task payload type.
payloadType(String) - Method in class io.nitric.api.queue.Task.Builder: Set the task payload type.
PERMISSION_DENIED - io.nitric.api.NitricException.Code: Caller does not have permission to execute the specified operation.
process(TriggerRequest) - Method in class io.nitric.faas.TriggerProcessor: Process the given gRPC TriggerRequest and return a TriggerResponse object.
processHttpTrigger(TriggerRequest) - Method in class io.nitric.faas.TriggerProcessor: Process the gRPC HTTP TriggerRequest and return a TriggerResponse.
processTopicTrigger(TriggerRequest) - Method in class io.nitric.faas.TriggerProcessor: Process the gRPC Topic TriggerRequest and return a Topic TriggerResponse.
ProtoUtils - Class in io.nitric.util: Provides protobuf utility functions.
publish(Event) - Method in class io.nitric.api.event.Topic: Publish the given event to this topic.
put(byte[]) - Method in class io.nitric.api.secret.Secret: Store a new value for the Secret and return a new SecretVersion object.
putAsText(String) - Method in class io.nitric.api.secret.Secret: Store a new text value for the Secret and return a new SecretVersion object.

Q

query() - Method in class io.nitric.api.document.AbstractCollection: Create a new query object with the Map value type.
query(Class<T>) - Method in class io.nitric.api.document.AbstractCollection: Create a new query object with the given value type.
query(String) - Method in class io.nitric.api.document.DocumentRef: Create a new sub collection query for this Document Ref.
query(String, Class<K>) - Method in class io.nitric.api.document.DocumentRef: Create a new sub collection query for this Document Ref, and with the given value type.
Query<T> - Class in io.nitric.api.document: Provides a Document Query class.
QueryResults<T> - Class in io.nitric.api.document: Provides an iterable Query Result class.
queue(String) - Method in class io.nitric.api.queue.Queues: Create a new queue with the given name.
queue(String) - Method in class io.nitric.api.queue.ReceivedTask.ReceivedTaskBuilder: Set the received task queue name.
Queue - Class in io.nitric.api.queue: Provides a Queue API queue class.
Queues - Class in io.nitric.api.queue: Provides the Queue API client.
Queues() - Constructor for class io.nitric.api.queue.Queues

R

read() - Method in class io.nitric.api.storage.File: Retrieve an item from a bucket with the given key if it exists.
receive(int) - Method in class io.nitric.api.queue.Queue: Return receive a maximum specified number of tasks from the queue.
ReceivedTask - Class in io.nitric.api.queue: Provides a Queue API Received Task class.
ReceivedTask.ReceivedTaskBuilder - Class in io.nitric.api.queue: Provides a ReceivedTask builder class.
request(HttpContext.Request) - Method in class io.nitric.faas.http.HttpContext.Builder: Copy the request values.
Request(String, String, byte[], Map<String, Object>) - Constructor for class io.nitric.faas.event.EventContext.Request: Create a new Request object.
Request(String, String, Map<String, List<String>>, Map<String, List<String>>, String, byte[], Map<String, String>, Map<String, Object>) - Constructor for class io.nitric.faas.http.HttpContext.Request: Create a new Request object.
requireNonBlank(String, String) - Static method in class io.nitric.util.Contracts: Ensure the specified parameter value is not blank.
requireNonNull(Object, String) - Static method in class io.nitric.util.Contracts: Ensure the specified parameter value is not null.
RESOURCE_EXHAUSTED - io.nitric.api.NitricException.Code: System resource has been exhausted.
Response() - Constructor for class io.nitric.faas.event.EventContext.Response: Create a new Event Response object.
Response() - Constructor for class io.nitric.faas.http.HttpContext.Response: Create a new Response object.
Response(EventContext.Response) - Constructor for class io.nitric.faas.event.EventContext.Response: Create a new Event Response object from the given response.
Response(HttpContext.Response) - Constructor for class io.nitric.faas.http.HttpContext.Response: Create a new Response object copied from the given response.
ResultDoc<T> - Class in io.nitric.api.document: Provides a Result Document class for QueryResults and Streams.
ResultDoc(Key, T) - Constructor for class io.nitric.api.document.ResultDoc: Create a new ResultDoc with the given key and content.
ResultDoc(T) - Constructor for class io.nitric.api.document.ResultDoc: Create a new ResultDoc with the given content.

S

secret(String) - Method in class io.nitric.api.secret.Secrets: Create a new secret with the given name.
Secret - Class in io.nitric.api.secret: Provides a named Secret class.
Secrets - Class in io.nitric.api.secret: Provides a Secret API client.
Secrets() - Constructor for class io.nitric.api.secret.Secrets
SecretValue - Class in io.nitric.api.secret: Provides a Secret Value class.
SecretVersion - Class in io.nitric.api.secret: Provides a Secret Version class.
send(Task) - Method in class io.nitric.api.queue.Queue: Send the given task to the client queue.
sendBatch(List<Task>) - Method in class io.nitric.api.queue.Queue: Send the given tasks to the client queue in a batch, and return any tasks which failed to send.
set(T) - Method in class io.nitric.api.document.DocumentRef: Set the document content for this document reference in the database.
setEventMiddlewares(List<EventMiddleware>) - Method in class io.nitric.faas.TriggerProcessor: Set the Topic TriggerRequest EventMiddlewares.
setEventServiceStub(EventServiceGrpc.EventServiceBlockingStub) - Static method in class io.nitric.api.event.Events: Set the Membrane GRPC Event Service stub.
setHttpMiddlewares(List<HttpMiddleware>) - Method in class io.nitric.faas.TriggerProcessor: Set the HTTP TriggerRequest HttpMiddlewares.
setLogger(Logger) - Method in class io.nitric.faas.TriggerProcessor: Configure the TriggerProcessor logger.
setNext(EventMiddleware) - Method in class io.nitric.faas.event.EventMiddleware: Set the next EventMiddleware to process request context.
setNext(HttpMiddleware) - Method in class io.nitric.faas.http.HttpMiddleware: Set the next HttpMiddleware to process request context.
setServiceStub(DocumentServiceGrpc.DocumentServiceBlockingStub) - Static method in class io.nitric.api.document.Documents: Set the Membrane GRPC Document Service Stub.
setServiceStub(QueueServiceGrpc.QueueServiceBlockingStub) - Static method in class io.nitric.api.queue.Queues: Set the Membrane GRPC Queue Service stub.
setServiceStub(SecretServiceGrpc.SecretServiceBlockingStub) - Static method in class io.nitric.api.secret.Secrets: Set the Membrane GRPC Secret Service stub.
setTopicServiceStub(TopicServiceGrpc.TopicServiceBlockingStub) - Static method in class io.nitric.api.event.Events: Set the Membrane GRPC Topic Service stub.
start() - Method in class io.nitric.faas.Faas: Start the FaaS server after configuring the given function.
status(int) - Method in class io.nitric.faas.http.HttpContext.Response: Set the HTTP response status code.
Storage - Class in io.nitric.api.storage: Provides a Storage API client.
Storage() - Constructor for class io.nitric.api.storage.Storage
stream() - Method in class io.nitric.api.document.Query: Perform the Query operation and return a Stream object.
stub(FaasServiceGrpc.FaasServiceStub) - Method in class io.nitric.faas.Faas: Set the gRPC stub to use for this FaaS instance.
success(boolean) - Method in class io.nitric.faas.event.EventContext.Response: Set the status for processing this topic trigger, false will cause the event to be re-queued.

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.
text(String) - Method in class io.nitric.faas.event.EventContext.Builder: Set the Event request body data with the given text.
text(String) - Method in class io.nitric.faas.event.EventContext.Response: Set the Event response body data with the text value.
text(String) - Method in class io.nitric.faas.http.HttpContext.Builder: Set the HTTP request body data with the given text.
text(String) - Method in class io.nitric.faas.http.HttpContext.Response: Set the HTTP response body data with the text value.
text(String, Object...) - Method in class io.nitric.faas.event.EventContext.Response: Set the Event response body data with the given text format value and args.
text(String, Object...) - Method in class io.nitric.faas.http.HttpContext.Response: Set the HTTP response body data with the given text format value and args.
toEventContext(TriggerRequest) - Static method in class io.nitric.faas.Marshaller: Create a new EventContext from the given GRPC Topic TriggerRequest.
toHttpContext(TriggerRequest) - Static method in class io.nitric.faas.Marshaller: Create a new HttpContext from the given GRPC HTTP TriggerRequest.
toHttpTriggerResponse(HttpContext.Response) - Static method in class io.nitric.faas.Marshaller: Create a new GRPC HTTP TriggerResponse from the given HttpContext.Response object.
toMap(Struct) - Static method in class io.nitric.util.ProtoUtils: Return a new Map built from the given struct.
topic(String) - Method in class io.nitric.api.event.Events: Return a new event topic with the given name.
topic(String) - Method in class io.nitric.faas.event.EventContext.Builder: Set the Event request topic.
Topic - Class in io.nitric.api.event: Provides an Topic class.
topics() - Method in class io.nitric.api.event.Events: List the available event topics.
toString() - Method in class io.nitric.api.document.AbstractCollection: Return this string representation of this object.
toString() - Method in class io.nitric.api.document.DocumentRef: Return the string representation of this object.
toString() - Method in class io.nitric.api.document.Key: Return the string representation of this object.
toString() - Method in class io.nitric.api.document.Query: Return the string representation of this object.
toString() - Method in class io.nitric.api.document.ResultDoc
toString() - Method in class io.nitric.api.event.Event: Return the string representation of this object.
toString() - Method in class io.nitric.api.event.Topic: Return the string representation of this object.
toString() - Method in exception io.nitric.api.NitricException: Return the string representation of this object.
toString() - Method in class io.nitric.api.queue.FailedTask: Return the string representation of this object.
toString() - Method in class io.nitric.api.queue.Queue: Return the string representation of this object.
toString() - Method in class io.nitric.api.queue.ReceivedTask: Return the string representation of this object.
toString() - Method in class io.nitric.api.queue.Task: Return the string representation of this object.
toString() - Method in class io.nitric.api.secret.Secret: Return the string representation of this object.
toString() - Method in class io.nitric.api.secret.SecretValue: Return the string representation of this object.
toString() - Method in class io.nitric.api.secret.SecretVersion: Return the string representation of this object.
toString() - Method in class io.nitric.api.storage.Bucket: Return the string representation of this object.
toString() - Method in class io.nitric.api.storage.File: Return the string representation of this object.
toString() - Method in class io.nitric.faas.event.EventContext.Request: Return the string representation of this object.
toString() - Method in class io.nitric.faas.event.EventContext.Response: Return the string representation of this object.
toString() - Method in class io.nitric.faas.event.EventContext: Return the string representation of this object.
toString() - Method in class io.nitric.faas.http.HttpContext.Request: Return the string representation of this object.
toString() - Method in class io.nitric.faas.http.HttpContext.Response: Return the string representation of this object.
toString() - Method in class io.nitric.faas.http.HttpContext: Return the string representation of this object.
toStruct(Map<String, Object>) - Static method in class io.nitric.util.ProtoUtils: Return a new Struct built from the given Map.
toTopicTriggerResponse(EventContext.Response) - Static method in class io.nitric.faas.Marshaller: Create a new GRPC Topic TriggerResponse from the given EventContext response.
triggerProcessor(TriggerProcessor) - Method in class io.nitric.faas.Faas: Configure the gRPC TriggerRequest processor.
TriggerProcessor - Class in io.nitric.faas: Provides a Nitric TriggerRequest processor class.
TriggerProcessor() - Constructor for class io.nitric.faas.TriggerProcessor
TriggerProcessor.EventMiddlewareWrapper - Class in io.nitric.faas: Provides an EventMiddleware wrapper to accurately report processing errors.
TriggerProcessor.HttpMiddlewareWrapper - Class in io.nitric.faas: Provides an HttpMiddleware wrapper to accurately report processing errors.

U

UNAUTHENTICATED - io.nitric.api.NitricException.Code: Request does not have valid authentication credentials.
UNAVAILABLE - io.nitric.api.NitricException.Code: Service unavailable, generally transient maybe retried.
UnavailableException - Exception in io.nitric.api: Provides a Nitric API service Unavailable exception class.
UnavailableException(NitricException.Code, String, StatusRuntimeException, ErrorDetails) - Constructor for exception io.nitric.api.UnavailableException: Create a new Nitric service UnavailableException with the given information.
UNIMPLEMENTED - io.nitric.api.NitricException.Code: Operation is not implemented or supported.
UNKNOWN - io.nitric.api.NitricException.Code: Errors raised by APIs that do not return enough error information may be converted to this error.

V

valueOf(String) - Static method in enum io.nitric.api.NitricException.Code: Returns the enum constant of this type with the specified name.
values() - Static method in enum io.nitric.api.NitricException.Code: Returns an array containing the constants of this enum type, in the order they are declared.
version(String) - Method in class io.nitric.api.secret.Secret: Return a new SecretVersion with the given version number.

W

where(String, String, Boolean) - Method in class io.nitric.api.document.Query: Add a where expression to the query.
where(String, String, Double) - Method in class io.nitric.api.document.Query: Add a where expression to the query.
where(String, String, Integer) - Method in class io.nitric.api.document.Query: Add a where expression to the query.
where(String, String, String) - Method in class io.nitric.api.document.Query: Add a where expression to the query.
write(byte[]) - Method in class io.nitric.api.storage.File: Store an item to a bucket with the given key.

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