1. Packages
  2. Google Cloud Native
  3. API Docs
  4. datacatalog
  5. datacatalog/v1beta1
  6. getEntry

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

google-native.datacatalog/v1beta1.getEntry

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

    Gets an entry.

    Using getEntry

    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 getEntry(args: GetEntryArgs, opts?: InvokeOptions): Promise<GetEntryResult>
    function getEntryOutput(args: GetEntryOutputArgs, opts?: InvokeOptions): Output<GetEntryResult>
    def get_entry(entry_group_id: Optional[str] = None,
                  entry_id: Optional[str] = None,
                  location: Optional[str] = None,
                  project: Optional[str] = None,
                  opts: Optional[InvokeOptions] = None) -> GetEntryResult
    def get_entry_output(entry_group_id: Optional[pulumi.Input[str]] = None,
                  entry_id: Optional[pulumi.Input[str]] = None,
                  location: Optional[pulumi.Input[str]] = None,
                  project: Optional[pulumi.Input[str]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetEntryResult]
    func LookupEntry(ctx *Context, args *LookupEntryArgs, opts ...InvokeOption) (*LookupEntryResult, error)
    func LookupEntryOutput(ctx *Context, args *LookupEntryOutputArgs, opts ...InvokeOption) LookupEntryResultOutput

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

    public static class GetEntry 
    {
        public static Task<GetEntryResult> InvokeAsync(GetEntryArgs args, InvokeOptions? opts = null)
        public static Output<GetEntryResult> Invoke(GetEntryInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetEntryResult> getEntry(GetEntryArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: google-native:datacatalog/v1beta1:getEntry
      arguments:
        # arguments dictionary

    The following arguments are supported:

    EntryGroupId string
    EntryId string
    Location string
    Project string
    EntryGroupId string
    EntryId string
    Location string
    Project string
    entryGroupId String
    entryId String
    location String
    project String
    entryGroupId string
    entryId string
    location string
    project string
    entryGroupId String
    entryId String
    location String
    project String

    getEntry Result

    The following output properties are available:

    BigqueryDateShardedSpec Pulumi.GoogleNative.DataCatalog.V1Beta1.Outputs.GoogleCloudDatacatalogV1beta1BigQueryDateShardedSpecResponse
    Specification for a group of BigQuery tables with name pattern [prefix]YYYYMMDD. Context: https://cloud.google.com/bigquery/docs/partitioned-tables#partitioning_versus_sharding.
    BigqueryTableSpec Pulumi.GoogleNative.DataCatalog.V1Beta1.Outputs.GoogleCloudDatacatalogV1beta1BigQueryTableSpecResponse
    Specification that applies to a BigQuery table. This is only valid on entries of type TABLE.
    Description string
    Entry description, which can consist of several sentences or paragraphs that describe entry contents. Default value is an empty string.
    DisplayName string
    Display information such as title and description. A short name to identify the entry, for example, "Analytics Data - Jan 2011". Default value is an empty string.
    GcsFilesetSpec Pulumi.GoogleNative.DataCatalog.V1Beta1.Outputs.GoogleCloudDatacatalogV1beta1GcsFilesetSpecResponse
    Specification that applies to a Cloud Storage fileset. This is only valid on entries of type FILESET.
    IntegratedSystem string
    This field indicates the entry's source system that Data Catalog integrates with, such as BigQuery or Pub/Sub.
    LinkedResource string
    The resource this metadata entry refers to. For Google Cloud Platform resources, linked_resource is the full name of the resource. For example, the linked_resource for a table resource from BigQuery is: * //bigquery.googleapis.com/projects/projectId/datasets/datasetId/tables/tableId Output only when Entry is of type in the EntryType enum. For entries with user_specified_type, this field is optional and defaults to an empty string.
    Name string
    The Data Catalog resource name of the entry in URL format. Example: * projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}/entries/{entry_id} Note that this Entry and its child resources may not actually be stored in the location in this name.
    Schema Pulumi.GoogleNative.DataCatalog.V1Beta1.Outputs.GoogleCloudDatacatalogV1beta1SchemaResponse
    Schema of the entry. An entry might not have any schema attached to it.
    SourceSystemTimestamps Pulumi.GoogleNative.DataCatalog.V1Beta1.Outputs.GoogleCloudDatacatalogV1beta1SystemTimestampsResponse
    Timestamps about the underlying resource, not about this Data Catalog entry. Output only when Entry is of type in the EntryType enum. For entries with user_specified_type, this field is optional and defaults to an empty timestamp.
    Type string
    The type of the entry. Only used for Entries with types in the EntryType enum.
    UsageSignal Pulumi.GoogleNative.DataCatalog.V1Beta1.Outputs.GoogleCloudDatacatalogV1beta1UsageSignalResponse
    Statistics on the usage level of the resource.
    UserSpecifiedSystem string
    This field indicates the entry's source system that Data Catalog does not integrate with. user_specified_system strings must begin with a letter or underscore and can only contain letters, numbers, and underscores; are case insensitive; must be at least 1 character and at most 64 characters long.
    UserSpecifiedType string
    Entry type if it does not fit any of the input-allowed values listed in EntryType enum above. When creating an entry, users should check the enum values first, if nothing matches the entry to be created, then provide a custom value, for example "my_special_type". user_specified_type strings must begin with a letter or underscore and can only contain letters, numbers, and underscores; are case insensitive; must be at least 1 character and at most 64 characters long. Currently, only FILESET enum value is allowed. All other entries created through Data Catalog must use user_specified_type.
    BigqueryDateShardedSpec GoogleCloudDatacatalogV1beta1BigQueryDateShardedSpecResponse
    Specification for a group of BigQuery tables with name pattern [prefix]YYYYMMDD. Context: https://cloud.google.com/bigquery/docs/partitioned-tables#partitioning_versus_sharding.
    BigqueryTableSpec GoogleCloudDatacatalogV1beta1BigQueryTableSpecResponse
    Specification that applies to a BigQuery table. This is only valid on entries of type TABLE.
    Description string
    Entry description, which can consist of several sentences or paragraphs that describe entry contents. Default value is an empty string.
    DisplayName string
    Display information such as title and description. A short name to identify the entry, for example, "Analytics Data - Jan 2011". Default value is an empty string.
    GcsFilesetSpec GoogleCloudDatacatalogV1beta1GcsFilesetSpecResponse
    Specification that applies to a Cloud Storage fileset. This is only valid on entries of type FILESET.
    IntegratedSystem string
    This field indicates the entry's source system that Data Catalog integrates with, such as BigQuery or Pub/Sub.
    LinkedResource string
    The resource this metadata entry refers to. For Google Cloud Platform resources, linked_resource is the full name of the resource. For example, the linked_resource for a table resource from BigQuery is: * //bigquery.googleapis.com/projects/projectId/datasets/datasetId/tables/tableId Output only when Entry is of type in the EntryType enum. For entries with user_specified_type, this field is optional and defaults to an empty string.
    Name string
    The Data Catalog resource name of the entry in URL format. Example: * projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}/entries/{entry_id} Note that this Entry and its child resources may not actually be stored in the location in this name.
    Schema GoogleCloudDatacatalogV1beta1SchemaResponse
    Schema of the entry. An entry might not have any schema attached to it.
    SourceSystemTimestamps GoogleCloudDatacatalogV1beta1SystemTimestampsResponse
    Timestamps about the underlying resource, not about this Data Catalog entry. Output only when Entry is of type in the EntryType enum. For entries with user_specified_type, this field is optional and defaults to an empty timestamp.
    Type string
    The type of the entry. Only used for Entries with types in the EntryType enum.
    UsageSignal GoogleCloudDatacatalogV1beta1UsageSignalResponse
    Statistics on the usage level of the resource.
    UserSpecifiedSystem string
    This field indicates the entry's source system that Data Catalog does not integrate with. user_specified_system strings must begin with a letter or underscore and can only contain letters, numbers, and underscores; are case insensitive; must be at least 1 character and at most 64 characters long.
    UserSpecifiedType string
    Entry type if it does not fit any of the input-allowed values listed in EntryType enum above. When creating an entry, users should check the enum values first, if nothing matches the entry to be created, then provide a custom value, for example "my_special_type". user_specified_type strings must begin with a letter or underscore and can only contain letters, numbers, and underscores; are case insensitive; must be at least 1 character and at most 64 characters long. Currently, only FILESET enum value is allowed. All other entries created through Data Catalog must use user_specified_type.
    bigqueryDateShardedSpec GoogleCloudDatacatalogV1beta1BigQueryDateShardedSpecResponse
    Specification for a group of BigQuery tables with name pattern [prefix]YYYYMMDD. Context: https://cloud.google.com/bigquery/docs/partitioned-tables#partitioning_versus_sharding.
    bigqueryTableSpec GoogleCloudDatacatalogV1beta1BigQueryTableSpecResponse
    Specification that applies to a BigQuery table. This is only valid on entries of type TABLE.
    description String
    Entry description, which can consist of several sentences or paragraphs that describe entry contents. Default value is an empty string.
    displayName String
    Display information such as title and description. A short name to identify the entry, for example, "Analytics Data - Jan 2011". Default value is an empty string.
    gcsFilesetSpec GoogleCloudDatacatalogV1beta1GcsFilesetSpecResponse
    Specification that applies to a Cloud Storage fileset. This is only valid on entries of type FILESET.
    integratedSystem String
    This field indicates the entry's source system that Data Catalog integrates with, such as BigQuery or Pub/Sub.
    linkedResource String
    The resource this metadata entry refers to. For Google Cloud Platform resources, linked_resource is the full name of the resource. For example, the linked_resource for a table resource from BigQuery is: * //bigquery.googleapis.com/projects/projectId/datasets/datasetId/tables/tableId Output only when Entry is of type in the EntryType enum. For entries with user_specified_type, this field is optional and defaults to an empty string.
    name String
    The Data Catalog resource name of the entry in URL format. Example: * projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}/entries/{entry_id} Note that this Entry and its child resources may not actually be stored in the location in this name.
    schema GoogleCloudDatacatalogV1beta1SchemaResponse
    Schema of the entry. An entry might not have any schema attached to it.
    sourceSystemTimestamps GoogleCloudDatacatalogV1beta1SystemTimestampsResponse
    Timestamps about the underlying resource, not about this Data Catalog entry. Output only when Entry is of type in the EntryType enum. For entries with user_specified_type, this field is optional and defaults to an empty timestamp.
    type String
    The type of the entry. Only used for Entries with types in the EntryType enum.
    usageSignal GoogleCloudDatacatalogV1beta1UsageSignalResponse
    Statistics on the usage level of the resource.
    userSpecifiedSystem String
    This field indicates the entry's source system that Data Catalog does not integrate with. user_specified_system strings must begin with a letter or underscore and can only contain letters, numbers, and underscores; are case insensitive; must be at least 1 character and at most 64 characters long.
    userSpecifiedType String
    Entry type if it does not fit any of the input-allowed values listed in EntryType enum above. When creating an entry, users should check the enum values first, if nothing matches the entry to be created, then provide a custom value, for example "my_special_type". user_specified_type strings must begin with a letter or underscore and can only contain letters, numbers, and underscores; are case insensitive; must be at least 1 character and at most 64 characters long. Currently, only FILESET enum value is allowed. All other entries created through Data Catalog must use user_specified_type.
    bigqueryDateShardedSpec GoogleCloudDatacatalogV1beta1BigQueryDateShardedSpecResponse
    Specification for a group of BigQuery tables with name pattern [prefix]YYYYMMDD. Context: https://cloud.google.com/bigquery/docs/partitioned-tables#partitioning_versus_sharding.
    bigqueryTableSpec GoogleCloudDatacatalogV1beta1BigQueryTableSpecResponse
    Specification that applies to a BigQuery table. This is only valid on entries of type TABLE.
    description string
    Entry description, which can consist of several sentences or paragraphs that describe entry contents. Default value is an empty string.
    displayName string
    Display information such as title and description. A short name to identify the entry, for example, "Analytics Data - Jan 2011". Default value is an empty string.
    gcsFilesetSpec GoogleCloudDatacatalogV1beta1GcsFilesetSpecResponse
    Specification that applies to a Cloud Storage fileset. This is only valid on entries of type FILESET.
    integratedSystem string
    This field indicates the entry's source system that Data Catalog integrates with, such as BigQuery or Pub/Sub.
    linkedResource string
    The resource this metadata entry refers to. For Google Cloud Platform resources, linked_resource is the full name of the resource. For example, the linked_resource for a table resource from BigQuery is: * //bigquery.googleapis.com/projects/projectId/datasets/datasetId/tables/tableId Output only when Entry is of type in the EntryType enum. For entries with user_specified_type, this field is optional and defaults to an empty string.
    name string
    The Data Catalog resource name of the entry in URL format. Example: * projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}/entries/{entry_id} Note that this Entry and its child resources may not actually be stored in the location in this name.
    schema GoogleCloudDatacatalogV1beta1SchemaResponse
    Schema of the entry. An entry might not have any schema attached to it.
    sourceSystemTimestamps GoogleCloudDatacatalogV1beta1SystemTimestampsResponse
    Timestamps about the underlying resource, not about this Data Catalog entry. Output only when Entry is of type in the EntryType enum. For entries with user_specified_type, this field is optional and defaults to an empty timestamp.
    type string
    The type of the entry. Only used for Entries with types in the EntryType enum.
    usageSignal GoogleCloudDatacatalogV1beta1UsageSignalResponse
    Statistics on the usage level of the resource.
    userSpecifiedSystem string
    This field indicates the entry's source system that Data Catalog does not integrate with. user_specified_system strings must begin with a letter or underscore and can only contain letters, numbers, and underscores; are case insensitive; must be at least 1 character and at most 64 characters long.
    userSpecifiedType string
    Entry type if it does not fit any of the input-allowed values listed in EntryType enum above. When creating an entry, users should check the enum values first, if nothing matches the entry to be created, then provide a custom value, for example "my_special_type". user_specified_type strings must begin with a letter or underscore and can only contain letters, numbers, and underscores; are case insensitive; must be at least 1 character and at most 64 characters long. Currently, only FILESET enum value is allowed. All other entries created through Data Catalog must use user_specified_type.
    bigquery_date_sharded_spec GoogleCloudDatacatalogV1beta1BigQueryDateShardedSpecResponse
    Specification for a group of BigQuery tables with name pattern [prefix]YYYYMMDD. Context: https://cloud.google.com/bigquery/docs/partitioned-tables#partitioning_versus_sharding.
    bigquery_table_spec GoogleCloudDatacatalogV1beta1BigQueryTableSpecResponse
    Specification that applies to a BigQuery table. This is only valid on entries of type TABLE.
    description str
    Entry description, which can consist of several sentences or paragraphs that describe entry contents. Default value is an empty string.
    display_name str
    Display information such as title and description. A short name to identify the entry, for example, "Analytics Data - Jan 2011". Default value is an empty string.
    gcs_fileset_spec GoogleCloudDatacatalogV1beta1GcsFilesetSpecResponse
    Specification that applies to a Cloud Storage fileset. This is only valid on entries of type FILESET.
    integrated_system str
    This field indicates the entry's source system that Data Catalog integrates with, such as BigQuery or Pub/Sub.
    linked_resource str
    The resource this metadata entry refers to. For Google Cloud Platform resources, linked_resource is the full name of the resource. For example, the linked_resource for a table resource from BigQuery is: * //bigquery.googleapis.com/projects/projectId/datasets/datasetId/tables/tableId Output only when Entry is of type in the EntryType enum. For entries with user_specified_type, this field is optional and defaults to an empty string.
    name str
    The Data Catalog resource name of the entry in URL format. Example: * projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}/entries/{entry_id} Note that this Entry and its child resources may not actually be stored in the location in this name.
    schema GoogleCloudDatacatalogV1beta1SchemaResponse
    Schema of the entry. An entry might not have any schema attached to it.
    source_system_timestamps GoogleCloudDatacatalogV1beta1SystemTimestampsResponse
    Timestamps about the underlying resource, not about this Data Catalog entry. Output only when Entry is of type in the EntryType enum. For entries with user_specified_type, this field is optional and defaults to an empty timestamp.
    type str
    The type of the entry. Only used for Entries with types in the EntryType enum.
    usage_signal GoogleCloudDatacatalogV1beta1UsageSignalResponse
    Statistics on the usage level of the resource.
    user_specified_system str
    This field indicates the entry's source system that Data Catalog does not integrate with. user_specified_system strings must begin with a letter or underscore and can only contain letters, numbers, and underscores; are case insensitive; must be at least 1 character and at most 64 characters long.
    user_specified_type str
    Entry type if it does not fit any of the input-allowed values listed in EntryType enum above. When creating an entry, users should check the enum values first, if nothing matches the entry to be created, then provide a custom value, for example "my_special_type". user_specified_type strings must begin with a letter or underscore and can only contain letters, numbers, and underscores; are case insensitive; must be at least 1 character and at most 64 characters long. Currently, only FILESET enum value is allowed. All other entries created through Data Catalog must use user_specified_type.
    bigqueryDateShardedSpec Property Map
    Specification for a group of BigQuery tables with name pattern [prefix]YYYYMMDD. Context: https://cloud.google.com/bigquery/docs/partitioned-tables#partitioning_versus_sharding.
    bigqueryTableSpec Property Map
    Specification that applies to a BigQuery table. This is only valid on entries of type TABLE.
    description String
    Entry description, which can consist of several sentences or paragraphs that describe entry contents. Default value is an empty string.
    displayName String
    Display information such as title and description. A short name to identify the entry, for example, "Analytics Data - Jan 2011". Default value is an empty string.
    gcsFilesetSpec Property Map
    Specification that applies to a Cloud Storage fileset. This is only valid on entries of type FILESET.
    integratedSystem String
    This field indicates the entry's source system that Data Catalog integrates with, such as BigQuery or Pub/Sub.
    linkedResource String
    The resource this metadata entry refers to. For Google Cloud Platform resources, linked_resource is the full name of the resource. For example, the linked_resource for a table resource from BigQuery is: * //bigquery.googleapis.com/projects/projectId/datasets/datasetId/tables/tableId Output only when Entry is of type in the EntryType enum. For entries with user_specified_type, this field is optional and defaults to an empty string.
    name String
    The Data Catalog resource name of the entry in URL format. Example: * projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}/entries/{entry_id} Note that this Entry and its child resources may not actually be stored in the location in this name.
    schema Property Map
    Schema of the entry. An entry might not have any schema attached to it.
    sourceSystemTimestamps Property Map
    Timestamps about the underlying resource, not about this Data Catalog entry. Output only when Entry is of type in the EntryType enum. For entries with user_specified_type, this field is optional and defaults to an empty timestamp.
    type String
    The type of the entry. Only used for Entries with types in the EntryType enum.
    usageSignal Property Map
    Statistics on the usage level of the resource.
    userSpecifiedSystem String
    This field indicates the entry's source system that Data Catalog does not integrate with. user_specified_system strings must begin with a letter or underscore and can only contain letters, numbers, and underscores; are case insensitive; must be at least 1 character and at most 64 characters long.
    userSpecifiedType String
    Entry type if it does not fit any of the input-allowed values listed in EntryType enum above. When creating an entry, users should check the enum values first, if nothing matches the entry to be created, then provide a custom value, for example "my_special_type". user_specified_type strings must begin with a letter or underscore and can only contain letters, numbers, and underscores; are case insensitive; must be at least 1 character and at most 64 characters long. Currently, only FILESET enum value is allowed. All other entries created through Data Catalog must use user_specified_type.

    Supporting Types

    GoogleCloudDatacatalogV1beta1BigQueryDateShardedSpecResponse

    Dataset string
    The Data Catalog resource name of the dataset entry the current table belongs to, for example, projects/{project_id}/locations/{location}/entrygroups/{entry_group_id}/entries/{entry_id}.
    ShardCount string
    Total number of shards.
    TablePrefix string
    The table name prefix of the shards. The name of any given shard is [table_prefix]YYYYMMDD, for example, for shard MyTable20180101, the table_prefix is MyTable.
    Dataset string
    The Data Catalog resource name of the dataset entry the current table belongs to, for example, projects/{project_id}/locations/{location}/entrygroups/{entry_group_id}/entries/{entry_id}.
    ShardCount string
    Total number of shards.
    TablePrefix string
    The table name prefix of the shards. The name of any given shard is [table_prefix]YYYYMMDD, for example, for shard MyTable20180101, the table_prefix is MyTable.
    dataset String
    The Data Catalog resource name of the dataset entry the current table belongs to, for example, projects/{project_id}/locations/{location}/entrygroups/{entry_group_id}/entries/{entry_id}.
    shardCount String
    Total number of shards.
    tablePrefix String
    The table name prefix of the shards. The name of any given shard is [table_prefix]YYYYMMDD, for example, for shard MyTable20180101, the table_prefix is MyTable.
    dataset string
    The Data Catalog resource name of the dataset entry the current table belongs to, for example, projects/{project_id}/locations/{location}/entrygroups/{entry_group_id}/entries/{entry_id}.
    shardCount string
    Total number of shards.
    tablePrefix string
    The table name prefix of the shards. The name of any given shard is [table_prefix]YYYYMMDD, for example, for shard MyTable20180101, the table_prefix is MyTable.
    dataset str
    The Data Catalog resource name of the dataset entry the current table belongs to, for example, projects/{project_id}/locations/{location}/entrygroups/{entry_group_id}/entries/{entry_id}.
    shard_count str
    Total number of shards.
    table_prefix str
    The table name prefix of the shards. The name of any given shard is [table_prefix]YYYYMMDD, for example, for shard MyTable20180101, the table_prefix is MyTable.
    dataset String
    The Data Catalog resource name of the dataset entry the current table belongs to, for example, projects/{project_id}/locations/{location}/entrygroups/{entry_group_id}/entries/{entry_id}.
    shardCount String
    Total number of shards.
    tablePrefix String
    The table name prefix of the shards. The name of any given shard is [table_prefix]YYYYMMDD, for example, for shard MyTable20180101, the table_prefix is MyTable.

    GoogleCloudDatacatalogV1beta1BigQueryTableSpecResponse

    TableSourceType string
    The table source type.
    TableSpec Pulumi.GoogleNative.DataCatalog.V1Beta1.Inputs.GoogleCloudDatacatalogV1beta1TableSpecResponse
    Spec of a BigQuery table. This field should only be populated if table_source_type is BIGQUERY_TABLE.
    ViewSpec Pulumi.GoogleNative.DataCatalog.V1Beta1.Inputs.GoogleCloudDatacatalogV1beta1ViewSpecResponse
    Table view specification. This field should only be populated if table_source_type is BIGQUERY_VIEW.
    TableSourceType string
    The table source type.
    TableSpec GoogleCloudDatacatalogV1beta1TableSpecResponse
    Spec of a BigQuery table. This field should only be populated if table_source_type is BIGQUERY_TABLE.
    ViewSpec GoogleCloudDatacatalogV1beta1ViewSpecResponse
    Table view specification. This field should only be populated if table_source_type is BIGQUERY_VIEW.
    tableSourceType String
    The table source type.
    tableSpec GoogleCloudDatacatalogV1beta1TableSpecResponse
    Spec of a BigQuery table. This field should only be populated if table_source_type is BIGQUERY_TABLE.
    viewSpec GoogleCloudDatacatalogV1beta1ViewSpecResponse
    Table view specification. This field should only be populated if table_source_type is BIGQUERY_VIEW.
    tableSourceType string
    The table source type.
    tableSpec GoogleCloudDatacatalogV1beta1TableSpecResponse
    Spec of a BigQuery table. This field should only be populated if table_source_type is BIGQUERY_TABLE.
    viewSpec GoogleCloudDatacatalogV1beta1ViewSpecResponse
    Table view specification. This field should only be populated if table_source_type is BIGQUERY_VIEW.
    table_source_type str
    The table source type.
    table_spec GoogleCloudDatacatalogV1beta1TableSpecResponse
    Spec of a BigQuery table. This field should only be populated if table_source_type is BIGQUERY_TABLE.
    view_spec GoogleCloudDatacatalogV1beta1ViewSpecResponse
    Table view specification. This field should only be populated if table_source_type is BIGQUERY_VIEW.
    tableSourceType String
    The table source type.
    tableSpec Property Map
    Spec of a BigQuery table. This field should only be populated if table_source_type is BIGQUERY_TABLE.
    viewSpec Property Map
    Table view specification. This field should only be populated if table_source_type is BIGQUERY_VIEW.

    GoogleCloudDatacatalogV1beta1ColumnSchemaResponse

    Column string
    Name of the column.
    Description string
    Optional. Description of the column. Default value is an empty string.
    Mode string
    Optional. A column's mode indicates whether the values in this column are required, nullable, etc. Only NULLABLE, REQUIRED and REPEATED are supported. Default mode is NULLABLE.
    Subcolumns List<Pulumi.GoogleNative.DataCatalog.V1Beta1.Inputs.GoogleCloudDatacatalogV1beta1ColumnSchemaResponse>
    Optional. Schema of sub-columns. A column can have zero or more sub-columns.
    Type string
    Type of the column.
    Column string
    Name of the column.
    Description string
    Optional. Description of the column. Default value is an empty string.
    Mode string
    Optional. A column's mode indicates whether the values in this column are required, nullable, etc. Only NULLABLE, REQUIRED and REPEATED are supported. Default mode is NULLABLE.
    Subcolumns []GoogleCloudDatacatalogV1beta1ColumnSchemaResponse
    Optional. Schema of sub-columns. A column can have zero or more sub-columns.
    Type string
    Type of the column.
    column String
    Name of the column.
    description String
    Optional. Description of the column. Default value is an empty string.
    mode String
    Optional. A column's mode indicates whether the values in this column are required, nullable, etc. Only NULLABLE, REQUIRED and REPEATED are supported. Default mode is NULLABLE.
    subcolumns List<GoogleCloudDatacatalogV1beta1ColumnSchemaResponse>
    Optional. Schema of sub-columns. A column can have zero or more sub-columns.
    type String
    Type of the column.
    column string
    Name of the column.
    description string
    Optional. Description of the column. Default value is an empty string.
    mode string
    Optional. A column's mode indicates whether the values in this column are required, nullable, etc. Only NULLABLE, REQUIRED and REPEATED are supported. Default mode is NULLABLE.
    subcolumns GoogleCloudDatacatalogV1beta1ColumnSchemaResponse[]
    Optional. Schema of sub-columns. A column can have zero or more sub-columns.
    type string
    Type of the column.
    column str
    Name of the column.
    description str
    Optional. Description of the column. Default value is an empty string.
    mode str
    Optional. A column's mode indicates whether the values in this column are required, nullable, etc. Only NULLABLE, REQUIRED and REPEATED are supported. Default mode is NULLABLE.
    subcolumns Sequence[GoogleCloudDatacatalogV1beta1ColumnSchemaResponse]
    Optional. Schema of sub-columns. A column can have zero or more sub-columns.
    type str
    Type of the column.
    column String
    Name of the column.
    description String
    Optional. Description of the column. Default value is an empty string.
    mode String
    Optional. A column's mode indicates whether the values in this column are required, nullable, etc. Only NULLABLE, REQUIRED and REPEATED are supported. Default mode is NULLABLE.
    subcolumns List<Property Map>
    Optional. Schema of sub-columns. A column can have zero or more sub-columns.
    type String
    Type of the column.

    GoogleCloudDatacatalogV1beta1GcsFileSpecResponse

    FilePath string
    The full file path. Example: gs://bucket_name/a/b.txt.
    GcsTimestamps Pulumi.GoogleNative.DataCatalog.V1Beta1.Inputs.GoogleCloudDatacatalogV1beta1SystemTimestampsResponse
    Timestamps about the Cloud Storage file.
    SizeBytes string
    The size of the file, in bytes.
    FilePath string
    The full file path. Example: gs://bucket_name/a/b.txt.
    GcsTimestamps GoogleCloudDatacatalogV1beta1SystemTimestampsResponse
    Timestamps about the Cloud Storage file.
    SizeBytes string
    The size of the file, in bytes.
    filePath String
    The full file path. Example: gs://bucket_name/a/b.txt.
    gcsTimestamps GoogleCloudDatacatalogV1beta1SystemTimestampsResponse
    Timestamps about the Cloud Storage file.
    sizeBytes String
    The size of the file, in bytes.
    filePath string
    The full file path. Example: gs://bucket_name/a/b.txt.
    gcsTimestamps GoogleCloudDatacatalogV1beta1SystemTimestampsResponse
    Timestamps about the Cloud Storage file.
    sizeBytes string
    The size of the file, in bytes.
    file_path str
    The full file path. Example: gs://bucket_name/a/b.txt.
    gcs_timestamps GoogleCloudDatacatalogV1beta1SystemTimestampsResponse
    Timestamps about the Cloud Storage file.
    size_bytes str
    The size of the file, in bytes.
    filePath String
    The full file path. Example: gs://bucket_name/a/b.txt.
    gcsTimestamps Property Map
    Timestamps about the Cloud Storage file.
    sizeBytes String
    The size of the file, in bytes.

    GoogleCloudDatacatalogV1beta1GcsFilesetSpecResponse

    FilePatterns List<string>
    Patterns to identify a set of files in Google Cloud Storage. See Cloud Storage documentation for more information. Note that bucket wildcards are currently not supported. Examples of valid file_patterns: * gs://bucket_name/dir/*: matches all files within bucket_name/dir directory. * gs://bucket_name/dir/**: matches all files in bucket_name/dir spanning all subdirectories. * gs://bucket_name/file*: matches files prefixed by file in bucket_name * gs://bucket_name/??.txt: matches files with two characters followed by .txt in bucket_name * gs://bucket_name/[aeiou].txt: matches files that contain a single vowel character followed by .txt in bucket_name * gs://bucket_name/[a-m].txt: matches files that contain a, b, ... or m followed by .txt in bucket_name * gs://bucket_name/a/*/b: matches all files in bucket_name that match a/*/b pattern, such as a/c/b, a/d/b * gs://another_bucket/a.txt: matches gs://another_bucket/a.txt You can combine wildcards to provide more powerful matches, for example: * gs://bucket_name/[a-m]??.j*g
    SampleGcsFileSpecs List<Pulumi.GoogleNative.DataCatalog.V1Beta1.Inputs.GoogleCloudDatacatalogV1beta1GcsFileSpecResponse>
    Sample files contained in this fileset, not all files contained in this fileset are represented here.
    FilePatterns []string
    Patterns to identify a set of files in Google Cloud Storage. See Cloud Storage documentation for more information. Note that bucket wildcards are currently not supported. Examples of valid file_patterns: * gs://bucket_name/dir/*: matches all files within bucket_name/dir directory. * gs://bucket_name/dir/**: matches all files in bucket_name/dir spanning all subdirectories. * gs://bucket_name/file*: matches files prefixed by file in bucket_name * gs://bucket_name/??.txt: matches files with two characters followed by .txt in bucket_name * gs://bucket_name/[aeiou].txt: matches files that contain a single vowel character followed by .txt in bucket_name * gs://bucket_name/[a-m].txt: matches files that contain a, b, ... or m followed by .txt in bucket_name * gs://bucket_name/a/*/b: matches all files in bucket_name that match a/*/b pattern, such as a/c/b, a/d/b * gs://another_bucket/a.txt: matches gs://another_bucket/a.txt You can combine wildcards to provide more powerful matches, for example: * gs://bucket_name/[a-m]??.j*g
    SampleGcsFileSpecs []GoogleCloudDatacatalogV1beta1GcsFileSpecResponse
    Sample files contained in this fileset, not all files contained in this fileset are represented here.
    filePatterns List<String>
    Patterns to identify a set of files in Google Cloud Storage. See Cloud Storage documentation for more information. Note that bucket wildcards are currently not supported. Examples of valid file_patterns: * gs://bucket_name/dir/*: matches all files within bucket_name/dir directory. * gs://bucket_name/dir/**: matches all files in bucket_name/dir spanning all subdirectories. * gs://bucket_name/file*: matches files prefixed by file in bucket_name * gs://bucket_name/??.txt: matches files with two characters followed by .txt in bucket_name * gs://bucket_name/[aeiou].txt: matches files that contain a single vowel character followed by .txt in bucket_name * gs://bucket_name/[a-m].txt: matches files that contain a, b, ... or m followed by .txt in bucket_name * gs://bucket_name/a/*/b: matches all files in bucket_name that match a/*/b pattern, such as a/c/b, a/d/b * gs://another_bucket/a.txt: matches gs://another_bucket/a.txt You can combine wildcards to provide more powerful matches, for example: * gs://bucket_name/[a-m]??.j*g
    sampleGcsFileSpecs List<GoogleCloudDatacatalogV1beta1GcsFileSpecResponse>
    Sample files contained in this fileset, not all files contained in this fileset are represented here.
    filePatterns string[]
    Patterns to identify a set of files in Google Cloud Storage. See Cloud Storage documentation for more information. Note that bucket wildcards are currently not supported. Examples of valid file_patterns: * gs://bucket_name/dir/*: matches all files within bucket_name/dir directory. * gs://bucket_name/dir/**: matches all files in bucket_name/dir spanning all subdirectories. * gs://bucket_name/file*: matches files prefixed by file in bucket_name * gs://bucket_name/??.txt: matches files with two characters followed by .txt in bucket_name * gs://bucket_name/[aeiou].txt: matches files that contain a single vowel character followed by .txt in bucket_name * gs://bucket_name/[a-m].txt: matches files that contain a, b, ... or m followed by .txt in bucket_name * gs://bucket_name/a/*/b: matches all files in bucket_name that match a/*/b pattern, such as a/c/b, a/d/b * gs://another_bucket/a.txt: matches gs://another_bucket/a.txt You can combine wildcards to provide more powerful matches, for example: * gs://bucket_name/[a-m]??.j*g
    sampleGcsFileSpecs GoogleCloudDatacatalogV1beta1GcsFileSpecResponse[]
    Sample files contained in this fileset, not all files contained in this fileset are represented here.
    file_patterns Sequence[str]
    Patterns to identify a set of files in Google Cloud Storage. See Cloud Storage documentation for more information. Note that bucket wildcards are currently not supported. Examples of valid file_patterns: * gs://bucket_name/dir/*: matches all files within bucket_name/dir directory. * gs://bucket_name/dir/**: matches all files in bucket_name/dir spanning all subdirectories. * gs://bucket_name/file*: matches files prefixed by file in bucket_name * gs://bucket_name/??.txt: matches files with two characters followed by .txt in bucket_name * gs://bucket_name/[aeiou].txt: matches files that contain a single vowel character followed by .txt in bucket_name * gs://bucket_name/[a-m].txt: matches files that contain a, b, ... or m followed by .txt in bucket_name * gs://bucket_name/a/*/b: matches all files in bucket_name that match a/*/b pattern, such as a/c/b, a/d/b * gs://another_bucket/a.txt: matches gs://another_bucket/a.txt You can combine wildcards to provide more powerful matches, for example: * gs://bucket_name/[a-m]??.j*g
    sample_gcs_file_specs Sequence[GoogleCloudDatacatalogV1beta1GcsFileSpecResponse]
    Sample files contained in this fileset, not all files contained in this fileset are represented here.
    filePatterns List<String>
    Patterns to identify a set of files in Google Cloud Storage. See Cloud Storage documentation for more information. Note that bucket wildcards are currently not supported. Examples of valid file_patterns: * gs://bucket_name/dir/*: matches all files within bucket_name/dir directory. * gs://bucket_name/dir/**: matches all files in bucket_name/dir spanning all subdirectories. * gs://bucket_name/file*: matches files prefixed by file in bucket_name * gs://bucket_name/??.txt: matches files with two characters followed by .txt in bucket_name * gs://bucket_name/[aeiou].txt: matches files that contain a single vowel character followed by .txt in bucket_name * gs://bucket_name/[a-m].txt: matches files that contain a, b, ... or m followed by .txt in bucket_name * gs://bucket_name/a/*/b: matches all files in bucket_name that match a/*/b pattern, such as a/c/b, a/d/b * gs://another_bucket/a.txt: matches gs://another_bucket/a.txt You can combine wildcards to provide more powerful matches, for example: * gs://bucket_name/[a-m]??.j*g
    sampleGcsFileSpecs List<Property Map>
    Sample files contained in this fileset, not all files contained in this fileset are represented here.

    GoogleCloudDatacatalogV1beta1SchemaResponse

    Columns List<Pulumi.GoogleNative.DataCatalog.V1Beta1.Inputs.GoogleCloudDatacatalogV1beta1ColumnSchemaResponse>
    Schema of columns. A maximum of 10,000 columns and sub-columns can be specified.
    Columns []GoogleCloudDatacatalogV1beta1ColumnSchemaResponse
    Schema of columns. A maximum of 10,000 columns and sub-columns can be specified.
    columns List<GoogleCloudDatacatalogV1beta1ColumnSchemaResponse>
    Schema of columns. A maximum of 10,000 columns and sub-columns can be specified.
    columns GoogleCloudDatacatalogV1beta1ColumnSchemaResponse[]
    Schema of columns. A maximum of 10,000 columns and sub-columns can be specified.
    columns Sequence[GoogleCloudDatacatalogV1beta1ColumnSchemaResponse]
    Schema of columns. A maximum of 10,000 columns and sub-columns can be specified.
    columns List<Property Map>
    Schema of columns. A maximum of 10,000 columns and sub-columns can be specified.

    GoogleCloudDatacatalogV1beta1SystemTimestampsResponse

    CreateTime string
    The creation time of the resource within the given system.
    ExpireTime string
    The expiration time of the resource within the given system. Currently only apllicable to BigQuery resources.
    UpdateTime string
    The last-modified time of the resource within the given system.
    CreateTime string
    The creation time of the resource within the given system.
    ExpireTime string
    The expiration time of the resource within the given system. Currently only apllicable to BigQuery resources.
    UpdateTime string
    The last-modified time of the resource within the given system.
    createTime String
    The creation time of the resource within the given system.
    expireTime String
    The expiration time of the resource within the given system. Currently only apllicable to BigQuery resources.
    updateTime String
    The last-modified time of the resource within the given system.
    createTime string
    The creation time of the resource within the given system.
    expireTime string
    The expiration time of the resource within the given system. Currently only apllicable to BigQuery resources.
    updateTime string
    The last-modified time of the resource within the given system.
    create_time str
    The creation time of the resource within the given system.
    expire_time str
    The expiration time of the resource within the given system. Currently only apllicable to BigQuery resources.
    update_time str
    The last-modified time of the resource within the given system.
    createTime String
    The creation time of the resource within the given system.
    expireTime String
    The expiration time of the resource within the given system. Currently only apllicable to BigQuery resources.
    updateTime String
    The last-modified time of the resource within the given system.

    GoogleCloudDatacatalogV1beta1TableSpecResponse

    GroupedEntry string
    If the table is a dated shard, i.e., with name pattern [prefix]YYYYMMDD, grouped_entry is the Data Catalog resource name of the date sharded grouped entry, for example, projects/{project_id}/locations/{location}/entrygroups/{entry_group_id}/entries/{entry_id}. Otherwise, grouped_entry is empty.
    GroupedEntry string
    If the table is a dated shard, i.e., with name pattern [prefix]YYYYMMDD, grouped_entry is the Data Catalog resource name of the date sharded grouped entry, for example, projects/{project_id}/locations/{location}/entrygroups/{entry_group_id}/entries/{entry_id}. Otherwise, grouped_entry is empty.
    groupedEntry String
    If the table is a dated shard, i.e., with name pattern [prefix]YYYYMMDD, grouped_entry is the Data Catalog resource name of the date sharded grouped entry, for example, projects/{project_id}/locations/{location}/entrygroups/{entry_group_id}/entries/{entry_id}. Otherwise, grouped_entry is empty.
    groupedEntry string
    If the table is a dated shard, i.e., with name pattern [prefix]YYYYMMDD, grouped_entry is the Data Catalog resource name of the date sharded grouped entry, for example, projects/{project_id}/locations/{location}/entrygroups/{entry_group_id}/entries/{entry_id}. Otherwise, grouped_entry is empty.
    grouped_entry str
    If the table is a dated shard, i.e., with name pattern [prefix]YYYYMMDD, grouped_entry is the Data Catalog resource name of the date sharded grouped entry, for example, projects/{project_id}/locations/{location}/entrygroups/{entry_group_id}/entries/{entry_id}. Otherwise, grouped_entry is empty.
    groupedEntry String
    If the table is a dated shard, i.e., with name pattern [prefix]YYYYMMDD, grouped_entry is the Data Catalog resource name of the date sharded grouped entry, for example, projects/{project_id}/locations/{location}/entrygroups/{entry_group_id}/entries/{entry_id}. Otherwise, grouped_entry is empty.

    GoogleCloudDatacatalogV1beta1UsageSignalResponse

    UpdateTime string
    The timestamp of the end of the usage statistics duration.
    UsageWithinTimeRange Dictionary<string, string>
    Usage statistics over each of the pre-defined time ranges, supported strings for time ranges are {"24H", "7D", "30D"}.
    UpdateTime string
    The timestamp of the end of the usage statistics duration.
    UsageWithinTimeRange map[string]string
    Usage statistics over each of the pre-defined time ranges, supported strings for time ranges are {"24H", "7D", "30D"}.
    updateTime String
    The timestamp of the end of the usage statistics duration.
    usageWithinTimeRange Map<String,String>
    Usage statistics over each of the pre-defined time ranges, supported strings for time ranges are {"24H", "7D", "30D"}.
    updateTime string
    The timestamp of the end of the usage statistics duration.
    usageWithinTimeRange {[key: string]: string}
    Usage statistics over each of the pre-defined time ranges, supported strings for time ranges are {"24H", "7D", "30D"}.
    update_time str
    The timestamp of the end of the usage statistics duration.
    usage_within_time_range Mapping[str, str]
    Usage statistics over each of the pre-defined time ranges, supported strings for time ranges are {"24H", "7D", "30D"}.
    updateTime String
    The timestamp of the end of the usage statistics duration.
    usageWithinTimeRange Map<String>
    Usage statistics over each of the pre-defined time ranges, supported strings for time ranges are {"24H", "7D", "30D"}.

    GoogleCloudDatacatalogV1beta1ViewSpecResponse

    ViewQuery string
    The query that defines the table view.
    ViewQuery string
    The query that defines the table view.
    viewQuery String
    The query that defines the table view.
    viewQuery string
    The query that defines the table view.
    view_query str
    The query that defines the table view.
    viewQuery String
    The query that defines the table view.

    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