Options
All
  • Public
  • Public/Protected
  • All
Menu

Class EventsClient

This service client uses {@link common.CircuitBreaker.DefaultConfiguration} for all the operations by default if no circuit breaker configuration is defined by the user.

Hierarchy

  • EventsClient

Constructors

constructor

  • new EventsClient(params: common.AuthParams, clientConfiguration?: common.ClientConfiguration): EventsClient

Properties

Protected _bodyDuplexMode

_bodyDuplexMode: any = undefined

Protected _circuitBreaker

_circuitBreaker: typeof Breaker | null = null

Protected _clientConfiguration

_clientConfiguration: ClientConfiguration

Protected _defaultHeaders

_defaultHeaders: any

Protected _endpoint

_endpoint: string = ""

Protected _httpClient

_httpClient: HttpClient

Protected _httpOptions

_httpOptions: any = undefined

Protected _lastSetRegionOrRegionId

_lastSetRegionOrRegionId: string = ""

Protected _realmSpecificEndpointTemplateEnabled

_realmSpecificEndpointTemplateEnabled: boolean | undefined = undefined

Protected _region

_region: Region

Protected _regionId

_regionId: string = ""

Protected _waiters

_waiters: EventsWaiter

targetService

targetService: string = "Events"

Static Protected endpointServiceName

endpointServiceName: string = ""

Static Protected serviceEndpointTemplate

serviceEndpointTemplate: string = "https://events.{region}.oci.{secondLevelDomain}"

Accessors

endpoint

  • get endpoint(): string
  • set endpoint(endpoint: string): void

logger

region

  • set region(region: Region): void
  • Sets the region to call (ex, Region.US_PHOENIX_1). Note, this will call {@link #endpoint(String) endpoint} after resolving the endpoint.

    Parameters

    • region: Region

      The region of the service.

    Returns void

regionId

  • set regionId(regionId: string): void
  • Sets the regionId to call (ex, 'us-phoenix-1').

    Note, this will first try to map the region ID to a known Region and call {@link #region(Region) region}. If no known Region could be determined, it will create an endpoint assuming its in default Realm OC1 and then call {@link #endpoint(String) endpoint}.

    Parameters

    • regionId: string

      The public region ID.

    Returns void

useRealmSpecificEndpointTemplate

  • set useRealmSpecificEndpointTemplate(realmSpecificEndpointTemplateEnabled: boolean): void
  • Determines whether realm specific endpoint should be used or not. Set realmSpecificEndpointTemplateEnabled to "true" if the user wants to enable use of realm specific endpoint template, otherwise set it to "false"

    Parameters

    • realmSpecificEndpointTemplateEnabled: boolean

      flag to enable the use of realm specific endpoint template

    Returns void

Methods

changeRuleCompartment

close

  • close(): void

createRule

  • Creates a new rule.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateRule API.

    Parameters

    Returns Promise<CreateRuleResponse>

    CreateRuleResponse

createWaiters

  • createWaiters(config?: common.WaiterConfiguration): EventsWaiter
  • Creates a new EventsWaiter for resources for this service.

    Parameters

    • Optional config: common.WaiterConfiguration

      The waiter configuration for termination and delay strategy

    Returns EventsWaiter

    The service waiters.

deleteRule

getRule

  • Retrieves a rule. This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetRule API.

    Parameters

    Returns Promise<GetRuleResponse>

    GetRuleResponse

getWaiters

listAllRules

  • NOTE: This function is deprecated in favor of listRulesRecordIterator function. Creates a new async iterator which will iterate over the models.RuleSummary objects contained in responses from the listRules operation. This iterator will fetch more data from the server as needed.

    Parameters

    • request: ListRulesRequest

      a request which can be sent to the service operation

    Returns AsyncIterableIterator<RuleSummary>

listAllRulesResponses

  • NOTE: This function is deprecated in favor of listRulesResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listRules operation. This iterator will fetch more data from the server as needed.

    Parameters

    • request: ListRulesRequest

      a request which can be sent to the service operation

    Returns AsyncIterableIterator<ListRulesResponse>

listRules

  • Lists rules for this compartment.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListRules API.

    Parameters

    Returns Promise<ListRulesResponse>

    ListRulesResponse

listRulesRecordIterator

  • Creates a new async iterator which will iterate over the models.RuleSummary objects contained in responses from the listRules operation. This iterator will fetch more data from the server as needed.

    Parameters

    • request: ListRulesRequest

      a request which can be sent to the service operation

    Returns AsyncIterableIterator<RuleSummary>

listRulesResponseIterator

  • Creates a new async iterator which will iterate over the responses received from the listRules operation. This iterator will fetch more data from the server as needed.

    Parameters

    • request: ListRulesRequest

      a request which can be sent to the service operation

    Returns AsyncIterableIterator<ListRulesResponse>

shutdownCircuitBreaker

  • shutdownCircuitBreaker(): void

updateRule