Index (functions-framework-api 1.0.1 API)

A B C D E G H I N O P R S T V
All Classes All Packages

A

accept(Context, CloudEvent) - Method in interface dev.openfunction.functions.CloudEventFunction
accept(Context, String) - Method in interface dev.openfunction.functions.OpenFunction: Called to service an incoming event.
appendHeader(String, String) - Method in interface dev.openfunction.functions.HttpResponse: Includes the given header name with the given value in the response.

B

BindingEvent - Class in dev.openfunction.functions
BindingEvent(String, Map<String, String>, ByteBuffer) - Constructor for class dev.openfunction.functions.BindingEvent

C

CloudEventFunction - Interface in dev.openfunction.functions
Component - Class in dev.openfunction.functions
Component() - Constructor for class dev.openfunction.functions.Component
Context - Interface in dev.openfunction.functions: An interface for event function context.

D

dev.openfunction.functions - package dev.openfunction.functions

E

execPostHook(Context) - Method in interface dev.openfunction.functions.Plugin: execPreHook executes a hook after the function called.
execPreHook(Context) - Method in interface dev.openfunction.functions.Plugin: execPreHook executes a hook before the function called.

G

getBindingEvent() - Method in interface dev.openfunction.functions.Context: getBindingEvent returns the binding event.
getCharacterEncoding() - Method in interface dev.openfunction.functions.HttpMessage: Returns the character encoding specified in the Content-Type header, or Optional.empty() if there is no Content-Type header or it does not have the charset parameter.
getCloudEvent() - Method in interface dev.openfunction.functions.Context: getCloudEvent returns the cloud Event.
getCode() - Method in class dev.openfunction.functions.Out
getComponentName() - Method in class dev.openfunction.functions.Component
getComponentType() - Method in class dev.openfunction.functions.Component
getContentLength() - Method in interface dev.openfunction.functions.HttpMessage: Returns the numeric value of the Content-Length header.
getContentType() - Method in interface dev.openfunction.functions.HttpMessage: Returns the value of the Content-Type header, if any.
getContentType() - Method in interface dev.openfunction.functions.HttpResponse: Returns the Content-Type that was previously set by HttpResponse.setContentType(java.lang.String), or by HttpResponse.appendHeader(java.lang.String, java.lang.String) with a header name of Content-Type.
getData() - Method in class dev.openfunction.functions.BindingEvent
getData() - Method in class dev.openfunction.functions.Out
getData() - Method in class dev.openfunction.functions.TopicEvent
getDatacontenttype() - Method in class dev.openfunction.functions.TopicEvent
getError() - Method in class dev.openfunction.functions.Out
getField(String) - Method in interface dev.openfunction.functions.Plugin: get return the value of the fieldName`
getFileName() - Method in interface dev.openfunction.functions.HttpRequest.HttpPart: Returns the filename associated with this part, if any.
getFirstHeader(String) - Method in interface dev.openfunction.functions.HttpMessage: Convenience method that returns the value of the first header with the given name.
getFirstQueryParameter(String) - Method in interface dev.openfunction.functions.HttpRequest: The first query parameter with the given name, if any.
getHeaders() - Method in interface dev.openfunction.functions.HttpMessage: Returns a map describing the headers of this HTTP request, or this part of a multipart request.
getHeaders() - Method in interface dev.openfunction.functions.HttpResponse: Returns the headers that have been defined for the response so far.
getHttpPattern() - Method in interface dev.openfunction.functions.Context: getHttpPattern returns the path of the server listening for http function.
getHttpRequest() - Method in interface dev.openfunction.functions.Context: getHttpRequest returns the Http request.
getHttpResponse() - Method in interface dev.openfunction.functions.Context: getHttpResponse returns the Http response.
getId() - Method in class dev.openfunction.functions.TopicEvent
getInputs() - Method in interface dev.openfunction.functions.Context: getInputs returns the Inputs of function.
getInputStream() - Method in interface dev.openfunction.functions.HttpMessage: Returns an InputStream that can be used to read the body of this HTTP request.
getMetadata() - Method in class dev.openfunction.functions.BindingEvent
getMetadata() - Method in class dev.openfunction.functions.Component
getMetadata() - Method in class dev.openfunction.functions.Out
getMethod() - Method in interface dev.openfunction.functions.HttpRequest: The HTTP method of this request, such as "POST" or "GET".
getMethods() - Method in class dev.openfunction.functions.Routable: Get the supported http methods.
getMode() - Method in interface dev.openfunction.functions.Context: getMode returns the operating environment mode of the function.
getName() - Method in class dev.openfunction.functions.BindingEvent
getName() - Method in interface dev.openfunction.functions.Context: getName returns the function's name.
getName() - Method in class dev.openfunction.functions.TopicEvent
getOperation() - Method in class dev.openfunction.functions.Component
getOut() - Method in interface dev.openfunction.functions.Context: GetOut returns the returned value of function.
getOutputs() - Method in interface dev.openfunction.functions.Context: getOutputs returns the Outputs of function.
getOutputStream() - Method in interface dev.openfunction.functions.HttpResponse: Returns an OutputStream that can be used to write the body of the response.
getParts() - Method in interface dev.openfunction.functions.HttpRequest: Returns the parts inside this multipart (multipart/form-data) HTTP request.
getPath() - Method in interface dev.openfunction.functions.HttpRequest: The path part of the URI for this request, without any query.
getPath() - Method in class dev.openfunction.functions.Routable: Get the URI that will be routed.
getPodName() - Method in interface dev.openfunction.functions.Context: getPodName returns the name of the pod the function is running on.
getPodNamespace() - Method in interface dev.openfunction.functions.Context: getPodNamespace returns the namespace of the pod the function is running on.
getPostPlugins() - Method in interface dev.openfunction.functions.Context
getPrePlugins() - Method in interface dev.openfunction.functions.Context
getQuery() - Method in interface dev.openfunction.functions.HttpRequest: The query part of the URI for this request.
getQueryParameters() - Method in interface dev.openfunction.functions.HttpRequest: The query parameters of this request.
getReader() - Method in interface dev.openfunction.functions.HttpMessage: Returns a BufferedReader that can be used to read the text body of this HTTP request.
getRuntime() - Method in interface dev.openfunction.functions.Context: getRuntime returns the Runtime.
getSource() - Method in class dev.openfunction.functions.TopicEvent
getSpecversion() - Method in class dev.openfunction.functions.TopicEvent
getStatusCode() - Method in interface dev.openfunction.functions.HttpResponse
getTopic() - Method in class dev.openfunction.functions.TopicEvent
getTopicEvent() - Method in interface dev.openfunction.functions.Context: getTopicEvent returns the topic event.
getType() - Method in class dev.openfunction.functions.TopicEvent
getUri() - Method in class dev.openfunction.functions.Component
getUri() - Method in interface dev.openfunction.functions.HttpRequest: The full URI of this request as it arrived at the server.
getWriter() - Method in interface dev.openfunction.functions.HttpResponse: Returns a BufferedWriter that can be used to write the text body of the response.

H

HttpFunction - Interface in dev.openfunction.functions
HttpMessage - Interface in dev.openfunction.functions: Represents an HTTP message, either an HTTP request or a part of a multipart HTTP request.
HttpRequest - Interface in dev.openfunction.functions: Represents the contents of an HTTP request that is being serviced by a Cloud Function.
HttpRequest.HttpPart - Interface in dev.openfunction.functions: Represents one part inside a multipart (multipart/form-data) HTTP request.
HttpResponse - Interface in dev.openfunction.functions: Represents the contents of an HTTP response that is being sent by a Cloud Function in response to an HTTP request.

I

init() - Method in interface dev.openfunction.functions.Plugin: init will create a new plugin, and execute hook in this calling.

N

name() - Method in interface dev.openfunction.functions.Plugin: name return the name of this plugin.

O

OpenFunction - Interface in dev.openfunction.functions
Out - Class in dev.openfunction.functions
Out() - Constructor for class dev.openfunction.functions.Out
Out(int, Error, ByteBuffer, Map<String, String>) - Constructor for class dev.openfunction.functions.Out

P

Plugin - Interface in dev.openfunction.functions

R

Routable - Class in dev.openfunction.functions: An object that can route the specified http request to the specified function.
Routable() - Constructor for class dev.openfunction.functions.Routable

S

send(String, String) - Method in interface dev.openfunction.functions.Context: send provides the ability to allow the user to send data to a specified output target.
service(HttpRequest, HttpResponse) - Method in interface dev.openfunction.functions.HttpFunction: Called to service an incoming HTTP request.
setCode(int) - Method in class dev.openfunction.functions.Out
setComponentName(String) - Method in class dev.openfunction.functions.Component
setComponentType(String) - Method in class dev.openfunction.functions.Component
setContentType(String) - Method in interface dev.openfunction.functions.HttpResponse: Sets the value to use for the Content-Type header in the response.
setData(ByteBuffer) - Method in class dev.openfunction.functions.Out
setError(Error) - Method in class dev.openfunction.functions.Out
setMetadata(Map<String, String>) - Method in class dev.openfunction.functions.Component
setMetadata(Map<String, String>) - Method in class dev.openfunction.functions.Out
setOperation(String) - Method in class dev.openfunction.functions.Component
setStatusCode(int) - Method in interface dev.openfunction.functions.HttpResponse: Sets the numeric HTTP status code to use in the response.
setStatusCode(int, String) - Method in interface dev.openfunction.functions.HttpResponse: Sets the numeric HTTP status code and reason message to use in the response.
setUri(String) - Method in class dev.openfunction.functions.Component

T

TopicEvent - Class in dev.openfunction.functions
TopicEvent(String, String, String, String, String, String, String, ByteBuffer) - Constructor for class dev.openfunction.functions.TopicEvent

V

version() - Method in interface dev.openfunction.functions.Plugin: version return the version of this plugin.

A B C D E G H I N O P R S T V
All Classes All Packages