Looks up a single Entry by name using the permission on the source system.Caution: The BigQuery metadata that is stored in Dataplex Catalog is changing. For more information, see Changes to BigQuery metadata stored in Dataplex Catalog (https://cloud.google.com/dataplex/docs/biqquery-metadata-changes).

Method Details

close()

Close httplib2 connections.

get(name, x__xgafv=None)

Gets information about a location.

Args:
  name: string, Resource name for the location. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A resource that represents a Google Cloud location.
  "displayName": "A String", # The friendly name for this location, typically a nearby city name. For example, "Tokyo".
  "labels": { # Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"}
    "a_key": "A String",
  },
  "locationId": "A String", # The canonical id for this location. For example: "us-east1".
  "metadata": { # Service-specific metadata. For example the available capacity at the given location.
    "a_key": "", # Properties of the object. Contains field @type with type URL.
  },
  "name": "A String", # Resource name for the location, which may vary between implementations. For example: "projects/example-project/locations/us-east1"
}

list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

Lists information about the supported locations for this service.

Args:
  name: string, The resource that owns the locations collection, if applicable. (required)
  filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in AIP-160 (https://google.aip.dev/160).
  pageSize: integer, The maximum number of results to return. If not set, the service selects a default.
  pageToken: string, A page token received from the next_page_token field in the response. Send that page token to receive the subsequent page.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The response message for Locations.ListLocations.
  "locations": [ # A list of locations that matches the specified filter in the request.
    { # A resource that represents a Google Cloud location.
      "displayName": "A String", # The friendly name for this location, typically a nearby city name. For example, "Tokyo".
      "labels": { # Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"}
        "a_key": "A String",
      },
      "locationId": "A String", # The canonical id for this location. For example: "us-east1".
      "metadata": { # Service-specific metadata. For example the available capacity at the given location.
        "a_key": "", # Properties of the object. Contains field @type with type URL.
      },
      "name": "A String", # Resource name for the location, which may vary between implementations. For example: "projects/example-project/locations/us-east1"
    },
  ],
  "nextPageToken": "A String", # The standard List next-page token.
}

list_next()

Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call 'execute()' on to request the next
          page. Returns None if there are no more items in the collection.

lookupEntry(name, aspectTypes=None, entry=None, paths=None, view=None, x__xgafv=None)

Args:
name: string, Required. The project to which the request should be attributed in the following form: projects/{project}/locations/{location}. (required)
aspectTypes: string, Optional. Limits the aspects returned to the provided aspect types. It only works for CUSTOM view. (repeated)
entry: string, Required. The resource name of the Entry: projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}.
paths: string, Optional. Limits the aspects returned to those associated with the provided paths within the Entry. It only works for CUSTOM view. (repeated)
view: string, Optional. View to control which parts of an entry the service should return.
Allowed values
ENTRY_VIEW_UNSPECIFIED - Unspecified EntryView. Defaults to FULL.
BASIC - Returns entry only, without aspects.
FULL - Returns all required aspects as well as the keys of all non-required aspects.
CUSTOM - Returns aspects matching custom fields in GetEntryRequest. If the number of aspects exceeds 100, the first 100 will be returned.
ALL - Returns all aspects. If the number of aspects exceeds 100, the first 100 will be returned.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # An entry is a representation of a data resource that can be described by various metadata.
"aspects": { # Optional. The aspects that are attached to the entry. Depending on how the aspect is attached to the entry, the format of the aspect key can be one of the following: If the aspect is attached directly to the entry: {project_id_or_number}.{location_id}.{aspect_type_id} If the aspect is attached to an entry's path: {project_id_or_number}.{location_id}.{aspect_type_id}@{path}
"a_key": { # An aspect is a single piece of metadata describing an entry.
"aspectSource": { # Information related to the source system of the aspect. # Optional. Information related to the source system of the aspect.
"createTime": "A String", # The time the aspect was created in the source system.
"dataVersion": "A String", # The version of the data format used to produce this data. This field is used to indicated when the underlying data format changes (e.g., schema modifications, changes to the source URL format definition, etc).
"updateTime": "A String", # The time the aspect was last updated in the source system.
},
"aspectType": "A String", # Output only. The resource name of the type used to create this Aspect.
"createTime": "A String", # Output only. The time when the Aspect was created.
"data": { # Required. The content of the aspect, according to its aspect type schema. The maximum size of the field is 120KB (encoded as UTF-8).
"a_key": "", # Properties of the object.
},
"path": "A String", # Output only. The path in the entry under which the aspect is attached.
"updateTime": "A String", # Output only. The time when the Aspect was last updated.
},
},
"createTime": "A String", # Output only. The time when the entry was created in Dataplex.
"entrySource": { # Information related to the source system of the data resource that is represented by the entry. # Optional. Information related to the source system of the data resource that is represented by the entry.
"ancestors": [ # Immutable. The entries representing the ancestors of the data resource in the source system.
{ # Information about individual items in the hierarchy that is associated with the data resource.
"name": "A String", # Optional. The name of the ancestor resource.
"type": "A String", # Optional. The type of the ancestor resource.
},
],
"createTime": "A String", # The time when the resource was created in the source system.
"description": "A String", # A description of the data resource. Maximum length is 2,000 characters.
"displayName": "A String", # A user-friendly display name. Maximum length is 500 characters.
"labels": { # User-defined labels. The maximum size of keys and values is 128 characters each.
"a_key": "A String",
},
"location": "A String", # Output only. Location of the resource in the source system. You can search the entry by this location. By default, this should match the location of the entry group containing this entry. A different value allows capturing the source location for data external to Google Cloud.
"platform": "A String", # The platform containing the source system. Maximum length is 64 characters.
"resource": "A String", # The name of the resource in the source system. Maximum length is 4,000 characters.
"system": "A String", # The name of the source system. Maximum length is 64 characters.
"updateTime": "A String", # The time when the resource was last updated in the source system. If the entry exists in the system and its EntrySource has update_time populated, further updates to the EntrySource of the entry must provide incremental updates to its update_time.
},
"entryType": "A String", # Required. Immutable. The relative resource name of the entry type that was used to create this entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryTypes/{entry_type_id}.
"fullyQualifiedName": "A String", # Optional. A name for the entry that can be referenced by an external system. For more information, see Fully qualified names (https://cloud.google.com/data-catalog/docs/fully-qualified-names). The maximum size of the field is 4000 characters.
"name": "A String", # Identifier. The relative resource name of the entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}.
"parentEntry": "A String", # Optional. Immutable. The resource name of the parent entry.
"updateTime": "A String", # Output only. The time when the entry was last updated in Dataplex.
}

searchEntries(name, orderBy=None, pageSize=None, pageToken=None, query=None, scope=None, x__xgafv=None)

Searches for Entries matching the given query and scope.

Args:
name: string, Required. The project to which the request should be attributed in the following form: projects/{project}/locations/{location}. (required)
orderBy: string, Optional. Specifies the ordering of results. Supported values are: * relevance (default) * last_modified_timestamp * last_modified_timestamp asc
pageSize: integer, Optional. Number of results in the search page. If <=0, then defaults to 10. Max limit for page_size is 1000. Throws an invalid argument for page_size > 1000.
pageToken: string, Optional. Page token received from a previous SearchEntries call. Provide this to retrieve the subsequent page.
query: string, Required. The query against which entries in scope should be matched. The query syntax is defined in Search syntax for Dataplex Catalog (https://cloud.google.com/dataplex/docs/search-syntax).
scope: string, Optional. The scope under which the search should be operating. It must either be organizations/ or projects/. If it is unspecified, it defaults to the organization where the project provided in name is located.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{
"nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results in the list.
"results": [ # The results matching the search query.
{ # A single result of a SearchEntries request.
"dataplexEntry": { # An entry is a representation of a data resource that can be described by various metadata.
"aspects": { # Optional. The aspects that are attached to the entry. Depending on how the aspect is attached to the entry, the format of the aspect key can be one of the following: If the aspect is attached directly to the entry: {project_id_or_number}.{location_id}.{aspect_type_id} If the aspect is attached to an entry's path: {project_id_or_number}.{location_id}.{aspect_type_id}@{path}
"a_key": { # An aspect is a single piece of metadata describing an entry.
"aspectSource": { # Information related to the source system of the aspect. # Optional. Information related to the source system of the aspect.
"createTime": "A String", # The time the aspect was created in the source system.
"dataVersion": "A String", # The version of the data format used to produce this data. This field is used to indicated when the underlying data format changes (e.g., schema modifications, changes to the source URL format definition, etc).
"updateTime": "A String", # The time the aspect was last updated in the source system.
},
"aspectType": "A String", # Output only. The resource name of the type used to create this Aspect.
"createTime": "A String", # Output only. The time when the Aspect was created.
"data": { # Required. The content of the aspect, according to its aspect type schema. The maximum size of the field is 120KB (encoded as UTF-8).
"a_key": "", # Properties of the object.
},
"path": "A String", # Output only. The path in the entry under which the aspect is attached.
"updateTime": "A String", # Output only. The time when the Aspect was last updated.
},
},
"createTime": "A String", # Output only. The time when the entry was created in Dataplex.
"entrySource": { # Information related to the source system of the data resource that is represented by the entry. # Optional. Information related to the source system of the data resource that is represented by the entry.
"ancestors": [ # Immutable. The entries representing the ancestors of the data resource in the source system.
{ # Information about individual items in the hierarchy that is associated with the data resource.
"name": "A String", # Optional. The name of the ancestor resource.
"type": "A String", # Optional. The type of the ancestor resource.
},
],
"createTime": "A String", # The time when the resource was created in the source system.
"description": "A String", # A description of the data resource. Maximum length is 2,000 characters.
"displayName": "A String", # A user-friendly display name. Maximum length is 500 characters.
"labels": { # User-defined labels. The maximum size of keys and values is 128 characters each.
"a_key": "A String",
},
"location": "A String", # Output only. Location of the resource in the source system. You can search the entry by this location. By default, this should match the location of the entry group containing this entry. A different value allows capturing the source location for data external to Google Cloud.
"platform": "A String", # The platform containing the source system. Maximum length is 64 characters.
"resource": "A String", # The name of the resource in the source system. Maximum length is 4,000 characters.
"system": "A String", # The name of the source system. Maximum length is 64 characters.
"updateTime": "A String", # The time when the resource was last updated in the source system. If the entry exists in the system and its EntrySource has update_time populated, further updates to the EntrySource of the entry must provide incremental updates to its update_time.
},
"entryType": "A String", # Required. Immutable. The relative resource name of the entry type that was used to create this entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryTypes/{entry_type_id}.
"fullyQualifiedName": "A String", # Optional. A name for the entry that can be referenced by an external system. For more information, see Fully qualified names (https://cloud.google.com/data-catalog/docs/fully-qualified-names). The maximum size of the field is 4000 characters.
"name": "A String", # Identifier. The relative resource name of the entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}.
"parentEntry": "A String", # Optional. Immutable. The resource name of the parent entry.
"updateTime": "A String", # Output only. The time when the entry was last updated in Dataplex.
},
"linkedResource": "A String", # Linked resource name.
"snippets": { # Snippets for the entry, contains HTML-style highlighting for matched tokens, will be used in UI. # Snippets.
"dataplexEntry": { # An entry is a representation of a data resource that can be described by various metadata. # Entry
"aspects": { # Optional. The aspects that are attached to the entry. Depending on how the aspect is attached to the entry, the format of the aspect key can be one of the following: If the aspect is attached directly to the entry: {project_id_or_number}.{location_id}.{aspect_type_id} If the aspect is attached to an entry's path: {project_id_or_number}.{location_id}.{aspect_type_id}@{path}
"a_key": { # An aspect is a single piece of metadata describing an entry.
"aspectSource": { # Information related to the source system of the aspect. # Optional. Information related to the source system of the aspect.
"createTime": "A String", # The time the aspect was created in the source system.
"dataVersion": "A String", # The version of the data format used to produce this data. This field is used to indicated when the underlying data format changes (e.g., schema modifications, changes to the source URL format definition, etc).
"updateTime": "A String", # The time the aspect was last updated in the source system.
},
"aspectType": "A String", # Output only. The resource name of the type used to create this Aspect.
"createTime": "A String", # Output only. The time when the Aspect was created.
"data": { # Required. The content of the aspect, according to its aspect type schema. The maximum size of the field is 120KB (encoded as UTF-8).
"a_key": "", # Properties of the object.
},
"path": "A String", # Output only. The path in the entry under which the aspect is attached.
"updateTime": "A String", # Output only. The time when the Aspect was last updated.
},
},
"createTime": "A String", # Output only. The time when the entry was created in Dataplex.
"entrySource": { # Information related to the source system of the data resource that is represented by the entry. # Optional. Information related to the source system of the data resource that is represented by the entry.
"ancestors": [ # Immutable. The entries representing the ancestors of the data resource in the source system.
{ # Information about individual items in the hierarchy that is associated with the data resource.
"name": "A String", # Optional. The name of the ancestor resource.
"type": "A String", # Optional. The type of the ancestor resource.
},
],
"createTime": "A String", # The time when the resource was created in the source system.
"description": "A String", # A description of the data resource. Maximum length is 2,000 characters.
"displayName": "A String", # A user-friendly display name. Maximum length is 500 characters.
"labels": { # User-defined labels. The maximum size of keys and values is 128 characters each.
"a_key": "A String",
},
"location": "A String", # Output only. Location of the resource in the source system. You can search the entry by this location. By default, this should match the location of the entry group containing this entry. A different value allows capturing the source location for data external to Google Cloud.
"platform": "A String", # The platform containing the source system. Maximum length is 64 characters.
"resource": "A String", # The name of the resource in the source system. Maximum length is 4,000 characters.
"system": "A String", # The name of the source system. Maximum length is 64 characters.
"updateTime": "A String", # The time when the resource was last updated in the source system. If the entry exists in the system and its EntrySource has update_time populated, further updates to the EntrySource of the entry must provide incremental updates to its update_time.
},
"entryType": "A String", # Required. Immutable. The relative resource name of the entry type that was used to create this entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryTypes/{entry_type_id}.
"fullyQualifiedName": "A String", # Optional. A name for the entry that can be referenced by an external system. For more information, see Fully qualified names (https://cloud.google.com/data-catalog/docs/fully-qualified-names). The maximum size of the field is 4000 characters.
"name": "A String", # Identifier. The relative resource name of the entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}.
"parentEntry": "A String", # Optional. Immutable. The resource name of the parent entry.
"updateTime": "A String", # Output only. The time when the entry was last updated in Dataplex.
},
},
},
],
"totalSize": 42, # The estimated total number of matching entries. This number isn't guaranteed to be accurate.
"unreachable": [ # Locations that the service couldn't reach. Search results don't include data from these locations.
"A String",
],
}

Cloud Dataplex API . projects . locations

Instance Methods

Method Details