Chronicle v1 API - Class DataAccessControlServiceClientImpl (1.0.0-beta02) 

public sealed class DataAccessControlServiceClientImpl : DataAccessControlServiceClient

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

DataAccessControlService client wrapper implementation, for convenient use.

Inheritance

object > DataAccessControlServiceClient > DataAccessControlServiceClientImpl

Namespace

Google.Cloud.Chronicle.V1

Assembly

Google.Cloud.Chronicle.V1.dll

Remarks

DataAccessControlService exposes resources and endpoints related to data access control.

Constructors

DataAccessControlServiceClientImpl(DataAccessControlServiceClient, DataAccessControlServiceSettings, ILogger)

public DataAccessControlServiceClientImpl(DataAccessControlService.DataAccessControlServiceClient grpcClient, DataAccessControlServiceSettings settings, ILogger logger)

Constructs a client wrapper for the DataAccessControlService service, with the specified gRPC client and settings.

Parameters
Name Description
grpcClient DataAccessControlServiceDataAccessControlServiceClient

The underlying gRPC client.
settings DataAccessControlServiceSettings

The base DataAccessControlServiceSettings used within this client.
logger ILogger

Optional ILogger to use within this client.

Properties

GrpcClient

public override DataAccessControlService.DataAccessControlServiceClient GrpcClient { get; }

The underlying gRPC DataAccessControlService client

Property Value
Type Description
DataAccessControlServiceDataAccessControlServiceClient
Overrides

Methods

CreateDataAccessLabel(CreateDataAccessLabelRequest, CallSettings)

