public final class Zone extends 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
Static Fields
ASSET_STATUS_FIELD_NUMBER
public static final int ASSET_STATUS_FIELD_NUMBER
Field Value
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
Field Value
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
Field Value
DISCOVERY_SPEC_FIELD_NUMBER
public static final int DISCOVERY_SPEC_FIELD_NUMBER
Field Value
DISPLAY_NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
LABELS_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER
Field Value
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Field Value
RESOURCE_SPEC_FIELD_NUMBER
public static final int RESOURCE_SPEC_FIELD_NUMBER
Field Value
STATE_FIELD_NUMBER
public static final int STATE_FIELD_NUMBER
Field Value
TYPE_FIELD_NUMBER
public static final int TYPE_FIELD_NUMBER
Field Value
UID_FIELD_NUMBER
public static final int UID_FIELD_NUMBER
Field Value
UPDATE_TIME_FIELD_NUMBER
public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static Zone getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static Zone.Builder newBuilder()
Returns
newBuilder(Zone prototype)
public static Zone.Builder newBuilder(Zone prototype)
Parameter
| Name | Description |
| prototype | Zone
|
Returns
public static Zone parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static Zone parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static Zone parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Zone parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static Zone parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Zone parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Zone parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static Zone parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Zone parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static Zone parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static Zone parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Zone parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<Zone> parser()
Returns
Methods
containsLabels(String key)
public boolean containsLabels(String key)
Optional. User defined labels for the zone.
map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
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];
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];
getCreateTime()
public Timestamp getCreateTime()
Output only. The time when the zone was created.
.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
getCreateTimeOrBuilder()
public TimestampOrBuilder getCreateTimeOrBuilder()
Output only. The time when the zone was created.
.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
getDefaultInstanceForType()
public Zone getDefaultInstanceForType()
Returns
getDescription()
public String getDescription()
Optional. Description of the zone.
string description = 7 [(.google.api.field_behavior) = OPTIONAL];
| Type | Description |
| String | The description.
|
getDescriptionBytes()
public ByteString getDescriptionBytes()
Optional. Description of the zone.
string description = 7 [(.google.api.field_behavior) = OPTIONAL];
| Type | Description |
| ByteString | The bytes for description.
|
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];
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];
getDisplayName()
public String getDisplayName()
Optional. User friendly display name.
string display_name = 2 [(.google.api.field_behavior) = OPTIONAL];
| Type | Description |
| String | The displayName.
|
getDisplayNameBytes()
public ByteString getDisplayNameBytes()
Optional. User friendly display name.
string display_name = 2 [(.google.api.field_behavior) = OPTIONAL];
| Type | Description |
| ByteString | The bytes for displayName.
|
getLabels()
public Map<String,String> getLabels()
Returns
getLabelsCount()
public int getLabelsCount()
Optional. User defined labels for the zone.
map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];
getLabelsMap()
public Map<String,String> getLabelsMap()
Optional. User defined labels for the zone.
map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];
getLabelsOrDefault(String key, String defaultValue)
public String getLabelsOrDefault(String key, String defaultValue)
Optional. User defined labels for the zone.
map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];
getLabelsOrThrow(String key)
public String getLabelsOrThrow(String key)
Optional. User defined labels for the zone.
map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];
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) = { ... }
| Type | Description |
| String | The name.
|
getNameBytes()
public 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) = { ... }
getParserForType()
public Parser<Zone> getParserForType()
Returns
Overrides
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];
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];
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getState()
Output only. Current state of the zone.
.google.cloud.dataplex.v1.State state = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| State | The state.
|
getStateValue()
public int getStateValue()
Output only. Current state of the zone.
.google.cloud.dataplex.v1.State state = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| int | The enum numeric value on the wire for state.
|
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];
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];
| Type | Description |
| int | The enum numeric value on the wire for type.
|
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];
getUidBytes()
public 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];
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
getUpdateTime()
public Timestamp getUpdateTime()
Output only. The time when the zone was last updated.
.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
getUpdateTimeOrBuilder()
public TimestampOrBuilder getUpdateTimeOrBuilder()
Output only. The time when the zone was last updated.
.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
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];
| Type | Description |
| boolean | Whether the assetStatus field is set.
|
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];
| Type | Description |
| boolean | Whether the createTime field is set.
|
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];
| Type | Description |
| boolean | Whether the discoverySpec field is set.
|
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];
| Type | Description |
| boolean | Whether the resourceSpec field is set.
|
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];
| Type | Description |
| boolean | Whether the updateTime field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
Parameter
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public Zone.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Zone.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public Zone.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
