Class FunctionsManagementClient

Service client instance for FunctionsManagement.

Inheritance

object

ClientBase

RegionalClientBase

FunctionsManagementClient

Implements

IDisposable

Inherited Members

RegionalClientBase.logger

RegionalClientBase.SetRegion(Region)

RegionalClientBase.SetRegion(string)

RegionalClientBase.UseRealmSpecificEndpointTemplate(bool)

RegionalClientBase.PopulateServiceParametersInEndpointTemplate(RestClient, Dictionary<string, object>)

RegionalClientBase.parseEndpointForParameters(string)

ClientBase.restClient

ClientBase.service

ClientBase.userAgent

ClientBase.Dispose()

ClientBase.Dispose(bool)

ClientBase.SetEndpoint(string)

ClientBase.GetEndpoint()

ClientBase.GetUserAgent()

ClientBase.SetRealmSpecificEndpointTemplate(string)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.FunctionsService

Assembly: OCI.DotNetSDK.Functions.dll

Syntax

public class FunctionsManagementClient : RegionalClientBase, IDisposable

Constructors

FunctionsManagementClient(IBasicAuthenticationDetailsProvider, ClientConfiguration, string)

Creates a new service instance using the given authentication provider and/or client configuration and/or endpoint. A client configuration can also be provided optionally to adjust REST client behaviors.

Declaration

public FunctionsManagementClient(IBasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration clientConfiguration = null, string endpoint = null)

Parameters

Type	Name	Description
IBasicAuthenticationDetailsProvider	authenticationDetailsProvider	The authentication details provider. Required.
ClientConfiguration	clientConfiguration	The client configuration that contains settings to adjust REST client behaviors. Optional.
string	endpoint	The endpoint of the service. If not provided and the client is a regional client, the endpoint will be constructed based on region information. Optional.

Properties

Paginators

Declaration

public FunctionsManagementPaginators Paginators { get; }

Property Value

Type	Description
FunctionsManagementPaginators

Waiters

Declaration

public FunctionsManagementWaiters Waiters { get; }

Property Value

Type	Description
FunctionsManagementWaiters

Methods

ChangeApplicationCompartment(ChangeApplicationCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Moves an application into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources Between Compartments.

Declaration

public Task<ChangeApplicationCompartmentResponse> ChangeApplicationCompartment(ChangeApplicationCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ChangeApplicationCompartmentRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ChangeApplicationCompartmentResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ChangeApplicationCompartment API.

CreateApplication(CreateApplicationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a new application.

Declaration

public Task<CreateApplicationResponse> CreateApplication(CreateApplicationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateApplicationRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<CreateApplicationResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateApplication API.

CreateFunction(CreateFunctionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a new function.

Declaration

public Task<CreateFunctionResponse> CreateFunction(CreateFunctionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateFunctionRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<CreateFunctionResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateFunction API.

DeleteApplication(DeleteApplicationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes an application.

Declaration

public Task<DeleteApplicationResponse> DeleteApplication(DeleteApplicationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteApplicationRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<DeleteApplicationResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteApplication API.

DeleteFunction(DeleteFunctionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes a function.

Declaration

public Task<DeleteFunctionResponse> DeleteFunction(DeleteFunctionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteFunctionRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<DeleteFunctionResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteFunction API.

GetApplication(GetApplicationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Retrieves an application.

Declaration

public Task<GetApplicationResponse> GetApplication(GetApplicationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetApplicationRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetApplicationResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetApplication API.

GetFunction(GetFunctionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Retrieves a function.

Declaration

public Task<GetFunctionResponse> GetFunction(GetFunctionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetFunctionRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetFunctionResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetFunction API.

GetPbfListing(GetPbfListingRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Fetches a Pre-built Function(PBF) Listing. Returns a PbfListing response model.

Declaration

public Task<GetPbfListingResponse> GetPbfListing(GetPbfListingRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetPbfListingRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetPbfListingResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetPbfListing API.

GetPbfListingVersion(GetPbfListingVersionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets a PbfListingVersion by identifier for a PbfListing.

Declaration

public Task<GetPbfListingVersionResponse> GetPbfListingVersion(GetPbfListingVersionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetPbfListingVersionRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetPbfListingVersionResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetPbfListingVersion API.

ListApplications(ListApplicationsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists applications for a compartment.

Declaration

public Task<ListApplicationsResponse> ListApplications(ListApplicationsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListApplicationsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListApplicationsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListApplications API.

ListFunctions(ListFunctionsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists functions for an application.

Declaration

public Task<ListFunctionsResponse> ListFunctions(ListFunctionsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListFunctionsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListFunctionsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListFunctions API.

ListPbfListingVersions(ListPbfListingVersionsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Fetches a wrapped list of all Pre-built Function(PBF) Listing versions. Returns a PbfListingVersionCollection containing an array of PbfListingVersionSummary response models. <br/> Note that the PbfListingIdentifier must be provided as a query parameter, otherwise an exception shall be thrown.

Declaration

public Task<ListPbfListingVersionsResponse> ListPbfListingVersions(ListPbfListingVersionsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListPbfListingVersionsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListPbfListingVersionsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListPbfListingVersions API.

ListPbfListings(ListPbfListingsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Fetches a wrapped list of all Pre-built Function(PBF) Listings. Returns a PbfListingCollection containing an array of PbfListingSummary response models.

Declaration

public Task<ListPbfListingsResponse> ListPbfListings(ListPbfListingsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListPbfListingsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListPbfListingsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListPbfListings API.

ListTriggers(ListTriggersRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns a list of Triggers.

Declaration

public Task<ListTriggersResponse> ListTriggers(ListTriggersRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListTriggersRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListTriggersResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListTriggers API.

UpdateApplication(UpdateApplicationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Modifies an application

Declaration

public Task<UpdateApplicationResponse> UpdateApplication(UpdateApplicationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
UpdateApplicationRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<UpdateApplicationResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use UpdateApplication API.

UpdateFunction(UpdateFunctionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Modifies a function

Declaration

public Task<UpdateFunctionResponse> UpdateFunction(UpdateFunctionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
UpdateFunctionRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<UpdateFunctionResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use UpdateFunction API.

Implements

IDisposable