BigQuery Data Policy v1 API - Class DataPolicyService.DataPolicyServiceClient (1.5.0)

Version latest

• 1.5.0 (latest)
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0

public class DataPolicyService.DataPolicyServiceClient : ClientBase<DataPolicyService.DataPolicyServiceClient>

Reference documentation and code samples for the BigQuery Data Policy v1 API class DataPolicyService.DataPolicyServiceClient.

Client for DataPolicyService

Inheritance

object > ClientBase > ClientBaseDataPolicyServiceDataPolicyServiceClient > DataPolicyService.DataPolicyServiceClient

Inherited Members

ClientBase<DataPolicyService.DataPolicyServiceClient>.WithHost(string)

ClientBase.CallInvoker

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.BigQuery.DataPolicies.V1

Assembly

Google.Cloud.BigQuery.DataPolicies.V1.dll

Constructors

DataPolicyServiceClient()

protected DataPolicyServiceClient()

Protected parameterless constructor to allow creation of test doubles.

DataPolicyServiceClient(CallInvoker)

public DataPolicyServiceClient(CallInvoker callInvoker)

Creates a new client for DataPolicyService that uses a custom CallInvoker.

Parameter
Name	Description
callInvoker	CallInvoker The callInvoker to use to make remote calls.

DataPolicyServiceClient(ChannelBase)

public DataPolicyServiceClient(ChannelBase channel)

Creates a new client for DataPolicyService

Parameter
Name	Description
channel	ChannelBase The channel to use to make remote calls.

DataPolicyServiceClient(ClientBaseConfiguration)

protected DataPolicyServiceClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration The client configuration.

Methods

CreateDataPolicy(CreateDataPolicyRequest, CallOptions)

public virtual DataPolicy CreateDataPolicy(CreateDataPolicyRequest request, CallOptions options)

Creates a new data policy under a project with the given dataPolicyId (used as the display name), policy tag, and data policy type.

Parameters
Name	Description
request	CreateDataPolicyRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
DataPolicy	The response received from the server.

CreateDataPolicy(CreateDataPolicyRequest, Metadata, DateTime?, CancellationToken)

