Package com.oracle.bmc.functions

Class FunctionsManagementClient

java.lang.Object

com.oracle.bmc.http.internal.BaseSyncClient

com.oracle.bmc.functions.FunctionsManagementClient

All Implemented Interfaces:

FunctionsManagement, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20181201")
public class FunctionsManagementClient
extends BaseSyncClient
implements FunctionsManagement

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FunctionsManagementClient.Builder	Builder class for this client.

Field Summary

Fields

Modifier and Type	Field	Description
String	clientCommonLibraryVersion	Compatible SDK version, provided by the codegen.
Optional<String>	minimumClientCommonLibraryVersionFromClient	Minimum compatible SDK version, maybe provided by the codegen.
static Service	SERVICE	Service instance for FunctionsManagement.

Constructor Summary

Constructors

Constructor	Description
FunctionsManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)	Deprecated. Use the builder instead.
FunctionsManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)	Deprecated. Use the builder instead.
FunctionsManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)	Deprecated. Use the builder instead.
FunctionsManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)	Deprecated. Use the builder instead.
FunctionsManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)	Deprecated. Use the builder instead.
FunctionsManagementClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)	Deprecated. Use the builder instead.
FunctionsManagementClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)	Deprecated. Use the builder instead.
FunctionsManagementClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)	Deprecated. Use the builder instead.

Method Summary

Modifier and Type	Method	Description
static FunctionsManagementClient.Builder	builder()	Create a builder for this client.
ChangeApplicationCompartmentResponse	changeApplicationCompartment(ChangeApplicationCompartmentRequest request)	Moves an application into a different compartment within the same tenancy.
void	close()
CreateApplicationResponse	createApplication(CreateApplicationRequest request)	Creates a new application.
CreateFunctionResponse	createFunction(CreateFunctionRequest request)	Creates a new function.
DeleteApplicationResponse	deleteApplication(DeleteApplicationRequest request)	Deletes an application.
DeleteFunctionResponse	deleteFunction(DeleteFunctionRequest request)	Deletes a function.
GetApplicationResponse	getApplication(GetApplicationRequest request)	Retrieves an application.
String	getClientCommonLibraryVersion()
protected ClientConfigurator	getDefaultConfigurator()
String	getEndpoint()
GetFunctionResponse	getFunction(GetFunctionRequest request)	Retrieves a function.
Optional<String>	getMinimumClientCommonLibraryVersionFromClient()
FunctionsManagementPaginators	getPaginators()	Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
GetPbfListingResponse	getPbfListing(GetPbfListingRequest request)	Fetches a Pre-built Function(PBF) Listing.
GetPbfListingVersionResponse	getPbfListingVersion(GetPbfListingVersionRequest request)	Gets a PbfListingVersion by identifier for a PbfListing.
FunctionsManagementWaiters	getWaiters()	Gets the pre-configured waiters available for resources for this service.
ListApplicationsResponse	listApplications(ListApplicationsRequest request)	Lists applications for a compartment.
ListFunctionsResponse	listFunctions(ListFunctionsRequest request)	Lists functions for an application.
ListPbfListingsResponse	listPbfListings(ListPbfListingsRequest request)	Fetches a wrapped list of all Pre-built Function(PBF) Listings.
ListPbfListingVersionsResponse	listPbfListingVersions(ListPbfListingVersionsRequest request)	Fetches a wrapped list of all Pre-built Function(PBF) Listing versions.
ListTriggersResponse	listTriggers(ListTriggersRequest request)	Returns a list of Triggers.
void	populateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap)	Populate the parameters in the endpoint with its corresponding value and update the base endpoint.
void	refreshClient()	Rebuild the backing HttpClient.
void	setEndpoint(String endpoint)
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’).
UpdateApplicationResponse	updateApplication(UpdateApplicationRequest request)	Modifies an application
void	updateBaseEndpoint(String endpoint)	This method should be used for parameterized endpoint templates only.
UpdateFunctionResponse	updateFunction(UpdateFunctionRequest request)	Modifies a function
void	useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)	This method should be used to enable or disable the use of realm-specific endpoint template.

Methods inherited from class com.oracle.bmc.http.internal.BaseSyncClient

clientCall

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.AutoCloseable

close

Methods inherited from interface com.oracle.bmc.functions.FunctionsManagement

getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

Field Detail

SERVICE

public static final Service SERVICE

Service instance for FunctionsManagement.

clientCommonLibraryVersion

public final String clientCommonLibraryVersion

Compatible SDK version, provided by the codegen.

minimumClientCommonLibraryVersionFromClient

public final Optional<String> minimumClientCommonLibraryVersionFromClient

Minimum compatible SDK version, maybe provided by the codegen.

Constructor Detail

