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

Class DataPolicy

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.bigquery.datapolicies.v2.DataPolicy
All Implemented Interfaces:
DataPolicyOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class DataPolicy extends com.google.protobuf.GeneratedMessage implements DataPolicyOrBuilder
 Represents the label-policy binding.
Protobuf type google.cloud.bigquery.datapolicies.v2.DataPolicy
See Also:

  • Field Details

    • DATA_MASKING_POLICY_FIELD_NUMBER

      public static final int DATA_MASKING_POLICY_FIELD_NUMBER
      See Also:

    • NAME_FIELD_NUMBER

      public static final int NAME_FIELD_NUMBER
      See Also:

    • DATA_POLICY_ID_FIELD_NUMBER

      public static final int DATA_POLICY_ID_FIELD_NUMBER
      See Also:

    • ETAG_FIELD_NUMBER

      public static final int ETAG_FIELD_NUMBER
      See Also:

    • DATA_POLICY_TYPE_FIELD_NUMBER

      public static final int DATA_POLICY_TYPE_FIELD_NUMBER
      See Also:

    • POLICY_TAG_FIELD_NUMBER

      public static final int POLICY_TAG_FIELD_NUMBER
      See Also:

    • GRANTEES_FIELD_NUMBER

      public static final int GRANTEES_FIELD_NUMBER
      See Also:

    • VERSION_FIELD_NUMBER

      public static final int VERSION_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • getPolicyCase

      public DataPolicy.PolicyCase getPolicyCase()
      Specified by:
      getPolicyCase in interface DataPolicyOrBuilder

    • hasDataMaskingPolicy

      public 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];
      Specified by:
      hasDataMaskingPolicy in interface DataPolicyOrBuilder
      Returns:
      Whether the dataMaskingPolicy field is set.

    • getDataMaskingPolicy

      public 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];
      Specified by:
      getDataMaskingPolicy in interface DataPolicyOrBuilder
      Returns:
      The dataMaskingPolicy.

    • getDataMaskingPolicyOrBuilder

      public 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];
      Specified by:
      getDataMaskingPolicyOrBuilder in interface DataPolicyOrBuilder

    • getName

      public 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];
      Specified by:
      getName in interface DataPolicyOrBuilder
      Returns:
      The name.

    • getNameBytes

      public 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];
      Specified by:
      getNameBytes in interface DataPolicyOrBuilder
      Returns:
      The bytes for name.

    • getDataPolicyId

      public 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];
      Specified by:
      getDataPolicyId in interface DataPolicyOrBuilder
      Returns:
      The dataPolicyId.

    • getDataPolicyIdBytes

      public 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];
      Specified by:
      getDataPolicyIdBytes in interface DataPolicyOrBuilder
      Returns:
      The bytes for dataPolicyId.

    • hasEtag

      public 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;
      Specified by:
      hasEtag in interface DataPolicyOrBuilder
      Returns:
      Whether the etag field is set.

    • getEtag

      public 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;
      Specified by:
      getEtag in interface DataPolicyOrBuilder
      Returns:
      The etag.

    • getEtagBytes

      public 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;
      Specified by:
      getEtagBytes in interface DataPolicyOrBuilder
      Returns:
      The bytes for etag.

    • getDataPolicyTypeValue

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

    • getDataPolicyType

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

    • getPolicyTag

      public 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) = { ... }
      Specified by:
      getPolicyTag in interface DataPolicyOrBuilder
      Returns:
      The policyTag.

    • getPolicyTagBytes

      public 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) = { ... }
      Specified by:
      getPolicyTagBytes in interface DataPolicyOrBuilder
      Returns:
      The bytes for policyTag.

    • getGranteesList

      public com.google.protobuf.ProtocolStringList 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];
      Specified by:
      getGranteesList in interface DataPolicyOrBuilder
      Returns:
      A list containing the grantees.

    • getGranteesCount

      public 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];
      Specified by:
      getGranteesCount in interface DataPolicyOrBuilder
      Returns:
      The count of grantees.

    • getGrantees

      public 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];
      Specified by:
      getGrantees in interface DataPolicyOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The grantees at the given index.

    • getGranteesBytes

      public 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];
      Specified by:
      getGranteesBytes in interface DataPolicyOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the grantees at the given index.

    • getVersionValue

      public 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];
      Specified by:
      getVersionValue in interface DataPolicyOrBuilder
      Returns:
      The enum numeric value on the wire for version.

    • getVersion

      public 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];
      Specified by:
      getVersion in interface DataPolicyOrBuilder
      Returns:
      The version.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static DataPolicy parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static DataPolicy parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static DataPolicy parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static DataPolicy parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static DataPolicy parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static DataPolicy parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static DataPolicy parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static DataPolicy parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static DataPolicy parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static DataPolicy parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static DataPolicy parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static DataPolicy parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public DataPolicy.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static DataPolicy.Builder newBuilder()

    • newBuilder

      public static DataPolicy.Builder newBuilder(DataPolicy prototype)

    • toBuilder

      public DataPolicy.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected DataPolicy.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static DataPolicy getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<DataPolicy> parser()

    • getParserForType

      public com.google.protobuf.Parser<DataPolicy> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public DataPolicy getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder