Class EventsClient

Service client instance for Events.

Inheritance

object

ClientBase

RegionalClientBase

EventsClient

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

Assembly: OCI.DotNetSDK.Events.dll

Syntax

public class EventsClient : RegionalClientBase, IDisposable

Constructors

EventsClient(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 EventsClient(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 EventsPaginators Paginators { get; }

Property Value

Type	Description
EventsPaginators

Waiters

Declaration

public EventsWaiters Waiters { get; }

Property Value

Type	Description
EventsWaiters

Methods

ChangeRuleCompartment(ChangeRuleCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Moves a rule 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<ChangeRuleCompartmentResponse> ChangeRuleCompartment(ChangeRuleCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

CreateRule(CreateRuleRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a new rule.

Declaration

public Task<CreateRuleResponse> CreateRule(CreateRuleRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

DeleteRule(DeleteRuleRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes a rule.

Declaration

public Task<DeleteRuleResponse> DeleteRule(DeleteRuleRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

GetRule(GetRuleRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Retrieves a rule.

Declaration

public Task<GetRuleResponse> GetRule(GetRuleRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

ListRules(ListRulesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists rules for this compartment.

Declaration

public Task<ListRulesResponse> ListRules(ListRulesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

UpdateRule(UpdateRuleRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates a rule.

Declaration

public Task<UpdateRuleResponse> UpdateRule(UpdateRuleRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

Implements

IDisposable