Class ConfigClient

Service client instance for Config.

Inheritance

object

ClientBase

RegionalClientBase

ConfigClient

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.ApmconfigService

Assembly: OCI.DotNetSDK.Apmconfig.dll

Syntax

public class ConfigClient : RegionalClientBase, IDisposable

Constructors

ConfigClient(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 ConfigClient(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 ConfigPaginators Paginators { get; }

Property Value

Type	Description
ConfigPaginators

Methods

CopyConfiguration(CopyConfigurationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Fast importing configuration items to a destination APM domain ID.

Declaration

public Task<CopyConfigurationResponse> CopyConfiguration(CopyConfigurationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CopyConfigurationRequest	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<CopyConfigurationResponse>	A response object containing details about the completed operation

Examples

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

CreateConfig(CreateConfigRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a new configuration item.

Declaration

public Task<CreateConfigResponse> CreateConfig(CreateConfigRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateConfigRequest	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<CreateConfigResponse>	A response object containing details about the completed operation

Examples

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

DeleteConfig(DeleteConfigRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes the configuration item identified by the OCID.

Declaration

public Task<DeleteConfigResponse> DeleteConfig(DeleteConfigRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteConfigRequest	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<DeleteConfigResponse>	A response object containing details about the completed operation

Examples

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

ExportConfiguration(ExportConfigurationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Exports configurations for the whole domain by domainId.

Declaration

public Task<ExportConfigurationResponse> ExportConfiguration(ExportConfigurationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ExportConfigurationRequest	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<ExportConfigurationResponse>	A response object containing details about the completed operation

Examples

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

GetConfig(GetConfigRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets the configuration item identified by the OCID.

Declaration

public Task<GetConfigResponse> GetConfig(GetConfigRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetConfigRequest	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<GetConfigResponse>	A response object containing details about the completed operation

Examples

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

ImportConfiguration(ImportConfigurationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Import configurations Item(s) with its dependencies into a destination domain.

Declaration

public Task<ImportConfigurationResponse> ImportConfiguration(ImportConfigurationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ImportConfigurationRequest	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<ImportConfigurationResponse>	A response object containing details about the completed operation

Examples

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

ListConfigs(ListConfigsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns all configuration items, which can optionally be filtered by configuration type.

Declaration

public Task<ListConfigsResponse> ListConfigs(ListConfigsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListConfigsRequest	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<ListConfigsResponse>	A response object containing details about the completed operation

Examples

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

RetrieveNamespaceMetrics(RetrieveNamespaceMetricsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns all metrics associated with the specified namespace.

Declaration

public Task<RetrieveNamespaceMetricsResponse> RetrieveNamespaceMetrics(RetrieveNamespaceMetricsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
RetrieveNamespaceMetricsRequest	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<RetrieveNamespaceMetricsResponse>	A response object containing details about the completed operation

Examples

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

RetrieveNamespaces(RetrieveNamespacesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns all namespaces available in APM.

Declaration

public Task<RetrieveNamespacesResponse> RetrieveNamespaces(RetrieveNamespacesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
RetrieveNamespacesRequest	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<RetrieveNamespacesResponse>	A response object containing details about the completed operation

Examples

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

Test(TestRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Tests a data processing operation on the provided input, returning the potentially modified input as output. Returns 200 on success, 422 when the input can not be processed.

Declaration

public Task<TestResponse> Test(TestRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
TestRequest	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<TestResponse>	A response object containing details about the completed operation

Examples

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

UpdateConfig(UpdateConfigRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates the details of the configuration item identified by the OCID.

Declaration

public Task<UpdateConfigResponse> UpdateConfig(UpdateConfigRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
UpdateConfigRequest	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<UpdateConfigResponse>	A response object containing details about the completed operation

Examples

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

ValidateSpanFilterPattern(ValidateSpanFilterPatternRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Validates the Span Filter pattern (filterText) for syntactic correctness. Returns 204 on success, 422 when validation fails.

Declaration

public Task<ValidateSpanFilterPatternResponse> ValidateSpanFilterPattern(ValidateSpanFilterPatternRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ValidateSpanFilterPatternRequest	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<ValidateSpanFilterPatternResponse>	A response object containing details about the completed operation

Examples

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

Implements

IDisposable