@Generated(value="OracleSDKGenerator", comments="API Version: 20181201") public interface FunctionsInvoke extends AutoCloseable
API for the Functions service.
This service client uses CircuitBreakerUtils.DEFAULT_CIRCUIT_BREAKER for all the operations by default if no circuit breaker configuration is defined by the user.
Modifier and Type | Method and Description |
---|---|
String |
getEndpoint()
Gets the set endpoint for REST call (ex, https://www.example.com)
|
InvokeFunctionResponse |
invokeFunction(InvokeFunctionRequest request)
Invokes a function
|
void |
refreshClient()
Rebuilds the client from scratch.
|
void |
setEndpoint(String endpoint)
Sets the endpoint to call (ex, https://www.example.com).
|
void |
setRegion(Region region)
Sets the region to call (ex, Region.US_PHOENIX_1).
|
void |
setRegion(String regionId)
Sets the region to call (ex, ‘us-phoenix-1’).
|
close
void refreshClient()
Rebuilds the client from scratch. Useful to refresh certificates.
void setEndpoint(String endpoint)
Sets the endpoint to call (ex, https://www.example.com).
endpoint
- The endpoint of the service.String getEndpoint()
Gets the set endpoint for REST call (ex, https://www.example.com)
void setRegion(Region region)
Sets the region to call (ex, Region.US_PHOENIX_1).
Note, this will call setEndpoint
after resolving the endpoint. If the service is not available in this Region, however, an IllegalArgumentException will be raised.
region
- The region of the service.void setRegion(String regionId)
Sets the region to call (ex, ‘us-phoenix-1’).
Note, this will first try to map the region ID to a known Region and call
setRegion
.
If no known Region could be determined, it will create an endpoint based on the
default endpoint format (Region.formatDefaultRegionEndpoint(Service, String)
and then call setEndpoint
.
regionId
- The public region ID.InvokeFunctionResponse invokeFunction(InvokeFunctionRequest request)
Invokes a function
Note: This operation consumes a stream.
If the stream supports InputStream.mark(int)
and InputStream.reset()
, when a retry is
necessary, the stream is reset so it starts at the beginning (or whatever the stream’s position was at the time this
operation is called}.
Note this means that if the caller has used InputStream.mark(int)
before, then the mark
will not be the same anymore after this operation, and a subsequent call to InputStream.reset()
by
the caller will reset the stream not to the caller’s mark, but to the position the stream was in when this operation
was called.
If the stream is a FileInputStream
, and the stream’s FileChannel
position
can be changed (like for a regular file), the stream will be wrapped in such a way that it does provide
support for InputStream.mark(int)
and InputStream.reset()
. Then the same procedure as
above is followed. If the stream’s FileChannel
position cannot be changed (like for a
named pipe), then the stream’s contents will be buffered in memory, as described below.
If the stream does not support InputStream.mark(int)
and InputStream.reset()
, then
the stream is wrapped in a BufferedInputStream
, which means the entire contents may
be buffered in memory. Then the same procedure as above is followed.
The contents of the stream, except when the stream is a FileInputStream
whose
FileChannel
position can be changed, should be less than 2 GiB in size if retries are used.
This is because streams 2 GiB in size or larger do no guarantee that mark-and-reset can be performed. If the stream
is larger, do not use built-in retries and manage retries yourself.
request
- The request object containing the details to sendBmcException
- when an error occurs.
This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it.
The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use InvokeFunction API.
Copyright © 2016–2022. All rights reserved.