Chronicle v1 API - Class DataAccessControlService.DataAccessControlServiceBase (1.0.0-beta02)

[BindServiceMethod(typeof(DataAccessControlService), "BindService")]
public abstract class DataAccessControlService.DataAccessControlServiceBase

Reference documentation and code samples for the Chronicle v1 API class DataAccessControlService.DataAccessControlServiceBase.

Base class for server-side implementations of DataAccessControlService

Inheritance

object > DataAccessControlService.DataAccessControlServiceBase

Namespace

Google.Cloud.Chronicle.V1

Assembly

Google.Cloud.Chronicle.V1.dll

Methods

CreateDataAccessLabel(CreateDataAccessLabelRequest, ServerCallContext)

public virtual Task<DataAccessLabel> CreateDataAccessLabel(CreateDataAccessLabelRequest request, ServerCallContext context)

Creates a data access label. Data access labels are applied to incoming event data and selected in data access scopes (another resource), and only users with scopes containing the label can see data with that label. Currently, the data access label resource only includes custom labels, which are labels that correspond to UDM queries over event data.

Parameters
Name Description
request CreateDataAccessLabelRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskDataAccessLabel

The response to send back to the client (wrapped by a task).

CreateDataAccessScope(CreateDataAccessScopeRequest, ServerCallContext)

public virtual Task<DataAccessScope> CreateDataAccessScope(CreateDataAccessScopeRequest request, ServerCallContext context)

Creates a data access scope. Data access scope is a combination of allowed and denied labels attached to a permission group. If a scope has allowed labels A and B and denied labels C and D, then the group of people attached to the scope will have permissions to see all events labeled with A or B (or both) and not labeled with either C or D.

Parameters
Name Description
request CreateDataAccessScopeRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskDataAccessScope

The response to send back to the client (wrapped by a task).

DeleteDataAccessLabel(DeleteDataAccessLabelRequest, ServerCallContext)

public virtual Task<Empty> DeleteDataAccessLabel(DeleteDataAccessLabelRequest request, ServerCallContext context)

Deletes a data access label. When a label is deleted, new data that enters in the system will not receive the label, but the label will not be removed from old data that still refers to it.

Parameters
Name Description
request DeleteDataAccessLabelRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskEmpty

The response to send back to the client (wrapped by a task).

DeleteDataAccessScope(DeleteDataAccessScopeRequest, ServerCallContext)

public virtual Task<Empty> DeleteDataAccessScope(DeleteDataAccessScopeRequest request, ServerCallContext context)

Deletes a data access scope.

Parameters
Name Description
request DeleteDataAccessScopeRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskEmpty

The response to send back to the client (wrapped by a task).

GetDataAccessLabel(GetDataAccessLabelRequest, ServerCallContext)

public virtual Task<DataAccessLabel> GetDataAccessLabel(GetDataAccessLabelRequest request, ServerCallContext context)

Gets a data access label.

Parameters
Name Description
request GetDataAccessLabelRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskDataAccessLabel

The response to send back to the client (wrapped by a task).

GetDataAccessScope(GetDataAccessScopeRequest, ServerCallContext)

public virtual Task<DataAccessScope> GetDataAccessScope(GetDataAccessScopeRequest request, ServerCallContext context)

Retrieves an existing data access scope.

Parameters
Name Description
request GetDataAccessScopeRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskDataAccessScope

The response to send back to the client (wrapped by a task).

ListDataAccessLabels(ListDataAccessLabelsRequest, ServerCallContext)

public virtual Task<ListDataAccessLabelsResponse> ListDataAccessLabels(ListDataAccessLabelsRequest request, ServerCallContext context)

Lists all data access labels for the customer.

Parameters
Name Description
request ListDataAccessLabelsRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskListDataAccessLabelsResponse

The response to send back to the client (wrapped by a task).

ListDataAccessScopes(ListDataAccessScopesRequest, ServerCallContext)

public virtual Task<ListDataAccessScopesResponse> ListDataAccessScopes(ListDataAccessScopesRequest request, ServerCallContext context)

Lists all existing data access scopes for the customer.

Parameters
Name Description
request ListDataAccessScopesRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskListDataAccessScopesResponse

The response to send back to the client (wrapped by a task).

UpdateDataAccessLabel(UpdateDataAccessLabelRequest, ServerCallContext)

public virtual Task<DataAccessLabel> UpdateDataAccessLabel(UpdateDataAccessLabelRequest request, ServerCallContext context)

Updates a data access label.

Parameters
Name Description
request UpdateDataAccessLabelRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskDataAccessLabel

The response to send back to the client (wrapped by a task).

UpdateDataAccessScope(UpdateDataAccessScopeRequest, ServerCallContext)

public virtual Task<DataAccessScope> UpdateDataAccessScope(UpdateDataAccessScopeRequest request, ServerCallContext context)

Updates a data access scope.

Parameters
Name Description
request UpdateDataAccessScopeRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskDataAccessScope

The response to send back to the client (wrapped by a task).