FunctionsManagementClient

@Deprecated
public FunctionsManagementClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see FunctionsManagementClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

FunctionsManagementClient

@Deprecated
public FunctionsManagementClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                 ClientConfiguration configuration)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see FunctionsManagementClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

FunctionsManagementClient

@Deprecated
public FunctionsManagementClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                 ClientConfiguration configuration,
                                 ClientConfigurator clientConfigurator)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see FunctionsManagementClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

FunctionsManagementClient

@Deprecated
public FunctionsManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                 ClientConfiguration configuration,
                                 ClientConfigurator clientConfigurator,
                                 RequestSignerFactory defaultRequestSignerFactory)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see FunctionsManagementClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

FunctionsManagementClient

@Deprecated
public FunctionsManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                 ClientConfiguration configuration,
                                 ClientConfigurator clientConfigurator,
                                 RequestSignerFactory defaultRequestSignerFactory,
                                 List<ClientConfigurator> additionalClientConfigurators)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see FunctionsManagementClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

FunctionsManagementClient

@Deprecated
public FunctionsManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                 ClientConfiguration configuration,
                                 ClientConfigurator clientConfigurator,
                                 RequestSignerFactory defaultRequestSignerFactory,
                                 List<ClientConfigurator> additionalClientConfigurators,
                                 String endpoint)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see FunctionsManagementClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

endpoint - ClientBuilderBase.endpoint(java.lang.String)

FunctionsManagementClient

@Deprecated
public FunctionsManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                 ClientConfiguration configuration,
                                 ClientConfigurator clientConfigurator,
                                 RequestSignerFactory defaultRequestSignerFactory,
                                 Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                                 List<ClientConfigurator> additionalClientConfigurators,
                                 String endpoint)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see FunctionsManagementClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

endpoint - ClientBuilderBase.endpoint(java.lang.String)

signingStrategyRequestSignerFactories - ClientBuilderBase.signingStrategyRequestSignerFactories

FunctionsManagementClient

@Deprecated
public FunctionsManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                 ClientConfiguration configuration,
                                 ClientConfigurator clientConfigurator,
                                 RequestSignerFactory defaultRequestSignerFactory,
                                 Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                                 List<ClientConfigurator> additionalClientConfigurators,
                                 String endpoint,
                                 ExecutorService executorService)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see FunctionsManagementClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

endpoint - ClientBuilderBase.endpoint(java.lang.String)

signingStrategyRequestSignerFactories - ClientBuilderBase.signingStrategyRequestSignerFactories

executorService - FunctionsManagementClient.Builder.executorService

Method Detail

builder

public static FunctionsManagementClient.Builder builder()

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: FunctionsManagement

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.

Specified by:

setRegion in interface FunctionsManagement

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: FunctionsManagement

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.

Specified by:

setRegion in interface FunctionsManagement

Parameters:

regionId - The public region ID.

changeApplicationCompartment

public ChangeApplicationCompartmentResponse changeApplicationCompartment(ChangeApplicationCompartmentRequest request)

Description copied from interface: FunctionsManagement

Moves an application into a different compartment within the same tenancy.

For information about moving resources between compartments, see Moving Resources Between Compartments.

Specified by:

changeApplicationCompartment in interface FunctionsManagement

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createApplication

public CreateApplicationResponse createApplication(CreateApplicationRequest request)

Description copied from interface: FunctionsManagement

Creates a new application.

Specified by:

createApplication in interface FunctionsManagement

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createFunction

public CreateFunctionResponse createFunction(CreateFunctionRequest request)

Description copied from interface: FunctionsManagement

Creates a new function.

Specified by:

createFunction in interface FunctionsManagement

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteApplication

public DeleteApplicationResponse deleteApplication(DeleteApplicationRequest request)

Description copied from interface: FunctionsManagement

Deletes an application.

Specified by:

deleteApplication in interface FunctionsManagement

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteFunction

public DeleteFunctionResponse deleteFunction(DeleteFunctionRequest request)

Description copied from interface: FunctionsManagement

Deletes a function.

Specified by:

deleteFunction in interface FunctionsManagement

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getApplication

public GetApplicationResponse getApplication(GetApplicationRequest request)

Description copied from interface: FunctionsManagement

Retrieves an application.

Specified by:

getApplication in interface FunctionsManagement

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getFunction

public GetFunctionResponse getFunction(GetFunctionRequest request)

Description copied from interface: FunctionsManagement

Retrieves a function.

Specified by:

getFunction in interface FunctionsManagement

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getPbfListing

public GetPbfListingResponse getPbfListing(GetPbfListingRequest request)

Description copied from interface: FunctionsManagement

Fetches a Pre-built Function(PBF) Listing.

