Package com.google.cloud.bigquery.datapolicies.v1 (0.24.0)

A client to BigQuery Data Policy API

The interfaces provided are listed below, along with usage samples.

DataPolicyServiceClient

Service Description: Data Policy Service provides APIs for managing the label-policy bindings.

Sample for DataPolicyServiceClient:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataPolicyServiceClient dataPolicyServiceClient = DataPolicyServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   DataPolicy dataPolicy = DataPolicy.newBuilder().build();
   DataPolicy response = dataPolicyServiceClient.createDataPolicy(parent, dataPolicy);
 }
 

Classes

CreateDataPolicyRequest

Request message for the CreateDataPolicy method.

Protobuf type google.cloud.bigquery.datapolicies.v1.CreateDataPolicyRequest

CreateDataPolicyRequest.Builder

Request message for the CreateDataPolicy method.

Protobuf type google.cloud.bigquery.datapolicies.v1.CreateDataPolicyRequest

DataMaskingPolicy

The data masking policy that is used to specify data masking rule.

Protobuf type google.cloud.bigquery.datapolicies.v1.DataMaskingPolicy

DataMaskingPolicy.Builder

The data masking policy that is used to specify data masking rule.

Protobuf type google.cloud.bigquery.datapolicies.v1.DataMaskingPolicy

DataPolicy

Represents the label-policy binding.

Protobuf type google.cloud.bigquery.datapolicies.v1.DataPolicy

DataPolicy.Builder

Represents the label-policy binding.

Protobuf type google.cloud.bigquery.datapolicies.v1.DataPolicy

DataPolicyName

DataPolicyName.Builder

Builder for projects/{project}/locations/{location}/dataPolicies/{data_policy}.

DataPolicyProto

DataPolicyServiceClient

Service Description: Data Policy Service provides APIs for managing the label-policy bindings.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataPolicyServiceClient dataPolicyServiceClient = DataPolicyServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   DataPolicy dataPolicy = DataPolicy.newBuilder().build();
   DataPolicy response = dataPolicyServiceClient.createDataPolicy(parent, dataPolicy);
 }
 

Note: close() needs to be called on the DataPolicyServiceClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

The surface of this class includes several types of Java methods for each of the API's methods:

  1. A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
  2. A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
  3. A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of DataPolicyServiceSettings to create(). For example:

To customize credentials:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 DataPolicyServiceSettings dataPolicyServiceSettings =
     DataPolicyServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 DataPolicyServiceClient dataPolicyServiceClient =
     DataPolicyServiceClient.create(dataPolicyServiceSettings);
 

To customize the endpoint:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 DataPolicyServiceSettings dataPolicyServiceSettings =
     DataPolicyServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 DataPolicyServiceClient dataPolicyServiceClient =
     DataPolicyServiceClient.create(dataPolicyServiceSettings);
 

To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 DataPolicyServiceSettings dataPolicyServiceSettings =
     DataPolicyServiceSettings.newHttpJsonBuilder().build();
 DataPolicyServiceClient dataPolicyServiceClient =
     DataPolicyServiceClient.create(dataPolicyServiceSettings);
 

Please refer to the GitHub repository's samples for more quickstart code snippets.

DataPolicyServiceClient.ListDataPoliciesFixedSizeCollection

DataPolicyServiceClient.ListDataPoliciesPage

DataPolicyServiceClient.ListDataPoliciesPagedResponse

DataPolicyServiceGrpc

Data Policy Service provides APIs for managing the label-policy bindings.

DataPolicyServiceGrpc.DataPolicyServiceBlockingStub

A stub to allow clients to do synchronous rpc calls to service DataPolicyService.

Data Policy Service provides APIs for managing the label-policy bindings.

DataPolicyServiceGrpc.DataPolicyServiceFutureStub

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

Data Policy Service provides APIs for managing the label-policy bindings.

DataPolicyServiceGrpc.DataPolicyServiceImplBase

Base class for the server implementation of the service DataPolicyService.

Data Policy Service provides APIs for managing the label-policy bindings.

DataPolicyServiceGrpc.DataPolicyServiceStub

A stub to allow clients to do asynchronous rpc calls to service DataPolicyService.

Data Policy Service provides APIs for managing the label-policy bindings.

