Index (nitric-java-sdk 0.9.0 API)

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

A

AbstractCollection - Class in io.nitric.api.document: Provides an abstract Collection class.
AbstractResponseContext - Class in io.nitric.faas: Provides an abstract Nitric response context class.
AbstractResponseContext() - Constructor for class io.nitric.faas.AbstractResponseContext
AbstractTriggerContext - Class in io.nitric.faas: Provides an abstract Nitric FaaS trigger context class.
AbstractTriggerContext() - Constructor for class io.nitric.faas.AbstractTriggerContext
access() - Method in class io.nitric.api.secret.SecretVersion: Return the version's secret value if found, or throws an exception otherwise.
addHeader(String, String) - Method in class io.nitric.faas.HttpResponseContext
addHeader(String, String) - Method in class io.nitric.mock.MockTrigger.HttpTriggerBuilder: Add a Trigger HTTP header value.
addQueryParam(String, String) - Method in class io.nitric.mock.MockTrigger.HttpTriggerBuilder: Add a Trigger HTTP query parameter.
asHttp() - Method in class io.nitric.faas.AbstractResponseContext
asHttp() - Method in class io.nitric.faas.AbstractTriggerContext: Return the HTTP trigger context if valid tpe or throw UnsupportedOperationException otherwise.
asTopic() - Method in class io.nitric.faas.AbstractResponseContext
asTopic() - Method in class io.nitric.faas.AbstractTriggerContext: Return the Topic trigger context if valid tpe or throw UnsupportedOperationException otherwise.

B

bucket(String) - Static 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.Task.Builder
build() - Method in class io.nitric.mock.MockTrigger.HttpTriggerBuilder: Build a new Mock HTTP Trigger object.
build() - Method in class io.nitric.mock.MockTrigger.TopicTriggerBuilder: Build a new Mock Trigger object.
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
buildResponse() - Method in interface io.nitric.faas.Trigger: Creates a default response object dependent on the context of the request.
buildResponse(byte[]) - Method in interface io.nitric.faas.Trigger: Creates a default response object dependent on the context of the request.
buildResponse(String) - Method in interface 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.FunctionTrigger: 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.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) - Static 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.
Contracts - Class in io.nitric.util: Provides 'Design by Contract' utility functions class.

D

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.

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.
Events - Class in io.nitric.api.event: Provides an Event API client.

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.
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.
FunctionTrigger - Class in io.nitric.faas: Provides a Nitric FaaS Trigger class.

G

get() - Method in class io.nitric.api.document.DocumentRef: Return the collection document reference value.
get() - Method in class io.nitric.api.secret.SecretValue: Return the secret value data.
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
getCollection() - Method in class io.nitric.api.document.Key: Return the document collection.
getContent() - Method in class io.nitric.api.document.ResultDoc
getContext() - Method in class io.nitric.faas.FunctionTrigger: Return the context which raised the trigger.
getContext() - Method in class io.nitric.faas.Response: Gets the context for this response.
getContext() - Method in interface io.nitric.faas.Trigger: Return the context which raised the trigger.
getContext() - Method in class io.nitric.mock.MockTrigger
getData() - Method in class io.nitric.faas.FunctionTrigger: Get the trigger data.
getData() - Method in class io.nitric.faas.Response: Get the data contained in the response.
getData() - Method in interface io.nitric.faas.Trigger: Return the trigger data.
getData() - Method in class io.nitric.mock.MockTrigger
getDataAsText() - Method in class io.nitric.faas.Response: Get the data contained in the response as UTF-8 encode text, or null if not define.
getDataAsText() - Method in interface io.nitric.faas.Trigger: Get the trigger data as UTF-8 encode text, or empty string if not defined.
getEnvVar(String, String) - Static method in class io.nitric.util.GrpcChannelProvider: Return the environment variable value if defined or the default value otherwise.
getHeaders() - Method in class io.nitric.faas.HttpResponseContext
getHeaders() - Method in class io.nitric.faas.HttpTriggerContext
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 class io.nitric.api.queue.FailedTask
getMethod() - Method in class io.nitric.faas.HttpTriggerContext
getMimeType() - Method in class io.nitric.faas.FunctionTrigger
getMimeType() - Method in interface io.nitric.faas.Trigger: Return the mime type of the trigger.
getMimeType() - Method in class io.nitric.mock.MockTrigger
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.
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.HttpTriggerContext
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.
getQueryParams() - Method in class io.nitric.faas.HttpTriggerContext
getQueue() - Method in class io.nitric.api.queue.ReceivedTask: Return the name of the received task queue.
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.
getStatus() - Method in class io.nitric.faas.HttpResponseContext
getTask() - Method in class io.nitric.api.queue.FailedTask
getTopic() - Method in class io.nitric.faas.TopicTriggerContext: Retrieve the topic name for this trigger
getVersion() - Method in class io.nitric.api.secret.SecretVersion: Return the secret version.
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.
HttpResponseContext - Class in io.nitric.faas: Provides contextual response metadata for triggers raised by HTTP Requests.
HttpResponseContext() - Constructor for class io.nitric.faas.HttpResponseContext
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.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 Function as a Service (FaaS) classes.
io.nitric.mock - package io.nitric.mock: Provides the Mock builders for Nitric Function unit testing.
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
iterator() - Method in class io.nitric.api.document.QueryResults: Return a typed query results iterator.

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

