public final class DataPolicy extends GeneratedMessageV3 implements DataPolicyOrBuilder
Represents the label-policy binding.
Protobuf type google.cloud.bigquery.datapolicies.v2beta1.DataPolicy
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
DATA_MASKING_POLICY_FIELD_NUMBER
public static final int DATA_MASKING_POLICY_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
DATA_POLICY_ID_FIELD_NUMBER
public static final int DATA_POLICY_ID_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
DATA_POLICY_TYPE_FIELD_NUMBER
public static final int DATA_POLICY_TYPE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
ETAG_FIELD_NUMBER
public static final int ETAG_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
GRANTEES_FIELD_NUMBER
public static final int GRANTEES_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
POLICY_TAG_FIELD_NUMBER
public static final int POLICY_TAG_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
VERSION_FIELD_NUMBER
public static final int VERSION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static DataPolicy getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static DataPolicy.Builder newBuilder()
newBuilder(DataPolicy prototype)
public static DataPolicy.Builder newBuilder(DataPolicy prototype)
public static DataPolicy parseDelimitedFrom(InputStream input)
public static DataPolicy parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static DataPolicy parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static DataPolicy parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static DataPolicy parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static DataPolicy parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static DataPolicy parseFrom(CodedInputStream input)
public static DataPolicy parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static DataPolicy parseFrom(InputStream input)
public static DataPolicy parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static DataPolicy parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static DataPolicy parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<DataPolicy> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
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.v2beta1.DataMaskingPolicy data_masking_policy = 7 [(.google.api.field_behavior) = OPTIONAL];
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.v2beta1.DataMaskingPolicy data_masking_policy = 7 [(.google.api.field_behavior) = OPTIONAL];
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];
| Returns |
| Type |
Description |
String |
The dataPolicyId.
|
getDataPolicyIdBytes()
public 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 DataPolicy.DataPolicyType getDataPolicyType()
Required. Type of data policy.
.google.cloud.bigquery.datapolicies.v2beta1.DataPolicy.DataPolicyType data_policy_type = 3 [(.google.api.field_behavior) = REQUIRED];
getDataPolicyTypeValue()
public 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.
|
getDefaultInstanceForType()
public DataPolicy getDefaultInstanceForType()
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 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 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 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 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 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 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];
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 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.
|
getParserForType()
public Parser<DataPolicy> getParserForType()
Overrides
getPolicyCase()
public DataPolicy.PolicyCase getPolicyCase()
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) = { ... }
| Returns |
| Type |
Description |
String |
The policyTag.
|
getPolicyTagBytes()
public 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.
|
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
getVersion()
public 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];
getVersionValue()
public 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 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()
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.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public DataPolicy.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected DataPolicy.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public DataPolicy.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
