Interface DataPolicyOrBuilder (0.65.0)

public interface DataPolicyOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getDataMaskingPolicy()

public abstract DataMaskingPolicy getDataMaskingPolicy()

Optional. The data masking policy that specifies the data masking rule to use. It must be set if the data policy type is DATA_MASKING_POLICY.

.google.cloud.bigquery.datapolicies.v2beta1.DataMaskingPolicy data_masking_policy = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DataMaskingPolicy

The dataMaskingPolicy.

getDataMaskingPolicyOrBuilder()

public abstract DataMaskingPolicyOrBuilder getDataMaskingPolicyOrBuilder()

Optional. The data masking policy that specifies the data masking rule to use. It must be set if the data policy type is DATA_MASKING_POLICY.

.google.cloud.bigquery.datapolicies.v2beta1.DataMaskingPolicy data_masking_policy = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DataMaskingPolicyOrBuilder

getDataPolicyId()

public abstract String getDataPolicyId()

Output only. User-assigned (human readable) ID of the data policy that needs to be unique within a project. Used as {data_policy_id} in part of the resource name.

string data_policy_id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The dataPolicyId.

getDataPolicyIdBytes()

public abstract ByteString getDataPolicyIdBytes()

Output only. User-assigned (human readable) ID of the data policy that needs to be unique within a project. Used as {data_policy_id} in part of the resource name.

string data_policy_id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for dataPolicyId.

getDataPolicyType()

public abstract DataPolicy.DataPolicyType getDataPolicyType()

Required. Type of data policy.

.google.cloud.bigquery.datapolicies.v2beta1.DataPolicy.DataPolicyType data_policy_type = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
DataPolicy.DataPolicyType

The dataPolicyType.

getDataPolicyTypeValue()

public abstract int getDataPolicyTypeValue()

Required. Type of data policy.

.google.cloud.bigquery.datapolicies.v2beta1.DataPolicy.DataPolicyType data_policy_type = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

The enum numeric value on the wire for dataPolicyType.

getEtag()

public abstract String getEtag()

The etag for this Data Policy. This field is used for UpdateDataPolicy calls. If Data Policy exists, this field is required and must match the server's etag. It will also be populated in the response of GetDataPolicy, CreateDataPolicy, and UpdateDataPolicy calls.

optional string etag = 11;

Returns
Type Description
String

The etag.

getEtagBytes()

public abstract ByteString getEtagBytes()

The etag for this Data Policy. This field is used for UpdateDataPolicy calls. If Data Policy exists, this field is required and must match the server's etag. It will also be populated in the response of GetDataPolicy, CreateDataPolicy, and UpdateDataPolicy calls.

optional string etag = 11;

Returns
Type Description
ByteString

The bytes for etag.

getGrantees(int index)

public abstract String getGrantees(int index)

Optional. The list of IAM principals that have Fine Grained Access to the underlying data goverened by this data policy.

Uses the IAM V2 principal syntax Only supports principal types users, groups, serviceaccounts, cloudidentity. This field is supported in V2 Data Policy only. In case of V1 data policies (i.e. verion = 1 and policy_tag is set), this field is not populated.

repeated string grantees = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The grantees at the given index.

getGranteesBytes(int index)

public abstract ByteString getGranteesBytes(int index)

Optional. The list of IAM principals that have Fine Grained Access to the underlying data goverened by this data policy.

Uses the IAM V2 principal syntax Only supports principal types users, groups, serviceaccounts, cloudidentity. This field is supported in V2 Data Policy only. In case of V1 data policies (i.e. verion = 1 and policy_tag is set), this field is not populated.

repeated string grantees = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the grantees at the given index.

getGranteesCount()

public abstract int getGranteesCount()

Optional. The list of IAM principals that have Fine Grained Access to the underlying data goverened by this data policy.

Uses the IAM V2 principal syntax Only supports principal types users, groups, serviceaccounts, cloudidentity. This field is supported in V2 Data Policy only. In case of V1 data policies (i.e. verion = 1 and policy_tag is set), this field is not populated.

repeated string grantees = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The count of grantees.

getGranteesList()

public abstract List<String> getGranteesList()

Optional. The list of IAM principals that have Fine Grained Access to the underlying data goverened by this data policy.

Uses the IAM V2 principal syntax Only supports principal types users, groups, serviceaccounts, cloudidentity. This field is supported in V2 Data Policy only. In case of V1 data policies (i.e. verion = 1 and policy_tag is set), this field is not populated.

repeated string grantees = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<String>

A list containing the grantees.

getName()

public abstract String getName()

Identifier. Resource name of this data policy, in the format of projects/{project_number}/locations/{location_id}/dataPolicies/{data_policy_id}.

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
String

The name.

getNameBytes()

public abstract ByteString getNameBytes()

Identifier. Resource name of this data policy, in the format of projects/{project_number}/locations/{location_id}/dataPolicies/{data_policy_id}.

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
ByteString

The bytes for name.

getPolicyCase()

public abstract DataPolicy.PolicyCase getPolicyCase()
Returns
Type Description
DataPolicy.PolicyCase

getPolicyTag()

public abstract String getPolicyTag()

Output only. Policy tag resource name, in the format of projects/{project_number}/locations/{location_id}/taxonomies/{taxonomy_id}/policyTags/{policyTag_id}. policy_tag is supported only for V1 data policies.

string policy_tag = 4 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The policyTag.

getPolicyTagBytes()

public abstract ByteString getPolicyTagBytes()

Output only. Policy tag resource name, in the format of projects/{project_number}/locations/{location_id}/taxonomies/{taxonomy_id}/policyTags/{policyTag_id}. policy_tag is supported only for V1 data policies.

string policy_tag = 4 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for policyTag.

getVersion()

public abstract DataPolicy.Version getVersion()

Output only. The version of the Data Policy resource.

.google.cloud.bigquery.datapolicies.v2beta1.DataPolicy.Version version = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
DataPolicy.Version

The version.

getVersionValue()

public abstract int getVersionValue()

Output only. The version of the Data Policy resource.

.google.cloud.bigquery.datapolicies.v2beta1.DataPolicy.Version version = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for version.

hasDataMaskingPolicy()

public abstract boolean hasDataMaskingPolicy()

Optional. The data masking policy that specifies the data masking rule to use. It must be set if the data policy type is DATA_MASKING_POLICY.

.google.cloud.bigquery.datapolicies.v2beta1.DataMaskingPolicy data_masking_policy = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the dataMaskingPolicy field is set.

hasEtag()

public abstract boolean hasEtag()

The etag for this Data Policy. This field is used for UpdateDataPolicy calls. If Data Policy exists, this field is required and must match the server's etag. It will also be populated in the response of GetDataPolicy, CreateDataPolicy, and UpdateDataPolicy calls.

optional string etag = 11;

Returns
Type Description
boolean

Whether the etag field is set.