M

mapGrpcError(StatusRuntimeException) - Static method in class io.nitric.util.ProtoUtils: Map the gRPC error to representative Java exception.
message(String) - Method in class io.nitric.api.queue.FailedTask.Builder: Set the task failure message.
MockTrigger - Class in io.nitric.mock: Provides a Mock Trigger class for function unit testing.
MockTrigger.HttpTriggerBuilder - Class in io.nitric.mock: Provides a Mock HTTP Trigger builder class.
MockTrigger.TopicTriggerBuilder - Class in io.nitric.mock: Provides a Mock Topic Trigger builder class.

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.
newHttpTriggerBuilder() - Static method in class io.nitric.mock.MockTrigger: Return a new Mock HTTP Trigger builder.
newTopicTriggerBuilder() - Static method in class io.nitric.mock.MockTrigger: Return a new Mock Topic Trigger builder.
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

pagingFrom(Map<String, String>) - Method in class io.nitric.api.document.Query: Set the query paging continuation token.
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.
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) - Static method in class io.nitric.api.queue.Queues: Create a new queue with the given 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.

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.
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.
Response - Class in io.nitric.faas: Provides a Nitric function response class.
Response(byte[], AbstractResponseContext) - Constructor for class io.nitric.faas.Response: Create a new Nitric FaaS response.
ResultDoc<T> - Class in io.nitric.api.document: Provides a Result Document class for QueryResults and Streams.

S

secret(String) - Static 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.
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.
setData(byte[]) - Method in class io.nitric.faas.Response: Set the data for this response.
setData(byte[]) - Method in class io.nitric.mock.MockTrigger.HttpTriggerBuilder: Set the Trigger request data.
setData(byte[]) - Method in class io.nitric.mock.MockTrigger.TopicTriggerBuilder: Set the Trigger request data.
setDataAsText(String) - Method in class io.nitric.faas.Response: Set the data for this response as UTF-8 encoded text.
setDataAsText(String) - Method in class io.nitric.mock.MockTrigger.HttpTriggerBuilder: Set the Trigger request data as text.
setDataAsText(String) - Method in class io.nitric.mock.MockTrigger.TopicTriggerBuilder: Set the Trigger request data as text.
setHeaders(Map<String, String>) - Method in class io.nitric.faas.HttpResponseContext
setHeaders(Map<String, String>) - Method in class io.nitric.mock.MockTrigger.HttpTriggerBuilder: Set the Trigger HTTP headers.
setMethod(String) - Method in class io.nitric.mock.MockTrigger.HttpTriggerBuilder: Set the Trigger HTTP Method.
setMimeType(String) - Method in class io.nitric.mock.MockTrigger.HttpTriggerBuilder: Set the Trigger request MIME type.
setMimeType(String) - Method in class io.nitric.mock.MockTrigger.TopicTriggerBuilder: Set the Trigger request MIME type.
setPath(String) - Method in class io.nitric.mock.MockTrigger.HttpTriggerBuilder: Set the Trigger HTTP URL path.
setQueryParams(Map<String, String>) - Method in class io.nitric.mock.MockTrigger.HttpTriggerBuilder: Set the Trigger HTTP query parameter.
setStatus(int) - Method in class io.nitric.faas.HttpResponseContext
setSuccess(boolean) - Method in class io.nitric.faas.TopicResponseContext
setTopic(String) - Method in class io.nitric.mock.MockTrigger.TopicTriggerBuilder: Add a Trigger Topic name.
start(NitricFunction) - Static method in class io.nitric.faas.Faas: Start a Nitric function server with the given function.
startFunction(NitricFunction) - Method in class io.nitric.faas.Faas: Start the FaaS server after configuring the given function.
Storage - Class in io.nitric.api.storage: Provides a Storage API client.
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.

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(String) - Static method in class io.nitric.api.event.Events: Return a new event topic with the given name.
Topic - Class in io.nitric.api.event: Provides an Topic class.
TopicResponseContext - Class in io.nitric.faas: Provides a Topic response context class which can specify whether the event was successfully processed.
TopicResponseContext() - Constructor for class io.nitric.faas.TopicResponseContext
topics() - Static method in class io.nitric.api.event.Events: List the available event topics.
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.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 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.FunctionTrigger
toString() - Method in class io.nitric.faas.HttpResponseContext
toString() - Method in class io.nitric.faas.HttpTriggerContext
toString() - Method in class io.nitric.faas.Response: Return the string representation of this object.
toString() - Method in class io.nitric.faas.TopicResponseContext
toString() - Method in class io.nitric.faas.TopicTriggerContext
toString() - Method in class io.nitric.mock.MockTrigger
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 - Interface in io.nitric.faas: Provides a Nitric FaaS Trigger inferface.

V

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 K L M N P Q R S T V W
All Classes All Packages