Interface ILogStreamsClient

Namespace

Auth0.ManagementApi.Clients

Assembly

Auth0.ManagementApi.dll

public interface ILogStreamsClient

Methods

CreateAsync(LogStreamCreateRequest, CancellationToken)

Creates a new log stream

Task<LogStream> CreateAsync(LogStreamCreateRequest request, CancellationToken cancellationToken = default)

Parameters

request LogStreamCreateRequest

The LogStreamCreateRequest containing the information needed to create the log stream

cancellationToken CancellationToken

The cancellation token to cancel operation.

Returns

Task<LogStream>

A Task that represents the asynchronous create operation.

DeleteAsync(string, CancellationToken)

Deletes a log stream

Task DeleteAsync(string id, CancellationToken cancellationToken = default)

Parameters

id string

The id of the log stream to delete

cancellationToken CancellationToken

The cancellation token to cancel operation.

Returns

Task

A Task that represents the asynchronous delete operation.

GetAllAsync(CancellationToken)

Gets all of the log streams

Task<IList<LogStream>> GetAllAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Returns

Task<IList<LogStream>>

A list of LogStream objects

GetAsync(string, CancellationToken)

Gets a log stream

Task<LogStream> GetAsync(string id, CancellationToken cancellationToken = default)

Parameters

id string

The id of the log stream to get

cancellationToken CancellationToken

The cancellation token to cancel operation.

Returns

Task<LogStream>

A LogStream object

UpdateAsync(string, LogStreamUpdateRequest, CancellationToken)

Updates a log stream

Task<LogStream> UpdateAsync(string id, LogStreamUpdateRequest request, CancellationToken cancellationToken = default)

Parameters

id string

The id of the log stream to update

request LogStreamUpdateRequest

The information required to update the log stream

cancellationToken CancellationToken

The cancellation token to cancel operation.

Returns

Task<LogStream>

The updated LogStream object