Class AttributesClient
Service client instance for Attributes.
Implements
Inherited Members
Namespace: Oci.ApmtracesService
Assembly: OCI.DotNetSDK.Apmtraces.dll
Syntax
public class AttributesClient : RegionalClientBase, IDisposable
Constructors
AttributesClient(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 AttributesClient(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. |
Methods
BulkActivateAttribute(BulkActivateAttributeRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Activates a set of attributes for the given APM Domain. The API is not case-sensitive. Any duplicates present in the bulk activation request are deduplicated and only unique attributes are activated. A maximum number of 700 string attributes and 100 numeric attributes can be activated in an APM Domain subject to the available string and numeric slots. Once an attribute has been activated, it may take sometime for it to be appear in searches as ingest might not have picked up the changes or any associated caches might not have refreshed. The bulk activation operation is atomic, and the operation succeeds only if all the attributes in the request have been processed successfully and they get a success status back. If the processing of any attribute results in a processing or validation error, then none of the attributes in the bulk request are activated. Attributes that are activated are unpinned by default if they are pinned.
Declaration
public Task<BulkActivateAttributeResponse> BulkActivateAttribute(BulkActivateAttributeRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
BulkActivateAttributeRequest | 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<BulkActivateAttributeResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use BulkActivateAttribute API.
BulkDeActivateAttribute(BulkDeActivateAttributeRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deactivates a set of attributes for the given APM Domain. The API is case in-sensitive. Any duplicates present in the bulk deactivation request are deduplicated and only unique attributes are deactivated. A maximum number of 700 string attributes and 100 numeric attributes can be deactivated in an APM Domain subject to the available string and numeric slots. Out of box attributes (Trace and Span) cannot be deactivated, and will result in a processing error. Once an attribute has been deactivated, it may take sometime for it to disappear in searches as ingest might not have picked up the changes or any associated caches might not have refreshed. The bulk deactivation operation is atomic, and the operation succeeds only if all the attributes in the request have been processed successfully and they get a success status back. If the processing of any attribute results in a processing or validation error, then none of the attributes in the bulk request are deactivated.
Declaration
public Task<BulkDeActivateAttributeResponse> BulkDeActivateAttribute(BulkDeActivateAttributeRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
BulkDeActivateAttributeRequest | 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<BulkDeActivateAttributeResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use BulkDeActivateAttribute API.
BulkPinAttribute(BulkPinAttributeRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Pin a set of attributes in the APM Domain. Attributes that are marked pinned are not autoactivated by ingest. Attributes that are deactivated are pinned by default.
Declaration
public Task<BulkPinAttributeResponse> BulkPinAttribute(BulkPinAttributeRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
BulkPinAttributeRequest | 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<BulkPinAttributeResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use BulkPinAttribute API.
BulkUnpinAttribute(BulkUnpinAttributeRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Unpin a set of attributes in the APM Domain.
Declaration
public Task<BulkUnpinAttributeResponse> BulkUnpinAttribute(BulkUnpinAttributeRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
BulkUnpinAttributeRequest | 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<BulkUnpinAttributeResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use BulkUnpinAttribute API.
BulkUpdateAttribute(BulkUpdateAttributeRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Update a set of attribute properties in the APM Domain.
Declaration
public Task<BulkUpdateAttributeResponse> BulkUpdateAttribute(BulkUpdateAttributeRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
BulkUpdateAttributeRequest | 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<BulkUpdateAttributeResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use BulkUpdateAttribute API.
BulkUpdateAttributeNotes(BulkUpdateAttributeNotesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Add or edit notes to a set of attributes in the APM Domain. Notes can be added to either an active or an inactive attribute. The notes will be preserved even if the attribute changes state (when an active attribute is deactivated or when an inactive attribute is activated).
Declaration
public Task<BulkUpdateAttributeNotesResponse> BulkUpdateAttributeNotes(BulkUpdateAttributeNotesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
BulkUpdateAttributeNotesRequest | 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<BulkUpdateAttributeNotesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use BulkUpdateAttributeNotes API.
GetStatusAutoActivate(GetStatusAutoActivateRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Get autoactivation status for a private data key or public data key in the APM Domain.
Declaration
public Task<GetStatusAutoActivateResponse> GetStatusAutoActivate(GetStatusAutoActivateRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetStatusAutoActivateRequest | 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<GetStatusAutoActivateResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetStatusAutoActivate API.
PutToggleAutoActivate(PutToggleAutoActivateRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Turn on or off autoactivate for private data key or public data key traffic a given APM Domain.
Declaration
public Task<PutToggleAutoActivateResponse> PutToggleAutoActivate(PutToggleAutoActivateRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
PutToggleAutoActivateRequest | 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<PutToggleAutoActivateResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use PutToggleAutoActivate API.