Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud Native
  3. API Docs
  4. datacatalog
  5. datacatalog/v1beta1
  6. getTaxonomy

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.datacatalog/v1beta1.getTaxonomy

Explore with Pulumi AI

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

Gets a taxonomy.

Using getTaxonomy

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 getTaxonomy(args: GetTaxonomyArgs, opts?: InvokeOptions): Promise<GetTaxonomyResult>
function getTaxonomyOutput(args: GetTaxonomyOutputArgs, opts?: InvokeOptions): Output<GetTaxonomyResult>
Copy
def get_taxonomy(location: Optional[str] = None,
                 project: Optional[str] = None,
                 taxonomy_id: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetTaxonomyResult
def get_taxonomy_output(location: Optional[pulumi.Input[str]] = None,
                 project: Optional[pulumi.Input[str]] = None,
                 taxonomy_id: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetTaxonomyResult]
Copy
func LookupTaxonomy(ctx *Context, args *LookupTaxonomyArgs, opts ...InvokeOption) (*LookupTaxonomyResult, error)
func LookupTaxonomyOutput(ctx *Context, args *LookupTaxonomyOutputArgs, opts ...InvokeOption) LookupTaxonomyResultOutput
Copy

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

public static class GetTaxonomy 
{
    public static Task<GetTaxonomyResult> InvokeAsync(GetTaxonomyArgs args, InvokeOptions? opts = null)
    public static Output<GetTaxonomyResult> Invoke(GetTaxonomyInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetTaxonomyResult> getTaxonomy(GetTaxonomyArgs args, InvokeOptions options)
public static Output<GetTaxonomyResult> getTaxonomy(GetTaxonomyArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: google-native:datacatalog/v1beta1:getTaxonomy
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Location This property is required. string
TaxonomyId This property is required. string
Project string
Location This property is required. string
TaxonomyId This property is required. string
Project string
location This property is required. String
taxonomyId This property is required. String
project String
location This property is required. string
taxonomyId This property is required. string
project string
location This property is required. str
taxonomy_id This property is required. str
project str
location This property is required. String
taxonomyId This property is required. String
project String

getTaxonomy Result

The following output properties are available:

ActivatedPolicyTypes List<string>
Optional. A list of policy types that are activated for this taxonomy. If not set, defaults to an empty list.
Description string
Optional. Description of this taxonomy. It must: contain only unicode characters, tabs, newlines, carriage returns and page breaks; and be at most 2000 bytes long when encoded in UTF-8. If not set, defaults to an empty description.
DisplayName string
User defined name of this taxonomy. It must: contain only unicode letters, numbers, underscores, dashes and spaces; not start or end with spaces; and be at most 200 bytes long when encoded in UTF-8. The taxonomy display name must be unique within an organization.
Name string
Resource name of this taxonomy, whose format is: "projects/{project_number}/locations/{location_id}/taxonomies/{id}".
PolicyTagCount int
Number of policy tags contained in this taxonomy.
Service Pulumi.GoogleNative.DataCatalog.V1Beta1.Outputs.GoogleCloudDatacatalogV1beta1TaxonomyServiceResponse
Identity of the service which owns the Taxonomy. This field is only populated when the taxonomy is created by a Google Cloud service. Currently only 'DATAPLEX' is supported.
TaxonomyTimestamps Pulumi.GoogleNative.DataCatalog.V1Beta1.Outputs.GoogleCloudDatacatalogV1beta1SystemTimestampsResponse
Timestamps about this taxonomy. Only create_time and update_time are used.
ActivatedPolicyTypes []string
Optional. A list of policy types that are activated for this taxonomy. If not set, defaults to an empty list.
Description string
Optional. Description of this taxonomy. It must: contain only unicode characters, tabs, newlines, carriage returns and page breaks; and be at most 2000 bytes long when encoded in UTF-8. If not set, defaults to an empty description.
DisplayName string
User defined name of this taxonomy. It must: contain only unicode letters, numbers, underscores, dashes and spaces; not start or end with spaces; and be at most 200 bytes long when encoded in UTF-8. The taxonomy display name must be unique within an organization.
Name string
Resource name of this taxonomy, whose format is: "projects/{project_number}/locations/{location_id}/taxonomies/{id}".
PolicyTagCount int
Number of policy tags contained in this taxonomy.
Service GoogleCloudDatacatalogV1beta1TaxonomyServiceResponse
Identity of the service which owns the Taxonomy. This field is only populated when the taxonomy is created by a Google Cloud service. Currently only 'DATAPLEX' is supported.
TaxonomyTimestamps GoogleCloudDatacatalogV1beta1SystemTimestampsResponse
Timestamps about this taxonomy. Only create_time and update_time are used.
activatedPolicyTypes List<String>
Optional. A list of policy types that are activated for this taxonomy. If not set, defaults to an empty list.
description String
Optional. Description of this taxonomy. It must: contain only unicode characters, tabs, newlines, carriage returns and page breaks; and be at most 2000 bytes long when encoded in UTF-8. If not set, defaults to an empty description.
displayName String
User defined name of this taxonomy. It must: contain only unicode letters, numbers, underscores, dashes and spaces; not start or end with spaces; and be at most 200 bytes long when encoded in UTF-8. The taxonomy display name must be unique within an organization.
name String
Resource name of this taxonomy, whose format is: "projects/{project_number}/locations/{location_id}/taxonomies/{id}".
policyTagCount Integer
Number of policy tags contained in this taxonomy.
service GoogleCloudDatacatalogV1beta1TaxonomyServiceResponse
Identity of the service which owns the Taxonomy. This field is only populated when the taxonomy is created by a Google Cloud service. Currently only 'DATAPLEX' is supported.
taxonomyTimestamps GoogleCloudDatacatalogV1beta1SystemTimestampsResponse
Timestamps about this taxonomy. Only create_time and update_time are used.
activatedPolicyTypes string[]
Optional. A list of policy types that are activated for this taxonomy. If not set, defaults to an empty list.
description string
Optional. Description of this taxonomy. It must: contain only unicode characters, tabs, newlines, carriage returns and page breaks; and be at most 2000 bytes long when encoded in UTF-8. If not set, defaults to an empty description.
displayName string
User defined name of this taxonomy. It must: contain only unicode letters, numbers, underscores, dashes and spaces; not start or end with spaces; and be at most 200 bytes long when encoded in UTF-8. The taxonomy display name must be unique within an organization.
name string
Resource name of this taxonomy, whose format is: "projects/{project_number}/locations/{location_id}/taxonomies/{id}".
policyTagCount number
Number of policy tags contained in this taxonomy.
service GoogleCloudDatacatalogV1beta1TaxonomyServiceResponse
Identity of the service which owns the Taxonomy. This field is only populated when the taxonomy is created by a Google Cloud service. Currently only 'DATAPLEX' is supported.
taxonomyTimestamps GoogleCloudDatacatalogV1beta1SystemTimestampsResponse
Timestamps about this taxonomy. Only create_time and update_time are used.
activated_policy_types Sequence[str]
Optional. A list of policy types that are activated for this taxonomy. If not set, defaults to an empty list.
description str
Optional. Description of this taxonomy. It must: contain only unicode characters, tabs, newlines, carriage returns and page breaks; and be at most 2000 bytes long when encoded in UTF-8. If not set, defaults to an empty description.
display_name str
User defined name of this taxonomy. It must: contain only unicode letters, numbers, underscores, dashes and spaces; not start or end with spaces; and be at most 200 bytes long when encoded in UTF-8. The taxonomy display name must be unique within an organization.
name str
Resource name of this taxonomy, whose format is: "projects/{project_number}/locations/{location_id}/taxonomies/{id}".
policy_tag_count int
Number of policy tags contained in this taxonomy.
service GoogleCloudDatacatalogV1beta1TaxonomyServiceResponse
Identity of the service which owns the Taxonomy. This field is only populated when the taxonomy is created by a Google Cloud service. Currently only 'DATAPLEX' is supported.
taxonomy_timestamps GoogleCloudDatacatalogV1beta1SystemTimestampsResponse
Timestamps about this taxonomy. Only create_time and update_time are used.
activatedPolicyTypes List<String>
Optional. A list of policy types that are activated for this taxonomy. If not set, defaults to an empty list.
description String
Optional. Description of this taxonomy. It must: contain only unicode characters, tabs, newlines, carriage returns and page breaks; and be at most 2000 bytes long when encoded in UTF-8. If not set, defaults to an empty description.
displayName String
User defined name of this taxonomy. It must: contain only unicode letters, numbers, underscores, dashes and spaces; not start or end with spaces; and be at most 200 bytes long when encoded in UTF-8. The taxonomy display name must be unique within an organization.
name String
Resource name of this taxonomy, whose format is: "projects/{project_number}/locations/{location_id}/taxonomies/{id}".
policyTagCount Number
Number of policy tags contained in this taxonomy.
service Property Map
Identity of the service which owns the Taxonomy. This field is only populated when the taxonomy is created by a Google Cloud service. Currently only 'DATAPLEX' is supported.
taxonomyTimestamps Property Map
Timestamps about this taxonomy. Only create_time and update_time are used.

Supporting Types

GoogleCloudDatacatalogV1beta1SystemTimestampsResponse

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

GoogleCloudDatacatalogV1beta1TaxonomyServiceResponse

Identity This property is required. string
The service agent for the service.
Name This property is required. string
The Google Cloud service name.
Identity This property is required. string
The service agent for the service.
Name This property is required. string
The Google Cloud service name.
identity This property is required. String
The service agent for the service.
name This property is required. String
The Google Cloud service name.
identity This property is required. string
The service agent for the service.
name This property is required. string
The Google Cloud service name.
identity This property is required. str
The service agent for the service.
name This property is required. str
The Google Cloud service name.
identity This property is required. String
The service agent for the service.
name This property is required. String
The Google Cloud service name.

Package Details

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

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