Returns a PbfListing response model.

Specified by:

getPbfListing in interface FunctionsManagement

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getPbfListingVersion

public GetPbfListingVersionResponse getPbfListingVersion(GetPbfListingVersionRequest request)

Description copied from interface: FunctionsManagement

Gets a PbfListingVersion by identifier for a PbfListing.

Specified by:

getPbfListingVersion in interface FunctionsManagement

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listApplications

public ListApplicationsResponse listApplications(ListApplicationsRequest request)

Description copied from interface: FunctionsManagement

Lists applications for a compartment.

Specified by:

listApplications in interface FunctionsManagement

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listFunctions

public ListFunctionsResponse listFunctions(ListFunctionsRequest request)

Description copied from interface: FunctionsManagement

Lists functions for an application.

Specified by:

listFunctions in interface FunctionsManagement

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listPbfListingVersions

public ListPbfListingVersionsResponse listPbfListingVersions(ListPbfListingVersionsRequest request)

Description copied from interface: FunctionsManagement

Fetches a wrapped list of all Pre-built Function(PBF) Listing versions.

Returns a PbfListingVersionCollection containing an array of PbfListingVersionSummary response models.

Note that the PbfListingIdentifier must be provided as a query parameter, otherwise an exception shall be thrown.

Specified by:

listPbfListingVersions in interface FunctionsManagement

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listPbfListings

public ListPbfListingsResponse listPbfListings(ListPbfListingsRequest request)

Description copied from interface: FunctionsManagement

Fetches a wrapped list of all Pre-built Function(PBF) Listings.

Returns a PbfListingCollection containing an array of PbfListingSummary response models.

Specified by:

listPbfListings in interface FunctionsManagement

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listTriggers

public ListTriggersResponse listTriggers(ListTriggersRequest request)

Description copied from interface: FunctionsManagement

Returns a list of Triggers.

Specified by:

listTriggers in interface FunctionsManagement

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateApplication

public UpdateApplicationResponse updateApplication(UpdateApplicationRequest request)

Description copied from interface: FunctionsManagement

Modifies an application

Specified by:

updateApplication in interface FunctionsManagement

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateFunction

public UpdateFunctionResponse updateFunction(UpdateFunctionRequest request)

Description copied from interface: FunctionsManagement

Modifies a function

Specified by:

updateFunction in interface FunctionsManagement

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getWaiters

public FunctionsManagementWaiters getWaiters()

Description copied from interface: FunctionsManagement

Gets the pre-configured waiters available for resources for this service.

Specified by:

getWaiters in interface FunctionsManagement

Returns:

The service waiters.

getPaginators

public FunctionsManagementPaginators getPaginators()

Description copied from interface: FunctionsManagement

Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.

These paginators provide an Iterable interface so that service responses, or resources/records, can be iterated through without having to manually deal with pagination and page tokens.

Specified by:

getPaginators in interface FunctionsManagement

Returns:

The service paginators.

getDefaultConfigurator

protected ClientConfigurator getDefaultConfigurator()

useRealmSpecificEndpointTemplate

public void useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)

This method should be used to enable or disable the use of realm-specific endpoint template.

The default value is null. To enable the use of endpoint template defined for the realm in use, set the flag to true To disable the use of endpoint template defined for the realm in use, set the flag to false

Parameters:

useOfRealmSpecificEndpointTemplateEnabled - This flag can be set to true or false to enable or disable the use of realm-specific endpoint template respectively

populateServiceParametersInEndpoint

public final void populateServiceParametersInEndpoint(String endpoint,
                                                      Map<String,Object> requiredParametersMap)

Populate the parameters in the endpoint with its corresponding value and update the base endpoint.

The value will be populated iff the parameter in endpoint is a required request path parameter or a required request query parameter. If not, the parameter in the endpoint will be ignored and left blank.

Parameters:

endpoint - The endpoint template in use

requiredParametersMap - Map of parameter name as key and value set in request path or query parameter as value

updateBaseEndpoint

public final void updateBaseEndpoint(String endpoint)

This method should be used for parameterized endpoint templates only.

This does not include {region} and {secondLevelDomain} parameters.

Parameters:

endpoint - The updated endpoint to use

setEndpoint

public final void setEndpoint(String endpoint)

getEndpoint

public final String getEndpoint()

refreshClient

public final void refreshClient()

Rebuild the backing HttpClient.

This will call ClientConfigurators again, and can be used to e.g. refresh the SSL certificate.

close

public final void close()

Specified by:

close in interface AutoCloseable

getClientCommonLibraryVersion

public String getClientCommonLibraryVersion()

getMinimumClientCommonLibraryVersionFromClient

public Optional<String> getMinimumClientCommonLibraryVersionFromClient()