Class DataAccessControlServiceGrpc.DataAccessControlServiceFutureStub (0.2.0)

public static final class DataAccessControlServiceGrpc.DataAccessControlServiceFutureStub extends AbstractFutureStub<DataAccessControlServiceGrpc.DataAccessControlServiceFutureStub>

A stub to allow clients to do ListenableFuture-style rpc calls to service DataAccessControlService.

DataAccessControlService exposes resources and endpoints related to data access control.

Inheritance

java.lang.Object > io.grpc.stub.AbstractStub > io.grpc.stub.AbstractFutureStub > DataAccessControlServiceGrpc.DataAccessControlServiceFutureStub

Methods

build(Channel channel, CallOptions callOptions)

protected DataAccessControlServiceGrpc.DataAccessControlServiceFutureStub build(Channel channel, CallOptions callOptions)
Parameters
Name Description
channel io.grpc.Channel
callOptions io.grpc.CallOptions
Returns
Type Description
DataAccessControlServiceGrpc.DataAccessControlServiceFutureStub
Overrides
io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

createDataAccessLabel(CreateDataAccessLabelRequest request)

public ListenableFuture<DataAccessLabel> createDataAccessLabel(CreateDataAccessLabelRequest request)

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.

Parameter
Name Description
request CreateDataAccessLabelRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<DataAccessLabel>

createDataAccessScope(CreateDataAccessScopeRequest request)

public ListenableFuture<DataAccessScope> createDataAccessScope(CreateDataAccessScopeRequest request)

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.

Parameter
Name Description
request CreateDataAccessScopeRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<DataAccessScope>

deleteDataAccessLabel(DeleteDataAccessLabelRequest request)

public ListenableFuture<Empty> deleteDataAccessLabel(DeleteDataAccessLabelRequest request)

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.

Parameter
Name Description
request DeleteDataAccessLabelRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Empty>

deleteDataAccessScope(DeleteDataAccessScopeRequest request)

public ListenableFuture<Empty> deleteDataAccessScope(DeleteDataAccessScopeRequest request)

Deletes a data access scope.

Parameter
Name Description
request DeleteDataAccessScopeRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Empty>

getDataAccessLabel(GetDataAccessLabelRequest request)

public ListenableFuture<DataAccessLabel> getDataAccessLabel(GetDataAccessLabelRequest request)

Gets a data access label.

Parameter
Name Description
request GetDataAccessLabelRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<DataAccessLabel>

getDataAccessScope(GetDataAccessScopeRequest request)

public ListenableFuture<DataAccessScope> getDataAccessScope(GetDataAccessScopeRequest request)

Retrieves an existing data access scope.

Parameter
Name Description
request GetDataAccessScopeRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<DataAccessScope>

listDataAccessLabels(ListDataAccessLabelsRequest request)

public ListenableFuture<ListDataAccessLabelsResponse> listDataAccessLabels(ListDataAccessLabelsRequest request)

Lists all data access labels for the customer.

Parameter
Name Description
request ListDataAccessLabelsRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ListDataAccessLabelsResponse>

listDataAccessScopes(ListDataAccessScopesRequest request)

public ListenableFuture<ListDataAccessScopesResponse> listDataAccessScopes(ListDataAccessScopesRequest request)

Lists all existing data access scopes for the customer.

Parameter
Name Description
request ListDataAccessScopesRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ListDataAccessScopesResponse>

updateDataAccessLabel(UpdateDataAccessLabelRequest request)

public ListenableFuture<DataAccessLabel> updateDataAccessLabel(UpdateDataAccessLabelRequest request)

Updates a data access label.

Parameter
Name Description
request UpdateDataAccessLabelRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<DataAccessLabel>

updateDataAccessScope(UpdateDataAccessScopeRequest request)

public ListenableFuture<DataAccessScope> updateDataAccessScope(UpdateDataAccessScopeRequest request)

Updates a data access scope.

Parameter
Name Description
request UpdateDataAccessScopeRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<DataAccessScope>