Class LogStreamsClient

Namespace

Auth0.ManagementApi.Clients

Assembly

Auth0.ManagementApi.dll

Contains methods to access the /log-streams endpoint

public class LogStreamsClient : BaseClient, ILogStreamsClient

Inheritance

object

BaseClient

LogStreamsClient

Implements

ILogStreamsClient

Inherited Members

BaseClient.Connection

BaseClient.BaseUri

BaseClient.DefaultHeaders

BaseClient.BuildUri(string, IDictionary<string, string>)

BaseClient.EncodePath(string)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

LogStreamsClient(IManagementConnection, Uri, IDictionary<string, string>)

Initializes a new instance of LogStreamsClient

public LogStreamsClient(IManagementConnection connection, Uri baseUri, IDictionary<string, string> defaultHeaders)

Parameters

connection IManagementConnection

IManagementConnection used to make all API calls.

baseUri Uri

Uri of the endpoint to use in making API calls.

defaultHeaders IDictionary<string, string>

Dictionary containing default headers included with every request this client makes.

Methods

CreateAsync(LogStreamCreateRequest, CancellationToken)

Creates a new log stream

public 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

public 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

public 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

public 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

public 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