Chronicle v1 API - Class DataAccessControlServiceClient (1.0.0-beta02)

public abstract class DataAccessControlServiceClient

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

DataAccessControlService client wrapper, for convenient use.

Inheritance

object > DataAccessControlServiceClient

Namespace

Google.Cloud.Chronicle.V1

Assembly

Google.Cloud.Chronicle.V1.dll

Remarks

DataAccessControlService exposes resources and endpoints related to data access control.

Properties

DefaultEndpoint

public static string DefaultEndpoint { get; }

The default endpoint for the DataAccessControlService service, which is a host of "chronicle.googleapis.com" and a port of 443.

Property Value
Type Description
string

DefaultScopes

public static IReadOnlyList<string> DefaultScopes { get; }

The default DataAccessControlService scopes.

Property Value
Type Description
IReadOnlyListstring
Remarks

The default DataAccessControlService scopes are:

GrpcClient

public virtual DataAccessControlService.DataAccessControlServiceClient GrpcClient { get; }

The underlying gRPC DataAccessControlService client

Property Value
Type Description
DataAccessControlServiceDataAccessControlServiceClient

ServiceMetadata

public static ServiceMetadata ServiceMetadata { get; }

The service metadata associated with this client type.

Property Value
Type Description
ServiceMetadata

Methods

Create()

public static DataAccessControlServiceClient Create()

Synchronously creates a DataAccessControlServiceClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use DataAccessControlServiceClientBuilder.

Returns
Type Description
DataAccessControlServiceClient

The created DataAccessControlServiceClient.

CreateAsync(CancellationToken)

public static Task<DataAccessControlServiceClient> CreateAsync(CancellationToken cancellationToken = default)

Asynchronously creates a DataAccessControlServiceClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use DataAccessControlServiceClientBuilder.

Parameter
Name Description
cancellationToken CancellationToken

The CancellationToken to use while creating the client.

Returns
Type Description
TaskDataAccessControlServiceClient

The task representing the created DataAccessControlServiceClient.

CreateDataAccessLabel(CreateDataAccessLabelRequest, CallSettings)

public virtual 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.

Example
// Create client
DataAccessControlServiceClient dataAccessControlServiceClient = DataAccessControlServiceClient.Create();
// Initialize request argument(s)
CreateDataAccessLabelRequest request = new CreateDataAccessLabelRequest
{
    ParentAsInstanceName = InstanceName.FromProjectLocationInstance("[PROJECT]", "[LOCATION]", "[INSTANCE]"),
    DataAccessLabel = new DataAccessLabel(),
    DataAccessLabelId = "",
};
// Make the request
DataAccessLabel response = dataAccessControlServiceClient.CreateDataAccessLabel(request);

CreateDataAccessLabel(InstanceName, DataAccessLabel, string, CallSettings)

