Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud Native
  3. API Docs
  4. datacatalog
  5. datacatalog/v1
  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/v1.getTaxonomy

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

    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>
    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]
    func LookupTaxonomy(ctx *Context, args *LookupTaxonomyArgs, opts ...InvokeOption) (*LookupTaxonomyResult, error)
func LookupTaxonomyOutput(ctx *Context, args *LookupTaxonomyOutputArgs, opts ...InvokeOption) LookupTaxonomyResultOutput

    > 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)
}
    public static CompletableFuture<GetTaxonomyResult> getTaxonomy(GetTaxonomyArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: google-native:datacatalog/v1:getTaxonomy
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Location string
    TaxonomyId string
    Project string
    Location string
    TaxonomyId string
    Project string
    location String
    taxonomyId String
    project String
    location string
    taxonomyId string
    project string
    location String
    taxonomyId 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. If not set, defaults to empty. The description must contain only Unicode characters, tabs, newlines, carriage returns, and page breaks, and be at most 2000 bytes long when encoded in UTF-8.
    DisplayName string
    User-defined name of this taxonomy. The name can't start or end with spaces, must contain only Unicode letters, numbers, underscores, dashes, and 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 in URL format. Note: Policy tag manager generates unique taxonomy IDs.
    PolicyTagCount int
    Number of policy tags in this taxonomy.
    Service Pulumi.GoogleNative.DataCatalog.V1.Outputs.GoogleCloudDatacatalogV1TaxonomyServiceResponse
    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.V1.Outputs.GoogleCloudDatacatalogV1SystemTimestampsResponse
    Creation and modification timestamps of this taxonomy.
    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. If not set, defaults to empty. The description must contain only Unicode characters, tabs, newlines, carriage returns, and page breaks, and be at most 2000 bytes long when encoded in UTF-8.
    DisplayName string
    User-defined name of this taxonomy. The name can't start or end with spaces, must contain only Unicode letters, numbers, underscores, dashes, and 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 in URL format. Note: Policy tag manager generates unique taxonomy IDs.
    PolicyTagCount int
    Number of policy tags in this taxonomy.
    Service GoogleCloudDatacatalogV1TaxonomyServiceResponse
    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 GoogleCloudDatacatalogV1SystemTimestampsResponse
    Creation and modification timestamps of this taxonomy.
    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. If not set, defaults to empty. The description must contain only Unicode characters, tabs, newlines, carriage returns, and page breaks, and be at most 2000 bytes long when encoded in UTF-8.
    displayName String
    User-defined name of this taxonomy. The name can't start or end with spaces, must contain only Unicode letters, numbers, underscores, dashes, and 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 in URL format. Note: Policy tag manager generates unique taxonomy IDs.
    policyTagCount Integer
    Number of policy tags in this taxonomy.
    service GoogleCloudDatacatalogV1TaxonomyServiceResponse
    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 GoogleCloudDatacatalogV1SystemTimestampsResponse
    Creation and modification timestamps of this taxonomy.
    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. If not set, defaults to empty. The description must contain only Unicode characters, tabs, newlines, carriage returns, and page breaks, and be at most 2000 bytes long when encoded in UTF-8.
    displayName string
    User-defined name of this taxonomy. The name can't start or end with spaces, must contain only Unicode letters, numbers, underscores, dashes, and 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 in URL format. Note: Policy tag manager generates unique taxonomy IDs.
    policyTagCount number
    Number of policy tags in this taxonomy.
    service GoogleCloudDatacatalogV1TaxonomyServiceResponse
    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 GoogleCloudDatacatalogV1SystemTimestampsResponse
    Creation and modification timestamps of this taxonomy.
    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. If not set, defaults to empty. The description must contain only Unicode characters, tabs, newlines, carriage returns, and page breaks, and be at most 2000 bytes long when encoded in UTF-8.
    display_name str
    User-defined name of this taxonomy. The name can't start or end with spaces, must contain only Unicode letters, numbers, underscores, dashes, and 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 in URL format. Note: Policy tag manager generates unique taxonomy IDs.
    policy_tag_count int
    Number of policy tags in this taxonomy.
    service GoogleCloudDatacatalogV1TaxonomyServiceResponse
    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 GoogleCloudDatacatalogV1SystemTimestampsResponse
    Creation and modification timestamps of this taxonomy.
    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. If not set, defaults to empty. The description must contain only Unicode characters, tabs, newlines, carriage returns, and page breaks, and be at most 2000 bytes long when encoded in UTF-8.
    displayName String
    User-defined name of this taxonomy. The name can't start or end with spaces, must contain only Unicode letters, numbers, underscores, dashes, and 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 in URL format. Note: Policy tag manager generates unique taxonomy IDs.
    policyTagCount Number
    Number of policy tags 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
    Creation and modification timestamps of this taxonomy.

    Supporting Types

    GoogleCloudDatacatalogV1SystemTimestampsResponse

    CreateTime string
    Creation timestamp of the resource within the given system.
    ExpireTime string
    Expiration timestamp of the resource within the given system. Currently only applicable to BigQuery resources.
    UpdateTime string
    Timestamp of the last modification of the resource or its metadata within a given system. Note: Depending on the source system, not every modification updates this timestamp. For example, BigQuery timestamps every metadata modification but not data or permission changes.
    CreateTime string
    Creation timestamp of the resource within the given system.
    ExpireTime string
    Expiration timestamp of the resource within the given system. Currently only applicable to BigQuery resources.
    UpdateTime string
    Timestamp of the last modification of the resource or its metadata within a given system. Note: Depending on the source system, not every modification updates this timestamp. For example, BigQuery timestamps every metadata modification but not data or permission changes.
    createTime String
    Creation timestamp of the resource within the given system.
    expireTime String
    Expiration timestamp of the resource within the given system. Currently only applicable to BigQuery resources.
    updateTime String
    Timestamp of the last modification of the resource or its metadata within a given system. Note: Depending on the source system, not every modification updates this timestamp. For example, BigQuery timestamps every metadata modification but not data or permission changes.
    createTime string
    Creation timestamp of the resource within the given system.
    expireTime string
    Expiration timestamp of the resource within the given system. Currently only applicable to BigQuery resources.
    updateTime string
    Timestamp of the last modification of the resource or its metadata within a given system. Note: Depending on the source system, not every modification updates this timestamp. For example, BigQuery timestamps every metadata modification but not data or permission changes.
    create_time str
    Creation timestamp of the resource within the given system.
    expire_time str
    Expiration timestamp of the resource within the given system. Currently only applicable to BigQuery resources.
    update_time str
    Timestamp of the last modification of the resource or its metadata within a given system. Note: Depending on the source system, not every modification updates this timestamp. For example, BigQuery timestamps every metadata modification but not data or permission changes.
    createTime String
    Creation timestamp of the resource within the given system.
    expireTime String
    Expiration timestamp of the resource within the given system. Currently only applicable to BigQuery resources.
    updateTime String
    Timestamp of the last modification of the resource or its metadata within a given system. Note: Depending on the source system, not every modification updates this timestamp. For example, BigQuery timestamps every metadata modification but not data or permission changes.

    GoogleCloudDatacatalogV1TaxonomyServiceResponse

    Identity string
    The service agent for the service.
    Name string
    The Google Cloud service name.
    Identity string
    The service agent for the service.
    Name string
    The Google Cloud service name.
    identity String
    The service agent for the service.
    name String
    The Google Cloud service name.
    identity string
    The service agent for the service.
    name string
    The Google Cloud service name.
    identity str
    The service agent for the service.
    name str
    The Google Cloud service name.
    identity String
    The service agent for the service.
    name String
    The Google Cloud service name.

    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