Package com.oracle.bmc.functions.requests

Class InvokeFunctionRequest

java.lang.Object

com.oracle.bmc.requests.BmcRequest<InputStream>

com.oracle.bmc.functions.requests.InvokeFunctionRequest

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20181201")
public class InvokeFunctionRequest
extends BmcRequest<InputStream>

Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/functions/InvokeFunctionExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use InvokeFunctionRequest.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	InvokeFunctionRequest.Builder
static class	InvokeFunctionRequest.FnIntent	An optional intent header that indicates to the FDK the way the event should be interpreted.
static class	InvokeFunctionRequest.FnInvokeType	Indicates whether Oracle Functions should execute the request and return the result (‘sync’) of the execution, or whether Oracle Functions should return as soon as processing has begun (‘detached’) and leave result handling to the function.

Constructor Summary

Constructors

Constructor	Description
InvokeFunctionRequest()

Method Summary

Modifier and Type	Method	Description
static InvokeFunctionRequest.Builder	builder()	Return a new builder for this request object.
boolean	equals(Object o)	Uses getInvocationCallback and getRetryConfiguration to determine if passed request is equal to ‘this’.
InputStream	getBody$()	Alternative accessor for the body parameter.
InvokeFunctionRequest.FnIntent	getFnIntent()	An optional intent header that indicates to the FDK the way the event should be interpreted.
InvokeFunctionRequest.FnInvokeType	getFnInvokeType()	Indicates whether Oracle Functions should execute the request and return the result (‘sync’) of the execution, or whether Oracle Functions should return as soon as processing has begun (‘detached’) and leave result handling to the function.
String	getFunctionId()	The OCID of this function.
InputStream	getInvokeFunctionBody()	The body of the function invocation.
Boolean	getIsDryRun()	Indicates that the request is a dry run, if set to “true”.
String	getOpcRequestId()	The unique Oracle-assigned identifier for the request.
int	hashCode()	Uses getInvocationCallback and getRetryConfiguration to generate a hash.
InvokeFunctionRequest.Builder	toBuilder()	Return an instance of InvokeFunctionRequest.Builder that allows you to modify request properties.
String	toString()

Methods inherited from class com.oracle.bmc.requests.BmcRequest

getInvocationCallback, getRetryConfiguration, setInvocationCallback, setRetryConfiguration, supportsExpect100Continue

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

InvokeFunctionRequest

public InvokeFunctionRequest()

Method Detail

getFunctionId

public String getFunctionId()

The OCID of this function.

getInvokeFunctionBody

public InputStream getInvokeFunctionBody()

The body of the function invocation.

Note: The maximum size of the request is limited. This limit is currently 6MB and the endpoint will not accept requests that are bigger than this limit.

getFnIntent

public InvokeFunctionRequest.FnIntent getFnIntent()

An optional intent header that indicates to the FDK the way the event should be interpreted.

E.g. ‘httprequest’, ‘cloudevent’.

getFnInvokeType

public InvokeFunctionRequest.FnInvokeType getFnInvokeType()

Indicates whether Oracle Functions should execute the request and return the result (‘sync’) of the execution, or whether Oracle Functions should return as soon as processing has begun (‘detached’) and leave result handling to the function.

getOpcRequestId

public String getOpcRequestId()

The unique Oracle-assigned identifier for the request.

If you need to contact Oracle about a particular request, please provide the request ID.

getIsDryRun

public Boolean getIsDryRun()

Indicates that the request is a dry run, if set to “true”.

A dry run request does not execute the function.

getBody$

public InputStream getBody$()

Alternative accessor for the body parameter.

Overrides:

getBody$ in class BmcRequest<InputStream>

Returns:

body parameter

toBuilder

public InvokeFunctionRequest.Builder toBuilder()

Return an instance of InvokeFunctionRequest.Builder that allows you to modify request properties.

Returns:

instance of InvokeFunctionRequest.Builder that allows you to modify request properties.

builder

public static InvokeFunctionRequest.Builder builder()

Return a new builder for this request object.

Returns:

builder for the request object

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Description copied from class: BmcRequest

Uses getInvocationCallback and getRetryConfiguration to determine if passed request is equal to ‘this’.

Overrides:

equals in class BmcRequest<InputStream>

hashCode

public int hashCode()

Description copied from class: BmcRequest

Uses getInvocationCallback and getRetryConfiguration to generate a hash.

Overrides:

hashCode in class BmcRequest<InputStream>