Relativity.Services.Interfaces.ResourceServer.ICacheLocationServerManager

public interface ICacheLocationServerManager : IDisposable

Exposes methods for working with cache location server objects.

Documentation

Task<CacheLocationServerResponse> CreateAsync(CacheLocationServerRequest request)

Adds a cache location server to Relativity.

Task DeleteAsync(int serverID)

Deletes a cache location server.

Task<Meta> GetMetadataAsync()

Returns a list of unsupported and read-only properties for a new cache location server.

Task<bool> IsLastVisibleServerAsync(int serverID)

Returns boolean value representing whether given cache location server is visible and whether it is the last visible among all cache location servers. Visible server means that it can be chosen while creating a workspace.

Task<QueryResultSlim> QueryEligibleFileAccessCredentialsAsync(QueryRequest request, int start, int length)

Performs a Query for eligible file access credentials.

Task<QueryResultSlim> QueryEligibleFileAccessCredentialsAsync(QueryRequest request, int start, int length, IProgress<ProgressReport> progress)

Performs a Query for eligible file access credentials and returns progress information.

Task<QueryResultSlim> QueryEligibleFileAccessCredentialsAsync(QueryRequest request, int start, int length, CancellationToken cancel, IProgress<ProgressReport> progress)

Performs a Query for eligible file access credentials, provides a token used for canceling the operation, and returns progress information.

Task<CacheLocationServerResponse> ReadAsync(int serverID)

Retrieves data for a cache location server.

Task<CacheLocationServerResponse> ReadAsync(int serverID, bool includeMetadata, bool includeActions)

Retrieves data for a cache location server.

Task<CacheLocationServerResponse> UpdateAsync(int serverID, CacheLocationServerRequest request)

Modifies properties of a cache location server.

Task<CacheLocationServerResponse> UpdateAsync(int serverID, CacheLocationServerRequest request, DateTime lastModifiedOn)

Modifies properties of a cache location server.