BigQuery Data Policy v1beta1 API - Class DataPolicyService.DataPolicyServiceClient (1.0.0-beta01)

public class DataPolicyServiceClient : ClientBase<DataPolicyService.DataPolicyServiceClient>

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

Client for DataPolicyService

Inheritance

Object > ClientBase > ClientBase<DataPolicyService.DataPolicyServiceClient> > DataPolicyService.DataPolicyServiceClient

Namespace

Google.Cloud.BigQuery.DataPolicies.V1Beta1

Assembly

Google.Cloud.BigQuery.DataPolicies.V1Beta1.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
NameDescription
callInvokerCallInvoker

The callInvoker to use to make remote calls.

DataPolicyServiceClient(ChannelBase)

public DataPolicyServiceClient(ChannelBase channel)

Creates a new client for DataPolicyService

Parameter
NameDescription
channelChannelBase

The channel to use to make remote calls.

DataPolicyServiceClient(ClientBase.ClientBaseConfiguration)

protected DataPolicyServiceClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
NameDescription
configurationClientBase.ClientBaseConfiguration

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
NameDescription
requestCreateDataPolicyRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
DataPolicy

The response received from the server.

CreateDataPolicy(CreateDataPolicyRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

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

Parameters
NameDescription
requestCreateDataPolicyRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
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
NameDescription
requestCreateDataPolicyRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<DataPolicy>

The call object.

CreateDataPolicyAsync(CreateDataPolicyRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

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

Parameters
NameDescription
requestCreateDataPolicyRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<DataPolicy>

The call object.

DeleteDataPolicy(DeleteDataPolicyRequest, CallOptions)

public virtual Empty DeleteDataPolicy(DeleteDataPolicyRequest request, CallOptions options)

Deletes the data policy specified by its resource name.

Parameters
NameDescription
requestDeleteDataPolicyRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Empty

The response received from the server.

DeleteDataPolicy(DeleteDataPolicyRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Deletes the data policy specified by its resource name.

Parameters
NameDescription
requestDeleteDataPolicyRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
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
NameDescription
requestDeleteDataPolicyRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Empty>

The call object.

DeleteDataPolicyAsync(DeleteDataPolicyRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Deletes the data policy specified by its resource name.

Parameters
NameDescription
requestDeleteDataPolicyRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Empty>

The call object.

GetDataPolicy(GetDataPolicyRequest, CallOptions)

public virtual DataPolicy GetDataPolicy(GetDataPolicyRequest request, CallOptions options)

Gets the data policy specified by its resource name.

Parameters
NameDescription
requestGetDataPolicyRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
DataPolicy

The response received from the server.

GetDataPolicy(GetDataPolicyRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Gets the data policy specified by its resource name.

Parameters
NameDescription
requestGetDataPolicyRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
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
NameDescription
requestGetDataPolicyRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<DataPolicy>

The call object.

GetDataPolicyAsync(GetDataPolicyRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Gets the data policy specified by its resource name.

Parameters
NameDescription
requestGetDataPolicyRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<DataPolicy>

The call object.

GetIamPolicy(GetIamPolicyRequest, CallOptions)

public virtual Policy GetIamPolicy(GetIamPolicyRequest request, CallOptions options)

Gets the IAM policy for the specified data policy.

Parameters
NameDescription
requestGetIamPolicyRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Policy

The response received from the server.

GetIamPolicy(GetIamPolicyRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Gets the IAM policy for the specified data policy.

Parameters
NameDescription
requestGetIamPolicyRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
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
NameDescription
requestGetIamPolicyRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Policy>

The call object.

GetIamPolicyAsync(GetIamPolicyRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Gets the IAM policy for the specified data policy.

Parameters
NameDescription
requestGetIamPolicyRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Policy>

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
NameDescription
requestListDataPoliciesRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
ListDataPoliciesResponse

The response received from the server.

ListDataPolicies(ListDataPoliciesRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

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

Parameters
NameDescription
requestListDataPoliciesRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
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
NameDescription
requestListDataPoliciesRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<ListDataPoliciesResponse>

The call object.

ListDataPoliciesAsync(ListDataPoliciesRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

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

Parameters
NameDescription
requestListDataPoliciesRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<ListDataPoliciesResponse>

The call object.

NewInstance(ClientBase.ClientBaseConfiguration)

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

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
NameDescription
configurationClientBase.ClientBaseConfiguration
Returns
TypeDescription
DataPolicyService.DataPolicyServiceClient
Overrides
Grpc.Core.ClientBase<Google.Cloud.BigQuery.DataPolicies.V1Beta1.DataPolicyService.DataPolicyServiceClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

SetIamPolicy(SetIamPolicyRequest, CallOptions)

public virtual Policy SetIamPolicy(SetIamPolicyRequest request, CallOptions options)

Sets the IAM policy for the specified data policy.

Parameters
NameDescription
requestSetIamPolicyRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Policy

The response received from the server.

SetIamPolicy(SetIamPolicyRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Sets the IAM policy for the specified data policy.

Parameters
NameDescription
requestSetIamPolicyRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
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
NameDescription
requestSetIamPolicyRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Policy>

The call object.

SetIamPolicyAsync(SetIamPolicyRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Sets the IAM policy for the specified data policy.

Parameters
NameDescription
requestSetIamPolicyRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Policy>

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
NameDescription
requestTestIamPermissionsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
TestIamPermissionsResponse

The response received from the server.

TestIamPermissions(TestIamPermissionsRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

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

Parameters
NameDescription
requestTestIamPermissionsRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
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
NameDescription
requestTestIamPermissionsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<TestIamPermissionsResponse>

The call object.

TestIamPermissionsAsync(TestIamPermissionsRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

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

Parameters
NameDescription
requestTestIamPermissionsRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<TestIamPermissionsResponse>

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
NameDescription
requestUpdateDataPolicyRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
DataPolicy

The response received from the server.

UpdateDataPolicy(UpdateDataPolicyRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

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

Parameters
NameDescription
requestUpdateDataPolicyRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
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
NameDescription
requestUpdateDataPolicyRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<DataPolicy>

The call object.

UpdateDataPolicyAsync(UpdateDataPolicyRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

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

Parameters
NameDescription
requestUpdateDataPolicyRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<DataPolicy>

The call object.