public virtual DataAccessLabel CreateDataAccessLabel(InstanceName parent, DataAccessLabel dataAccessLabel, string dataAccessLabelId, 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
parent InstanceName

Required. The parent resource where this Data Access Label will be created. Format: projects/{project}/locations/{location}/instances/{instance}

dataAccessLabel DataAccessLabel

Required. Data access label to create.

dataAccessLabelId string

Required. The ID to use for the data access label, which will become the label's display name and the final component of the label's resource name. The maximum number of characters should be 63. Regex pattern is as per AIP: https://google.aip.dev/122#resource-id-segments

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
DataAccessLabel

The RPC response.

Example
// Create client
DataAccessControlServiceClient dataAccessControlServiceClient = DataAccessControlServiceClient.Create();
// Initialize request argument(s)
InstanceName parent = InstanceName.FromProjectLocationInstance("[PROJECT]", "[LOCATION]", "[INSTANCE]");
DataAccessLabel dataAccessLabel = new DataAccessLabel();
string dataAccessLabelId = "";
// Make the request
DataAccessLabel response = dataAccessControlServiceClient.CreateDataAccessLabel(parent, dataAccessLabel, dataAccessLabelId);

CreateDataAccessLabel(string, DataAccessLabel, string, CallSettings)

public virtual DataAccessLabel CreateDataAccessLabel(string parent, DataAccessLabel dataAccessLabel, string dataAccessLabelId, 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
parent string

Required. The parent resource where this Data Access Label will be created. Format: projects/{project}/locations/{location}/instances/{instance}

dataAccessLabel DataAccessLabel

Required. Data access label to create.

dataAccessLabelId string

Required. The ID to use for the data access label, which will become the label's display name and the final component of the label's resource name. The maximum number of characters should be 63. Regex pattern is as per AIP: https://google.aip.dev/122#resource-id-segments

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
DataAccessLabel

The RPC response.

Example
// Create client
DataAccessControlServiceClient dataAccessControlServiceClient = DataAccessControlServiceClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/instances/[INSTANCE]";
DataAccessLabel dataAccessLabel = new DataAccessLabel();
string dataAccessLabelId = "";
// Make the request
DataAccessLabel response = dataAccessControlServiceClient.CreateDataAccessLabel(parent, dataAccessLabel, dataAccessLabelId);

CreateDataAccessLabelAsync(CreateDataAccessLabelRequest, CallSettings)

public virtual 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.

Example
// Create client
DataAccessControlServiceClient dataAccessControlServiceClient = await DataAccessControlServiceClient.CreateAsync();
// Initialize request argument(s)
CreateDataAccessLabelRequest request = new CreateDataAccessLabelRequest
{
    ParentAsInstanceName = InstanceName.FromProjectLocationInstance("[PROJECT]", "[LOCATION]", "[INSTANCE]"),
    DataAccessLabel = new DataAccessLabel(),
    DataAccessLabelId = "",
};
// Make the request
DataAccessLabel response = await dataAccessControlServiceClient.CreateDataAccessLabelAsync(request);

CreateDataAccessLabelAsync(CreateDataAccessLabelRequest, CancellationToken)

public virtual Task<DataAccessLabel> CreateDataAccessLabelAsync(CreateDataAccessLabelRequest request, CancellationToken cancellationToken)

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.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskDataAccessLabel

A Task containing the RPC response.

Example
// Create client
DataAccessControlServiceClient dataAccessControlServiceClient = await DataAccessControlServiceClient.CreateAsync();
// Initialize request argument(s)
CreateDataAccessLabelRequest request = new CreateDataAccessLabelRequest
{
    ParentAsInstanceName = InstanceName.FromProjectLocationInstance("[PROJECT]", "[LOCATION]", "[INSTANCE]"),
    DataAccessLabel = new DataAccessLabel(),
    DataAccessLabelId = "",
};
// Make the request
DataAccessLabel response = await dataAccessControlServiceClient.CreateDataAccessLabelAsync(request);

CreateDataAccessLabelAsync(InstanceName, DataAccessLabel, string, CallSettings)

public virtual Task<DataAccessLabel> CreateDataAccessLabelAsync(InstanceName parent, DataAccessLabel dataAccessLabel, string dataAccessLabelId, 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
parent InstanceName

Required. The parent resource where this Data Access Label will be created. Format: projects/{project}/locations/{location}/instances/{instance}

dataAccessLabel DataAccessLabel

Required. Data access label to create.

dataAccessLabelId string

Required. The ID to use for the data access label, which will become the label's display name and the final component of the label's resource name. The maximum number of characters should be 63. Regex pattern is as per AIP: https://google.aip.dev/122#resource-id-segments

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskDataAccessLabel

A Task containing the RPC response.

Example
// Create client
DataAccessControlServiceClient dataAccessControlServiceClient = await DataAccessControlServiceClient.CreateAsync();
// Initialize request argument(s)
InstanceName parent = InstanceName.FromProjectLocationInstance("[PROJECT]", "[LOCATION]", "[INSTANCE]");
DataAccessLabel dataAccessLabel = new DataAccessLabel();
string dataAccessLabelId = "";
// Make the request
DataAccessLabel response = await dataAccessControlServiceClient.CreateDataAccessLabelAsync(parent, dataAccessLabel, dataAccessLabelId);

CreateDataAccessLabelAsync(InstanceName, DataAccessLabel, string, CancellationToken)

public virtual Task<DataAccessLabel> CreateDataAccessLabelAsync(InstanceName parent, DataAccessLabel dataAccessLabel, string dataAccessLabelId, CancellationToken cancellationToken)

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
parent InstanceName

Required. The parent resource where this Data Access Label will be created. Format: projects/{project}/locations/{location}/instances/{instance}

dataAccessLabel DataAccessLabel

Required. Data access label to create.

dataAccessLabelId string

Required. The ID to use for the data access label, which will become the label's display name and the final component of the label's resource name. The maximum number of characters should be 63. Regex pattern is as per AIP: https://google.aip.dev/122#resource-id-segments

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskDataAccessLabel

A Task containing the RPC response.

Example
// Create client
DataAccessControlServiceClient dataAccessControlServiceClient = await DataAccessControlServiceClient.CreateAsync();
// Initialize request argument(s)
InstanceName parent = InstanceName.FromProjectLocationInstance("[PROJECT]", "[LOCATION]", "[INSTANCE]");
DataAccessLabel dataAccessLabel = new DataAccessLabel();
string dataAccessLabelId = "";
// Make the request
DataAccessLabel response = await dataAccessControlServiceClient.CreateDataAccessLabelAsync(parent, dataAccessLabel, dataAccessLabelId);

CreateDataAccessLabelAsync(string, DataAccessLabel, string, CallSettings)

public virtual Task<DataAccessLabel> CreateDataAccessLabelAsync(string parent, DataAccessLabel dataAccessLabel, string dataAccessLabelId, 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
parent string

Required. The parent resource where this Data Access Label will be created. Format: projects/{project}/locations/{location}/instances/{instance}

dataAccessLabel DataAccessLabel

Required. Data access label to create.

dataAccessLabelId string

Required. The ID to use for the data access label, which will become the label's display name and the final component of the label's resource name. The maximum number of characters should be 63. Regex pattern is as per AIP: https://google.aip.dev/122#resource-id-segments

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskDataAccessLabel

A Task containing the RPC response.

Example
// Create client
DataAccessControlServiceClient dataAccessControlServiceClient = await DataAccessControlServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/instances/[INSTANCE]";
DataAccessLabel dataAccessLabel = new DataAccessLabel();
string dataAccessLabelId = "";
// Make the request
DataAccessLabel response = await dataAccessControlServiceClient.CreateDataAccessLabelAsync(parent, dataAccessLabel, dataAccessLabelId);

CreateDataAccessLabelAsync(string, DataAccessLabel, string, CancellationToken)

public virtual Task<DataAccessLabel> CreateDataAccessLabelAsync(string parent, DataAccessLabel dataAccessLabel, string dataAccessLabelId, CancellationToken cancellationToken)

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
parent string

Required. The parent resource where this Data Access Label will be created. Format: projects/{project}/locations/{location}/instances/{instance}

dataAccessLabel DataAccessLabel

Required. Data access label to create.

dataAccessLabelId string

Required. The ID to use for the data access label, which will become the label's display name and the final component of the label's resource name. The maximum number of characters should be 63. Regex pattern is as per AIP: https://google.aip.dev/122#resource-id-segments

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskDataAccessLabel

A Task containing the RPC response.

Example
// Create client
DataAccessControlServiceClient dataAccessControlServiceClient = await DataAccessControlServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/instances/[INSTANCE]";
DataAccessLabel dataAccessLabel = new DataAccessLabel();
string dataAccessLabelId = "";
// Make the request
DataAccessLabel response = await dataAccessControlServiceClient.CreateDataAccessLabelAsync(parent, dataAccessLabel, dataAccessLabelId);

CreateDataAccessScope(CreateDataAccessScopeRequest, CallSettings)

public virtual 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.

Example
// Create client
DataAccessControlServiceClient dataAccessControlServiceClient = DataAccessControlServiceClient.Create();
// Initialize request argument(s)
CreateDataAccessScopeRequest request = new CreateDataAccessScopeRequest
{
    ParentAsInstanceName = InstanceName.FromProjectLocationInstance("[PROJECT]", "[LOCATION]", "[INSTANCE]"),
    DataAccessScope = new DataAccessScope(),
    DataAccessScopeId = "",
};
// Make the request
DataAccessScope response = dataAccessControlServiceClient.CreateDataAccessScope(request);

CreateDataAccessScope(InstanceName, DataAccessScope, string, CallSettings)

public virtual DataAccessScope CreateDataAccessScope(InstanceName parent, DataAccessScope dataAccessScope, string dataAccessScopeId, 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
parent InstanceName

Required. The parent resource where this Data Access Scope will be created. Format: projects/{project}/locations/{location}/instances/{instance}

dataAccessScope DataAccessScope

Required. Data access scope to create.

dataAccessScopeId string

Required. The user provided scope id which will become the last part of the name of the scope resource. Needs to be compliant with https://google.aip.dev/122

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
DataAccessScope

The RPC response.

Example
// Create client
DataAccessControlServiceClient dataAccessControlServiceClient = DataAccessControlServiceClient.Create();
// Initialize request argument(s)
InstanceName parent = InstanceName.FromProjectLocationInstance("[PROJECT]", "[LOCATION]", "[INSTANCE]");
DataAccessScope dataAccessScope = new DataAccessScope();
string dataAccessScopeId = "";
// Make the request
DataAccessScope response = dataAccessControlServiceClient.CreateDataAccessScope(parent, dataAccessScope, dataAccessScopeId);

CreateDataAccessScope(string, DataAccessScope, string, CallSettings)

public virtual DataAccessScope CreateDataAccessScope(string parent, DataAccessScope dataAccessScope, string dataAccessScopeId, 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
parent string

Required. The parent resource where this Data Access Scope will be created. Format: projects/{project}/locations/{location}/instances/{instance}

dataAccessScope DataAccessScope

Required. Data access scope to create.

dataAccessScopeId string

Required. The user provided scope id which will become the last part of the name of the scope resource. Needs to be compliant with https://google.aip.dev/122

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
DataAccessScope

The RPC response.

Example
// Create client
DataAccessControlServiceClient dataAccessControlServiceClient = DataAccessControlServiceClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/instances/[INSTANCE]";
DataAccessScope dataAccessScope = new DataAccessScope();
string dataAccessScopeId = "";
// Make the request
DataAccessScope response = dataAccessControlServiceClient.CreateDataAccessScope(parent, dataAccessScope, dataAccessScopeId);

CreateDataAccessScopeAsync(CreateDataAccessScopeRequest, CallSettings)

public virtual 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.

Example
// Create client
DataAccessControlServiceClient dataAccessControlServiceClient = await DataAccessControlServiceClient.CreateAsync();
// Initialize request argument(s)
CreateDataAccessScopeRequest request = new CreateDataAccessScopeRequest
{
    ParentAsInstanceName = InstanceName.FromProjectLocationInstance("[PROJECT]", "[LOCATION]", "[INSTANCE]"),
    DataAccessScope = new DataAccessScope(),
    DataAccessScopeId = "",
};
// Make the request
DataAccessScope response = await dataAccessControlServiceClient.CreateDataAccessScopeAsync(request);

CreateDataAccessScopeAsync(CreateDataAccessScopeRequest, CancellationToken)

public virtual Task<DataAccessScope> CreateDataAccessScopeAsync(CreateDataAccessScopeRequest request, CancellationToken cancellationToken)

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.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskDataAccessScope

A Task containing the RPC response.

Example
// Create client
DataAccessControlServiceClient dataAccessControlServiceClient = await DataAccessControlServiceClient.CreateAsync();
// Initialize request argument(s)
CreateDataAccessScopeRequest request = new CreateDataAccessScopeRequest
{
    ParentAsInstanceName = InstanceName.FromProjectLocationInstance("[PROJECT]", "[LOCATION]", "[INSTANCE]"),
    DataAccessScope = new DataAccessScope(),
    DataAccessScopeId = "",
};
// Make the request
DataAccessScope response = await dataAccessControlServiceClient.CreateDataAccessScopeAsync(request);

CreateDataAccessScopeAsync(InstanceName, DataAccessScope, string, CallSettings)

public virtual Task<DataAccessScope> CreateDataAccessScopeAsync(InstanceName parent, DataAccessScope dataAccessScope, string dataAccessScopeId, 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
parent InstanceName

Required. The parent resource where this Data Access Scope will be created. Format: projects/{project}/locations/{location}/instances/{instance}

dataAccessScope DataAccessScope

Required. Data access scope to create.

dataAccessScopeId string

Required. The user provided scope id which will become the last part of the name of the scope resource. Needs to be compliant with https://google.aip.dev/122

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskDataAccessScope

A Task containing the RPC response.

Example
// Create client
DataAccessControlServiceClient dataAccessControlServiceClient = await DataAccessControlServiceClient.CreateAsync();
// Initialize request argument(s)
InstanceName parent = InstanceName.FromProjectLocationInstance("[PROJECT]", "[LOCATION]", "[INSTANCE]");
DataAccessScope dataAccessScope = new DataAccessScope();
string dataAccessScopeId = "";
// Make the request
DataAccessScope response = await dataAccessControlServiceClient.CreateDataAccessScopeAsync(parent, dataAccessScope, dataAccessScopeId);

CreateDataAccessScopeAsync(InstanceName, DataAccessScope, string, CancellationToken)

public virtual Task<DataAccessScope> CreateDataAccessScopeAsync(InstanceName parent, DataAccessScope dataAccessScope, string dataAccessScopeId, CancellationToken cancellationToken)

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
parent InstanceName

Required. The parent resource where this Data Access Scope will be created. Format: projects/{project}/locations/{location}/instances/{instance}

dataAccessScope DataAccessScope

Required. Data access scope to create.

dataAccessScopeId string

Required. The user provided scope id which will become the last part of the name of the scope resource. Needs to be compliant with https://google.aip.dev/122

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskDataAccessScope

A Task containing the RPC response.

Example
// Create client
DataAccessControlServiceClient dataAccessControlServiceClient = await DataAccessControlServiceClient.CreateAsync();
// Initialize request argument(s)
InstanceName parent = InstanceName.FromProjectLocationInstance("[PROJECT]", "[LOCATION]", "[INSTANCE]");
DataAccessScope dataAccessScope = new DataAccessScope();
string dataAccessScopeId = "";
// Make the request
DataAccessScope response = await dataAccessControlServiceClient.CreateDataAccessScopeAsync(parent, dataAccessScope, dataAccessScopeId);

CreateDataAccessScopeAsync(string, DataAccessScope, string, CallSettings)

public virtual Task<DataAccessScope> CreateDataAccessScopeAsync(string parent, DataAccessScope dataAccessScope, string dataAccessScopeId, 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
parent string

Required. The parent resource where this Data Access Scope will be created. Format: projects/{project}/locations/{location}/instances/{instance}

dataAccessScope DataAccessScope

Required. Data access scope to create.

dataAccessScopeId string

Required. The user provided scope id which will become the last part of the name of the scope resource. Needs to be compliant with https://google.aip.dev/122

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskDataAccessScope

A Task containing the RPC response.

Example
// Create client
DataAccessControlServiceClient dataAccessControlServiceClient = await DataAccessControlServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/instances/[INSTANCE]";
DataAccessScope dataAccessScope = new DataAccessScope();
string dataAccessScopeId = "";
// Make the request
DataAccessScope response = await dataAccessControlServiceClient.CreateDataAccessScopeAsync(parent, dataAccessScope, dataAccessScopeId);

CreateDataAccessScopeAsync(string, DataAccessScope, string, CancellationToken)

public virtual Task<DataAccessScope> CreateDataAccessScopeAsync(string parent, DataAccessScope dataAccessScope, string dataAccessScopeId, CancellationToken cancellationToken)

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
parent string

Required. The parent resource where this Data Access Scope will be created. Format: projects/{project}/locations/{location}/instances/{instance}

dataAccessScope DataAccessScope

Required. Data access scope to create.

dataAccessScopeId string

Required. The user provided scope id which will become the last part of the name of the scope resource. Needs to be compliant with https://google.aip.dev/122

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskDataAccessScope

A Task containing the RPC response.

Example
// Create client
DataAccessControlServiceClient dataAccessControlServiceClient = await DataAccessControlServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/instances/[INSTANCE]";
DataAccessScope dataAccessScope = new DataAccessScope();
string dataAccessScopeId = "";
// Make the request
DataAccessScope response = await dataAccessControlServiceClient.CreateDataAccessScopeAsync(parent, dataAccessScope, dataAccessScopeId);

DeleteDataAccessLabel(DataAccessLabelName, CallSettings)

public virtual void DeleteDataAccessLabel(DataAccessLabelName name, 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
name DataAccessLabelName

Required. The ID of the data access label to delete. Format: projects/{project}/locations/{location}/instances/{instance}/dataAccessLabels/{data_access_label}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Example
// Create client
DataAccessControlServiceClient dataAccessControlServiceClient = DataAccessControlServiceClient.Create();
// Initialize request argument(s)
DataAccessLabelName name = DataAccessLabelName.FromProjectLocationInstanceDataAccessLabel("[PROJECT]", "[LOCATION]", "[INSTANCE]", "[DATA_ACCESS_LABEL]");
// Make the request
dataAccessControlServiceClient.DeleteDataAccessLabel(name);

DeleteDataAccessLabel(DeleteDataAccessLabelRequest, CallSettings)

public virtual 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.

Example
// Create client
DataAccessControlServiceClient dataAccessControlServiceClient = DataAccessControlServiceClient.Create();
// Initialize request argument(s)
DeleteDataAccessLabelRequest request = new DeleteDataAccessLabelRequest
{
    DataAccessLabelName = DataAccessLabelName.FromProjectLocationInstanceDataAccessLabel("[PROJECT]", "[LOCATION]", "[INSTANCE]", "[DATA_ACCESS_LABEL]"),
};
// Make the request
dataAccessControlServiceClient.DeleteDataAccessLabel(request);

DeleteDataAccessLabel(string, CallSettings)

public virtual void DeleteDataAccessLabel(string name, 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
name string

Required. The ID of the data access label to delete. Format: projects/{project}/locations/{location}/instances/{instance}/dataAccessLabels/{data_access_label}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Example
// Create client
DataAccessControlServiceClient dataAccessControlServiceClient = DataAccessControlServiceClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/instances/[INSTANCE]/dataAccessLabels/[DATA_ACCESS_LABEL]";
// Make the request
dataAccessControlServiceClient.DeleteDataAccessLabel(name);

DeleteDataAccessLabelAsync(DataAccessLabelName, CallSettings)

public virtual Task DeleteDataAccessLabelAsync(DataAccessLabelName name, 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
name DataAccessLabelName

Required. The ID of the data access label to delete. Format: projects/{project}/locations/{location}/instances/{instance}/dataAccessLabels/{data_access_label}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Task

A Task containing the RPC response.

Example
// Create client
DataAccessControlServiceClient dataAccessControlServiceClient = await DataAccessControlServiceClient.CreateAsync();
// Initialize request argument(s)
DataAccessLabelName name = DataAccessLabelName.FromProjectLocationInstanceDataAccessLabel("[PROJECT]", "[LOCATION]", "[INSTANCE]", "[DATA_ACCESS_LABEL]");
// Make the request
await dataAccessControlServiceClient.DeleteDataAccessLabelAsync(name);

DeleteDataAccessLabelAsync(DataAccessLabelName, CancellationToken)

public virtual Task DeleteDataAccessLabelAsync(DataAccessLabelName name, CancellationToken cancellationToken)

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
name DataAccessLabelName

Required. The ID of the data access label to delete. Format: projects/{project}/locations/{location}/instances/{instance}/dataAccessLabels/{data_access_label}

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
Task

A Task containing the RPC response.

Example
// Create client
DataAccessControlServiceClient dataAccessControlServiceClient = await DataAccessControlServiceClient.CreateAsync();
// Initialize request argument(s)
DataAccessLabelName name = DataAccessLabelName.FromProjectLocationInstanceDataAccessLabel("[PROJECT]", "[LOCATION]", "[INSTANCE]", "[DATA_ACCESS_LABEL]");
// Make the request
await dataAccessControlServiceClient.DeleteDataAccessLabelAsync(name);

DeleteDataAccessLabelAsync(DeleteDataAccessLabelRequest, CallSettings)

public virtual 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.

Example
// Create client
DataAccessControlServiceClient dataAccessControlServiceClient = await DataAccessControlServiceClient.CreateAsync();
// Initialize request argument(s)
DeleteDataAccessLabelRequest request = new DeleteDataAccessLabelRequest
{
    DataAccessLabelName = DataAccessLabelName.FromProjectLocationInstanceDataAccessLabel("[PROJECT]", "[LOCATION]", "[INSTANCE]", "[DATA_ACCESS_LABEL]"),
};
// Make the request
await dataAccessControlServiceClient.DeleteDataAccessLabelAsync(request);

DeleteDataAccessLabelAsync(DeleteDataAccessLabelRequest, CancellationToken)

public virtual Task DeleteDataAccessLabelAsync(DeleteDataAccessLabelRequest request, CancellationToken cancellationToken)

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.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
Task

A Task containing the RPC response.

Example
// Create client
DataAccessControlServiceClient dataAccessControlServiceClient = await DataAccessControlServiceClient.CreateAsync();
// Initialize request argument(s)
DeleteDataAccessLabelRequest request = new DeleteDataAccessLabelRequest
{
    DataAccessLabelName = DataAccessLabelName.FromProjectLocationInstanceDataAccessLabel("[PROJECT]", "[LOCATION]", "[INSTANCE]", "[DATA_ACCESS_LABEL]"),
};
// Make the request
await dataAccessControlServiceClient.DeleteDataAccessLabelAsync(request);

DeleteDataAccessLabelAsync(string, CallSettings)

public virtual Task DeleteDataAccessLabelAsync(string name, 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
name string

Required. The ID of the data access label to delete. Format: projects/{project}/locations/{location}/instances/{instance}/dataAccessLabels/{data_access_label}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Task

A Task containing the RPC response.

Example
// Create client
DataAccessControlServiceClient dataAccessControlServiceClient = await DataAccessControlServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/instances/[INSTANCE]/dataAccessLabels/[DATA_ACCESS_LABEL]";
// Make the request
await dataAccessControlServiceClient.DeleteDataAccessLabelAsync(name);

DeleteDataAccessLabelAsync(string, CancellationToken)

public virtual Task DeleteDataAccessLabelAsync(string name, CancellationToken cancellationToken)

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
name string

Required. The ID of the data access label to delete. Format: projects/{project}/locations/{location}/instances/{instance}/dataAccessLabels/{data_access_label}

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
Task

A Task containing the RPC response.

Example
// Create client
DataAccessControlServiceClient dataAccessControlServiceClient = await DataAccessControlServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/instances/[INSTANCE]/dataAccessLabels/[DATA_ACCESS_LABEL]";
// Make the request
await dataAccessControlServiceClient.DeleteDataAccessLabelAsync(name);

DeleteDataAccessScope(DataAccessScopeName, CallSettings)

public virtual void DeleteDataAccessScope(DataAccessScopeName name, CallSettings callSettings = null)

Deletes a data access scope.

Parameters
Name Description
name DataAccessScopeName

Required. The ID of the data access scope to delete. Format: projects/{project}/locations/{location}/instances/{instance}/dataAccessScopes/{data_access_scope}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Example
// Create client
DataAccessControlServiceClient dataAccessControlServiceClient = DataAccessControlServiceClient.Create();
// Initialize request argument(s)
DataAccessScopeName name = DataAccessScopeName.FromProjectLocationInstanceDataAccessScope("[PROJECT]", "[LOCATION]", "[INSTANCE]", "[DATA_ACCESS_SCOPE]");
// Make the request
dataAccessControlServiceClient.DeleteDataAccessScope(name);

DeleteDataAccessScope(DeleteDataAccessScopeRequest, CallSettings)

public virtual 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.

Example
// Create client
DataAccessControlServiceClient dataAccessControlServiceClient = DataAccessControlServiceClient.Create();
// Initialize request argument(s)
DeleteDataAccessScopeRequest request = new DeleteDataAccessScopeRequest
{
    DataAccessScopeName = DataAccessScopeName.FromProjectLocationInstanceDataAccessScope("[PROJECT]", "[LOCATION]", "[INSTANCE]", "[DATA_ACCESS_SCOPE]"),
};
// Make the request
dataAccessControlServiceClient.DeleteDataAccessScope(request);

DeleteDataAccessScope(string, CallSettings)

public virtual void DeleteDataAccessScope(string name, CallSettings callSettings = null)

Deletes a data access scope.

Parameters
Name Description
name string

Required. The ID of the data access scope to delete. Format: projects/{project}/locations/{location}/instances/{instance}/dataAccessScopes/{data_access_scope}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Example
// Create client
DataAccessControlServiceClient dataAccessControlServiceClient = DataAccessControlServiceClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/instances/[INSTANCE]/dataAccessScopes/[DATA_ACCESS_SCOPE]";
// Make the request
dataAccessControlServiceClient.DeleteDataAccessScope(name);

DeleteDataAccessScopeAsync(DataAccessScopeName, CallSettings)

public virtual Task DeleteDataAccessScopeAsync(DataAccessScopeName name, CallSettings callSettings = null)

Deletes a data access scope.

Parameters
Name Description
name DataAccessScopeName

Required. The ID of the data access scope to delete. Format: projects/{project}/locations/{location}/instances/{instance}/dataAccessScopes/{data_access_scope}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Task

A Task containing the RPC response.

Example
// Create client
DataAccessControlServiceClient dataAccessControlServiceClient = await DataAccessControlServiceClient.CreateAsync();
// Initialize request argument(s)
DataAccessScopeName name = DataAccessScopeName.FromProjectLocationInstanceDataAccessScope("[PROJECT]", "[LOCATION]", "[INSTANCE]", "[DATA_ACCESS_SCOPE]");
// Make the request
await dataAccessControlServiceClient.DeleteDataAccessScopeAsync(name);

DeleteDataAccessScopeAsync(DataAccessScopeName, CancellationToken)

public virtual Task DeleteDataAccessScopeAsync(DataAccessScopeName name, CancellationToken cancellationToken)

Deletes a data access scope.

Parameters
Name Description
name DataAccessScopeName

Required. The ID of the data access scope to delete. Format: projects/{project}/locations/{location}/instances/{instance}/dataAccessScopes/{data_access_scope}

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
Task

A Task containing the RPC response.

Example
// Create client
DataAccessControlServiceClient dataAccessControlServiceClient = await DataAccessControlServiceClient.CreateAsync();
// Initialize request argument(s)
DataAccessScopeName name = DataAccessScopeName.FromProjectLocationInstanceDataAccessScope("[PROJECT]", "[LOCATION]", "[INSTANCE]", "[DATA_ACCESS_SCOPE]");
// Make the request
await dataAccessControlServiceClient.DeleteDataAccessScopeAsync(name);

DeleteDataAccessScopeAsync(DeleteDataAccessScopeRequest, CallSettings)

public virtual 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.

Example
// Create client
DataAccessControlServiceClient dataAccessControlServiceClient = await DataAccessControlServiceClient.CreateAsync();
// Initialize request argument(s)
DeleteDataAccessScopeRequest request = new DeleteDataAccessScopeRequest
{
    DataAccessScopeName = DataAccessScopeName.FromProjectLocationInstanceDataAccessScope("[PROJECT]", "[LOCATION]", "[INSTANCE]", "[DATA_ACCESS_SCOPE]"),
};
// Make the request
await dataAccessControlServiceClient.DeleteDataAccessScopeAsync(request);

DeleteDataAccessScopeAsync(DeleteDataAccessScopeRequest, CancellationToken)

public virtual Task DeleteDataAccessScopeAsync(DeleteDataAccessScopeRequest request, CancellationToken cancellationToken)

Deletes a data access scope.

Parameters
Name Description
request DeleteDataAccessScopeRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
Task

A Task containing the RPC response.

Example
// Create client
DataAccessControlServiceClient dataAccessControlServiceClient = await DataAccessControlServiceClient.CreateAsync();
// Initialize request argument(s)
DeleteDataAccessScopeRequest request = new DeleteDataAccessScopeRequest
{
    DataAccessScopeName = DataAccessScopeName.FromProjectLocationInstanceDataAccessScope("[PROJECT]", "[LOCATION]", "[INSTANCE]", "[DATA_ACCESS_SCOPE]"),
};
// Make the request
await dataAccessControlServiceClient.DeleteDataAccessScopeAsync(request);

DeleteDataAccessScopeAsync(string, CallSettings)

public virtual Task DeleteDataAccessScopeAsync(string name, CallSettings callSettings = null)

Deletes a data access scope.

Parameters
Name Description
name string

Required. The ID of the data access scope to delete. Format: projects/{project}/locations/{location}/instances/{instance}/dataAccessScopes/{data_access_scope}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Task

A Task containing the RPC response.

Example
// Create client
DataAccessControlServiceClient dataAccessControlServiceClient = await DataAccessControlServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/instances/[INSTANCE]/dataAccessScopes/[DATA_ACCESS_SCOPE]";
// Make the request
await dataAccessControlServiceClient.DeleteDataAccessScopeAsync(name);

DeleteDataAccessScopeAsync(string, CancellationToken)

public virtual Task DeleteDataAccessScopeAsync(string name, CancellationToken cancellationToken)

Deletes a data access scope.

Parameters
Name Description
name string

Required. The ID of the data access scope to delete. Format: projects/{project}/locations/{location}/instances/{instance}/dataAccessScopes/{data_access_scope}

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
Task

A Task containing the RPC response.

Example
// Create client
DataAccessControlServiceClient dataAccessControlServiceClient = await DataAccessControlServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/instances/[INSTANCE]/dataAccessScopes/[DATA_ACCESS_SCOPE]";
// Make the request
await dataAccessControlServiceClient.DeleteDataAccessScopeAsync(name);

GetDataAccessLabel(DataAccessLabelName, CallSettings)

public virtual DataAccessLabel GetDataAccessLabel(DataAccessLabelName name, CallSettings callSettings = null)

Gets a data access label.

Parameters
Name Description
name DataAccessLabelName

Required. The ID of the data access label to retrieve. Format: projects/{project}/locations/{location}/instances/{instance}/dataAccessLabels/{data_access_label}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
DataAccessLabel

The RPC response.

Example
// Create client
DataAccessControlServiceClient dataAccessControlServiceClient = DataAccessControlServiceClient.Create();
// Initialize request argument(s)
DataAccessLabelName name = DataAccessLabelName.FromProjectLocationInstanceDataAccessLabel("[PROJECT]", "[LOCATION]", "[INSTANCE]", "[DATA_ACCESS_LABEL]");
// Make the request
DataAccessLabel response = dataAccessControlServiceClient.GetDataAccessLabel(name);

GetDataAccessLabel(GetDataAccessLabelRequest, CallSettings)

public virtual 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.

Example
// Create client
DataAccessControlServiceClient dataAccessControlServiceClient = DataAccessControlServiceClient.Create();
// Initialize request argument(s)
GetDataAccessLabelRequest request = new GetDataAccessLabelRequest
{
    DataAccessLabelName = DataAccessLabelName.FromProjectLocationInstanceDataAccessLabel("[PROJECT]", "[LOCATION]", "[INSTANCE]", "[DATA_ACCESS_LABEL]"),
};
// Make the request
DataAccessLabel response = dataAccessControlServiceClient.GetDataAccessLabel(request);

GetDataAccessLabel(string, CallSettings)

public virtual DataAccessLabel GetDataAccessLabel(string name, CallSettings callSettings = null)

Gets a data access label.

Parameters
Name Description
name string

Required. The ID of the data access label to retrieve. Format: projects/{project}/locations/{location}/instances/{instance}/dataAccessLabels/{data_access_label}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
DataAccessLabel

The RPC response.

Example
// Create client
DataAccessControlServiceClient dataAccessControlServiceClient = DataAccessControlServiceClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/instances/[INSTANCE]/dataAccessLabels/[DATA_ACCESS_LABEL]";
// Make the request
DataAccessLabel response = dataAccessControlServiceClient.GetDataAccessLabel(name);

GetDataAccessLabelAsync(DataAccessLabelName, CallSettings)

public virtual Task<DataAccessLabel> GetDataAccessLabelAsync(DataAccessLabelName name, CallSettings callSettings = null)

Gets a data access label.

Parameters
Name Description
name DataAccessLabelName

Required. The ID of the data access label to retrieve. Format: projects/{project}/locations/{location}/instances/{instance}/dataAccessLabels/{data_access_label}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskDataAccessLabel

A Task containing the RPC response.

Example
// Create client
DataAccessControlServiceClient dataAccessControlServiceClient = await DataAccessControlServiceClient.CreateAsync();
// Initialize request argument(s)
DataAccessLabelName name = DataAccessLabelName.FromProjectLocationInstanceDataAccessLabel("[PROJECT]", "[LOCATION]", "[INSTANCE]", "[DATA_ACCESS_LABEL]");
// Make the request
DataAccessLabel response = await dataAccessControlServiceClient.GetDataAccessLabelAsync(name);

GetDataAccessLabelAsync(DataAccessLabelName, CancellationToken)

public virtual Task<DataAccessLabel> GetDataAccessLabelAsync(DataAccessLabelName name, CancellationToken cancellationToken)

Gets a data access label.

Parameters
Name Description
name DataAccessLabelName

Required. The ID of the data access label to retrieve. Format: projects/{project}/locations/{location}/instances/{instance}/dataAccessLabels/{data_access_label}

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskDataAccessLabel

A Task containing the RPC response.

Example
// Create client
DataAccessControlServiceClient dataAccessControlServiceClient = await DataAccessControlServiceClient.CreateAsync();
// Initialize request argument(s)
DataAccessLabelName name = DataAccessLabelName.FromProjectLocationInstanceDataAccessLabel("[PROJECT]", "[LOCATION]", "[INSTANCE]", "[DATA_ACCESS_LABEL]");
// Make the request
DataAccessLabel response = await dataAccessControlServiceClient.GetDataAccessLabelAsync(name);

GetDataAccessLabelAsync(GetDataAccessLabelRequest, CallSettings)

public virtual 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.

Example
// Create client
DataAccessControlServiceClient dataAccessControlServiceClient = await DataAccessControlServiceClient.CreateAsync();
// Initialize request argument(s)
GetDataAccessLabelRequest request = new GetDataAccessLabelRequest
{
    DataAccessLabelName = DataAccessLabelName.FromProjectLocationInstanceDataAccessLabel("[PROJECT]", "[LOCATION]", "[INSTANCE]", "[DATA_ACCESS_LABEL]"),
};
// Make the request
DataAccessLabel response = await dataAccessControlServiceClient.GetDataAccessLabelAsync(request);

GetDataAccessLabelAsync(GetDataAccessLabelRequest, CancellationToken)

public virtual Task<DataAccessLabel> GetDataAccessLabelAsync(GetDataAccessLabelRequest request, CancellationToken cancellationToken)

Gets a data access label.

Parameters
Name Description
request GetDataAccessLabelRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskDataAccessLabel

A Task containing the RPC response.

Example
// Create client
DataAccessControlServiceClient dataAccessControlServiceClient = await DataAccessControlServiceClient.CreateAsync();
// Initialize request argument(s)
GetDataAccessLabelRequest request = new GetDataAccessLabelRequest
{
    DataAccessLabelName = DataAccessLabelName.FromProjectLocationInstanceDataAccessLabel("[PROJECT]", "[LOCATION]", "[INSTANCE]", "[DATA_ACCESS_LABEL]"),
};
// Make the request
DataAccessLabel response = await dataAccessControlServiceClient.GetDataAccessLabelAsync(request);

GetDataAccessLabelAsync(string, CallSettings)

public virtual Task<DataAccessLabel> GetDataAccessLabelAsync(string name, CallSettings callSettings = null)

Gets a data access label.

Parameters
Name Description
name string

Required. The ID of the data access label to retrieve. Format: projects/{project}/locations/{location}/instances/{instance}/dataAccessLabels/{data_access_label}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskDataAccessLabel

A Task containing the RPC response.

Example
// Create client
DataAccessControlServiceClient dataAccessControlServiceClient = await DataAccessControlServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/instances/[INSTANCE]/dataAccessLabels/[DATA_ACCESS_LABEL]";
// Make the request
DataAccessLabel response = await dataAccessControlServiceClient.GetDataAccessLabelAsync(name);

GetDataAccessLabelAsync(string, CancellationToken)

public virtual Task<DataAccessLabel> GetDataAccessLabelAsync(string name, CancellationToken cancellationToken)

Gets a data access label.

Parameters
Name Description
name string

Required. The ID of the data access label to retrieve. Format: projects/{project}/locations/{location}/instances/{instance}/dataAccessLabels/{data_access_label}

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskDataAccessLabel

A Task containing the RPC response.

Example
// Create client
DataAccessControlServiceClient dataAccessControlServiceClient = await DataAccessControlServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/instances/[INSTANCE]/dataAccessLabels/[DATA_ACCESS_LABEL]";
// Make the request
DataAccessLabel response = await dataAccessControlServiceClient.GetDataAccessLabelAsync(name);

GetDataAccessScope(DataAccessScopeName, CallSettings)

public virtual DataAccessScope GetDataAccessScope(DataAccessScopeName name, CallSettings callSettings = null)

Retrieves an existing data access scope.

Parameters
Name Description
name DataAccessScopeName

Required. The ID of the data access scope to retrieve. Format: projects/{project}/locations/{location}/instances/{instance}/dataAccessScopes/{data_access_scope}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
DataAccessScope

The RPC response.

Example
// Create client
DataAccessControlServiceClient dataAccessControlServiceClient = DataAccessControlServiceClient.Create();
// Initialize request argument(s)
DataAccessScopeName name = DataAccessScopeName.FromProjectLocationInstanceDataAccessScope("[PROJECT]", "[LOCATION]", "[INSTANCE]", "[DATA_ACCESS_SCOPE]");
// Make the request
DataAccessScope response = dataAccessControlServiceClient.GetDataAccessScope(name);

GetDataAccessScope(GetDataAccessScopeRequest, CallSettings)

public virtual 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.

Example
// Create client
DataAccessControlServiceClient dataAccessControlServiceClient = DataAccessControlServiceClient.Create();
// Initialize request argument(s)
GetDataAccessScopeRequest request = new GetDataAccessScopeRequest
{
    DataAccessScopeName = DataAccessScopeName.FromProjectLocationInstanceDataAccessScope("[PROJECT]", "[LOCATION]", "[INSTANCE]", "[DATA_ACCESS_SCOPE]"),
};
// Make the request
DataAccessScope response = dataAccessControlServiceClient.GetDataAccessScope(request);

GetDataAccessScope(string, CallSettings)

public virtual DataAccessScope GetDataAccessScope(string name, CallSettings callSettings = null)

Retrieves an existing data access scope.

Parameters
Name Description
name string

Required. The ID of the data access scope to retrieve. Format: projects/{project}/locations/{location}/instances/{instance}/dataAccessScopes/{data_access_scope}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
DataAccessScope

The RPC response.

Example
// Create client
DataAccessControlServiceClient dataAccessControlServiceClient = DataAccessControlServiceClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/instances/[INSTANCE]/dataAccessScopes/[DATA_ACCESS_SCOPE]";
// Make the request
DataAccessScope response = dataAccessControlServiceClient.GetDataAccessScope(name);

GetDataAccessScopeAsync(DataAccessScopeName, CallSettings)

public virtual Task<DataAccessScope> GetDataAccessScopeAsync(DataAccessScopeName name, CallSettings callSettings = null)

Retrieves an existing data access scope.

Parameters
Name Description
name DataAccessScopeName

Required. The ID of the data access scope to retrieve. Format: projects/{project}/locations/{location}/instances/{instance}/dataAccessScopes/{data_access_scope}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskDataAccessScope

A Task containing the RPC response.

Example
// Create client
DataAccessControlServiceClient dataAccessControlServiceClient = await DataAccessControlServiceClient.CreateAsync();
// Initialize request argument(s)
DataAccessScopeName name = DataAccessScopeName.FromProjectLocationInstanceDataAccessScope("[PROJECT]", "[LOCATION]", "[INSTANCE]", "[DATA_ACCESS_SCOPE]");
// Make the request
DataAccessScope response = await dataAccessControlServiceClient.GetDataAccessScopeAsync(name);

GetDataAccessScopeAsync(DataAccessScopeName, CancellationToken)

public virtual Task<DataAccessScope> GetDataAccessScopeAsync(DataAccessScopeName name, CancellationToken cancellationToken)

Retrieves an existing data access scope.

Parameters
Name Description
name DataAccessScopeName

Required. The ID of the data access scope to retrieve. Format: projects/{project}/locations/{location}/instances/{instance}/dataAccessScopes/{data_access_scope}

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskDataAccessScope

A Task containing the RPC response.

Example
// Create client
DataAccessControlServiceClient dataAccessControlServiceClient = await DataAccessControlServiceClient.CreateAsync();
// Initialize request argument(s)
DataAccessScopeName name = DataAccessScopeName.FromProjectLocationInstanceDataAccessScope("[PROJECT]", "[LOCATION]", "[INSTANCE]", "[DATA_ACCESS_SCOPE]");
// Make the request
DataAccessScope response = await dataAccessControlServiceClient.GetDataAccessScopeAsync(name);

GetDataAccessScopeAsync(GetDataAccessScopeRequest, CallSettings)

public virtual 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.

Example
// Create client
DataAccessControlServiceClient dataAccessControlServiceClient = await DataAccessControlServiceClient.CreateAsync();
// Initialize request argument(s)
GetDataAccessScopeRequest request = new GetDataAccessScopeRequest
{
    DataAccessScopeName = DataAccessScopeName.FromProjectLocationInstanceDataAccessScope("[PROJECT]", "[LOCATION]", "[INSTANCE]", "[DATA_ACCESS_SCOPE]"),
};
// Make the request
DataAccessScope response = await dataAccessControlServiceClient.GetDataAccessScopeAsync(request);

GetDataAccessScopeAsync(GetDataAccessScopeRequest, CancellationToken)

public virtual Task<DataAccessScope> GetDataAccessScopeAsync(GetDataAccessScopeRequest request, CancellationToken cancellationToken)

Retrieves an existing data access scope.

Parameters
Name Description
request GetDataAccessScopeRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskDataAccessScope

A Task containing the RPC response.

Example
// Create client
DataAccessControlServiceClient dataAccessControlServiceClient = await DataAccessControlServiceClient.CreateAsync();
// Initialize request argument(s)
GetDataAccessScopeRequest request = new GetDataAccessScopeRequest
{
    DataAccessScopeName = DataAccessScopeName.FromProjectLocationInstanceDataAccessScope("[PROJECT]", "[LOCATION]", "[INSTANCE]", "[DATA_ACCESS_SCOPE]"),
};
// Make the request
DataAccessScope response = await dataAccessControlServiceClient.GetDataAccessScopeAsync(request);

GetDataAccessScopeAsync(string, CallSettings)

public virtual Task<DataAccessScope> GetDataAccessScopeAsync(string name, CallSettings callSettings = null)

Retrieves an existing data access scope.

Parameters
Name Description
name string

Required. The ID of the data access scope to retrieve. Format: projects/{project}/locations/{location}/instances/{instance}/dataAccessScopes/{data_access_scope}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskDataAccessScope

A Task containing the RPC response.

Example
// Create client
DataAccessControlServiceClient dataAccessControlServiceClient = await DataAccessControlServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/instances/[INSTANCE]/dataAccessScopes/[DATA_ACCESS_SCOPE]";
// Make the request
DataAccessScope response = await dataAccessControlServiceClient.GetDataAccessScopeAsync(name);

GetDataAccessScopeAsync(string, CancellationToken)

public virtual Task<DataAccessScope> GetDataAccessScopeAsync(string name, CancellationToken cancellationToken)

Retrieves an existing data access scope.

Parameters
Name Description
name string

Required. The ID of the data access scope to retrieve. Format: projects/{project}/locations/{location}/instances/{instance}/dataAccessScopes/{data_access_scope}

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskDataAccessScope

A Task containing the RPC response.

Example
// Create client
DataAccessControlServiceClient dataAccessControlServiceClient = await DataAccessControlServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/instances/[INSTANCE]/dataAccessScopes/[DATA_ACCESS_SCOPE]";
// Make the request
DataAccessScope response = await dataAccessControlServiceClient.GetDataAccessScopeAsync(name);

ListDataAccessLabels(InstanceName, string, int?, CallSettings)

public virtual PagedEnumerable<ListDataAccessLabelsResponse, DataAccessLabel> ListDataAccessLabels(InstanceName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists all data access labels for the customer.

Parameters
Name Description
parent InstanceName

Required. The parent resource where this data access label will be created. Format: projects/{project}/locations/{location}/instances/{instance}

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableListDataAccessLabelsResponseDataAccessLabel

A pageable sequence of DataAccessLabel resources.

Example
// Create client
DataAccessControlServiceClient dataAccessControlServiceClient = DataAccessControlServiceClient.Create();
// Initialize request argument(s)
InstanceName parent = InstanceName.FromProjectLocationInstance("[PROJECT]", "[LOCATION]", "[INSTANCE]");
// Make the request
PagedEnumerable<ListDataAccessLabelsResponse, DataAccessLabel> response = dataAccessControlServiceClient.ListDataAccessLabels(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (DataAccessLabel item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListDataAccessLabelsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (DataAccessLabel item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<DataAccessLabel> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (DataAccessLabel item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListDataAccessLabels(ListDataAccessLabelsRequest, CallSettings)

public virtual 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.

Example
// Create client
DataAccessControlServiceClient dataAccessControlServiceClient = DataAccessControlServiceClient.Create();
// Initialize request argument(s)
ListDataAccessLabelsRequest request = new ListDataAccessLabelsRequest
{
    ParentAsInstanceName = InstanceName.FromProjectLocationInstance("[PROJECT]", "[LOCATION]", "[INSTANCE]"),
    Filter = "",
};
// Make the request
PagedEnumerable<ListDataAccessLabelsResponse, DataAccessLabel> response = dataAccessControlServiceClient.ListDataAccessLabels(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (DataAccessLabel item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListDataAccessLabelsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (DataAccessLabel item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<DataAccessLabel> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (DataAccessLabel item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListDataAccessLabels(string, string, int?, CallSettings)

public virtual PagedEnumerable<ListDataAccessLabelsResponse, DataAccessLabel> ListDataAccessLabels(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists all data access labels for the customer.

Parameters
Name Description
parent string

Required. The parent resource where this data access label will be created. Format: projects/{project}/locations/{location}/instances/{instance}

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableListDataAccessLabelsResponseDataAccessLabel

A pageable sequence of DataAccessLabel resources.

Example
// Create client
DataAccessControlServiceClient dataAccessControlServiceClient = DataAccessControlServiceClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/instances/[INSTANCE]";
// Make the request
PagedEnumerable<ListDataAccessLabelsResponse, DataAccessLabel> response = dataAccessControlServiceClient.ListDataAccessLabels(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (DataAccessLabel item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListDataAccessLabelsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (DataAccessLabel item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<DataAccessLabel> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (DataAccessLabel item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListDataAccessLabelsAsync(InstanceName, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListDataAccessLabelsResponse, DataAccessLabel> ListDataAccessLabelsAsync(InstanceName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists all data access labels for the customer.

Parameters
Name Description
parent InstanceName

Required. The parent resource where this data access label will be created. Format: projects/{project}/locations/{location}/instances/{instance}

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableListDataAccessLabelsResponseDataAccessLabel

A pageable asynchronous sequence of DataAccessLabel resources.

Example
// Create client
DataAccessControlServiceClient dataAccessControlServiceClient = await DataAccessControlServiceClient.CreateAsync();
// Initialize request argument(s)
InstanceName parent = InstanceName.FromProjectLocationInstance("[PROJECT]", "[LOCATION]", "[INSTANCE]");
// Make the request
PagedAsyncEnumerable<ListDataAccessLabelsResponse, DataAccessLabel> response = dataAccessControlServiceClient.ListDataAccessLabelsAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((DataAccessLabel item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListDataAccessLabelsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (DataAccessLabel item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<DataAccessLabel> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (DataAccessLabel item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListDataAccessLabelsAsync(ListDataAccessLabelsRequest, CallSettings)

public virtual 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.

Example
// Create client
DataAccessControlServiceClient dataAccessControlServiceClient = await DataAccessControlServiceClient.CreateAsync();
// Initialize request argument(s)
ListDataAccessLabelsRequest request = new ListDataAccessLabelsRequest
{
    ParentAsInstanceName = InstanceName.FromProjectLocationInstance("[PROJECT]", "[LOCATION]", "[INSTANCE]"),
    Filter = "",
};
// Make the request
PagedAsyncEnumerable<ListDataAccessLabelsResponse, DataAccessLabel> response = dataAccessControlServiceClient.ListDataAccessLabelsAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((DataAccessLabel item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListDataAccessLabelsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (DataAccessLabel item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<DataAccessLabel> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (DataAccessLabel item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListDataAccessLabelsAsync(string, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListDataAccessLabelsResponse, DataAccessLabel> ListDataAccessLabelsAsync(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists all data access labels for the customer.

Parameters
Name Description
parent string

Required. The parent resource where this data access label will be created. Format: projects/{project}/locations/{location}/instances/{instance}

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableListDataAccessLabelsResponseDataAccessLabel

A pageable asynchronous sequence of DataAccessLabel resources.

Example
// Create client
DataAccessControlServiceClient dataAccessControlServiceClient = await DataAccessControlServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/instances/[INSTANCE]";
// Make the request
PagedAsyncEnumerable<ListDataAccessLabelsResponse, DataAccessLabel> response = dataAccessControlServiceClient.ListDataAccessLabelsAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((DataAccessLabel item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListDataAccessLabelsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (DataAccessLabel item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<DataAccessLabel> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (DataAccessLabel item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListDataAccessScopes(InstanceName, string, int?, CallSettings)

public virtual PagedEnumerable<ListDataAccessScopesResponse, DataAccessScope> ListDataAccessScopes(InstanceName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists all existing data access scopes for the customer.

Parameters
Name Description
parent InstanceName

Required. The parent resource where this data access scope will be created. Format: projects/{project}/locations/{location}/instances/{instance}

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableListDataAccessScopesResponseDataAccessScope

A pageable sequence of DataAccessScope resources.

Example
// Create client
DataAccessControlServiceClient dataAccessControlServiceClient = DataAccessControlServiceClient.Create();
// Initialize request argument(s)
InstanceName parent = InstanceName.FromProjectLocationInstance("[PROJECT]", "[LOCATION]", "[INSTANCE]");
// Make the request
PagedEnumerable<ListDataAccessScopesResponse, DataAccessScope> response = dataAccessControlServiceClient.ListDataAccessScopes(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (DataAccessScope item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListDataAccessScopesResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (DataAccessScope item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<DataAccessScope> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (DataAccessScope item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListDataAccessScopes(ListDataAccessScopesRequest, CallSettings)

public virtual 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.

Example
// Create client
DataAccessControlServiceClient dataAccessControlServiceClient = DataAccessControlServiceClient.Create();
// Initialize request argument(s)
ListDataAccessScopesRequest request = new ListDataAccessScopesRequest
{
    ParentAsInstanceName = InstanceName.FromProjectLocationInstance("[PROJECT]", "[LOCATION]", "[INSTANCE]"),
    Filter = "",
};
// Make the request
PagedEnumerable<ListDataAccessScopesResponse, DataAccessScope> response = dataAccessControlServiceClient.ListDataAccessScopes(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (DataAccessScope item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListDataAccessScopesResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (DataAccessScope item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<DataAccessScope> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (DataAccessScope item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListDataAccessScopes(string, string, int?, CallSettings)

public virtual PagedEnumerable<ListDataAccessScopesResponse, DataAccessScope> ListDataAccessScopes(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists all existing data access scopes for the customer.

Parameters
Name Description
parent string

Required. The parent resource where this data access scope will be created. Format: projects/{project}/locations/{location}/instances/{instance}

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableListDataAccessScopesResponseDataAccessScope

A pageable sequence of DataAccessScope resources.

Example
// Create client
DataAccessControlServiceClient dataAccessControlServiceClient = DataAccessControlServiceClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/instances/[INSTANCE]";
// Make the request
PagedEnumerable<ListDataAccessScopesResponse, DataAccessScope> response = dataAccessControlServiceClient.ListDataAccessScopes(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (DataAccessScope item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListDataAccessScopesResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (DataAccessScope item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<DataAccessScope> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (DataAccessScope item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListDataAccessScopesAsync(InstanceName, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListDataAccessScopesResponse, DataAccessScope> ListDataAccessScopesAsync(InstanceName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists all existing data access scopes for the customer.

Parameters
Name Description
parent InstanceName

Required. The parent resource where this data access scope will be created. Format: projects/{project}/locations/{location}/instances/{instance}

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableListDataAccessScopesResponseDataAccessScope

A pageable asynchronous sequence of DataAccessScope resources.

Example
// Create client
DataAccessControlServiceClient dataAccessControlServiceClient = await DataAccessControlServiceClient.CreateAsync();
// Initialize request argument(s)
InstanceName parent = InstanceName.FromProjectLocationInstance("[PROJECT]", "[LOCATION]", "[INSTANCE]");
// Make the request
PagedAsyncEnumerable<ListDataAccessScopesResponse, DataAccessScope> response = dataAccessControlServiceClient.ListDataAccessScopesAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((DataAccessScope item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListDataAccessScopesResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (DataAccessScope item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<DataAccessScope> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (DataAccessScope item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListDataAccessScopesAsync(ListDataAccessScopesRequest, CallSettings)

public virtual 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.

Example
// Create client
DataAccessControlServiceClient dataAccessControlServiceClient = await DataAccessControlServiceClient.CreateAsync();
// Initialize request argument(s)
ListDataAccessScopesRequest request = new ListDataAccessScopesRequest
{
    ParentAsInstanceName = InstanceName.FromProjectLocationInstance("[PROJECT]", "[LOCATION]", "[INSTANCE]"),
    Filter = "",
};
// Make the request
PagedAsyncEnumerable<ListDataAccessScopesResponse, DataAccessScope> response = dataAccessControlServiceClient.ListDataAccessScopesAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((DataAccessScope item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListDataAccessScopesResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (DataAccessScope item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<DataAccessScope> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (DataAccessScope item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListDataAccessScopesAsync(string, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListDataAccessScopesResponse, DataAccessScope> ListDataAccessScopesAsync(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists all existing data access scopes for the customer.

Parameters
Name Description
parent string

Required. The parent resource where this data access scope will be created. Format: projects/{project}/locations/{location}/instances/{instance}

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableListDataAccessScopesResponseDataAccessScope

A pageable asynchronous sequence of DataAccessScope resources.

Example
// Create client
DataAccessControlServiceClient dataAccessControlServiceClient = await DataAccessControlServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/instances/[INSTANCE]";
// Make the request
PagedAsyncEnumerable<ListDataAccessScopesResponse, DataAccessScope> response = dataAccessControlServiceClient.ListDataAccessScopesAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((DataAccessScope item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListDataAccessScopesResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (DataAccessScope item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<DataAccessScope> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (DataAccessScope item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ShutdownDefaultChannelsAsync()

public static Task ShutdownDefaultChannelsAsync()

Shuts down any channels automatically created by Create() and CreateAsync(CancellationToken). Channels which weren't automatically created are not affected.

Returns
Type Description
Task

A task representing the asynchronous shutdown operation.

Remarks

After calling this method, further calls to Create() and CreateAsync(CancellationToken) will create new channels, which could in turn be shut down by another call to this method.

UpdateDataAccessLabel(DataAccessLabel, FieldMask, CallSettings)

public virtual DataAccessLabel UpdateDataAccessLabel(DataAccessLabel dataAccessLabel, FieldMask updateMask, CallSettings callSettings = null)

Updates a data access label.

Parameters
Name Description
dataAccessLabel DataAccessLabel

Required. The data access label to update.

The label's name field is used to identify the label to update. Format: projects/{project}/locations/{location}/instances/{instance}/dataAccessLabels/{data_access_label}

updateMask FieldMask

The list of fields to update. If not included, all fields with a non-empty value will be overwritten. Currently, only the description and definition fields are supported for update; an update call that attempts to update any other fields will return INVALID_ARGUMENT.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
DataAccessLabel

The RPC response.

Example
// Create client
DataAccessControlServiceClient dataAccessControlServiceClient = DataAccessControlServiceClient.Create();
// Initialize request argument(s)
DataAccessLabel dataAccessLabel = new DataAccessLabel();
FieldMask updateMask = new FieldMask();
// Make the request
DataAccessLabel response = dataAccessControlServiceClient.UpdateDataAccessLabel(dataAccessLabel, updateMask);

UpdateDataAccessLabel(UpdateDataAccessLabelRequest, CallSettings)

public virtual 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.

Example
// Create client
DataAccessControlServiceClient dataAccessControlServiceClient = DataAccessControlServiceClient.Create();
// Initialize request argument(s)
UpdateDataAccessLabelRequest request = new UpdateDataAccessLabelRequest
{
    DataAccessLabel = new DataAccessLabel(),
    UpdateMask = new FieldMask(),
};
// Make the request
DataAccessLabel response = dataAccessControlServiceClient.UpdateDataAccessLabel(request);

UpdateDataAccessLabelAsync(DataAccessLabel, FieldMask, CallSettings)

public virtual Task<DataAccessLabel> UpdateDataAccessLabelAsync(DataAccessLabel dataAccessLabel, FieldMask updateMask, CallSettings callSettings = null)

Updates a data access label.

Parameters
Name Description
dataAccessLabel DataAccessLabel

Required. The data access label to update.

The label's name field is used to identify the label to update. Format: projects/{project}/locations/{location}/instances/{instance}/dataAccessLabels/{data_access_label}

updateMask FieldMask

The list of fields to update. If not included, all fields with a non-empty value will be overwritten. Currently, only the description and definition fields are supported for update; an update call that attempts to update any other fields will return INVALID_ARGUMENT.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskDataAccessLabel

A Task containing the RPC response.

Example
// Create client
DataAccessControlServiceClient dataAccessControlServiceClient = await DataAccessControlServiceClient.CreateAsync();
// Initialize request argument(s)
DataAccessLabel dataAccessLabel = new DataAccessLabel();
FieldMask updateMask = new FieldMask();
// Make the request
DataAccessLabel response = await dataAccessControlServiceClient.UpdateDataAccessLabelAsync(dataAccessLabel, updateMask);

UpdateDataAccessLabelAsync(DataAccessLabel, FieldMask, CancellationToken)

public virtual Task<DataAccessLabel> UpdateDataAccessLabelAsync(DataAccessLabel dataAccessLabel, FieldMask updateMask, CancellationToken cancellationToken)

Updates a data access label.

Parameters
Name Description
dataAccessLabel DataAccessLabel

Required. The data access label to update.

The label's name field is used to identify the label to update. Format: projects/{project}/locations/{location}/instances/{instance}/dataAccessLabels/{data_access_label}

updateMask FieldMask

The list of fields to update. If not included, all fields with a non-empty value will be overwritten. Currently, only the description and definition fields are supported for update; an update call that attempts to update any other fields will return INVALID_ARGUMENT.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskDataAccessLabel

A Task containing the RPC response.

Example
// Create client
DataAccessControlServiceClient dataAccessControlServiceClient = await DataAccessControlServiceClient.CreateAsync();
// Initialize request argument(s)
DataAccessLabel dataAccessLabel = new DataAccessLabel();
FieldMask updateMask = new FieldMask();
// Make the request
DataAccessLabel response = await dataAccessControlServiceClient.UpdateDataAccessLabelAsync(dataAccessLabel, updateMask);

UpdateDataAccessLabelAsync(UpdateDataAccessLabelRequest, CallSettings)

public virtual 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.

Example
// Create client
DataAccessControlServiceClient dataAccessControlServiceClient = await DataAccessControlServiceClient.CreateAsync();
// Initialize request argument(s)
UpdateDataAccessLabelRequest request = new UpdateDataAccessLabelRequest
{
    DataAccessLabel = new DataAccessLabel(),
    UpdateMask = new FieldMask(),
};
// Make the request
DataAccessLabel response = await dataAccessControlServiceClient.UpdateDataAccessLabelAsync(request);

UpdateDataAccessLabelAsync(UpdateDataAccessLabelRequest, CancellationToken)

public virtual Task<DataAccessLabel> UpdateDataAccessLabelAsync(UpdateDataAccessLabelRequest request, CancellationToken cancellationToken)

Updates a data access label.

Parameters
Name Description
request UpdateDataAccessLabelRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskDataAccessLabel

A Task containing the RPC response.

Example
// Create client
DataAccessControlServiceClient dataAccessControlServiceClient = await DataAccessControlServiceClient.CreateAsync();
// Initialize request argument(s)
UpdateDataAccessLabelRequest request = new UpdateDataAccessLabelRequest
{
    DataAccessLabel = new DataAccessLabel(),
    UpdateMask = new FieldMask(),
};
// Make the request
DataAccessLabel response = await dataAccessControlServiceClient.UpdateDataAccessLabelAsync(request);

UpdateDataAccessScope(DataAccessScope, FieldMask, CallSettings)

public virtual DataAccessScope UpdateDataAccessScope(DataAccessScope dataAccessScope, FieldMask updateMask, CallSettings callSettings = null)

Updates a data access scope.

Parameters
Name Description
dataAccessScope DataAccessScope

Required. The data access scope to update.

The scope's name field is used to identify the scope to update. Format: projects/{project}/locations/{location}/instances/{instance}/dataAccessScopes/{data_access_scope}

updateMask FieldMask

The list of fields to update. If not included, all fields with a non-empty value will be overwritten. Currently, only the description, the allowed and denied labels list fields are supported for update; an update call that attempts to update any other fields will return INVALID_ARGUMENT.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
DataAccessScope

The RPC response.

Example
// Create client
DataAccessControlServiceClient dataAccessControlServiceClient = DataAccessControlServiceClient.Create();
// Initialize request argument(s)
DataAccessScope dataAccessScope = new DataAccessScope();
FieldMask updateMask = new FieldMask();
// Make the request
DataAccessScope response = dataAccessControlServiceClient.UpdateDataAccessScope(dataAccessScope, updateMask);

UpdateDataAccessScope(UpdateDataAccessScopeRequest, CallSettings)

public virtual 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.

Example
// Create client
DataAccessControlServiceClient dataAccessControlServiceClient = DataAccessControlServiceClient.Create();
// Initialize request argument(s)
UpdateDataAccessScopeRequest request = new UpdateDataAccessScopeRequest
{
    DataAccessScope = new DataAccessScope(),
    UpdateMask = new FieldMask(),
};
// Make the request
DataAccessScope response = dataAccessControlServiceClient.UpdateDataAccessScope(request);

UpdateDataAccessScopeAsync(DataAccessScope, FieldMask, CallSettings)

public virtual Task<DataAccessScope> UpdateDataAccessScopeAsync(DataAccessScope dataAccessScope, FieldMask updateMask, CallSettings callSettings = null)

Updates a data access scope.

Parameters
Name Description
dataAccessScope DataAccessScope

Required. The data access scope to update.

The scope's name field is used to identify the scope to update. Format: projects/{project}/locations/{location}/instances/{instance}/dataAccessScopes/{data_access_scope}

updateMask FieldMask

The list of fields to update. If not included, all fields with a non-empty value will be overwritten. Currently, only the description, the allowed and denied labels list fields are supported for update; an update call that attempts to update any other fields will return INVALID_ARGUMENT.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskDataAccessScope

A Task containing the RPC response.

Example
// Create client
DataAccessControlServiceClient dataAccessControlServiceClient = await DataAccessControlServiceClient.CreateAsync();
// Initialize request argument(s)
DataAccessScope dataAccessScope = new DataAccessScope();
FieldMask updateMask = new FieldMask();
// Make the request
DataAccessScope response = await dataAccessControlServiceClient.UpdateDataAccessScopeAsync(dataAccessScope, updateMask);

UpdateDataAccessScopeAsync(DataAccessScope, FieldMask, CancellationToken)

public virtual Task<DataAccessScope> UpdateDataAccessScopeAsync(DataAccessScope dataAccessScope, FieldMask updateMask, CancellationToken cancellationToken)

Updates a data access scope.

Parameters
Name Description
dataAccessScope DataAccessScope

Required. The data access scope to update.

The scope's name field is used to identify the scope to update. Format: projects/{project}/locations/{location}/instances/{instance}/dataAccessScopes/{data_access_scope}

updateMask FieldMask

The list of fields to update. If not included, all fields with a non-empty value will be overwritten. Currently, only the description, the allowed and denied labels list fields are supported for update; an update call that attempts to update any other fields will return INVALID_ARGUMENT.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskDataAccessScope

A Task containing the RPC response.

Example
// Create client
DataAccessControlServiceClient dataAccessControlServiceClient = await DataAccessControlServiceClient.CreateAsync();
// Initialize request argument(s)
DataAccessScope dataAccessScope = new DataAccessScope();
FieldMask updateMask = new FieldMask();
// Make the request
DataAccessScope response = await dataAccessControlServiceClient.UpdateDataAccessScopeAsync(dataAccessScope, updateMask);

UpdateDataAccessScopeAsync(UpdateDataAccessScopeRequest, CallSettings)

public virtual 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.

Example
// Create client
DataAccessControlServiceClient dataAccessControlServiceClient = await DataAccessControlServiceClient.CreateAsync();
// Initialize request argument(s)
UpdateDataAccessScopeRequest request = new UpdateDataAccessScopeRequest
{
    DataAccessScope = new DataAccessScope(),
    UpdateMask = new FieldMask(),
};
// Make the request
DataAccessScope response = await dataAccessControlServiceClient.UpdateDataAccessScopeAsync(request);

UpdateDataAccessScopeAsync(UpdateDataAccessScopeRequest, CancellationToken)

public virtual Task<DataAccessScope> UpdateDataAccessScopeAsync(UpdateDataAccessScopeRequest request, CancellationToken cancellationToken)

Updates a data access scope.

Parameters
Name Description
request UpdateDataAccessScopeRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskDataAccessScope

A Task containing the RPC response.

Example
// Create client
DataAccessControlServiceClient dataAccessControlServiceClient = await DataAccessControlServiceClient.CreateAsync();
// Initialize request argument(s)
UpdateDataAccessScopeRequest request = new UpdateDataAccessScopeRequest
{
    DataAccessScope = new DataAccessScope(),
    UpdateMask = new FieldMask(),
};
// Make the request
DataAccessScope response = await dataAccessControlServiceClient.UpdateDataAccessScopeAsync(request);