public override DataAccessLabel CreateDataAccessLabel(CreateDataAccessLabelRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
DataAccessLabel

The RPC response.
Overrides

CreateDataAccessLabelAsync(CreateDataAccessLabelRequest, CallSettings)

public override Task<DataAccessLabel> CreateDataAccessLabelAsync(CreateDataAccessLabelRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskDataAccessLabel

A Task containing the RPC response.
Overrides

CreateDataAccessScope(CreateDataAccessScopeRequest, CallSettings)

public override DataAccessScope CreateDataAccessScope(CreateDataAccessScopeRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
DataAccessScope

The RPC response.
Overrides

CreateDataAccessScopeAsync(CreateDataAccessScopeRequest, CallSettings)

public override Task<DataAccessScope> CreateDataAccessScopeAsync(CreateDataAccessScopeRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskDataAccessScope

A Task containing the RPC response.
Overrides

DeleteDataAccessLabel(DeleteDataAccessLabelRequest, CallSettings)

public override void DeleteDataAccessLabel(DeleteDataAccessLabelRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Overrides

DeleteDataAccessLabelAsync(DeleteDataAccessLabelRequest, CallSettings)

public override Task DeleteDataAccessLabelAsync(DeleteDataAccessLabelRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task

A Task containing the RPC response.
Overrides

DeleteDataAccessScope(DeleteDataAccessScopeRequest, CallSettings)

public override void DeleteDataAccessScope(DeleteDataAccessScopeRequest request, CallSettings callSettings = null)

Deletes a data access scope.

Parameters
Name Description
request DeleteDataAccessScopeRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Overrides

DeleteDataAccessScopeAsync(DeleteDataAccessScopeRequest, CallSettings)

public override Task DeleteDataAccessScopeAsync(DeleteDataAccessScopeRequest request, CallSettings callSettings = null)

Deletes a data access scope.

Parameters
Name Description
request DeleteDataAccessScopeRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task

A Task containing the RPC response.
Overrides

GetDataAccessLabel(GetDataAccessLabelRequest, CallSettings)

public override DataAccessLabel GetDataAccessLabel(GetDataAccessLabelRequest request, CallSettings callSettings = null)

Gets a data access label.

Parameters
Name Description
request GetDataAccessLabelRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
DataAccessLabel

The RPC response.
Overrides

GetDataAccessLabelAsync(GetDataAccessLabelRequest, CallSettings)

public override Task<DataAccessLabel> GetDataAccessLabelAsync(GetDataAccessLabelRequest request, CallSettings callSettings = null)

Gets a data access label.

Parameters
Name Description
request GetDataAccessLabelRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskDataAccessLabel

A Task containing the RPC response.
Overrides

GetDataAccessScope(GetDataAccessScopeRequest, CallSettings)

public override DataAccessScope GetDataAccessScope(GetDataAccessScopeRequest request, CallSettings callSettings = null)

Retrieves an existing data access scope.

Parameters
Name Description
request GetDataAccessScopeRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
DataAccessScope

The RPC response.
Overrides

GetDataAccessScopeAsync(GetDataAccessScopeRequest, CallSettings)

public override Task<DataAccessScope> GetDataAccessScopeAsync(GetDataAccessScopeRequest request, CallSettings callSettings = null)

Retrieves an existing data access scope.

Parameters
Name Description
request GetDataAccessScopeRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskDataAccessScope

A Task containing the RPC response.
Overrides

ListDataAccessLabels(ListDataAccessLabelsRequest, CallSettings)

public override PagedEnumerable<ListDataAccessLabelsResponse, DataAccessLabel> ListDataAccessLabels(ListDataAccessLabelsRequest request, CallSettings callSettings = null)

Lists all data access labels for the customer.

Parameters
Name Description
request ListDataAccessLabelsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListDataAccessLabelsResponseDataAccessLabel

A pageable sequence of DataAccessLabel resources.
Overrides

ListDataAccessLabelsAsync(ListDataAccessLabelsRequest, CallSettings)

public override PagedAsyncEnumerable<ListDataAccessLabelsResponse, DataAccessLabel> ListDataAccessLabelsAsync(ListDataAccessLabelsRequest request, CallSettings callSettings = null)

Lists all data access labels for the customer.

Parameters
Name Description
request ListDataAccessLabelsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListDataAccessLabelsResponseDataAccessLabel

A pageable asynchronous sequence of DataAccessLabel resources.
Overrides

ListDataAccessScopes(ListDataAccessScopesRequest, CallSettings)

public override PagedEnumerable<ListDataAccessScopesResponse, DataAccessScope> ListDataAccessScopes(ListDataAccessScopesRequest request, CallSettings callSettings = null)

Lists all existing data access scopes for the customer.

Parameters
Name Description
request ListDataAccessScopesRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListDataAccessScopesResponseDataAccessScope

A pageable sequence of DataAccessScope resources.
Overrides

ListDataAccessScopesAsync(ListDataAccessScopesRequest, CallSettings)

public override PagedAsyncEnumerable<ListDataAccessScopesResponse, DataAccessScope> ListDataAccessScopesAsync(ListDataAccessScopesRequest request, CallSettings callSettings = null)

Lists all existing data access scopes for the customer.

Parameters
Name Description
request ListDataAccessScopesRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListDataAccessScopesResponseDataAccessScope

A pageable asynchronous sequence of DataAccessScope resources.
Overrides

UpdateDataAccessLabel(UpdateDataAccessLabelRequest, CallSettings)

public override DataAccessLabel UpdateDataAccessLabel(UpdateDataAccessLabelRequest request, CallSettings callSettings = null)

Updates a data access label.

Parameters
Name Description
request UpdateDataAccessLabelRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
DataAccessLabel

The RPC response.
Overrides

UpdateDataAccessLabelAsync(UpdateDataAccessLabelRequest, CallSettings)

public override Task<DataAccessLabel> UpdateDataAccessLabelAsync(UpdateDataAccessLabelRequest request, CallSettings callSettings = null)

Updates a data access label.

Parameters
Name Description
request UpdateDataAccessLabelRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskDataAccessLabel

A Task containing the RPC response.
Overrides

UpdateDataAccessScope(UpdateDataAccessScopeRequest, CallSettings)

public override DataAccessScope UpdateDataAccessScope(UpdateDataAccessScopeRequest request, CallSettings callSettings = null)

Updates a data access scope.

Parameters
Name Description
request UpdateDataAccessScopeRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
DataAccessScope

The RPC response.
Overrides

UpdateDataAccessScopeAsync(UpdateDataAccessScopeRequest, CallSettings)

public override Task<DataAccessScope> UpdateDataAccessScopeAsync(UpdateDataAccessScopeRequest request, CallSettings callSettings = null)

Updates a data access scope.

Parameters
Name Description
request UpdateDataAccessScopeRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskDataAccessScope

A Task containing the RPC response.
Overrides