DataPolicyServiceSettings

Settings class to configure an instance of DataPolicyServiceClient.

The default instance has everything set to sensible defaults:

  • The default service address (bigquerydatapolicy.googleapis.com) and default port (443) are used.
  • Credentials are acquired automatically through Application Default Credentials.
  • Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the total timeout of createDataPolicy to 30 seconds:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 DataPolicyServiceSettings.Builder dataPolicyServiceSettingsBuilder =
     DataPolicyServiceSettings.newBuilder();
 dataPolicyServiceSettingsBuilder
     .createDataPolicySettings()
     .setRetrySettings(
         dataPolicyServiceSettingsBuilder
             .createDataPolicySettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 DataPolicyServiceSettings dataPolicyServiceSettings = dataPolicyServiceSettingsBuilder.build();
 

DataPolicyServiceSettings.Builder

Builder for DataPolicyServiceSettings.

DeleteDataPolicyRequest

Request message for the DeleteDataPolicy method.

Protobuf type google.cloud.bigquery.datapolicies.v1.DeleteDataPolicyRequest

DeleteDataPolicyRequest.Builder

Request message for the DeleteDataPolicy method.

Protobuf type google.cloud.bigquery.datapolicies.v1.DeleteDataPolicyRequest

GetDataPolicyRequest

Request message for the GetDataPolicy method.

Protobuf type google.cloud.bigquery.datapolicies.v1.GetDataPolicyRequest

GetDataPolicyRequest.Builder

Request message for the GetDataPolicy method.

Protobuf type google.cloud.bigquery.datapolicies.v1.GetDataPolicyRequest

ListDataPoliciesRequest

Request message for the ListDataPolicies method.

Protobuf type google.cloud.bigquery.datapolicies.v1.ListDataPoliciesRequest

ListDataPoliciesRequest.Builder

Request message for the ListDataPolicies method.

Protobuf type google.cloud.bigquery.datapolicies.v1.ListDataPoliciesRequest

ListDataPoliciesResponse

Response message for the ListDataPolicies method.

Protobuf type google.cloud.bigquery.datapolicies.v1.ListDataPoliciesResponse

ListDataPoliciesResponse.Builder

Response message for the ListDataPolicies method.

Protobuf type google.cloud.bigquery.datapolicies.v1.ListDataPoliciesResponse

LocationName

LocationName.Builder

Builder for projects/{project}/locations/{location}.

RenameDataPolicyRequest

Request message for the RenameDataPolicy method.

Protobuf type google.cloud.bigquery.datapolicies.v1.RenameDataPolicyRequest

RenameDataPolicyRequest.Builder

Request message for the RenameDataPolicy method.

Protobuf type google.cloud.bigquery.datapolicies.v1.RenameDataPolicyRequest

UpdateDataPolicyRequest

Response message for the UpdateDataPolicy method.

Protobuf type google.cloud.bigquery.datapolicies.v1.UpdateDataPolicyRequest

UpdateDataPolicyRequest.Builder

Response message for the UpdateDataPolicy method.

Protobuf type google.cloud.bigquery.datapolicies.v1.UpdateDataPolicyRequest

Interfaces

CreateDataPolicyRequestOrBuilder

DataMaskingPolicyOrBuilder

DataPolicyOrBuilder

DataPolicyServiceGrpc.AsyncService

Data Policy Service provides APIs for managing the label-policy bindings.

DeleteDataPolicyRequestOrBuilder

GetDataPolicyRequestOrBuilder

ListDataPoliciesRequestOrBuilder

ListDataPoliciesResponseOrBuilder

RenameDataPolicyRequestOrBuilder

UpdateDataPolicyRequestOrBuilder

Enums

DataMaskingPolicy.MaskingExpressionCase

DataMaskingPolicy.PredefinedExpression

The available masking rules. Learn more here: https://cloud.google.com/bigquery/docs/column-data-masking-intro#masking_options.

Protobuf enum google.cloud.bigquery.datapolicies.v1.DataMaskingPolicy.PredefinedExpression

DataPolicy.DataPolicyType

A list of supported data policy types.

Protobuf enum google.cloud.bigquery.datapolicies.v1.DataPolicy.DataPolicyType

DataPolicy.MatchingLabelCase

DataPolicy.PolicyCase