Package com.google.cloud.dataplex.v1

Class Zone

  • All Implemented Interfaces:
    ZoneOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class Zone
extends com.google.protobuf.GeneratedMessageV3
implements ZoneOrBuilder
     A zone represents a logical group of related assets within a lake. A zone can
 be used to map to organizational structure or represent stages of data
 readiness from raw to curated. It provides managing behavior that is shared
 or inherited by all contained assets.
    Protobuf type google.cloud.dataplex.v1.Zone
    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 zone, of the form:
 `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}`.
        string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
        Specified by:
        getName in interface ZoneOrBuilder
        Returns:
        The name.

      • getNameBytes

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

      • getDisplayName

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

      • getDisplayNameBytes

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

      • getUid

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

      • getUidBytes

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

      • hasCreateTime

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

      • getCreateTime

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

      • getCreateTimeOrBuilder

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

      • hasUpdateTime

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

      • getUpdateTime

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

      • getUpdateTimeOrBuilder

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

      • getLabelsCount

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

      • containsLabels

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

      • getLabelsMap

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

      • getLabelsOrDefault

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

      • getLabelsOrThrow

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

      • getDescription

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

      • getDescriptionBytes

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

      • getStateValue

        public int getStateValue()
         Output only. Current state of the zone.
        .google.cloud.dataplex.v1.State state = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getStateValue in interface ZoneOrBuilder
        Returns:
        The enum numeric value on the wire for state.

      • getState

        public State getState()
         Output only. Current state of the zone.
        .google.cloud.dataplex.v1.State state = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getState in interface ZoneOrBuilder
        Returns:
        The state.

      • getTypeValue

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

      • getType

        public Zone.Type getType()
         Required. Immutable. The type of the zone.
        .google.cloud.dataplex.v1.Zone.Type type = 9 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        getType in interface ZoneOrBuilder
        Returns:
        The type.

      • hasDiscoverySpec

        public boolean hasDiscoverySpec()
         Optional. Specification of the discovery feature applied to data in this
 zone.
        .google.cloud.dataplex.v1.Zone.DiscoverySpec discovery_spec = 103 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        hasDiscoverySpec in interface ZoneOrBuilder
        Returns:
        Whether the discoverySpec field is set.

      • getDiscoverySpec

        public Zone.DiscoverySpec getDiscoverySpec()
         Optional. Specification of the discovery feature applied to data in this
 zone.
        .google.cloud.dataplex.v1.Zone.DiscoverySpec discovery_spec = 103 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getDiscoverySpec in interface ZoneOrBuilder
        Returns:
        The discoverySpec.

      • getDiscoverySpecOrBuilder

        public Zone.DiscoverySpecOrBuilder getDiscoverySpecOrBuilder()
         Optional. Specification of the discovery feature applied to data in this
 zone.
        .google.cloud.dataplex.v1.Zone.DiscoverySpec discovery_spec = 103 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getDiscoverySpecOrBuilder in interface ZoneOrBuilder

      • hasResourceSpec

        public boolean hasResourceSpec()
         Required. Specification of the resources that are referenced by the assets
 within this zone.
        .google.cloud.dataplex.v1.Zone.ResourceSpec resource_spec = 104 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        hasResourceSpec in interface ZoneOrBuilder
        Returns:
        Whether the resourceSpec field is set.

      • getResourceSpec

        public Zone.ResourceSpec getResourceSpec()
         Required. Specification of the resources that are referenced by the assets
 within this zone.
        .google.cloud.dataplex.v1.Zone.ResourceSpec resource_spec = 104 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getResourceSpec in interface ZoneOrBuilder
        Returns:
        The resourceSpec.

      • getResourceSpecOrBuilder

        public Zone.ResourceSpecOrBuilder getResourceSpecOrBuilder()
         Required. Specification of the resources that are referenced by the assets
 within this zone.
        .google.cloud.dataplex.v1.Zone.ResourceSpec resource_spec = 104 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getResourceSpecOrBuilder in interface ZoneOrBuilder

      • hasAssetStatus

        public boolean hasAssetStatus()
         Output only. Aggregated status of the underlying assets of the zone.
        .google.cloud.dataplex.v1.AssetStatus asset_status = 105 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasAssetStatus in interface ZoneOrBuilder
        Returns:
        Whether the assetStatus field is set.

      • getAssetStatus

        public AssetStatus getAssetStatus()
         Output only. Aggregated status of the underlying assets of the zone.
        .google.cloud.dataplex.v1.AssetStatus asset_status = 105 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getAssetStatus in interface ZoneOrBuilder
        Returns:
        The assetStatus.

      • getAssetStatusOrBuilder

        public AssetStatusOrBuilder getAssetStatusOrBuilder()
         Output only. Aggregated status of the underlying assets of the zone.
        .google.cloud.dataplex.v1.AssetStatus asset_status = 105 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getAssetStatusOrBuilder in interface ZoneOrBuilder

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getDefaultInstance

        public static Zone getDefaultInstance()

      • parser

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

      • getParserForType

        public com.google.protobuf.Parser<Zone> 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 Zone getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder