Package com.google.cloud.dataplex.v1

Class Entity.Builder

  • All Implemented Interfaces:
    EntityOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
    Enclosing class:
    Entity
    public static final class Entity.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<Entity.Builder>
implements EntityOrBuilder
     Represents tables and fileset metadata contained within a zone.
    Protobuf type google.cloud.dataplex.v1.Entity

    • Method Detail

      • getDescriptor

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

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<Entity.Builder>

      • clear

        public Entity.Builder clear()
        Specified by:
        clear in interface com.google.protobuf.Message.Builder
        Specified by:
        clear in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clear in class com.google.protobuf.GeneratedMessageV3.Builder<Entity.Builder>

      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<Entity.Builder>

      • getDefaultInstanceForType

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

      • build

        public Entity build()
        Specified by:
        build in interface com.google.protobuf.Message.Builder
        Specified by:
        build in interface com.google.protobuf.MessageLite.Builder

      • buildPartial

        public Entity buildPartial()
        Specified by:
        buildPartial in interface com.google.protobuf.Message.Builder
        Specified by:
        buildPartial in interface com.google.protobuf.MessageLite.Builder

      • clone

        public Entity.Builder clone()
        Specified by:
        clone in interface com.google.protobuf.Message.Builder
        Specified by:
        clone in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clone in class com.google.protobuf.GeneratedMessageV3.Builder<Entity.Builder>

      • setField

        public Entity.Builder setField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                               Object value)
        Specified by:
        setField in interface com.google.protobuf.Message.Builder
        Overrides:
        setField in class com.google.protobuf.GeneratedMessageV3.Builder<Entity.Builder>

      • clearField

        public Entity.Builder clearField​(com.google.protobuf.Descriptors.FieldDescriptor field)
        Specified by:
        clearField in interface com.google.protobuf.Message.Builder
        Overrides:
        clearField in class com.google.protobuf.GeneratedMessageV3.Builder<Entity.Builder>

      • clearOneof

        public Entity.Builder clearOneof​(com.google.protobuf.Descriptors.OneofDescriptor oneof)
        Specified by:
        clearOneof in interface com.google.protobuf.Message.Builder
        Overrides:
        clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<Entity.Builder>

      • setRepeatedField

        public Entity.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                       int index,
                                       Object value)
        Specified by:
        setRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Entity.Builder>

      • addRepeatedField

        public Entity.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                       Object value)
        Specified by:
        addRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Entity.Builder>

      • mergeFrom

        public Entity.Builder mergeFrom​(com.google.protobuf.Message other)
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Entity.Builder>

      • isInitialized

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

      • mergeFrom

        public Entity.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                         throws IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Entity.Builder>
        Throws:
        IOException

      • getName

        public String getName()
         Output only. The resource name of the entity, of the form:
 `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{id}`.
        string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
        Specified by:
        getName in interface EntityOrBuilder
        Returns:
        The name.

      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         Output only. The resource name of the entity, of the form:
 `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{id}`.
        string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
        Specified by:
        getNameBytes in interface EntityOrBuilder
        Returns:
        The bytes for name.

      • setName

        public Entity.Builder setName​(String value)
         Output only. The resource name of the entity, of the form:
 `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{id}`.
        string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
        Parameters:
        value - The name to set.
        Returns:
        This builder for chaining.

      • clearName

        public Entity.Builder clearName()
         Output only. The resource name of the entity, of the form:
 `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{id}`.
        string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
        Returns:
        This builder for chaining.

      • setNameBytes

        public Entity.Builder setNameBytes​(com.google.protobuf.ByteString value)
         Output only. The resource name of the entity, of the form:
 `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{id}`.
        string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
        Parameters:
        value - The bytes for name to set.
        Returns:
        This builder for chaining.

      • getDisplayName

        public String getDisplayName()
         Optional. Display name must be shorter than or equal to 256 characters.
        string display_name = 2 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getDisplayName in interface EntityOrBuilder
        Returns:
        The displayName.

      • getDisplayNameBytes

        public com.google.protobuf.ByteString getDisplayNameBytes()
         Optional. Display name must be shorter than or equal to 256 characters.
        string display_name = 2 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getDisplayNameBytes in interface EntityOrBuilder
        Returns:
        The bytes for displayName.

      • setDisplayName

        public Entity.Builder setDisplayName​(String value)
         Optional. Display name must be shorter than or equal to 256 characters.
        string display_name = 2 [(.google.api.field_behavior) = OPTIONAL];
        Parameters:
        value - The displayName to set.
        Returns:
        This builder for chaining.

      • clearDisplayName

        public Entity.Builder clearDisplayName()
         Optional. Display name must be shorter than or equal to 256 characters.
        string display_name = 2 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        This builder for chaining.

      • setDisplayNameBytes

        public Entity.Builder setDisplayNameBytes​(com.google.protobuf.ByteString value)
         Optional. Display name must be shorter than or equal to 256 characters.
        string display_name = 2 [(.google.api.field_behavior) = OPTIONAL];
        Parameters:
        value - The bytes for displayName to set.
        Returns:
        This builder for chaining.

      • getDescription

        public String getDescription()
         Optional. User friendly longer description text. Must be shorter than or
 equal to 1024 characters.
        string description = 3 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getDescription in interface EntityOrBuilder
        Returns:
        The description.

      • getDescriptionBytes

        public com.google.protobuf.ByteString getDescriptionBytes()
         Optional. User friendly longer description text. Must be shorter than or
 equal to 1024 characters.
        string description = 3 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getDescriptionBytes in interface EntityOrBuilder
        Returns:
        The bytes for description.

      • setDescription

        public Entity.Builder setDescription​(String value)
         Optional. User friendly longer description text. Must be shorter than or
 equal to 1024 characters.
        string description = 3 [(.google.api.field_behavior) = OPTIONAL];
        Parameters:
        value - The description to set.
        Returns:
        This builder for chaining.

      • clearDescription

        public Entity.Builder clearDescription()
         Optional. User friendly longer description text. Must be shorter than or
 equal to 1024 characters.
        string description = 3 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        This builder for chaining.

      • setDescriptionBytes

        public Entity.Builder setDescriptionBytes​(com.google.protobuf.ByteString value)
         Optional. User friendly longer description text. Must be shorter than or
 equal to 1024 characters.
        string description = 3 [(.google.api.field_behavior) = OPTIONAL];
        Parameters:
        value - The bytes for description to set.
        Returns:
        This builder for chaining.

      • hasCreateTime

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

      • getCreateTime

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

      • setCreateTime

        public Entity.Builder setCreateTime​(com.google.protobuf.Timestamp value)
         Output only. The time when the entity was created.
        .google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • setCreateTime

        public Entity.Builder setCreateTime​(com.google.protobuf.Timestamp.Builder builderForValue)
         Output only. The time when the entity was created.
        .google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • mergeCreateTime

        public Entity.Builder mergeCreateTime​(com.google.protobuf.Timestamp value)
         Output only. The time when the entity was created.
        .google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • clearCreateTime

        public Entity.Builder clearCreateTime()
         Output only. The time when the entity was created.
        .google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • getCreateTimeBuilder

        public com.google.protobuf.Timestamp.Builder getCreateTimeBuilder()
         Output only. The time when the entity was created.
        .google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • getCreateTimeOrBuilder

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

      • hasUpdateTime

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

      • getUpdateTime

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

      • setUpdateTime

        public Entity.Builder setUpdateTime​(com.google.protobuf.Timestamp value)
         Output only. The time when the entity was last updated.
        .google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • setUpdateTime

        public Entity.Builder setUpdateTime​(com.google.protobuf.Timestamp.Builder builderForValue)
         Output only. The time when the entity was last updated.
        .google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • mergeUpdateTime

        public Entity.Builder mergeUpdateTime​(com.google.protobuf.Timestamp value)
         Output only. The time when the entity was last updated.
        .google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • clearUpdateTime

        public Entity.Builder clearUpdateTime()
         Output only. The time when the entity was last updated.
        .google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • getUpdateTimeBuilder

        public com.google.protobuf.Timestamp.Builder getUpdateTimeBuilder()
         Output only. The time when the entity was last updated.
        .google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • getUpdateTimeOrBuilder

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

      • getId

        public String getId()
         Required. A user-provided entity ID. It is mutable, and will be used as the
 published table name. Specifying a new ID in an update entity
 request will override the existing value.
 The ID must contain only letters (a-z, A-Z), numbers (0-9), and
 underscores, and consist of 256 or fewer characters.
        string id = 7 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getId in interface EntityOrBuilder
        Returns:
        The id.

      • getIdBytes

        public com.google.protobuf.ByteString getIdBytes()
         Required. A user-provided entity ID. It is mutable, and will be used as the
 published table name. Specifying a new ID in an update entity
 request will override the existing value.
 The ID must contain only letters (a-z, A-Z), numbers (0-9), and
 underscores, and consist of 256 or fewer characters.
        string id = 7 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getIdBytes in interface EntityOrBuilder
        Returns:
        The bytes for id.

      • setId

        public Entity.Builder setId​(String value)
         Required. A user-provided entity ID. It is mutable, and will be used as the
 published table name. Specifying a new ID in an update entity
 request will override the existing value.
 The ID must contain only letters (a-z, A-Z), numbers (0-9), and
 underscores, and consist of 256 or fewer characters.
        string id = 7 [(.google.api.field_behavior) = REQUIRED];
        Parameters:
        value - The id to set.
        Returns:
        This builder for chaining.

      • clearId

        public Entity.Builder clearId()
         Required. A user-provided entity ID. It is mutable, and will be used as the
 published table name. Specifying a new ID in an update entity
 request will override the existing value.
 The ID must contain only letters (a-z, A-Z), numbers (0-9), and
 underscores, and consist of 256 or fewer characters.
        string id = 7 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        This builder for chaining.

      • setIdBytes

        public Entity.Builder setIdBytes​(com.google.protobuf.ByteString value)
         Required. A user-provided entity ID. It is mutable, and will be used as the
 published table name. Specifying a new ID in an update entity
 request will override the existing value.
 The ID must contain only letters (a-z, A-Z), numbers (0-9), and
 underscores, and consist of 256 or fewer characters.
        string id = 7 [(.google.api.field_behavior) = REQUIRED];
        Parameters:
        value - The bytes for id to set.
        Returns:
        This builder for chaining.

      • getEtag

        public String getEtag()
         Optional. The etag associated with the entity, which can be retrieved with
 a [GetEntity][] request. Required for update and delete requests.
        string etag = 8 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getEtag in interface EntityOrBuilder
        Returns:
        The etag.

      • getEtagBytes

        public com.google.protobuf.ByteString getEtagBytes()
         Optional. The etag associated with the entity, which can be retrieved with
 a [GetEntity][] request. Required for update and delete requests.
        string etag = 8 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getEtagBytes in interface EntityOrBuilder
        Returns:
        The bytes for etag.

      • setEtag

        public Entity.Builder setEtag​(String value)
         Optional. The etag associated with the entity, which can be retrieved with
 a [GetEntity][] request. Required for update and delete requests.
        string etag = 8 [(.google.api.field_behavior) = OPTIONAL];
        Parameters:
        value - The etag to set.
        Returns:
        This builder for chaining.

      • clearEtag

        public Entity.Builder clearEtag()
         Optional. The etag associated with the entity, which can be retrieved with
 a [GetEntity][] request. Required for update and delete requests.
        string etag = 8 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        This builder for chaining.

      • setEtagBytes

        public Entity.Builder setEtagBytes​(com.google.protobuf.ByteString value)
         Optional. The etag associated with the entity, which can be retrieved with
 a [GetEntity][] request. Required for update and delete requests.
        string etag = 8 [(.google.api.field_behavior) = OPTIONAL];
        Parameters:
        value - The bytes for etag to set.
        Returns:
        This builder for chaining.

      • getTypeValue

        public int getTypeValue()
         Required. Immutable. The type of entity.
        .google.cloud.dataplex.v1.Entity.Type type = 10 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        getTypeValue in interface EntityOrBuilder
        Returns:
        The enum numeric value on the wire for type.

      • setTypeValue

        public Entity.Builder setTypeValue​(int value)
         Required. Immutable. The type of entity.
        .google.cloud.dataplex.v1.Entity.Type type = 10 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
        Parameters:
        value - The enum numeric value on the wire for type to set.
        Returns:
        This builder for chaining.

      • getType

        public Entity.Type getType()
         Required. Immutable. The type of entity.
        .google.cloud.dataplex.v1.Entity.Type type = 10 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        getType in interface EntityOrBuilder
        Returns:
        The type.

      • setType

        public Entity.Builder setType​(Entity.Type value)
         Required. Immutable. The type of entity.
        .google.cloud.dataplex.v1.Entity.Type type = 10 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
        Parameters:
        value - The type to set.
        Returns:
        This builder for chaining.

      • clearType

        public Entity.Builder clearType()
         Required. Immutable. The type of entity.
        .google.cloud.dataplex.v1.Entity.Type type = 10 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
        Returns:
        This builder for chaining.

      • getAsset

        public String getAsset()
         Required. Immutable. The ID of the asset associated with the storage
 location containing the entity data. The entity must be with in the same
 zone with the asset.
        string asset = 11 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        getAsset in interface EntityOrBuilder
        Returns:
        The asset.

      • getAssetBytes

        public com.google.protobuf.ByteString getAssetBytes()
         Required. Immutable. The ID of the asset associated with the storage
 location containing the entity data. The entity must be with in the same
 zone with the asset.
        string asset = 11 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        getAssetBytes in interface EntityOrBuilder
        Returns:
        The bytes for asset.

      • setAsset

        public Entity.Builder setAsset​(String value)
         Required. Immutable. The ID of the asset associated with the storage
 location containing the entity data. The entity must be with in the same
 zone with the asset.
        string asset = 11 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
        Parameters:
        value - The asset to set.
        Returns:
        This builder for chaining.

      • clearAsset

        public Entity.Builder clearAsset()
         Required. Immutable. The ID of the asset associated with the storage
 location containing the entity data. The entity must be with in the same
 zone with the asset.
        string asset = 11 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
        Returns:
        This builder for chaining.

      • setAssetBytes

        public Entity.Builder setAssetBytes​(com.google.protobuf.ByteString value)
         Required. Immutable. The ID of the asset associated with the storage
 location containing the entity data. The entity must be with in the same
 zone with the asset.
        string asset = 11 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
        Parameters:
        value - The bytes for asset to set.
        Returns:
        This builder for chaining.

      • getDataPath

        public String getDataPath()
         Required. Immutable. The storage path of the entity data.
 For Cloud Storage data, this is the fully-qualified path to the entity,
 such as `gs://bucket/path/to/data`. For BigQuery data, this is the name of
 the table resource, such as
 `projects/project_id/datasets/dataset_id/tables/table_id`.
        string data_path = 12 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        getDataPath in interface EntityOrBuilder
        Returns:
        The dataPath.

      • getDataPathBytes

        public com.google.protobuf.ByteString getDataPathBytes()
         Required. Immutable. The storage path of the entity data.
 For Cloud Storage data, this is the fully-qualified path to the entity,
 such as `gs://bucket/path/to/data`. For BigQuery data, this is the name of
 the table resource, such as
 `projects/project_id/datasets/dataset_id/tables/table_id`.
        string data_path = 12 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        getDataPathBytes in interface EntityOrBuilder
        Returns:
        The bytes for dataPath.

      • setDataPath

        public Entity.Builder setDataPath​(String value)
         Required. Immutable. The storage path of the entity data.
 For Cloud Storage data, this is the fully-qualified path to the entity,
 such as `gs://bucket/path/to/data`. For BigQuery data, this is the name of
 the table resource, such as
 `projects/project_id/datasets/dataset_id/tables/table_id`.
        string data_path = 12 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
        Parameters:
        value - The dataPath to set.
        Returns:
        This builder for chaining.

      • clearDataPath

        public Entity.Builder clearDataPath()
         Required. Immutable. The storage path of the entity data.
 For Cloud Storage data, this is the fully-qualified path to the entity,
 such as `gs://bucket/path/to/data`. For BigQuery data, this is the name of
 the table resource, such as
 `projects/project_id/datasets/dataset_id/tables/table_id`.
        string data_path = 12 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
        Returns:
        This builder for chaining.

      • setDataPathBytes

        public Entity.Builder setDataPathBytes​(com.google.protobuf.ByteString value)
         Required. Immutable. The storage path of the entity data.
 For Cloud Storage data, this is the fully-qualified path to the entity,
 such as `gs://bucket/path/to/data`. For BigQuery data, this is the name of
 the table resource, such as
 `projects/project_id/datasets/dataset_id/tables/table_id`.
        string data_path = 12 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
        Parameters:
        value - The bytes for dataPath to set.
        Returns:
        This builder for chaining.

      • getDataPathPattern

        public String getDataPathPattern()
         Optional. The set of items within the data path constituting the data in
 the entity, represented as a glob path. Example:
 `gs://bucket/path/to/data/**/*.csv`.
        string data_path_pattern = 13 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getDataPathPattern in interface EntityOrBuilder
        Returns:
        The dataPathPattern.

      • getDataPathPatternBytes

        public com.google.protobuf.ByteString getDataPathPatternBytes()
         Optional. The set of items within the data path constituting the data in
 the entity, represented as a glob path. Example:
 `gs://bucket/path/to/data/**/*.csv`.
        string data_path_pattern = 13 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getDataPathPatternBytes in interface EntityOrBuilder
        Returns:
        The bytes for dataPathPattern.

      • setDataPathPattern

        public Entity.Builder setDataPathPattern​(String value)
         Optional. The set of items within the data path constituting the data in
 the entity, represented as a glob path. Example:
 `gs://bucket/path/to/data/**/*.csv`.
        string data_path_pattern = 13 [(.google.api.field_behavior) = OPTIONAL];
        Parameters:
        value - The dataPathPattern to set.
        Returns:
        This builder for chaining.

      • clearDataPathPattern

        public Entity.Builder clearDataPathPattern()
         Optional. The set of items within the data path constituting the data in
 the entity, represented as a glob path. Example:
 `gs://bucket/path/to/data/**/*.csv`.
        string data_path_pattern = 13 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        This builder for chaining.

      • setDataPathPatternBytes

        public Entity.Builder setDataPathPatternBytes​(com.google.protobuf.ByteString value)
         Optional. The set of items within the data path constituting the data in
 the entity, represented as a glob path. Example:
 `gs://bucket/path/to/data/**/*.csv`.
        string data_path_pattern = 13 [(.google.api.field_behavior) = OPTIONAL];
        Parameters:
        value - The bytes for dataPathPattern to set.
        Returns:
        This builder for chaining.

      • getCatalogEntry

        public String getCatalogEntry()
         Output only. The name of the associated Data Catalog entry.
        string catalog_entry = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCatalogEntry in interface EntityOrBuilder
        Returns:
        The catalogEntry.

      • getCatalogEntryBytes

        public com.google.protobuf.ByteString getCatalogEntryBytes()
         Output only. The name of the associated Data Catalog entry.
        string catalog_entry = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCatalogEntryBytes in interface EntityOrBuilder
        Returns:
        The bytes for catalogEntry.

      • setCatalogEntry

        public Entity.Builder setCatalogEntry​(String value)
         Output only. The name of the associated Data Catalog entry.
        string catalog_entry = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Parameters:
        value - The catalogEntry to set.
        Returns:
        This builder for chaining.

      • clearCatalogEntry

        public Entity.Builder clearCatalogEntry()
         Output only. The name of the associated Data Catalog entry.
        string catalog_entry = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        This builder for chaining.

      • setCatalogEntryBytes

        public Entity.Builder setCatalogEntryBytes​(com.google.protobuf.ByteString value)
         Output only. The name of the associated Data Catalog entry.
        string catalog_entry = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Parameters:
        value - The bytes for catalogEntry to set.
        Returns:
        This builder for chaining.

      • getSystemValue

        public int getSystemValue()
         Required. Immutable. Identifies the storage system of the entity data.
        .google.cloud.dataplex.v1.StorageSystem system = 15 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        getSystemValue in interface EntityOrBuilder
        Returns:
        The enum numeric value on the wire for system.

      • setSystemValue

        public Entity.Builder setSystemValue​(int value)
         Required. Immutable. Identifies the storage system of the entity data.
        .google.cloud.dataplex.v1.StorageSystem system = 15 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
        Parameters:
        value - The enum numeric value on the wire for system to set.
        Returns:
        This builder for chaining.

      • getSystem

        public StorageSystem getSystem()
         Required. Immutable. Identifies the storage system of the entity data.
        .google.cloud.dataplex.v1.StorageSystem system = 15 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        getSystem in interface EntityOrBuilder
        Returns:
        The system.

      • setSystem

        public Entity.Builder setSystem​(StorageSystem value)
         Required. Immutable. Identifies the storage system of the entity data.
        .google.cloud.dataplex.v1.StorageSystem system = 15 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
        Parameters:
        value - The system to set.
        Returns:
        This builder for chaining.

      • clearSystem

        public Entity.Builder clearSystem()
         Required. Immutable. Identifies the storage system of the entity data.
        .google.cloud.dataplex.v1.StorageSystem system = 15 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
        Returns:
        This builder for chaining.

      • hasFormat

        public boolean hasFormat()
         Required. Identifies the storage format of the entity data.
 It does not apply to entities with data stored in BigQuery.
        .google.cloud.dataplex.v1.StorageFormat format = 16 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        hasFormat in interface EntityOrBuilder
        Returns:
        Whether the format field is set.

      • getFormat

        public StorageFormat getFormat()
         Required. Identifies the storage format of the entity data.
 It does not apply to entities with data stored in BigQuery.
        .google.cloud.dataplex.v1.StorageFormat format = 16 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getFormat in interface EntityOrBuilder
        Returns:
        The format.

      • setFormat

        public Entity.Builder setFormat​(StorageFormat value)
         Required. Identifies the storage format of the entity data.
 It does not apply to entities with data stored in BigQuery.
        .google.cloud.dataplex.v1.StorageFormat format = 16 [(.google.api.field_behavior) = REQUIRED];

      • setFormat

        public Entity.Builder setFormat​(StorageFormat.Builder builderForValue)
         Required. Identifies the storage format of the entity data.
 It does not apply to entities with data stored in BigQuery.
        .google.cloud.dataplex.v1.StorageFormat format = 16 [(.google.api.field_behavior) = REQUIRED];

      • mergeFormat

        public Entity.Builder mergeFormat​(StorageFormat value)
         Required. Identifies the storage format of the entity data.
 It does not apply to entities with data stored in BigQuery.
        .google.cloud.dataplex.v1.StorageFormat format = 16 [(.google.api.field_behavior) = REQUIRED];

      • clearFormat

        public Entity.Builder clearFormat()
         Required. Identifies the storage format of the entity data.
 It does not apply to entities with data stored in BigQuery.
        .google.cloud.dataplex.v1.StorageFormat format = 16 [(.google.api.field_behavior) = REQUIRED];

      • getFormatBuilder

        public StorageFormat.Builder getFormatBuilder()
         Required. Identifies the storage format of the entity data.
 It does not apply to entities with data stored in BigQuery.
        .google.cloud.dataplex.v1.StorageFormat format = 16 [(.google.api.field_behavior) = REQUIRED];

      • getFormatOrBuilder

        public StorageFormatOrBuilder getFormatOrBuilder()
         Required. Identifies the storage format of the entity data.
 It does not apply to entities with data stored in BigQuery.
        .google.cloud.dataplex.v1.StorageFormat format = 16 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getFormatOrBuilder in interface EntityOrBuilder

      • hasCompatibility

        public boolean hasCompatibility()
         Output only. Metadata stores that the entity is compatible with.
        .google.cloud.dataplex.v1.Entity.CompatibilityStatus compatibility = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasCompatibility in interface EntityOrBuilder
        Returns:
        Whether the compatibility field is set.

      • getCompatibility

        public Entity.CompatibilityStatus getCompatibility()
         Output only. Metadata stores that the entity is compatible with.
        .google.cloud.dataplex.v1.Entity.CompatibilityStatus compatibility = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCompatibility in interface EntityOrBuilder
        Returns:
        The compatibility.

      • setCompatibility

        public Entity.Builder setCompatibility​(Entity.CompatibilityStatus value)
         Output only. Metadata stores that the entity is compatible with.
        .google.cloud.dataplex.v1.Entity.CompatibilityStatus compatibility = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • setCompatibility

        public Entity.Builder setCompatibility​(Entity.CompatibilityStatus.Builder builderForValue)
         Output only. Metadata stores that the entity is compatible with.
        .google.cloud.dataplex.v1.Entity.CompatibilityStatus compatibility = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • mergeCompatibility

        public Entity.Builder mergeCompatibility​(Entity.CompatibilityStatus value)
         Output only. Metadata stores that the entity is compatible with.
        .google.cloud.dataplex.v1.Entity.CompatibilityStatus compatibility = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • clearCompatibility

        public Entity.Builder clearCompatibility()
         Output only. Metadata stores that the entity is compatible with.
        .google.cloud.dataplex.v1.Entity.CompatibilityStatus compatibility = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • getCompatibilityBuilder

        public Entity.CompatibilityStatus.Builder getCompatibilityBuilder()
         Output only. Metadata stores that the entity is compatible with.
        .google.cloud.dataplex.v1.Entity.CompatibilityStatus compatibility = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • hasAccess

        public boolean hasAccess()
         Output only. Identifies the access mechanism to the entity. Not user
 settable.
        .google.cloud.dataplex.v1.StorageAccess access = 21 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasAccess in interface EntityOrBuilder
        Returns:
        Whether the access field is set.

      • getAccess

        public StorageAccess getAccess()
         Output only. Identifies the access mechanism to the entity. Not user
 settable.
        .google.cloud.dataplex.v1.StorageAccess access = 21 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getAccess in interface EntityOrBuilder
        Returns:
        The access.

      • setAccess

        public Entity.Builder setAccess​(StorageAccess value)
         Output only. Identifies the access mechanism to the entity. Not user
 settable.
        .google.cloud.dataplex.v1.StorageAccess access = 21 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • setAccess

        public Entity.Builder setAccess​(StorageAccess.Builder builderForValue)
         Output only. Identifies the access mechanism to the entity. Not user
 settable.
        .google.cloud.dataplex.v1.StorageAccess access = 21 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • mergeAccess

        public Entity.Builder mergeAccess​(StorageAccess value)
         Output only. Identifies the access mechanism to the entity. Not user
 settable.
        .google.cloud.dataplex.v1.StorageAccess access = 21 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • clearAccess

        public Entity.Builder clearAccess()
         Output only. Identifies the access mechanism to the entity. Not user
 settable.
        .google.cloud.dataplex.v1.StorageAccess access = 21 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • getAccessBuilder

        public StorageAccess.Builder getAccessBuilder()
         Output only. Identifies the access mechanism to the entity. Not user
 settable.
        .google.cloud.dataplex.v1.StorageAccess access = 21 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • getAccessOrBuilder

        public StorageAccessOrBuilder getAccessOrBuilder()
         Output only. Identifies the access mechanism to the entity. Not user
 settable.
        .google.cloud.dataplex.v1.StorageAccess access = 21 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getAccessOrBuilder in interface EntityOrBuilder

      • getUid

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

      • getUidBytes

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

      • setUid

        public Entity.Builder setUid​(String value)
         Output only. System generated unique ID for the Entity. This ID will be
 different if the Entity is deleted and re-created with the same name.
        string uid = 22 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Parameters:
        value - The uid to set.
        Returns:
        This builder for chaining.

      • clearUid

        public Entity.Builder clearUid()
         Output only. System generated unique ID for the Entity. This ID will be
 different if the Entity is deleted and re-created with the same name.
        string uid = 22 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        This builder for chaining.

      • setUidBytes

        public Entity.Builder setUidBytes​(com.google.protobuf.ByteString value)
         Output only. System generated unique ID for the Entity. This ID will be
 different if the Entity is deleted and re-created with the same name.
        string uid = 22 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Parameters:
        value - The bytes for uid to set.
        Returns:
        This builder for chaining.

      • hasSchema

        public boolean hasSchema()
         Required. The description of the data structure and layout.
 The schema is not included in list responses. It is only included in
 `SCHEMA` and `FULL` entity views of a `GetEntity` response.
        .google.cloud.dataplex.v1.Schema schema = 50 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        hasSchema in interface EntityOrBuilder
        Returns:
        Whether the schema field is set.

      • getSchema

        public Schema getSchema()
         Required. The description of the data structure and layout.
 The schema is not included in list responses. It is only included in
 `SCHEMA` and `FULL` entity views of a `GetEntity` response.
        .google.cloud.dataplex.v1.Schema schema = 50 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getSchema in interface EntityOrBuilder
        Returns:
        The schema.

      • setSchema

        public Entity.Builder setSchema​(Schema value)
         Required. The description of the data structure and layout.
 The schema is not included in list responses. It is only included in
 `SCHEMA` and `FULL` entity views of a `GetEntity` response.
        .google.cloud.dataplex.v1.Schema schema = 50 [(.google.api.field_behavior) = REQUIRED];

      • setSchema

        public Entity.Builder setSchema​(Schema.Builder builderForValue)
         Required. The description of the data structure and layout.
 The schema is not included in list responses. It is only included in
 `SCHEMA` and `FULL` entity views of a `GetEntity` response.
        .google.cloud.dataplex.v1.Schema schema = 50 [(.google.api.field_behavior) = REQUIRED];

      • mergeSchema

        public Entity.Builder mergeSchema​(Schema value)
         Required. The description of the data structure and layout.
 The schema is not included in list responses. It is only included in
 `SCHEMA` and `FULL` entity views of a `GetEntity` response.
        .google.cloud.dataplex.v1.Schema schema = 50 [(.google.api.field_behavior) = REQUIRED];

      • clearSchema

        public Entity.Builder clearSchema()
         Required. The description of the data structure and layout.
 The schema is not included in list responses. It is only included in
 `SCHEMA` and `FULL` entity views of a `GetEntity` response.
        .google.cloud.dataplex.v1.Schema schema = 50 [(.google.api.field_behavior) = REQUIRED];

      • getSchemaBuilder

        public Schema.Builder getSchemaBuilder()
         Required. The description of the data structure and layout.
 The schema is not included in list responses. It is only included in
 `SCHEMA` and `FULL` entity views of a `GetEntity` response.
        .google.cloud.dataplex.v1.Schema schema = 50 [(.google.api.field_behavior) = REQUIRED];

      • getSchemaOrBuilder

        public SchemaOrBuilder getSchemaOrBuilder()
         Required. The description of the data structure and layout.
 The schema is not included in list responses. It is only included in
 `SCHEMA` and `FULL` entity views of a `GetEntity` response.
        .google.cloud.dataplex.v1.Schema schema = 50 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getSchemaOrBuilder in interface EntityOrBuilder

      • setUnknownFields

        public final Entity.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Entity.Builder>

      • mergeUnknownFields

        public final Entity.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Entity.Builder>