GoogleApi.DataCatalog.V1.Model.GoogleCloudDatacatalogV1SearchCatalogResult (google_api_data_catalog v0.32.2)

View Source

Result in the response to a search request. Each result captures details of one entry that matches the search.

Attributes

  • description (type: String.t, default: nil) - Entry description that can consist of several sentences or paragraphs that describe entry contents.
  • displayName (type: String.t, default: nil) - The display name of the result.
  • fullyQualifiedName (type: String.t, default: nil) - Fully qualified name (FQN) of the resource. FQNs take two forms: For non-regionalized resources: {SYSTEM}:{PROJECT}.{PATH_TO_RESOURCE_SEPARATED_WITH_DOTS} For regionalized resources: {SYSTEM}:{PROJECT}.{LOCATION_ID}.{PATH_TO_RESOURCE_SEPARATED_WITH_DOTS} Example for a DPMS table: dataproc_metastore:PROJECT_ID.LOCATION_ID.INSTANCE_ID.DATABASE_ID.TABLE_ID
  • integratedSystem (type: String.t, default: nil) - Output only. The source system that Data Catalog automatically integrates with, such as BigQuery, Cloud Pub/Sub, or Dataproc Metastore.
  • linkedResource (type: String.t, default: nil) - The full name of the Google Cloud resource the entry belongs to. For more information, see [Full Resource Name] (/apis/design/resource_names#full_resource_name). Example: //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID
  • modifyTime (type: DateTime.t, default: nil) - The last modification timestamp of the entry in the source system.
  • relativeResourceName (type: String.t, default: nil) - The relative name of the resource in URL format. Examples: projects/{PROJECT_ID}/locations/{LOCATION_ID}/entryGroups/{ENTRY_GROUP_ID}/entries/{ENTRY_ID} projects/{PROJECT_ID}/tagTemplates/{TAG_TEMPLATE_ID}
  • searchResultSubtype (type: String.t, default: nil) - Sub-type of the search result. A dot-delimited full type of the resource. The same type you specify in the type search predicate. Examples: entry.table, entry.dataStream, tagTemplate.
  • searchResultType (type: String.t, default: nil) - Type of the search result. You can use this field to determine which get method to call to fetch the full resource.
  • userSpecifiedSystem (type: String.t, default: nil) - Custom source system that you can manually integrate Data Catalog with.

Summary

Types

t()

Functions

decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::
  %GoogleApi.DataCatalog.V1.Model.GoogleCloudDatacatalogV1SearchCatalogResult{
    description: String.t() | nil,
    displayName: String.t() | nil,
    fullyQualifiedName: String.t() | nil,
    integratedSystem: String.t() | nil,
    linkedResource: String.t() | nil,
    modifyTime: DateTime.t() | nil,
    relativeResourceName: String.t() | nil,
    searchResultSubtype: String.t() | nil,
    searchResultType: String.t() | nil,
    userSpecifiedSystem: String.t() | nil
  }

Functions

decode(value, options)

@spec decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.