Package com.google.cloud.dataplex.v1

Class DataAttribute

  • All Implemented Interfaces:
    DataAttributeOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class DataAttribute
extends com.google.protobuf.GeneratedMessageV3
implements DataAttributeOrBuilder
     Denotes one dataAttribute in a dataTaxonomy, for example, PII.
 DataAttribute resources can be defined in a hierarchy.
 A single dataAttribute resource can contain specs of multiple types

 ```
 PII
   - ResourceAccessSpec :
                 - readers :foo@bar.com
   - DataAccessSpec :
                 - readers :bar@foo.com
 ```
    Protobuf type google.cloud.dataplex.v1.DataAttribute
    See Also:
    Serialized Form

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

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

      • internalGetMapField

        protected com.google.protobuf.MapField internalGetMapField​(int number)
        Overrides:
        internalGetMapField in class com.google.protobuf.GeneratedMessageV3

      • internalGetFieldAccessorTable

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

      • getName

        public String getName()
         Output only. The relative resource name of the dataAttribute, of the form:
 projects/{project_number}/locations/{location_id}/dataTaxonomies/{dataTaxonomy}/attributes/{data_attribute_id}.
        string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
        Specified by:
        getName in interface DataAttributeOrBuilder
        Returns:
        The name.

      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         Output only. The relative resource name of the dataAttribute, of the form:
 projects/{project_number}/locations/{location_id}/dataTaxonomies/{dataTaxonomy}/attributes/{data_attribute_id}.
        string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
        Specified by:
        getNameBytes in interface DataAttributeOrBuilder
        Returns:
        The bytes for name.

      • getUid

        public String getUid()
         Output only. System generated globally unique ID for the DataAttribute.
 This ID will be different if the DataAttribute is deleted and re-created
 with the same name.
        string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getUid in interface DataAttributeOrBuilder
        Returns:
        The uid.

      • getUidBytes

        public com.google.protobuf.ByteString getUidBytes()
         Output only. System generated globally unique ID for the DataAttribute.
 This ID will be different if the DataAttribute is deleted and re-created
 with the same name.
        string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getUidBytes in interface DataAttributeOrBuilder
        Returns:
        The bytes for uid.

      • hasCreateTime

        public boolean hasCreateTime()
         Output only. The time when the DataAttribute was created.
        .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasCreateTime in interface DataAttributeOrBuilder
        Returns:
        Whether the createTime field is set.

      • getCreateTime

        public com.google.protobuf.Timestamp getCreateTime()
         Output only. The time when the DataAttribute was created.
        .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCreateTime in interface DataAttributeOrBuilder
        Returns:
        The createTime.

      • getCreateTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
         Output only. The time when the DataAttribute was created.
        .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCreateTimeOrBuilder in interface DataAttributeOrBuilder

      • hasUpdateTime

        public boolean hasUpdateTime()
         Output only. The time when the DataAttribute was last updated.
        .google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasUpdateTime in interface DataAttributeOrBuilder
        Returns:
        Whether the updateTime field is set.

      • getUpdateTime

        public com.google.protobuf.Timestamp getUpdateTime()
         Output only. The time when the DataAttribute was last updated.
        .google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getUpdateTime in interface DataAttributeOrBuilder
        Returns:
        The updateTime.

      • getUpdateTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
         Output only. The time when the DataAttribute was last updated.
        .google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getUpdateTimeOrBuilder in interface DataAttributeOrBuilder

      • getDescription

        public String getDescription()
         Optional. Description of the DataAttribute.
        string description = 5 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getDescription in interface DataAttributeOrBuilder
        Returns:
        The description.

      • getDescriptionBytes

        public com.google.protobuf.ByteString getDescriptionBytes()
         Optional. Description of the DataAttribute.
        string description = 5 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getDescriptionBytes in interface DataAttributeOrBuilder
        Returns:
        The bytes for description.

      • getDisplayName

        public String getDisplayName()
         Optional. User friendly display name.
        string display_name = 6 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getDisplayName in interface DataAttributeOrBuilder
        Returns:
        The displayName.

      • getDisplayNameBytes

        public com.google.protobuf.ByteString getDisplayNameBytes()
         Optional. User friendly display name.
        string display_name = 6 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getDisplayNameBytes in interface DataAttributeOrBuilder
        Returns:
        The bytes for displayName.

      • getLabelsCount

        public int getLabelsCount()
        Description copied from interface: DataAttributeOrBuilder
         Optional. User-defined labels for the DataAttribute.
        map<string, string> labels = 7 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getLabelsCount in interface DataAttributeOrBuilder

      • containsLabels

        public boolean containsLabels​(String key)
         Optional. User-defined labels for the DataAttribute.
        map<string, string> labels = 7 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        containsLabels in interface DataAttributeOrBuilder

      • getLabelsMap

        public Map<String,​String> getLabelsMap()
         Optional. User-defined labels for the DataAttribute.
        map<string, string> labels = 7 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getLabelsMap in interface DataAttributeOrBuilder

      • getLabelsOrDefault

        public String getLabelsOrDefault​(String key,
                                 String defaultValue)
         Optional. User-defined labels for the DataAttribute.
        map<string, string> labels = 7 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getLabelsOrDefault in interface DataAttributeOrBuilder

      • getLabelsOrThrow

        public String getLabelsOrThrow​(String key)
         Optional. User-defined labels for the DataAttribute.
        map<string, string> labels = 7 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getLabelsOrThrow in interface DataAttributeOrBuilder

      • getParentId

        public String getParentId()
         Optional. The ID of the parent DataAttribute resource, should belong to the
 same data taxonomy. Circular dependency in parent chain is not valid.
 Maximum depth of the hierarchy allowed is 4.
 [a -> b -> c -> d -> e, depth = 4]
        string parent_id = 8 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
        Specified by:
        getParentId in interface DataAttributeOrBuilder
        Returns:
        The parentId.

      • getParentIdBytes

        public com.google.protobuf.ByteString getParentIdBytes()
         Optional. The ID of the parent DataAttribute resource, should belong to the
 same data taxonomy. Circular dependency in parent chain is not valid.
 Maximum depth of the hierarchy allowed is 4.
 [a -> b -> c -> d -> e, depth = 4]
        string parent_id = 8 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
        Specified by:
        getParentIdBytes in interface DataAttributeOrBuilder
        Returns:
        The bytes for parentId.

      • getAttributeCount

        public int getAttributeCount()
         Output only. The number of child attributes present for this attribute.
        int32 attribute_count = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getAttributeCount in interface DataAttributeOrBuilder
        Returns:
        The attributeCount.

      • getEtag

        public String getEtag()
         This checksum is computed by the server based on the value of other
 fields, and may be sent on update and delete requests to ensure the
 client has an up-to-date value before proceeding.
        string etag = 10;
        Specified by:
        getEtag in interface DataAttributeOrBuilder
        Returns:
        The etag.

      • getEtagBytes

        public com.google.protobuf.ByteString getEtagBytes()
         This checksum is computed by the server based on the value of other
 fields, and may be sent on update and delete requests to ensure the
 client has an up-to-date value before proceeding.
        string etag = 10;
        Specified by:
        getEtagBytes in interface DataAttributeOrBuilder
        Returns:
        The bytes for etag.

      • hasResourceAccessSpec

        public boolean hasResourceAccessSpec()
         Optional. Specified when applied to a resource (eg: Cloud Storage bucket,
 BigQuery dataset, BigQuery table).
        .google.cloud.dataplex.v1.ResourceAccessSpec resource_access_spec = 100 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        hasResourceAccessSpec in interface DataAttributeOrBuilder
        Returns:
        Whether the resourceAccessSpec field is set.

      • getResourceAccessSpec

        public ResourceAccessSpec getResourceAccessSpec()
         Optional. Specified when applied to a resource (eg: Cloud Storage bucket,
 BigQuery dataset, BigQuery table).
        .google.cloud.dataplex.v1.ResourceAccessSpec resource_access_spec = 100 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getResourceAccessSpec in interface DataAttributeOrBuilder
        Returns:
        The resourceAccessSpec.

      • getResourceAccessSpecOrBuilder

        public ResourceAccessSpecOrBuilder getResourceAccessSpecOrBuilder()
         Optional. Specified when applied to a resource (eg: Cloud Storage bucket,
 BigQuery dataset, BigQuery table).
        .google.cloud.dataplex.v1.ResourceAccessSpec resource_access_spec = 100 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getResourceAccessSpecOrBuilder in interface DataAttributeOrBuilder

      • hasDataAccessSpec

        public boolean hasDataAccessSpec()
         Optional. Specified when applied to data stored on the resource (eg: rows,
 columns in BigQuery Tables).
        .google.cloud.dataplex.v1.DataAccessSpec data_access_spec = 101 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        hasDataAccessSpec in interface DataAttributeOrBuilder
        Returns:
        Whether the dataAccessSpec field is set.

      • getDataAccessSpec

        public DataAccessSpec getDataAccessSpec()
         Optional. Specified when applied to data stored on the resource (eg: rows,
 columns in BigQuery Tables).
        .google.cloud.dataplex.v1.DataAccessSpec data_access_spec = 101 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getDataAccessSpec in interface DataAttributeOrBuilder
        Returns:
        The dataAccessSpec.

      • getDataAccessSpecOrBuilder

        public DataAccessSpecOrBuilder getDataAccessSpecOrBuilder()
         Optional. Specified when applied to data stored on the resource (eg: rows,
 columns in BigQuery Tables).
        .google.cloud.dataplex.v1.DataAccessSpec data_access_spec = 101 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getDataAccessSpecOrBuilder in interface DataAttributeOrBuilder

      • isInitialized

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

      • 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.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

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

      • 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 DataAttribute parseFrom​(ByteBuffer data)
                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

        protected DataAttribute.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstance

        public static DataAttribute getDefaultInstance()

      • parser

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

      • getParserForType

        public com.google.protobuf.Parser<DataAttribute> 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.GeneratedMessageV3

      • getDefaultInstanceForType

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