Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LoggingManagementClient

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

  • LoggingManagementClient

Constructors

Properties

Accessors

Methods

Constructors

constructor

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

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

targetService

targetService: string = "LoggingManagement"

Static Protected endpointServiceName

endpointServiceName: string = ""

Static Protected serviceEndpointTemplate

serviceEndpointTemplate: string = "https://logging.{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

changeLogGroupCompartment

changeLogLogGroup

  • Moves a log into a different log group within the same tenancy. When provided, the If-Match is checked against the ETag values of the resource.

    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 ChangeLogLogGroup API.

    Parameters

    Returns Promise<ChangeLogLogGroupResponse>

    ChangeLogLogGroupResponse

changeLogSavedSearchCompartment

changeUnifiedAgentConfigurationCompartment

close

  • close(): void

createLog

  • Creates a log within the specified log group. This call fails if a log group has already been created with the same displayName or (service, resource, category) triplet.

    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 CreateLog API.

    Parameters

    Returns Promise<CreateLogResponse>

    CreateLogResponse

createLogGroup

  • Create a new log group with a unique display name. This call fails if the log group is already created with the same displayName in the 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 CreateLogGroup API.

    Parameters

    Returns Promise<CreateLogGroupResponse>

    CreateLogGroupResponse

createLogSavedSearch

createUnifiedAgentConfiguration

createWaiters

  • Creates a new LoggingManagementWaiter for resources for this service.

    Parameters

    • Optional config: common.WaiterConfiguration

      The waiter configuration for termination and delay strategy

    Returns LoggingManagementWaiter

    The service waiters.

deleteLog

  • Deletes the log object in a log group. 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 DeleteLog API.

    Parameters

    Returns Promise<DeleteLogResponse>

    DeleteLogResponse

deleteLogGroup

deleteLogSavedSearch

deleteUnifiedAgentConfiguration

deleteWorkRequest

getLog

  • Gets the log object configuration for the log object OCID.

    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 GetLog API.

    Parameters

    Returns Promise<GetLogResponse>

    GetLogResponse

getLogGroup

  • Get the specified log group's information. 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 GetLogGroup API.

    Parameters

    Returns Promise<GetLogGroupResponse>

    GetLogGroupResponse

getLogSavedSearch

getUnifiedAgentConfiguration

getWaiters

getWorkRequest

  • Gets the details of the work request with the given ID. 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 GetWorkRequest API.

    Parameters

    Returns Promise<GetWorkRequestResponse>

    GetWorkRequestResponse

listAllLogGroups

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

    Parameters

    Returns AsyncIterableIterator<LogGroupSummary>

listAllLogGroupsResponses

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

    Parameters

    Returns AsyncIterableIterator<ListLogGroupsResponse>

listAllLogs

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

    Parameters

    • request: ListLogsRequest

      a request which can be sent to the service operation

    Returns AsyncIterableIterator<LogSummary>

listAllLogsResponses

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

    Parameters

    • request: ListLogsRequest

      a request which can be sent to the service operation

    Returns AsyncIterableIterator<ListLogsResponse>

listAllWorkRequestErrors

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

    Parameters

    Returns AsyncIterableIterator<WorkRequestError>

listAllWorkRequestErrorsResponses

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

    Parameters

    Returns AsyncIterableIterator<ListWorkRequestErrorsResponse>

listAllWorkRequestLogs

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

    Parameters

    Returns AsyncIterableIterator<WorkRequestLog>

listAllWorkRequestLogsResponses

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

    Parameters

    Returns AsyncIterableIterator<ListWorkRequestLogsResponse>

listAllWorkRequests

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

    Parameters

    Returns AsyncIterableIterator<WorkRequestSummary>

listAllWorkRequestsResponses

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

    Parameters

    Returns AsyncIterableIterator<ListWorkRequestsResponse>

listLogGroups

  • Lists all log groups for the specified compartment or tenancy. 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 ListLogGroups API.

    Parameters

    Returns Promise<ListLogGroupsResponse>

    ListLogGroupsResponse

listLogGroupsRecordIterator

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

    Parameters

    Returns AsyncIterableIterator<LogGroupSummary>

listLogGroupsResponseIterator

listLogSavedSearches

listLogs

  • Lists the specified log group's log objects. 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 ListLogs API.

    Parameters

    Returns Promise<ListLogsResponse>

    ListLogsResponse

listLogsRecordIterator

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

    Parameters

    • request: ListLogsRequest

      a request which can be sent to the service operation

    Returns AsyncIterableIterator<LogSummary>

listLogsResponseIterator

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

    Parameters

    • request: ListLogsRequest

      a request which can be sent to the service operation

    Returns AsyncIterableIterator<ListLogsResponse>

listServices

  • Lists all services that support logging. 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 ListServices API.

    Parameters

    Returns Promise<ListServicesResponse>

    ListServicesResponse

listUnifiedAgentConfigurations

listWorkRequestErrors

listWorkRequestErrorsRecordIterator

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

    Parameters

    Returns AsyncIterableIterator<WorkRequestError>

listWorkRequestErrorsResponseIterator

listWorkRequestLogs

listWorkRequestLogsRecordIterator

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

    Parameters

    Returns AsyncIterableIterator<WorkRequestLog>

listWorkRequestLogsResponseIterator

listWorkRequests

listWorkRequestsRecordIterator

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

    Parameters

    Returns AsyncIterableIterator<WorkRequestSummary>

listWorkRequestsResponseIterator

shutdownCircuitBreaker

  • shutdownCircuitBreaker(): void

updateLog

  • Updates the existing log object with the associated configuration. This call fails if the log object does not exist.

    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 UpdateLog API.

    Parameters

    Returns Promise<UpdateLogResponse>

    UpdateLogResponse

updateLogGroup

  • Updates the existing log group with the associated configuration. This call fails if the log group does not exist.

    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 UpdateLogGroup API.

    Parameters

    Returns Promise<UpdateLogGroupResponse>

    UpdateLogGroupResponse

updateLogSavedSearch

updateUnifiedAgentConfiguration