Class ThreatintelClient
Service client instance for Threatintel.
Implements
Inherited Members
Namespace: Oci.ThreatintelligenceService
Assembly: OCI.DotNetSDK.Threatintelligence.dll
Syntax
public class ThreatintelClient : RegionalClientBase, IDisposable
Constructors
ThreatintelClient(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 ThreatintelClient(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 ThreatintelPaginators Paginators { get; }
Property Value
Type | Description |
---|---|
ThreatintelPaginators |
Waiters
Declaration
public ThreatintelWaiters Waiters { get; }
Property Value
Type | Description |
---|---|
ThreatintelWaiters |
Methods
GetIndicator(GetIndicatorRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Get detailed information about a threat indicator with a given identifier.
Declaration
public Task<GetIndicatorResponse> GetIndicator(GetIndicatorRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetIndicatorRequest | 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<GetIndicatorResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetIndicator API.
ListIndicatorCounts(ListIndicatorCountsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Get the current count of each threat indicator type. Indicator counts can be sorted in ascending or descending order.
Declaration
public Task<ListIndicatorCountsResponse> ListIndicatorCounts(ListIndicatorCountsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListIndicatorCountsRequest | 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<ListIndicatorCountsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListIndicatorCounts API.
ListIndicators(ListIndicatorsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Get a list of threat indicator summaries based on the search criteria.
Declaration
public Task<ListIndicatorsResponse> ListIndicators(ListIndicatorsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListIndicatorsRequest | 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<ListIndicatorsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListIndicators API.
ListThreatTypes(ListThreatTypesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets a list of threat types that are available to use as parameters when querying indicators. The list is sorted by threat type name according to the sort order query param.
Declaration
public Task<ListThreatTypesResponse> ListThreatTypes(ListThreatTypesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListThreatTypesRequest | 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<ListThreatTypesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListThreatTypes API.
SummarizeIndicators(SummarizeIndicatorsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Get indicator summaries based on advanced search criteria.
Declaration
public Task<SummarizeIndicatorsResponse> SummarizeIndicators(SummarizeIndicatorsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
SummarizeIndicatorsRequest | 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<SummarizeIndicatorsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use SummarizeIndicators API.