REST Resource: projects.locations.lakes.zones

Resource: Zone

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.

JSON representation 
{
  "name": string,
  "displayName": string,
  "uid": string,
  "createTime": string,
  "updateTime": string,
  "labels": {
    string: string,
    ...
  },
  "description": string,
  "state": enum (State),
  "type": enum (Type),
  "discoverySpec": {
    object (DiscoverySpec)
  },
  "resourceSpec": {
    object (ResourceSpec)
  },
  "assetStatus": {
    object (AssetStatus)
  }
}
Fields
name

string

Output only. The relative resource name of the zone, of the form: projects/{project_number}/locations/{locationId}/lakes/{lakeId}/zones/{zoneId}.
displayName

string

Optional. User friendly display name.
uid

string

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.
createTime

string (Timestamp format)

Output only. The time when the zone was created.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
updateTime

string (Timestamp format)

Output only. The time when the zone was last updated.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
labels

map (key: string, value: string)

Optional. User defined labels for the zone.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
description

string

Optional. Description of the zone.
state

enum (State)

Output only. Current state of the zone.
type

enum (Type)

Required. Immutable. The type of the zone.
discoverySpec

object (DiscoverySpec)

Optional. Specification of the discovery feature applied to data in this zone.
resourceSpec

object (ResourceSpec)

Required. Specification of the resources that are referenced by the assets within this zone.
assetStatus

object (AssetStatus)

Output only. Aggregated status of the underlying assets of the zone.

Type

Type of zone.

Enums
TYPE_UNSPECIFIED Zone type not specified.
RAW A zone that contains data that needs further processing before it is considered generally ready for consumption and analytics workloads.
CURATED A zone that contains data that is considered to be ready for broader consumption and analytics workloads. Curated structured data stored in Cloud Storage must conform to certain file formats (parquet, avro and orc) and organized in a hive-compatible directory layout.

DiscoverySpec

Settings to manage the metadata discovery and publishing in a zone.

JSON representation 
{
  "enabled": boolean,
  "includePatterns": [
    string
  ],
  "excludePatterns": [
    string
  ],
  "csvOptions": {
    object (CsvOptions)
  },
  "jsonOptions": {
    object (JsonOptions)
  },

  // Union field trigger can be only one of the following:
  "schedule": string
  // End of list of possible types for union field trigger.
}
Fields
enabled

boolean

Required. Whether discovery is enabled.
includePatterns[]

string

Optional. The list of patterns to apply for selecting data to include during discovery if only a subset of the data should considered. For Cloud Storage bucket assets, these are interpreted as glob patterns used to match object names. For BigQuery dataset assets, these are interpreted as patterns to match table names.
excludePatterns[]

string

Optional. The list of patterns to apply for selecting data to exclude during discovery. For Cloud Storage bucket assets, these are interpreted as glob patterns used to match object names. For BigQuery dataset assets, these are interpreted as patterns to match table names.
csvOptions

object (CsvOptions)

Optional. Configuration for CSV data.
jsonOptions

object (JsonOptions)

Optional. Configuration for Json data.
Union field trigger. Determines when discovery is triggered. trigger can be only one of the following:
schedule

string

Optional. Cron schedule (https://en.wikipedia.org/wiki/Cron) for running discovery periodically. Successive discovery runs must be scheduled at least 60 minutes apart. The default value is to run discovery every 60 minutes. To explicitly set a timezone to the cron tab, apply a prefix in the cron tab: "CRON_TZ=${IANA_TIME_ZONE}" or TZ=${IANA_TIME_ZONE}". The ${IANA_TIME_ZONE} may only be a valid string from IANA time zone database. For example, CRON_TZ=America/New_York 1 * * * *, or TZ=America/New_York 1 * * * *.

CsvOptions

Describe CSV and similar semi-structured data formats.

JSON representation 
{
  "headerRows": integer,
  "delimiter": string,
  "encoding": string,
  "disableTypeInference": boolean
}
Fields
headerRows

integer

Optional. The number of rows to interpret as header rows that should be skipped when reading data rows.
delimiter

string

Optional. The delimiter being used to separate values. This defaults to ','.
encoding

string

Optional. The character encoding of the data. The default is UTF-8.
disableTypeInference

boolean

Optional. Whether to disable the inference of data type for CSV data. If true, all columns will be registered as strings.

JsonOptions

Describe JSON data format.

JSON representation 
{
  "encoding": string,
  "disableTypeInference": boolean
}
Fields
encoding

string

Optional. The character encoding of the data. The default is UTF-8.
disableTypeInference

boolean

Optional. Whether to disable the inference of data type for Json data. If true, all columns will be registered as their primitive types (strings, number or boolean).

ResourceSpec

Settings for resources attached as assets within a zone.

JSON representation 
{
  "locationType": enum (LocationType)
}
Fields
locationType

enum (LocationType)

Required. Immutable. The location type of the resources that are allowed to be attached to the assets within this zone.

LocationType

Location type of the resources attached to a zone.

Enums
LOCATION_TYPE_UNSPECIFIED Unspecified location type.
SINGLE_REGION Resources that are associated with a single region.
MULTI_REGION Resources that are associated with a multi-region location.

Methods

create

 Creates a zone resource within a lake.

delete

 Deletes a zone resource.

get

 Retrieves a zone resource.

getIamPolicy

 Gets the access control policy for a resource.

list

 Lists zone resources in a lake.

patch

 Updates a zone resource.

setIamPolicy

 Sets the access control policy on the specified resource.

testIamPermissions

 Returns permissions that a caller has on the specified resource.