Package com.google.cloud.bigquery.datapolicies.v2

Interface DataPolicyOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
DataPolicy, DataPolicy.Builder
@Generated public interface DataPolicyOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • hasDataMaskingPolicy

      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.v2.DataMaskingPolicy data_masking_policy = 7 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      Whether the dataMaskingPolicy field is set.

    • getDataMaskingPolicy

      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.v2.DataMaskingPolicy data_masking_policy = 7 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The dataMaskingPolicy.

    • getDataMaskingPolicyOrBuilder

      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.v2.DataMaskingPolicy data_masking_policy = 7 [(.google.api.field_behavior) = OPTIONAL];

    • getName

      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:
      The name.

    • getNameBytes

      com.google.protobuf.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:
      The bytes for name.

    • getDataPolicyId

      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:
      The dataPolicyId.

    • getDataPolicyIdBytes

      com.google.protobuf.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:
      The bytes for dataPolicyId.

    • hasEtag

      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:
      Whether the etag field is set.

    • getEtag

      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:
      The etag.

    • getEtagBytes

      com.google.protobuf.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:
      The bytes for etag.

    • getDataPolicyTypeValue

      int getDataPolicyTypeValue()
       Required. Type of data policy.
      .google.cloud.bigquery.datapolicies.v2.DataPolicy.DataPolicyType data_policy_type = 3 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The enum numeric value on the wire for dataPolicyType.

    • getDataPolicyType

      DataPolicy.DataPolicyType getDataPolicyType()
       Required. Type of data policy.
      .google.cloud.bigquery.datapolicies.v2.DataPolicy.DataPolicyType data_policy_type = 3 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The dataPolicyType.

    • getPolicyTag

      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:
      The policyTag.

    • getPolicyTagBytes

      com.google.protobuf.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:
      The bytes for policyTag.

    • getGranteesList

      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](https://cloud.google.com/iam/docs/principal-identifiers#v2) 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:
      A list containing the grantees.

    • getGranteesCount

      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](https://cloud.google.com/iam/docs/principal-identifiers#v2) 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:
      The count of grantees.

    • getGrantees

      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](https://cloud.google.com/iam/docs/principal-identifiers#v2) 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];
      Parameters:
      index - The index of the element to return.
      Returns:
      The grantees at the given index.

    • getGranteesBytes

      com.google.protobuf.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](https://cloud.google.com/iam/docs/principal-identifiers#v2) 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];
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the grantees at the given index.

    • getVersionValue

      int getVersionValue()
       Output only. The version of the Data Policy resource.
      .google.cloud.bigquery.datapolicies.v2.DataPolicy.Version version = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The enum numeric value on the wire for version.

    • getVersion

      DataPolicy.Version getVersion()
       Output only. The version of the Data Policy resource.
      .google.cloud.bigquery.datapolicies.v2.DataPolicy.Version version = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The version.

    • getPolicyCase

      DataPolicy.PolicyCase getPolicyCase()