Docs Packages
  1. Packages
  2. Google Cloud Native
  3. API Docs
  4. dataplex
  5. dataplex/v1
  6. getZone

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

google-native.dataplex/v1.getZone

Explore with Pulumi AI

google-native logo

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

    Retrieves a zone resource.

    Using getZone

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getZone(args: GetZoneArgs, opts?: InvokeOptions): Promise<GetZoneResult>
function getZoneOutput(args: GetZoneOutputArgs, opts?: InvokeOptions): Output<GetZoneResult>
    def get_zone(lake_id: Optional[str] = None,
             location: Optional[str] = None,
             project: Optional[str] = None,
             zone: Optional[str] = None,
             opts: Optional[InvokeOptions] = None) -> GetZoneResult
def get_zone_output(lake_id: Optional[pulumi.Input[str]] = None,
             location: Optional[pulumi.Input[str]] = None,
             project: Optional[pulumi.Input[str]] = None,
             zone: Optional[pulumi.Input[str]] = None,
             opts: Optional[InvokeOptions] = None) -> Output[GetZoneResult]
    func LookupZone(ctx *Context, args *LookupZoneArgs, opts ...InvokeOption) (*LookupZoneResult, error)
func LookupZoneOutput(ctx *Context, args *LookupZoneOutputArgs, opts ...InvokeOption) LookupZoneResultOutput

    > Note: This function is named LookupZone in the Go SDK.

    public static class GetZone 
{
    public static Task<GetZoneResult> InvokeAsync(GetZoneArgs args, InvokeOptions? opts = null)
    public static Output<GetZoneResult> Invoke(GetZoneInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetZoneResult> getZone(GetZoneArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: google-native:dataplex/v1:getZone
  arguments:
    # arguments dictionary

    The following arguments are supported:

    LakeId string
    Location string
    Zone string
    Project string
    LakeId string
    Location string
    Zone string
    Project string
    lakeId String
    location String
    zone String
    project String
    lakeId string
    location string
    zone string
    project string
    lakeId String
    location String
    zone String
    project String

    getZone Result

    The following output properties are available:

    AssetStatus Pulumi.GoogleNative.Dataplex.V1.Outputs.GoogleCloudDataplexV1AssetStatusResponse
    Aggregated status of the underlying assets of the zone.
    CreateTime string
    The time when the zone was created.
    Description string
    Optional. Description of the zone.
    DiscoverySpec Pulumi.GoogleNative.Dataplex.V1.Outputs.GoogleCloudDataplexV1ZoneDiscoverySpecResponse
    Optional. Specification of the discovery feature applied to data in this zone.
    DisplayName string
    Optional. User friendly display name.
    Labels Dictionary<string, string>
    Optional. User defined labels for the zone.
    Name string
    The relative resource name of the zone, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}.
    ResourceSpec Pulumi.GoogleNative.Dataplex.V1.Outputs.GoogleCloudDataplexV1ZoneResourceSpecResponse
    Specification of the resources that are referenced by the assets within this zone.
    State string
    Current state of the zone.
    Type string
    Immutable. The type of the zone.
    Uid string
    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.
    UpdateTime string
    The time when the zone was last updated.
    AssetStatus GoogleCloudDataplexV1AssetStatusResponse
    Aggregated status of the underlying assets of the zone.
    CreateTime string
    The time when the zone was created.
    Description string
    Optional. Description of the zone.
    DiscoverySpec GoogleCloudDataplexV1ZoneDiscoverySpecResponse
    Optional. Specification of the discovery feature applied to data in this zone.
    DisplayName string
    Optional. User friendly display name.
    Labels map[string]string
    Optional. User defined labels for the zone.
    Name string
    The relative resource name of the zone, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}.
    ResourceSpec GoogleCloudDataplexV1ZoneResourceSpecResponse
    Specification of the resources that are referenced by the assets within this zone.
    State string
    Current state of the zone.
    Type string
    Immutable. The type of the zone.
    Uid string
    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.
    UpdateTime string
    The time when the zone was last updated.
    assetStatus GoogleCloudDataplexV1AssetStatusResponse
    Aggregated status of the underlying assets of the zone.
    createTime String
    The time when the zone was created.
    description String
    Optional. Description of the zone.
    discoverySpec GoogleCloudDataplexV1ZoneDiscoverySpecResponse
    Optional. Specification of the discovery feature applied to data in this zone.
    displayName String
    Optional. User friendly display name.
    labels Map<String,String>
    Optional. User defined labels for the zone.
    name String
    The relative resource name of the zone, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}.
    resourceSpec GoogleCloudDataplexV1ZoneResourceSpecResponse
    Specification of the resources that are referenced by the assets within this zone.
    state String
    Current state of the zone.
    type String
    Immutable. The type of the zone.
    uid String
    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.
    updateTime String
    The time when the zone was last updated.
    assetStatus GoogleCloudDataplexV1AssetStatusResponse
    Aggregated status of the underlying assets of the zone.
    createTime string
    The time when the zone was created.
    description string
    Optional. Description of the zone.
    discoverySpec GoogleCloudDataplexV1ZoneDiscoverySpecResponse
    Optional. Specification of the discovery feature applied to data in this zone.
    displayName string
    Optional. User friendly display name.
    labels {[key: string]: string}
    Optional. User defined labels for the zone.
    name string
    The relative resource name of the zone, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}.
    resourceSpec GoogleCloudDataplexV1ZoneResourceSpecResponse
    Specification of the resources that are referenced by the assets within this zone.
    state string
    Current state of the zone.
    type string
    Immutable. The type of the zone.
    uid string
    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.
    updateTime string
    The time when the zone was last updated.
    asset_status GoogleCloudDataplexV1AssetStatusResponse
    Aggregated status of the underlying assets of the zone.
    create_time str
    The time when the zone was created.
    description str
    Optional. Description of the zone.
    discovery_spec GoogleCloudDataplexV1ZoneDiscoverySpecResponse
    Optional. Specification of the discovery feature applied to data in this zone.
    display_name str
    Optional. User friendly display name.
    labels Mapping[str, str]
    Optional. User defined labels for the zone.
    name str
    The relative resource name of the zone, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}.
    resource_spec GoogleCloudDataplexV1ZoneResourceSpecResponse
    Specification of the resources that are referenced by the assets within this zone.
    state str
    Current state of the zone.
    type str
    Immutable. The type of the zone.
    uid str
    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.
    update_time str
    The time when the zone was last updated.
    assetStatus Property Map
    Aggregated status of the underlying assets of the zone.
    createTime String
    The time when the zone was created.
    description String
    Optional. Description of the zone.
    discoverySpec Property Map
    Optional. Specification of the discovery feature applied to data in this zone.
    displayName String
    Optional. User friendly display name.
    labels Map<String>
    Optional. User defined labels for the zone.
    name String
    The relative resource name of the zone, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}.
    resourceSpec Property Map
    Specification of the resources that are referenced by the assets within this zone.
    state String
    Current state of the zone.
    type String
    Immutable. The type of the zone.
    uid String
    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.
    updateTime String
    The time when the zone was last updated.

    Supporting Types

    GoogleCloudDataplexV1AssetStatusResponse

    ActiveAssets int
    Number of active assets.
    SecurityPolicyApplyingAssets int
    Number of assets that are in process of updating the security policy on attached resources.
    UpdateTime string
    Last update time of the status.
    ActiveAssets int
    Number of active assets.
    SecurityPolicyApplyingAssets int
    Number of assets that are in process of updating the security policy on attached resources.
    UpdateTime string
    Last update time of the status.
    activeAssets Integer
    Number of active assets.
    securityPolicyApplyingAssets Integer
    Number of assets that are in process of updating the security policy on attached resources.
    updateTime String
    Last update time of the status.
    activeAssets number
    Number of active assets.
    securityPolicyApplyingAssets number
    Number of assets that are in process of updating the security policy on attached resources.
    updateTime string
    Last update time of the status.
    active_assets int
    Number of active assets.
    security_policy_applying_assets int
    Number of assets that are in process of updating the security policy on attached resources.
    update_time str
    Last update time of the status.
    activeAssets Number
    Number of active assets.
    securityPolicyApplyingAssets Number
    Number of assets that are in process of updating the security policy on attached resources.
    updateTime String
    Last update time of the status.

    GoogleCloudDataplexV1ZoneDiscoverySpecCsvOptionsResponse

    Delimiter string
    Optional. The delimiter being used to separate values. This defaults to ','.
    DisableTypeInference bool
    Optional. Whether to disable the inference of data type for CSV data. If true, all columns will be registered as strings.
    Encoding string
    Optional. The character encoding of the data. The default is UTF-8.
    HeaderRows int
    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 ','.
    DisableTypeInference bool
    Optional. Whether to disable the inference of data type for CSV data. If true, all columns will be registered as strings.
    Encoding string
    Optional. The character encoding of the data. The default is UTF-8.
    HeaderRows int
    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 ','.
    disableTypeInference Boolean
    Optional. Whether to disable the inference of data type for CSV data. If true, all columns will be registered as strings.
    encoding String
    Optional. The character encoding of the data. The default is UTF-8.
    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 ','.
    disableTypeInference boolean
    Optional. Whether to disable the inference of data type for CSV data. If true, all columns will be registered as strings.
    encoding string
    Optional. The character encoding of the data. The default is UTF-8.
    headerRows number
    Optional. The number of rows to interpret as header rows that should be skipped when reading data rows.
    delimiter str
    Optional. The delimiter being used to separate values. This defaults to ','.
    disable_type_inference bool
    Optional. Whether to disable the inference of data type for CSV data. If true, all columns will be registered as strings.
    encoding str
    Optional. The character encoding of the data. The default is UTF-8.
    header_rows int
    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 ','.
    disableTypeInference Boolean
    Optional. Whether to disable the inference of data type for CSV data. If true, all columns will be registered as strings.
    encoding String
    Optional. The character encoding of the data. The default is UTF-8.
    headerRows Number
    Optional. The number of rows to interpret as header rows that should be skipped when reading data rows.

    GoogleCloudDataplexV1ZoneDiscoverySpecJsonOptionsResponse

    DisableTypeInference bool
    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).
    Encoding string
    Optional. The character encoding of the data. The default is UTF-8.
    DisableTypeInference bool
    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).
    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).
    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).
    encoding string
    Optional. The character encoding of the data. The default is UTF-8.
    disable_type_inference bool
    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).
    encoding str
    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).
    encoding String
    Optional. The character encoding of the data. The default is UTF-8.

    GoogleCloudDataplexV1ZoneDiscoverySpecResponse

    CsvOptions Pulumi.GoogleNative.Dataplex.V1.Inputs.GoogleCloudDataplexV1ZoneDiscoverySpecCsvOptionsResponse
    Optional. Configuration for CSV data.
    Enabled bool
    Whether discovery is enabled.
    ExcludePatterns List<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.
    IncludePatterns List<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.
    JsonOptions Pulumi.GoogleNative.Dataplex.V1.Inputs.GoogleCloudDataplexV1ZoneDiscoverySpecJsonOptionsResponse
    Optional. Configuration for Json data.
    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 GoogleCloudDataplexV1ZoneDiscoverySpecCsvOptionsResponse
    Optional. Configuration for CSV data.
    Enabled bool
    Whether discovery is enabled.
    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.
    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.
    JsonOptions GoogleCloudDataplexV1ZoneDiscoverySpecJsonOptionsResponse
    Optional. Configuration for Json data.
    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 GoogleCloudDataplexV1ZoneDiscoverySpecCsvOptionsResponse
    Optional. Configuration for CSV data.
    enabled Boolean
    Whether discovery is enabled.
    excludePatterns List<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.
    includePatterns List<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.
    jsonOptions GoogleCloudDataplexV1ZoneDiscoverySpecJsonOptionsResponse
    Optional. Configuration for Json data.
    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 GoogleCloudDataplexV1ZoneDiscoverySpecCsvOptionsResponse
    Optional. Configuration for CSV data.
    enabled boolean
    Whether discovery is enabled.
    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.
    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.
    jsonOptions GoogleCloudDataplexV1ZoneDiscoverySpecJsonOptionsResponse
    Optional. Configuration for Json data.
    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 * * * *.
    csv_options GoogleCloudDataplexV1ZoneDiscoverySpecCsvOptionsResponse
    Optional. Configuration for CSV data.
    enabled bool
    Whether discovery is enabled.
    exclude_patterns Sequence[str]
    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.
    include_patterns Sequence[str]
    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.
    json_options GoogleCloudDataplexV1ZoneDiscoverySpecJsonOptionsResponse
    Optional. Configuration for Json data.
    schedule str
    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 Property Map
    Optional. Configuration for CSV data.
    enabled Boolean
    Whether discovery is enabled.
    excludePatterns List<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.
    includePatterns List<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.
    jsonOptions Property Map
    Optional. Configuration for Json data.
    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 * * * *.

    GoogleCloudDataplexV1ZoneResourceSpecResponse

    LocationType string
    Immutable. The location type of the resources that are allowed to be attached to the assets within this zone.
    LocationType string
    Immutable. The location type of the resources that are allowed to be attached to the assets within this zone.
    locationType String
    Immutable. The location type of the resources that are allowed to be attached to the assets within this zone.
    locationType string
    Immutable. The location type of the resources that are allowed to be attached to the assets within this zone.
    location_type str
    Immutable. The location type of the resources that are allowed to be attached to the assets within this zone.
    locationType String
    Immutable. The location type of the resources that are allowed to be attached to the assets within this zone.

    Package Details

    Repository
    Google Cloud Native pulumi/pulumi-google-native
    License
    Apache-2.0
    google-native logo

    Google Cloud Native is in preview. Google Cloud Classic is fully supported.

    Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
    pulumi/pulumi-google-native