Class CorpusPermissionClient
- Namespace
- GenerativeAI.Clients
- Assembly
- GenerativeAI.dll
A client for interacting with the Corpus Permissions endpoint.
public class CorpusPermissionClient : BaseClient
- Inheritance
-
CorpusPermissionClient
- Inherited Members
- Extension Methods
Constructors
CorpusPermissionClient(IPlatformAdapter, HttpClient?, ILogger?)
Provides operations for managing permissions in a corpus using the Corpus Permissions API.
public CorpusPermissionClient(IPlatformAdapter platform, HttpClient? httpClient = null, ILogger? logger = null)
Parameters
platformIPlatformAdapterhttpClientHttpClientloggerILogger
Methods
AddAuthorizationHeader(HttpRequestMessage, bool, CancellationToken)
Adds authorization headers to an HTTP request.
protected override Task AddAuthorizationHeader(HttpRequestMessage request, bool requireAccessToken = false, CancellationToken cancellationToken = default)
Parameters
requestHttpRequestMessageThe HTTP request where headers will be added.
requireAccessTokenboolWhether an access token is required for the request.
cancellationTokenCancellationTokenToken to monitor for cancellation requests.
Returns
Remarks
Override this method in derived classes to dynamically add authorization headers. By default, this implementation does nothing.
CreatePermissionAsync(string, Permission, CancellationToken)
Creates a new Permission resource.
public Task<Permission?> CreatePermissionAsync(string parent, Permission permission, CancellationToken cancellationToken = default)
Parameters
parentstringThe parent resource of the Permission.
permissionPermissionThe Permission to create.
cancellationTokenCancellationTokenThe cancellation token to cancel the operation.
Returns
- Task<Permission>
The created Permission.
- See Also
DeletePermissionAsync(string, CancellationToken)
Deletes a Permission resource.
public Task DeletePermissionAsync(string name, CancellationToken cancellationToken = default)
Parameters
namestringThe resource name of the Permission to delete.
cancellationTokenCancellationTokenThe cancellation token to cancel the operation.
Returns
- Task
A task representing the asynchronous operation.
- See Also
GetPermissionAsync(string, CancellationToken)
Gets a specific Permission resource.
public Task<Permission?> GetPermissionAsync(string name, CancellationToken cancellationToken = default)
Parameters
namestringThe resource name of the Permission.
cancellationTokenCancellationTokenThe cancellation token to cancel the operation.
Returns
- Task<Permission>
The Permission resource.
- See Also
ListPermissionsAsync(string, int?, string?, CancellationToken)
Lists available Permission resources.
public Task<ListPermissionsResponse?> ListPermissionsAsync(string parent, int? pageSize = null, string? pageToken = null, CancellationToken cancellationToken = default)
Parameters
parentstringThe parent resource of the permissions.
pageSizeint?The maximum number of Permission resources to return.
pageTokenstringA page token, received from a previous ListPermissionsAsync(string, int?, string?, CancellationToken) call.
cancellationTokenCancellationTokenThe cancellation token to cancel the operation.
Returns
- Task<ListPermissionsResponse>
A list of Permission resources.
- See Also
UpdatePermissionAsync(string, Permission, string?, CancellationToken)
Updates a Permission resource.
public Task<Permission?> UpdatePermissionAsync(string permissionName, Permission permission, string? updateMask = null, CancellationToken cancellationToken = default)
Parameters
permissionNamestringThe resource name of the permission.
permissionPermissionThe Permission resource to update.
updateMaskstringThe list of fields to update.
cancellationTokenCancellationTokenThe cancellation token to cancel the operation.
Returns
- Task<Permission>
The updated Permission resource.
- See Also