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 classFunctionsManagementClient.BuilderBuilder class for this client.
-
Field Summary
Fields Modifier and Type Field Description StringclientCommonLibraryVersionCompatible SDK version, provided by the codegen.Optional<String>minimumClientCommonLibraryVersionFromClientMinimum compatible SDK version, maybe provided by the codegen.static ServiceSERVICEService instance for FunctionsManagement.
-
Constructor Summary
Constructors Constructor Description FunctionsManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)Deprecated.Use thebuilderinstead.FunctionsManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)Deprecated.Use thebuilderinstead.FunctionsManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)Deprecated.Use thebuilderinstead.FunctionsManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)Deprecated.Use thebuilderinstead.FunctionsManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)Deprecated.Use thebuilderinstead.FunctionsManagementClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)Deprecated.Use thebuilderinstead.FunctionsManagementClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)Deprecated.Use thebuilderinstead.FunctionsManagementClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)Deprecated.Use thebuilderinstead.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static FunctionsManagementClient.Builderbuilder()Create a builder for this client.ChangeApplicationCompartmentResponsechangeApplicationCompartment(ChangeApplicationCompartmentRequest request)Moves an application into a different compartment within the same tenancy.voidclose()CreateApplicationResponsecreateApplication(CreateApplicationRequest request)Creates a new application.CreateFunctionResponsecreateFunction(CreateFunctionRequest request)Creates a new function.DeleteApplicationResponsedeleteApplication(DeleteApplicationRequest request)Deletes an application.DeleteFunctionResponsedeleteFunction(DeleteFunctionRequest request)Deletes a function.voidenableDualStackEndpoints(boolean enableDualStackEndpoints)This method should be used to enable or disable the use of dual-stack endpoints.GetApplicationResponsegetApplication(GetApplicationRequest request)Retrieves an application.StringgetClientCommonLibraryVersion()protected ClientConfiguratorgetDefaultConfigurator()StringgetEndpoint()Get the endpoint of the client.GetFunctionResponsegetFunction(GetFunctionRequest request)Retrieves a function.Optional<String>getMinimumClientCommonLibraryVersionFromClient()Map<String,Boolean>getOptionsMap()Return an immutable snapshot representing the current options set for this client.FunctionsManagementPaginatorsgetPaginators()Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.GetPbfListingResponsegetPbfListing(GetPbfListingRequest request)Fetches a Pre-built Function(PBF) Listing.GetPbfListingVersionResponsegetPbfListingVersion(GetPbfListingVersionRequest request)Gets a PbfListingVersion by identifier for a PbfListing.StringgetResolvedEndpoint(Map<String,Object> requiredParametersMap)Returns the endpoint after filling in the current options, as determined byBaseClient.getOptionsMap(), and then filling in the required parameters in requiredParametersMap into the placeholders in the endpoint.FunctionsManagementWaitersgetWaiters()Gets the pre-configured waiters available for resources for this service.ListApplicationsResponselistApplications(ListApplicationsRequest request)Lists applications for a compartment.ListFunctionsResponselistFunctions(ListFunctionsRequest request)Lists functions for an application.ListPbfListingsResponselistPbfListings(ListPbfListingsRequest request)Fetches a wrapped list of all Pre-built Function(PBF) Listings.ListPbfListingVersionsResponselistPbfListingVersions(ListPbfListingVersionsRequest request)Fetches a wrapped list of all Pre-built Function(PBF) Listing versions.ListTriggersResponselistTriggers(ListTriggersRequest request)Returns a list of Triggers.voidrefreshClient()Rebuild the backingHttpClient.voidsetEndpoint(String endpoint)voidsetRegion(Region region)Sets the region to call (ex, Region.US_PHOENIX_1).voidsetRegion(String regionId)Sets the region to call (ex, ‘us-phoenix-1’).UpdateApplicationResponseupdateApplication(UpdateApplicationRequest request)Modifies an applicationUpdateFunctionResponseupdateFunction(UpdateFunctionRequest request)Modifies a functionvoiduseRealmSpecificEndpointTemplate(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
-
-
-
-
Constructor Detail
-
FunctionsManagementClient
@Deprecated public FunctionsManagementClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeFunctionsManagementClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
-
FunctionsManagementClient
@Deprecated public FunctionsManagementClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeFunctionsManagementClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configuration
-
FunctionsManagementClient
@Deprecated public FunctionsManagementClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeFunctionsManagementClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
-
FunctionsManagementClient
@Deprecated public FunctionsManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeFunctionsManagementClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-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 thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeFunctionsManagementClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfigurators
-
FunctionsManagementClient
@Deprecated public FunctionsManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeFunctionsManagementClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfiguratorsendpoint-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 thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeFunctionsManagementClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfiguratorsendpoint-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 thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeFunctionsManagementClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfiguratorsendpoint-ClientBuilderBase.endpoint(java.lang.String)signingStrategyRequestSignerFactories-ClientBuilderBase.signingStrategyRequestSignerFactoriesexecutorService-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:FunctionsManagementSets the region to call (ex, Region.US_PHOENIX_1).Note, this will call
setEndpointafter resolving the endpoint. If the service is not available in this Region, however, an IllegalArgumentException will be raised.- Specified by:
setRegionin interfaceFunctionsManagement- Parameters:
region- The region of the service.
-
setRegion
public void setRegion(String regionId)
Description copied from interface:FunctionsManagementSets 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 callsetEndpoint.- Specified by:
setRegionin interfaceFunctionsManagement- Parameters:
regionId- The public region ID.
-
changeApplicationCompartment
public ChangeApplicationCompartmentResponse changeApplicationCompartment(ChangeApplicationCompartmentRequest request)
Description copied from interface:FunctionsManagementMoves an application into a different compartment within the same tenancy.For information about moving resources between compartments, see Moving Resources Between Compartments.
- Specified by:
changeApplicationCompartmentin interfaceFunctionsManagement- 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:FunctionsManagementCreates a new application.- Specified by:
createApplicationin interfaceFunctionsManagement- 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:FunctionsManagementCreates a new function.- Specified by:
createFunctionin interfaceFunctionsManagement- 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:FunctionsManagementDeletes an application.- Specified by:
deleteApplicationin interfaceFunctionsManagement- 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:FunctionsManagementDeletes a function.- Specified by:
deleteFunctionin interfaceFunctionsManagement- 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:FunctionsManagementRetrieves an application.- Specified by:
getApplicationin interfaceFunctionsManagement- 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:FunctionsManagementRetrieves a function.- Specified by:
getFunctionin interfaceFunctionsManagement- 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:FunctionsManagementFetches a Pre-built Function(PBF) Listing.Returns a PbfListing response model.
- Specified by:
getPbfListingin interfaceFunctionsManagement- 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:FunctionsManagementGets a PbfListingVersion by identifier for a PbfListing.- Specified by:
getPbfListingVersionin interfaceFunctionsManagement- 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:FunctionsManagementLists applications for a compartment.- Specified by:
listApplicationsin interfaceFunctionsManagement- 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:FunctionsManagementLists functions for an application.- Specified by:
listFunctionsin interfaceFunctionsManagement- 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:FunctionsManagementFetches 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:
listPbfListingVersionsin interfaceFunctionsManagement- 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:FunctionsManagementFetches a wrapped list of all Pre-built Function(PBF) Listings.Returns a PbfListingCollection containing an array of PbfListingSummary response models.
- Specified by:
listPbfListingsin interfaceFunctionsManagement- 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:FunctionsManagementReturns a list of Triggers.- Specified by:
listTriggersin interfaceFunctionsManagement- 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:FunctionsManagementModifies an application- Specified by:
updateApplicationin interfaceFunctionsManagement- 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:FunctionsManagementModifies a function- Specified by:
updateFunctionin interfaceFunctionsManagement- 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:FunctionsManagementGets the pre-configured waiters available for resources for this service.- Specified by:
getWaitersin interfaceFunctionsManagement- Returns:
- The service waiters.
-
getPaginators
public FunctionsManagementPaginators getPaginators()
Description copied from interface:FunctionsManagementGets the pre-configured paginators available for list operations in this service which may return multiple pages of data.These paginators provide an
Iterableinterface so that service responses, or resources/records, can be iterated through without having to manually deal with pagination and page tokens.- Specified by:
getPaginatorsin interfaceFunctionsManagement- Returns:
- The service paginators.
-
getDefaultConfigurator
protected ClientConfigurator getDefaultConfigurator()
-
enableDualStackEndpoints
public void enableDualStackEndpoints(boolean enableDualStackEndpoints)
This method should be used to enable or disable the use of dual-stack endpoints.The default value is false i.e. dual-stack endpoints are disabled by default.
- Parameters:
enableDualStackEndpoints- This flag can be set to true or false to enable or disable the use of dual-stack endpoints respectively
-
getOptionsMap
public Map<String,Boolean> getOptionsMap()
Return an immutable snapshot representing the current options set for this client.- Returns:
- immutable snapshot representing the current options set for this client
-
getResolvedEndpoint
public String getResolvedEndpoint(Map<String,Object> requiredParametersMap)
Returns the endpoint after filling in the current options, as determined byBaseClient.getOptionsMap(), and then filling in the required parameters in requiredParametersMap into the placeholders in the endpoint.- Parameters:
requiredParametersMap- the map from required parameter name to their values- Returns:
- resolved endpoint, with all options and placeholders filled in
-
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
-
setEndpoint
public final void setEndpoint(String endpoint)
-
getEndpoint
public final String getEndpoint()
Get the endpoint of the client.Note that the endpoint may be parameterized and contain placeholders and options. The region subdomain and realm domain will have been properly replaced already if the endpoint was selected using a
Region.Examples of endpoints this may return:
- Unparameterized endpoints
https://identity.us-phoenix-1.oci.oraclecloud.com https://identity.us-ashburn-1.oci.oraclecloud.com https://test-namespace.objectstorage.us-ashburn-1.oci.customer-oci.com - Parameterized endpoints with placeholders
https://{namespaceName+Dot}objectstorage.us-phoenix-1.oci.customer-oci.com https://{namespaceName+Dot}objectstorage.us-ashburn-1.oci.customer-oci.com - Parameterized endpoints with options
https://{dualStack?ds.:}identity.us-phoenix-1.oci.oraclecloud.com https://{dualStack?ds.:}identity.us-ashburn-1.oci.oraclecloud.com - Parameterized endpoints with placeholders and options
https://{namespaceName+Dot}{dualStack?ds.:}objectstorage.us-phoenix-1.oci.customer-oci.com https://{namespaceName+Dot}{dualStack?ds.:}objectstorage.us-ashburn-1.oci.customer-oci.com
To get the actual endpoint for a parameterized request, you can use
BaseClient.getResolvedEndpoint(Map)orParameterizedEndpointUtil.getEndpointWithPopulatedServiceParameters(String, Map, Map).- Returns:
- the endpoint being used by the client
- Unparameterized endpoints
-
refreshClient
public final void refreshClient()
Rebuild the backingHttpClient.This will call
ClientConfigurators again, and can be used to e.g. refresh the SSL certificate.
-
close
public final void close()
- Specified by:
closein interfaceAutoCloseable
-
getClientCommonLibraryVersion
public String getClientCommonLibraryVersion()
-
-