public virtual DataPolicy CreateDataPolicy(CreateDataPolicyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates a new data policy under a project with the given dataPolicyId (used as the display name), policy tag, and data policy type.

Parameters
Name	Description
request	CreateDataPolicyRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
DataPolicy	The response received from the server.

CreateDataPolicyAsync(CreateDataPolicyRequest, CallOptions)

public virtual AsyncUnaryCall<DataPolicy> CreateDataPolicyAsync(CreateDataPolicyRequest request, CallOptions options)

Creates a new data policy under a project with the given dataPolicyId (used as the display name), policy tag, and data policy type.

Parameters
Name	Description
request	CreateDataPolicyRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallDataPolicy	The call object.

CreateDataPolicyAsync(CreateDataPolicyRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<DataPolicy> CreateDataPolicyAsync(CreateDataPolicyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates a new data policy under a project with the given dataPolicyId (used as the display name), policy tag, and data policy type.

Parameters
Name	Description
request	CreateDataPolicyRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallDataPolicy	The call object.

DeleteDataPolicy(DeleteDataPolicyRequest, CallOptions)

public virtual Empty DeleteDataPolicy(DeleteDataPolicyRequest request, CallOptions options)

Deletes the data policy specified by its resource name.

Parameters
Name	Description
request	DeleteDataPolicyRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Empty	The response received from the server.

DeleteDataPolicy(DeleteDataPolicyRequest, Metadata, DateTime?, CancellationToken)

public virtual Empty DeleteDataPolicy(DeleteDataPolicyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes the data policy specified by its resource name.

Parameters
Name	Description
request	DeleteDataPolicyRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Empty	The response received from the server.

DeleteDataPolicyAsync(DeleteDataPolicyRequest, CallOptions)

public virtual AsyncUnaryCall<Empty> DeleteDataPolicyAsync(DeleteDataPolicyRequest request, CallOptions options)

Deletes the data policy specified by its resource name.

Parameters
Name	Description
request	DeleteDataPolicyRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallEmpty	The call object.

DeleteDataPolicyAsync(DeleteDataPolicyRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Empty> DeleteDataPolicyAsync(DeleteDataPolicyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes the data policy specified by its resource name.

Parameters
Name	Description
request	DeleteDataPolicyRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallEmpty	The call object.

GetDataPolicy(GetDataPolicyRequest, CallOptions)

public virtual DataPolicy GetDataPolicy(GetDataPolicyRequest request, CallOptions options)

Gets the data policy specified by its resource name.

Parameters
Name	Description
request	GetDataPolicyRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
DataPolicy	The response received from the server.

GetDataPolicy(GetDataPolicyRequest, Metadata, DateTime?, CancellationToken)

public virtual DataPolicy GetDataPolicy(GetDataPolicyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets the data policy specified by its resource name.

Parameters
Name	Description
request	GetDataPolicyRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
DataPolicy	The response received from the server.

GetDataPolicyAsync(GetDataPolicyRequest, CallOptions)

public virtual AsyncUnaryCall<DataPolicy> GetDataPolicyAsync(GetDataPolicyRequest request, CallOptions options)

Gets the data policy specified by its resource name.

Parameters
Name	Description
request	GetDataPolicyRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallDataPolicy	The call object.

GetDataPolicyAsync(GetDataPolicyRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<DataPolicy> GetDataPolicyAsync(GetDataPolicyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets the data policy specified by its resource name.

Parameters
Name	Description
request	GetDataPolicyRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallDataPolicy	The call object.

GetIamPolicy(GetIamPolicyRequest, CallOptions)

public virtual Policy GetIamPolicy(GetIamPolicyRequest request, CallOptions options)

Gets the IAM policy for the specified data policy.

Parameters
Name	Description
request	GetIamPolicyRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Policy	The response received from the server.

GetIamPolicy(GetIamPolicyRequest, Metadata, DateTime?, CancellationToken)

public virtual Policy GetIamPolicy(GetIamPolicyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets the IAM policy for the specified data policy.

Parameters
Name	Description
request	GetIamPolicyRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Policy	The response received from the server.

GetIamPolicyAsync(GetIamPolicyRequest, CallOptions)

public virtual AsyncUnaryCall<Policy> GetIamPolicyAsync(GetIamPolicyRequest request, CallOptions options)

Gets the IAM policy for the specified data policy.

Parameters
Name	Description
request	GetIamPolicyRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallPolicy	The call object.

GetIamPolicyAsync(GetIamPolicyRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Policy> GetIamPolicyAsync(GetIamPolicyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets the IAM policy for the specified data policy.

Parameters
Name	Description
request	GetIamPolicyRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallPolicy	The call object.

ListDataPolicies(ListDataPoliciesRequest, CallOptions)

public virtual ListDataPoliciesResponse ListDataPolicies(ListDataPoliciesRequest request, CallOptions options)

List all of the data policies in the specified parent project.

Parameters
Name	Description
request	ListDataPoliciesRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
ListDataPoliciesResponse	The response received from the server.

ListDataPolicies(ListDataPoliciesRequest, Metadata, DateTime?, CancellationToken)

public virtual ListDataPoliciesResponse ListDataPolicies(ListDataPoliciesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

List all of the data policies in the specified parent project.

Parameters
Name	Description
request	ListDataPoliciesRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
ListDataPoliciesResponse	The response received from the server.

ListDataPoliciesAsync(ListDataPoliciesRequest, CallOptions)

public virtual AsyncUnaryCall<ListDataPoliciesResponse> ListDataPoliciesAsync(ListDataPoliciesRequest request, CallOptions options)

List all of the data policies in the specified parent project.

Parameters
Name	Description
request	ListDataPoliciesRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallListDataPoliciesResponse	The call object.

ListDataPoliciesAsync(ListDataPoliciesRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListDataPoliciesResponse> ListDataPoliciesAsync(ListDataPoliciesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

List all of the data policies in the specified parent project.

Parameters
Name	Description
request	ListDataPoliciesRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallListDataPoliciesResponse	The call object.

NewInstance(ClientBaseConfiguration)

protected override DataPolicyService.DataPolicyServiceClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration

Returns
Type	Description
DataPolicyServiceDataPolicyServiceClient

Overrides

ClientBase<DataPolicyService.DataPolicyServiceClient>.NewInstance(ClientBase.ClientBaseConfiguration)

RenameDataPolicy(RenameDataPolicyRequest, CallOptions)

public virtual DataPolicy RenameDataPolicy(RenameDataPolicyRequest request, CallOptions options)

Renames the id (display name) of the specified data policy.

Parameters
Name	Description
request	RenameDataPolicyRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
DataPolicy	The response received from the server.

RenameDataPolicy(RenameDataPolicyRequest, Metadata, DateTime?, CancellationToken)

public virtual DataPolicy RenameDataPolicy(RenameDataPolicyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Renames the id (display name) of the specified data policy.

Parameters
Name	Description
request	RenameDataPolicyRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
DataPolicy	The response received from the server.

RenameDataPolicyAsync(RenameDataPolicyRequest, CallOptions)

public virtual AsyncUnaryCall<DataPolicy> RenameDataPolicyAsync(RenameDataPolicyRequest request, CallOptions options)

Renames the id (display name) of the specified data policy.

Parameters
Name	Description
request	RenameDataPolicyRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallDataPolicy	The call object.

RenameDataPolicyAsync(RenameDataPolicyRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<DataPolicy> RenameDataPolicyAsync(RenameDataPolicyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Renames the id (display name) of the specified data policy.

Parameters
Name	Description
request	RenameDataPolicyRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallDataPolicy	The call object.

SetIamPolicy(SetIamPolicyRequest, CallOptions)

public virtual Policy SetIamPolicy(SetIamPolicyRequest request, CallOptions options)

Sets the IAM policy for the specified data policy.

Parameters
Name	Description
request	SetIamPolicyRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Policy	The response received from the server.

SetIamPolicy(SetIamPolicyRequest, Metadata, DateTime?, CancellationToken)

public virtual Policy SetIamPolicy(SetIamPolicyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Sets the IAM policy for the specified data policy.

Parameters
Name	Description
request	SetIamPolicyRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Policy	The response received from the server.

SetIamPolicyAsync(SetIamPolicyRequest, CallOptions)

public virtual AsyncUnaryCall<Policy> SetIamPolicyAsync(SetIamPolicyRequest request, CallOptions options)

Sets the IAM policy for the specified data policy.

Parameters
Name	Description
request	SetIamPolicyRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallPolicy	The call object.

SetIamPolicyAsync(SetIamPolicyRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Policy> SetIamPolicyAsync(SetIamPolicyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Sets the IAM policy for the specified data policy.

Parameters
Name	Description
request	SetIamPolicyRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallPolicy	The call object.

TestIamPermissions(TestIamPermissionsRequest, CallOptions)

public virtual TestIamPermissionsResponse TestIamPermissions(TestIamPermissionsRequest request, CallOptions options)

Returns the caller's permission on the specified data policy resource.

Parameters
Name	Description
request	TestIamPermissionsRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
TestIamPermissionsResponse	The response received from the server.

TestIamPermissions(TestIamPermissionsRequest, Metadata, DateTime?, CancellationToken)

public virtual TestIamPermissionsResponse TestIamPermissions(TestIamPermissionsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Returns the caller's permission on the specified data policy resource.

Parameters
Name	Description
request	TestIamPermissionsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
TestIamPermissionsResponse	The response received from the server.

TestIamPermissionsAsync(TestIamPermissionsRequest, CallOptions)

public virtual AsyncUnaryCall<TestIamPermissionsResponse> TestIamPermissionsAsync(TestIamPermissionsRequest request, CallOptions options)

Returns the caller's permission on the specified data policy resource.

Parameters
Name	Description
request	TestIamPermissionsRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallTestIamPermissionsResponse	The call object.

TestIamPermissionsAsync(TestIamPermissionsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<TestIamPermissionsResponse> TestIamPermissionsAsync(TestIamPermissionsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Returns the caller's permission on the specified data policy resource.

Parameters
Name	Description
request	TestIamPermissionsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallTestIamPermissionsResponse	The call object.

UpdateDataPolicy(UpdateDataPolicyRequest, CallOptions)

public virtual DataPolicy UpdateDataPolicy(UpdateDataPolicyRequest request, CallOptions options)

Updates the metadata for an existing data policy. The target data policy can be specified by the resource name.

Parameters
Name	Description
request	UpdateDataPolicyRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
DataPolicy	The response received from the server.

UpdateDataPolicy(UpdateDataPolicyRequest, Metadata, DateTime?, CancellationToken)

public virtual DataPolicy UpdateDataPolicy(UpdateDataPolicyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates the metadata for an existing data policy. The target data policy can be specified by the resource name.

Parameters
Name	Description
request	UpdateDataPolicyRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
DataPolicy	The response received from the server.

UpdateDataPolicyAsync(UpdateDataPolicyRequest, CallOptions)

public virtual AsyncUnaryCall<DataPolicy> UpdateDataPolicyAsync(UpdateDataPolicyRequest request, CallOptions options)

Updates the metadata for an existing data policy. The target data policy can be specified by the resource name.

Parameters
Name	Description
request	UpdateDataPolicyRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallDataPolicy	The call object.

UpdateDataPolicyAsync(UpdateDataPolicyRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<DataPolicy> UpdateDataPolicyAsync(UpdateDataPolicyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates the metadata for an existing data policy. The target data policy can be specified by the resource name.

Parameters
Name	Description
request	UpdateDataPolicyRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallDataPolicy	The call object.