com.oracle.bmc.functions

Class FunctionsManagementClient

java.lang.Object

com.oracle.bmc.functions.FunctionsManagementClient

All Implemented Interfaces:

FunctionsManagement, AutoCloseable

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

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
static Service	SERVICE Service instance for FunctionsManagement.

Constructor Summary

Constructors

Modifier	Constructor and Description
	FunctionsManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory) Creates a new service instance using the given authentication provider and client configuration.
	FunctionsManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators) Creates a new service instance using the given authentication provider and client configuration.
	FunctionsManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint) Creates a new service instance using the given authentication provider and client configuration.
	FunctionsManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint) Creates a new service instance using the given authentication provider and client configuration.
	FunctionsManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService) Creates a new service instance using the given authentication provider and client configuration.
protected	FunctionsManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService, com.oracle.bmc.http.internal.RestClientFactoryBuilder restClientFactoryBuilder) Creates a new service instance using the given authentication provider and client configuration.
	FunctionsManagementClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider) Creates a new service instance using the given authentication provider.
	FunctionsManagementClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration) Creates a new service instance using the given authentication provider and client configuration.
	FunctionsManagementClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator) Creates a new service instance using the given authentication provider and client configuration.

Method Summary

Modifier and Type	Method and 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	getEndpoint() Gets the set endpoint for REST call (ex, https://www.example.com)
GetFunctionResponse	getFunction(GetFunctionRequest request) Retrieves a function.
FunctionsManagementPaginators	getPaginators() Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
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.
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’).
UpdateApplicationResponse	updateApplication(UpdateApplicationRequest request) Modifies an application
UpdateFunctionResponse	updateFunction(UpdateFunctionRequest request) Modifies a function

Methods inherited from class java.lang.Object

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

Field Detail

SERVICE

public static final Service SERVICE

Service instance for FunctionsManagement.

Constructor Detail

FunctionsManagementClient

public FunctionsManagementClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Creates a new service instance using the given authentication provider.

Parameters:

authenticationDetailsProvider - The authentication details provider, required.

FunctionsManagementClient

public FunctionsManagementClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                 ClientConfiguration configuration)

Creates a new service instance using the given authentication provider and client configuration.

Parameters:

authenticationDetailsProvider - The authentication details provider, required.

configuration - The client configuration, optional.

FunctionsManagementClient

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

Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.

Parameters:

authenticationDetailsProvider - The authentication details provider, required.

configuration - The client configuration, optional.

clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.

FunctionsManagementClient

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

Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.

This is an advanced constructor for clients that want to take control over how requests are signed.

Parameters:

authenticationDetailsProvider - The authentication details provider, required.

configuration - The client configuration, optional.

clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.

defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.

FunctionsManagementClient

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

Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.

This is an advanced constructor for clients that want to take control over how requests are signed.

Parameters:

authenticationDetailsProvider - The authentication details provider, required.

configuration - The client configuration, optional.

clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.

defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.

additionalClientConfigurators - Additional client configurators to be run after the primary configurator.

FunctionsManagementClient

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

Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.

This is an advanced constructor for clients that want to take control over how requests are signed.

Parameters:

authenticationDetailsProvider - The authentication details provider, required.

configuration - The client configuration, optional.

clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.

defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.

additionalClientConfigurators - Additional client configurators to be run after the primary configurator.

endpoint - Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider)

FunctionsManagementClient

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

Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.

This is an advanced constructor for clients that want to take control over how requests are signed.

Parameters:

authenticationDetailsProvider - The authentication details provider, required.

configuration - The client configuration, optional.

clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.

defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.

signingStrategyRequestSignerFactories - The request signer factories for each signing strategy used to create the request signer

additionalClientConfigurators - Additional client configurators to be run after the primary configurator.

endpoint - Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider)

FunctionsManagementClient

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

Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.

This is an advanced constructor for clients that want to take control over how requests are signed.

Parameters:

authenticationDetailsProvider - The authentication details provider, required.

configuration - The client configuration, optional.

clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.

defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.

signingStrategyRequestSignerFactories - The request signer factories for each signing strategy used to create the request signer

additionalClientConfigurators - Additional client configurators to be run after the primary configurator.

endpoint - Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider)

executorService - ExecutorService used by the client, or null to use the default configured ThreadPoolExecutor

FunctionsManagementClient

protected FunctionsManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                    ClientConfiguration configuration,
                                    ClientConfigurator clientConfigurator,
                                    RequestSignerFactory defaultRequestSignerFactory,
                                    Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                                    List<ClientConfigurator> additionalClientConfigurators,
                                    String endpoint,
                                    ExecutorService executorService,
                                    com.oracle.bmc.http.internal.RestClientFactoryBuilder restClientFactoryBuilder)

Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.

This is an advanced constructor for clients that want to take control over how requests are signed. Use the FunctionsManagementClient.Builder to get access to all these parameters.

Parameters:

authenticationDetailsProvider - The authentication details provider, required.

configuration - The client configuration, optional.

clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.

defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.

signingStrategyRequestSignerFactories - The request signer factories for each signing strategy used to create the request signer

additionalClientConfigurators - Additional client configurators to be run after the primary configurator.

endpoint - Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider)

executorService - ExecutorService used by the client, or null to use the default configured ThreadPoolExecutor

restClientFactoryBuilder - the builder for the RestClientFactory

Method Detail

builder

public static FunctionsManagementClient.Builder builder()

Create a builder for this client.

Returns:

builder

setEndpoint

public void setEndpoint(String endpoint)

Description copied from interface: FunctionsManagement

Sets the endpoint to call (ex, https://www.example.com).

Specified by:

setEndpoint in interface FunctionsManagement

Parameters:

endpoint - The endpoint of the service.

getEndpoint

public String getEndpoint()

Description copied from interface: FunctionsManagement

Gets the set endpoint for REST call (ex, https://www.example.com)

Specified by:

getEndpoint in interface FunctionsManagement

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.

close

public void close()

Specified by:

close in interface AutoCloseable

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

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

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.