Package com.oracle.bmc.functions.requests

Class InvokeFunctionRequest.Builder

java.lang.Object

com.oracle.bmc.functions.requests.InvokeFunctionRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<InvokeFunctionRequest,InputStream>

Enclosing class:

InvokeFunctionRequest

public static class InvokeFunctionRequest.Builder
extends Object
implements BmcRequest.Builder<InvokeFunctionRequest,InputStream>

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
InvokeFunctionRequest.Builder	body$(InputStream body)	Alternative setter for the body parameter.
InvokeFunctionRequest	build()	Build the instance of InvokeFunctionRequest as configured by this builder
InvokeFunctionRequest	buildWithoutInvocationCallback()	Build the instance of InvokeFunctionRequest as configured by this builder
InvokeFunctionRequest.Builder	copy(InvokeFunctionRequest o)	Copy method to populate the builder with values from the given instance.
InvokeFunctionRequest.Builder	fnIntent(InvokeFunctionRequest.FnIntent fnIntent)	An optional intent header that indicates to the FDK the way the event should be interpreted.
InvokeFunctionRequest.Builder	fnInvokeType(InvokeFunctionRequest.FnInvokeType 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.
InvokeFunctionRequest.Builder	functionId(String functionId)	The OCID of this function.
InvokeFunctionRequest.Builder	invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)	Set the invocation callback for the request to be built.
InvokeFunctionRequest.Builder	invokeFunctionBody(InputStream invokeFunctionBody)	The body of the function invocation.
InvokeFunctionRequest.Builder	isDryRun(Boolean isDryRun)	Indicates that the request is a dry run, if set to “true”.
InvokeFunctionRequest.Builder	opcRequestId(String opcRequestId)	The unique Oracle-assigned identifier for the request.
InvokeFunctionRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration)	Set the retry configuration for the request to be built.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

functionId

public InvokeFunctionRequest.Builder functionId(String functionId)

The OCID of this function.

Parameters:

functionId - the value to set

Returns:

this builder instance

invokeFunctionBody

public InvokeFunctionRequest.Builder invokeFunctionBody(InputStream invokeFunctionBody)

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.

Parameters:

invokeFunctionBody - the value to set

Returns:

this builder instance

fnIntent

public InvokeFunctionRequest.Builder fnIntent(InvokeFunctionRequest.FnIntent fnIntent)

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

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

Parameters:

fnIntent - the value to set

Returns:

this builder instance

fnInvokeType

public InvokeFunctionRequest.Builder fnInvokeType(InvokeFunctionRequest.FnInvokeType 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.

Parameters:

fnInvokeType - the value to set

Returns:

this builder instance

opcRequestId

public InvokeFunctionRequest.Builder opcRequestId(String opcRequestId)

The unique Oracle-assigned identifier for the request.

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

Parameters:

opcRequestId - the value to set

Returns:

this builder instance

isDryRun

public InvokeFunctionRequest.Builder isDryRun(Boolean isDryRun)

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

A dry run request does not execute the function.

Parameters:

isDryRun - the value to set

Returns:

this builder instance

invocationCallback

public InvokeFunctionRequest.Builder invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)

Set the invocation callback for the request to be built.

Parameters:

invocationCallback - the invocation callback to be set for the request

Returns:

this builder instance

retryConfiguration

public InvokeFunctionRequest.Builder retryConfiguration(RetryConfiguration retryConfiguration)

Set the retry configuration for the request to be built.

Parameters:

retryConfiguration - the retry configuration to be used for the request

Returns:

this builder instance

copy

public InvokeFunctionRequest.Builder copy(InvokeFunctionRequest o)

Copy method to populate the builder with values from the given instance.

Specified by:

copy in interface BmcRequest.Builder<InvokeFunctionRequest,InputStream>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public InvokeFunctionRequest build()

Build the instance of InvokeFunctionRequest as configured by this builder

Note that this method takes calls to invocationCallback(com.oracle.bmc.http.client.RequestInterceptor) into account, while the method buildWithoutInvocationCallback() does not.

This is the preferred method to build an instance.

Specified by:

build in interface BmcRequest.Builder<InvokeFunctionRequest,InputStream>

Returns:

instance of InvokeFunctionRequest

body$

public InvokeFunctionRequest.Builder body$(InputStream body)

Alternative setter for the body parameter.

Specified by:

body$ in interface BmcRequest.Builder<InvokeFunctionRequest,InputStream>

Parameters:

body - the body parameter

Returns:

this builder instance

buildWithoutInvocationCallback

public InvokeFunctionRequest buildWithoutInvocationCallback()

Build the instance of InvokeFunctionRequest as configured by this builder

Note that this method does not take calls to invocationCallback(com.oracle.bmc.http.client.RequestInterceptor) into account, while the method build() does

Returns:

instance of InvokeFunctionRequest