Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud Native
  3. API Docs
  4. dataplex
  5. dataplex/v1
  6. getAttribute

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

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

Retrieves a Data Attribute resource.

Using getAttribute

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 getAttribute(args: GetAttributeArgs, opts?: InvokeOptions): Promise<GetAttributeResult>
function getAttributeOutput(args: GetAttributeOutputArgs, opts?: InvokeOptions): Output<GetAttributeResult>
Copy
def get_attribute(attribute_id: Optional[str] = None,
                  data_taxonomy_id: Optional[str] = None,
                  location: Optional[str] = None,
                  project: Optional[str] = None,
                  opts: Optional[InvokeOptions] = None) -> GetAttributeResult
def get_attribute_output(attribute_id: Optional[pulumi.Input[str]] = None,
                  data_taxonomy_id: Optional[pulumi.Input[str]] = None,
                  location: Optional[pulumi.Input[str]] = None,
                  project: Optional[pulumi.Input[str]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetAttributeResult]
Copy
func LookupAttribute(ctx *Context, args *LookupAttributeArgs, opts ...InvokeOption) (*LookupAttributeResult, error)
func LookupAttributeOutput(ctx *Context, args *LookupAttributeOutputArgs, opts ...InvokeOption) LookupAttributeResultOutput
Copy

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

public static class GetAttribute 
{
    public static Task<GetAttributeResult> InvokeAsync(GetAttributeArgs args, InvokeOptions? opts = null)
    public static Output<GetAttributeResult> Invoke(GetAttributeInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetAttributeResult> getAttribute(GetAttributeArgs args, InvokeOptions options)
public static Output<GetAttributeResult> getAttribute(GetAttributeArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: google-native:dataplex/v1:getAttribute
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

AttributeId This property is required. string
DataTaxonomyId This property is required. string
Location This property is required. string
Project string
AttributeId This property is required. string
DataTaxonomyId This property is required. string
Location This property is required. string
Project string
attributeId This property is required. String
dataTaxonomyId This property is required. String
location This property is required. String
project String
attributeId This property is required. string
dataTaxonomyId This property is required. string
location This property is required. string
project string
attribute_id This property is required. str
data_taxonomy_id This property is required. str
location This property is required. str
project str
attributeId This property is required. String
dataTaxonomyId This property is required. String
location This property is required. String
project String

getAttribute Result

The following output properties are available:

AttributeCount int
The number of child attributes present for this attribute.
CreateTime string
The time when the DataAttribute was created.
DataAccessSpec Pulumi.GoogleNative.Dataplex.V1.Outputs.GoogleCloudDataplexV1DataAccessSpecResponse
Optional. Specified when applied to data stored on the resource (eg: rows, columns in BigQuery Tables).
Description string
Optional. Description of the DataAttribute.
DisplayName string
Optional. User friendly display name.
Etag string
This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
Labels Dictionary<string, string>
Optional. User-defined labels for the DataAttribute.
Name string
The relative resource name of the dataAttribute, of the form: projects/{project_number}/locations/{location_id}/dataTaxonomies/{dataTaxonomy}/attributes/{data_attribute_id}.
ParentId string
Optional. The ID of the parent DataAttribute resource, should belong to the same data taxonomy. Circular dependency in parent chain is not valid. Maximum depth of the hierarchy allowed is 4. a -> b -> c -> d -> e, depth = 4
ResourceAccessSpec Pulumi.GoogleNative.Dataplex.V1.Outputs.GoogleCloudDataplexV1ResourceAccessSpecResponse
Optional. Specified when applied to a resource (eg: Cloud Storage bucket, BigQuery dataset, BigQuery table).
Uid string
System generated globally unique ID for the DataAttribute. This ID will be different if the DataAttribute is deleted and re-created with the same name.
UpdateTime string
The time when the DataAttribute was last updated.
AttributeCount int
The number of child attributes present for this attribute.
CreateTime string
The time when the DataAttribute was created.
DataAccessSpec GoogleCloudDataplexV1DataAccessSpecResponse
Optional. Specified when applied to data stored on the resource (eg: rows, columns in BigQuery Tables).
Description string
Optional. Description of the DataAttribute.
DisplayName string
Optional. User friendly display name.
Etag string
This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
Labels map[string]string
Optional. User-defined labels for the DataAttribute.
Name string
The relative resource name of the dataAttribute, of the form: projects/{project_number}/locations/{location_id}/dataTaxonomies/{dataTaxonomy}/attributes/{data_attribute_id}.
ParentId string
Optional. The ID of the parent DataAttribute resource, should belong to the same data taxonomy. Circular dependency in parent chain is not valid. Maximum depth of the hierarchy allowed is 4. a -> b -> c -> d -> e, depth = 4
ResourceAccessSpec GoogleCloudDataplexV1ResourceAccessSpecResponse
Optional. Specified when applied to a resource (eg: Cloud Storage bucket, BigQuery dataset, BigQuery table).
Uid string
System generated globally unique ID for the DataAttribute. This ID will be different if the DataAttribute is deleted and re-created with the same name.
UpdateTime string
The time when the DataAttribute was last updated.
attributeCount Integer
The number of child attributes present for this attribute.
createTime String
The time when the DataAttribute was created.
dataAccessSpec GoogleCloudDataplexV1DataAccessSpecResponse
Optional. Specified when applied to data stored on the resource (eg: rows, columns in BigQuery Tables).
description String
Optional. Description of the DataAttribute.
displayName String
Optional. User friendly display name.
etag String
This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
labels Map<String,String>
Optional. User-defined labels for the DataAttribute.
name String
The relative resource name of the dataAttribute, of the form: projects/{project_number}/locations/{location_id}/dataTaxonomies/{dataTaxonomy}/attributes/{data_attribute_id}.
parentId String
Optional. The ID of the parent DataAttribute resource, should belong to the same data taxonomy. Circular dependency in parent chain is not valid. Maximum depth of the hierarchy allowed is 4. a -> b -> c -> d -> e, depth = 4
resourceAccessSpec GoogleCloudDataplexV1ResourceAccessSpecResponse
Optional. Specified when applied to a resource (eg: Cloud Storage bucket, BigQuery dataset, BigQuery table).
uid String
System generated globally unique ID for the DataAttribute. This ID will be different if the DataAttribute is deleted and re-created with the same name.
updateTime String
The time when the DataAttribute was last updated.
attributeCount number
The number of child attributes present for this attribute.
createTime string
The time when the DataAttribute was created.
dataAccessSpec GoogleCloudDataplexV1DataAccessSpecResponse
Optional. Specified when applied to data stored on the resource (eg: rows, columns in BigQuery Tables).
description string
Optional. Description of the DataAttribute.
displayName string
Optional. User friendly display name.
etag string
This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
labels {[key: string]: string}
Optional. User-defined labels for the DataAttribute.
name string
The relative resource name of the dataAttribute, of the form: projects/{project_number}/locations/{location_id}/dataTaxonomies/{dataTaxonomy}/attributes/{data_attribute_id}.
parentId string
Optional. The ID of the parent DataAttribute resource, should belong to the same data taxonomy. Circular dependency in parent chain is not valid. Maximum depth of the hierarchy allowed is 4. a -> b -> c -> d -> e, depth = 4
resourceAccessSpec GoogleCloudDataplexV1ResourceAccessSpecResponse
Optional. Specified when applied to a resource (eg: Cloud Storage bucket, BigQuery dataset, BigQuery table).
uid string
System generated globally unique ID for the DataAttribute. This ID will be different if the DataAttribute is deleted and re-created with the same name.
updateTime string
The time when the DataAttribute was last updated.
attribute_count int
The number of child attributes present for this attribute.
create_time str
The time when the DataAttribute was created.
data_access_spec GoogleCloudDataplexV1DataAccessSpecResponse
Optional. Specified when applied to data stored on the resource (eg: rows, columns in BigQuery Tables).
description str
Optional. Description of the DataAttribute.
display_name str
Optional. User friendly display name.
etag str
This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
labels Mapping[str, str]
Optional. User-defined labels for the DataAttribute.
name str
The relative resource name of the dataAttribute, of the form: projects/{project_number}/locations/{location_id}/dataTaxonomies/{dataTaxonomy}/attributes/{data_attribute_id}.
parent_id str
Optional. The ID of the parent DataAttribute resource, should belong to the same data taxonomy. Circular dependency in parent chain is not valid. Maximum depth of the hierarchy allowed is 4. a -> b -> c -> d -> e, depth = 4
resource_access_spec GoogleCloudDataplexV1ResourceAccessSpecResponse
Optional. Specified when applied to a resource (eg: Cloud Storage bucket, BigQuery dataset, BigQuery table).
uid str
System generated globally unique ID for the DataAttribute. This ID will be different if the DataAttribute is deleted and re-created with the same name.
update_time str
The time when the DataAttribute was last updated.
attributeCount Number
The number of child attributes present for this attribute.
createTime String
The time when the DataAttribute was created.
dataAccessSpec Property Map
Optional. Specified when applied to data stored on the resource (eg: rows, columns in BigQuery Tables).
description String
Optional. Description of the DataAttribute.
displayName String
Optional. User friendly display name.
etag String
This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
labels Map<String>
Optional. User-defined labels for the DataAttribute.
name String
The relative resource name of the dataAttribute, of the form: projects/{project_number}/locations/{location_id}/dataTaxonomies/{dataTaxonomy}/attributes/{data_attribute_id}.
parentId String
Optional. The ID of the parent DataAttribute resource, should belong to the same data taxonomy. Circular dependency in parent chain is not valid. Maximum depth of the hierarchy allowed is 4. a -> b -> c -> d -> e, depth = 4
resourceAccessSpec Property Map
Optional. Specified when applied to a resource (eg: Cloud Storage bucket, BigQuery dataset, BigQuery table).
uid String
System generated globally unique ID for the DataAttribute. This ID will be different if the DataAttribute is deleted and re-created with the same name.
updateTime String
The time when the DataAttribute was last updated.

Supporting Types

GoogleCloudDataplexV1DataAccessSpecResponse

Readers This property is required. List<string>
Optional. The format of strings follows the pattern followed by IAM in the bindings. user:{email}, serviceAccount:{email} group:{email}. The set of principals to be granted reader role on data stored within resources.
Readers This property is required. []string
Optional. The format of strings follows the pattern followed by IAM in the bindings. user:{email}, serviceAccount:{email} group:{email}. The set of principals to be granted reader role on data stored within resources.
readers This property is required. List<String>
Optional. The format of strings follows the pattern followed by IAM in the bindings. user:{email}, serviceAccount:{email} group:{email}. The set of principals to be granted reader role on data stored within resources.
readers This property is required. string[]
Optional. The format of strings follows the pattern followed by IAM in the bindings. user:{email}, serviceAccount:{email} group:{email}. The set of principals to be granted reader role on data stored within resources.
readers This property is required. Sequence[str]
Optional. The format of strings follows the pattern followed by IAM in the bindings. user:{email}, serviceAccount:{email} group:{email}. The set of principals to be granted reader role on data stored within resources.
readers This property is required. List<String>
Optional. The format of strings follows the pattern followed by IAM in the bindings. user:{email}, serviceAccount:{email} group:{email}. The set of principals to be granted reader role on data stored within resources.

GoogleCloudDataplexV1ResourceAccessSpecResponse

Owners This property is required. List<string>
Optional. The set of principals to be granted owner role on the resource.
Readers This property is required. List<string>
Optional. The format of strings follows the pattern followed by IAM in the bindings. user:{email}, serviceAccount:{email} group:{email}. The set of principals to be granted reader role on the resource.
Writers This property is required. List<string>
Optional. The set of principals to be granted writer role on the resource.
Owners This property is required. []string
Optional. The set of principals to be granted owner role on the resource.
Readers This property is required. []string
Optional. The format of strings follows the pattern followed by IAM in the bindings. user:{email}, serviceAccount:{email} group:{email}. The set of principals to be granted reader role on the resource.
Writers This property is required. []string
Optional. The set of principals to be granted writer role on the resource.
owners This property is required. List<String>
Optional. The set of principals to be granted owner role on the resource.
readers This property is required. List<String>
Optional. The format of strings follows the pattern followed by IAM in the bindings. user:{email}, serviceAccount:{email} group:{email}. The set of principals to be granted reader role on the resource.
writers This property is required. List<String>
Optional. The set of principals to be granted writer role on the resource.
owners This property is required. string[]
Optional. The set of principals to be granted owner role on the resource.
readers This property is required. string[]
Optional. The format of strings follows the pattern followed by IAM in the bindings. user:{email}, serviceAccount:{email} group:{email}. The set of principals to be granted reader role on the resource.
writers This property is required. string[]
Optional. The set of principals to be granted writer role on the resource.
owners This property is required. Sequence[str]
Optional. The set of principals to be granted owner role on the resource.
readers This property is required. Sequence[str]
Optional. The format of strings follows the pattern followed by IAM in the bindings. user:{email}, serviceAccount:{email} group:{email}. The set of principals to be granted reader role on the resource.
writers This property is required. Sequence[str]
Optional. The set of principals to be granted writer role on the resource.
owners This property is required. List<String>
Optional. The set of principals to be granted owner role on the resource.
readers This property is required. List<String>
Optional. The format of strings follows the pattern followed by IAM in the bindings. user:{email}, serviceAccount:{email} group:{email}. The set of principals to be granted reader role on the resource.
writers This property is required. List<String>
Optional. The set of principals to be granted writer role on the resource.

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