Show / Hide Table of Contents

Class EventClient

Service client instance for Event.

Inheritance
object
ClientBase
RegionalClientBase
EventClient
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.OsmanagementService
Assembly: OCI.DotNetSDK.Osmanagement.dll
Syntax
public class EventClient : RegionalClientBase, IDisposable

Constructors

EventClient(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 EventClient(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 EventPaginators Paginators { get; }
Property Value
Type Description
EventPaginators

Methods

DeleteEventContent(DeleteEventContentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Delete an event content ZIP archive from the service

Declaration
public Task<DeleteEventContentResponse> DeleteEventContent(DeleteEventContentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
DeleteEventContentRequest 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<DeleteEventContentResponse>

A response object containing details about the completed operation

Examples

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

GetEvent(GetEventRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets an Event by identifier

Declaration
public Task<GetEventResponse> GetEvent(GetEventRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
GetEventRequest 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<GetEventResponse>

A response object containing details about the completed operation

Examples

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

GetEventContent(GetEventContentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Get additional data about a event as a ZIP archive. The archive content depends on the event eventType.

Declaration
public Task<GetEventContentResponse> GetEventContent(GetEventContentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
GetEventContentRequest 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<GetEventContentResponse>

A response object containing details about the completed operation

Examples

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

GetEventReport(GetEventReportRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Get summary information about events on this instance.

Declaration
public Task<GetEventReportResponse> GetEventReport(GetEventReportRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
GetEventReportRequest 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<GetEventReportResponse>

A response object containing details about the completed operation

Examples

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

ListEvents(ListEventsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns a list of Events.

Declaration
public Task<ListEventsResponse> ListEvents(ListEventsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ListEventsRequest 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<ListEventsResponse>

A response object containing details about the completed operation

Examples

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

ListRelatedEvents(ListRelatedEventsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns a list of related events. For now pagination is not implemented.

Declaration
public Task<ListRelatedEventsResponse> ListRelatedEvents(ListRelatedEventsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ListRelatedEventsRequest 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<ListRelatedEventsResponse>

A response object containing details about the completed operation

Examples

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

UpdateEvent(UpdateEventRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates an existing event associated to a managed instance

Declaration
public Task<UpdateEventResponse> UpdateEvent(UpdateEventRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
UpdateEventRequest 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<UpdateEventResponse>

A response object containing details about the completed operation

Examples

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

UploadEventContent(UploadEventContentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Upload the event content as a ZIP archive from the managed instance to the service

Declaration
public Task<UploadEventContentResponse> UploadEventContent(UploadEventContentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
UploadEventContentRequest 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<UploadEventContentResponse>

A response object containing details about the completed operation

Examples

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

Implements

IDisposable
In this article
Back to top