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

Assembly: OCI.DotNetSDK.Osmanagementhub.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

Waiters

Declaration

public EventWaiters Waiters { get; }

Property Value

Type	Description
EventWaiters

Methods

ChangeEventCompartment(ChangeEventCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Moves an event into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.

Declaration

public Task<ChangeEventCompartmentResponse> ChangeEventCompartment(ChangeEventCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

DeleteEvent(DeleteEventRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes the specified event.

Declaration

public Task<DeleteEventResponse> DeleteEvent(DeleteEventRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

DeleteEventContent(DeleteEventContentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes 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)

Returns information about the specified event.

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)

Returns a ZIP archive with additional information about an event. The archive content depends on the event type.

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.

ImportEventContent(ImportEventContentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Uploads an event content ZIP archive from an instance to the service.

Declaration

public Task<ImportEventContentResponse> ImportEventContent(ImportEventContentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

ListEvents(ListEventsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists events that match the specified criteria, such as compartment, state, and event type.

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.

UpdateEvent(UpdateEventRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates the tags for an event.

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.

Implements

IDisposable