| <html><body> |
| <style> |
| |
| body, h1, h2, h3, div, span, p, pre, a { |
| margin: 0; |
| padding: 0; |
| border: 0; |
| font-weight: inherit; |
| font-style: inherit; |
| font-size: 100%; |
| font-family: inherit; |
| vertical-align: baseline; |
| } |
| |
| body { |
| font-size: 13px; |
| padding: 1em; |
| } |
| |
| h1 { |
| font-size: 26px; |
| margin-bottom: 1em; |
| } |
| |
| h2 { |
| font-size: 24px; |
| margin-bottom: 1em; |
| } |
| |
| h3 { |
| font-size: 20px; |
| margin-bottom: 1em; |
| margin-top: 1em; |
| } |
| |
| pre, code { |
| line-height: 1.5; |
| font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| } |
| |
| pre { |
| margin-top: 0.5em; |
| } |
| |
| h1, h2, h3, p { |
| font-family: Arial, sans serif; |
| } |
| |
| h1, h2, h3 { |
| border-bottom: solid #CCC 1px; |
| } |
| |
| .toc_element { |
| margin-top: 0.5em; |
| } |
| |
| .firstline { |
| margin-left: 2 em; |
| } |
| |
| .method { |
| margin-top: 1em; |
| border: solid 1px #CCC; |
| padding: 1em; |
| background: #EEE; |
| } |
| |
| .details { |
| font-weight: bold; |
| font-size: 14px; |
| } |
| |
| </style> |
| |
| <h1><a href="dataplex_v1.html">Cloud Dataplex API</a> . <a href="dataplex_v1.projects.html">projects</a> . <a href="dataplex_v1.projects.locations.html">locations</a></h1> |
| <h2>Instance Methods</h2> |
| <p class="toc_element"> |
| <code><a href="dataplex_v1.projects.locations.aspectTypes.html">aspectTypes()</a></code> |
| </p> |
| <p class="firstline">Returns the aspectTypes Resource.</p> |
| |
| <p class="toc_element"> |
| <code><a href="dataplex_v1.projects.locations.dataAttributeBindings.html">dataAttributeBindings()</a></code> |
| </p> |
| <p class="firstline">Returns the dataAttributeBindings Resource.</p> |
| |
| <p class="toc_element"> |
| <code><a href="dataplex_v1.projects.locations.dataScans.html">dataScans()</a></code> |
| </p> |
| <p class="firstline">Returns the dataScans Resource.</p> |
| |
| <p class="toc_element"> |
| <code><a href="dataplex_v1.projects.locations.dataTaxonomies.html">dataTaxonomies()</a></code> |
| </p> |
| <p class="firstline">Returns the dataTaxonomies Resource.</p> |
| |
| <p class="toc_element"> |
| <code><a href="dataplex_v1.projects.locations.entryGroups.html">entryGroups()</a></code> |
| </p> |
| <p class="firstline">Returns the entryGroups Resource.</p> |
| |
| <p class="toc_element"> |
| <code><a href="dataplex_v1.projects.locations.entryTypes.html">entryTypes()</a></code> |
| </p> |
| <p class="firstline">Returns the entryTypes Resource.</p> |
| |
| <p class="toc_element"> |
| <code><a href="dataplex_v1.projects.locations.governanceRules.html">governanceRules()</a></code> |
| </p> |
| <p class="firstline">Returns the governanceRules Resource.</p> |
| |
| <p class="toc_element"> |
| <code><a href="dataplex_v1.projects.locations.lakes.html">lakes()</a></code> |
| </p> |
| <p class="firstline">Returns the lakes Resource.</p> |
| |
| <p class="toc_element"> |
| <code><a href="dataplex_v1.projects.locations.operations.html">operations()</a></code> |
| </p> |
| <p class="firstline">Returns the operations Resource.</p> |
| |
| <p class="toc_element"> |
| <code><a href="#close">close()</a></code></p> |
| <p class="firstline">Close httplib2 connections.</p> |
| <p class="toc_element"> |
| <code><a href="#get">get(name, x__xgafv=None)</a></code></p> |
| <p class="firstline">Gets information about a location.</p> |
| <p class="toc_element"> |
| <code><a href="#list">list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Lists information about the supported locations for this service.</p> |
| <p class="toc_element"> |
| <code><a href="#list_next">list_next()</a></code></p> |
| <p class="firstline">Retrieves the next page of results.</p> |
| <p class="toc_element"> |
| <code><a href="#lookupEntry">lookupEntry(name, aspectTypes=None, entry=None, paths=None, view=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Looks up a single entry.</p> |
| <p class="toc_element"> |
| <code><a href="#searchEntries">searchEntries(name, orderBy=None, pageSize=None, pageToken=None, query=None, scope=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Searches for entries matching given query and scope.</p> |
| <p class="toc_element"> |
| <code><a href="#searchEntries_next">searchEntries_next()</a></code></p> |
| <p class="firstline">Retrieves the next page of results.</p> |
| <h3>Method Details</h3> |
| <div class="method"> |
| <code class="details" id="close">close()</code> |
| <pre>Close httplib2 connections.</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="get">get(name, x__xgafv=None)</code> |
| <pre>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" |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list">list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code> |
| <pre>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. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list_next">list_next()</code> |
| <pre>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. |
| </pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="lookupEntry">lookupEntry(name, aspectTypes=None, entry=None, paths=None, view=None, x__xgafv=None)</code> |
| <pre>Looks up a single entry. |
| |
| 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. Only works if the CUSTOM view is selected. (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. Only works if the CUSTOM view is selected. (repeated) |
| view: string, Optional. View for controlling which parts of an entry are to be returned. |
| 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 would exceed 100, the first 100 will be returned. |
| ALL - Returns all aspects. If the number of aspects would exceed 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 asset which can be described by various metadata. |
| "aspects": { # Optional. The Aspects attached to the Entry. The key is either the resource name of the aspect type (if the aspect is attached directly to the entry) or "aspectType@path" if the aspect is attached to an entry's path. |
| "a_key": { # An aspect is a single piece of metadata describing an entry. |
| "aspectSource": { # AspectSource contains source system related information for the aspect. |
| "createTime": "A String", # The create time of the aspect in the source system. |
| "updateTime": "A String", # The update time of the aspect 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. This will replace content. 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. |
| "entrySource": { # EntrySource contains source system related information for the entry. # Optional. Source system related information for an entry. |
| "ancestors": [ # Immutable. The ancestors of the Entry in the source system. |
| { # Ancestor contains information about individual items in the hierarchy of an Entry. |
| "name": "A String", # Optional. The name of the ancestor resource. |
| "type": "A String", # Optional. The type of the ancestor resource. |
| }, |
| ], |
| "createTime": "A String", # The create time of the resource in the source system. |
| "description": "A String", # Description of the Entry. The maximum size of the field is 2000 characters. |
| "displayName": "A String", # User friendly display name. The maximum size of the field is 500 characters. |
| "labels": { # User-defined labels. The maximum size of keys and values is 128 characters each. |
| "a_key": "A String", |
| }, |
| "platform": "A String", # The platform containing the source system. The maximum size of the field is 64 characters. |
| "resource": "A String", # The name of the resource in the source system. The maximum size of the field is 4000 characters. |
| "system": "A String", # The name of the source system. The maximum size of the field is 64 characters. |
| "updateTime": "A String", # The update time of the resource in the source system. |
| }, |
| "entryType": "A String", # Required. Immutable. The resource name of the EntryType used to create this Entry. |
| "fullyQualifiedName": "A String", # Optional. A name for the entry that can reference it in an external system. The maximum size of the field is 4000 characters. |
| "name": "A String", # Identifier. The relative resource name of the Entry, of the form: projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}. |
| "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. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="searchEntries">searchEntries(name, orderBy=None, pageSize=None, pageToken=None, query=None, scope=None, x__xgafv=None)</code> |
| <pre>Searches for entries matching 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. Ordering of the results. Supported options to be added later. |
| pageSize: integer, Optional. Pagination. |
| pageToken: string, A parameter |
| query: string, Required. The query against which entries in scope should be matched. |
| scope: string, Optional. The scope under which the search should be operating. Should either be organizations/ or projects/. If left unspecified, it will default 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", # Pagination token. |
| "results": [ # The results matching the search query. |
| { # A single result of a SearchEntries request. |
| "dataplexEntry": { # An entry is a representation of a data asset which can be described by various metadata. # Entry format of the result. |
| "aspects": { # Optional. The Aspects attached to the Entry. The key is either the resource name of the aspect type (if the aspect is attached directly to the entry) or "aspectType@path" if the aspect is attached to an entry's path. |
| "a_key": { # An aspect is a single piece of metadata describing an entry. |
| "aspectSource": { # AspectSource contains source system related information for the aspect. |
| "createTime": "A String", # The create time of the aspect in the source system. |
| "updateTime": "A String", # The update time of the aspect 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. This will replace content. 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. |
| "entrySource": { # EntrySource contains source system related information for the entry. # Optional. Source system related information for an entry. |
| "ancestors": [ # Immutable. The ancestors of the Entry in the source system. |
| { # Ancestor contains information about individual items in the hierarchy of an Entry. |
| "name": "A String", # Optional. The name of the ancestor resource. |
| "type": "A String", # Optional. The type of the ancestor resource. |
| }, |
| ], |
| "createTime": "A String", # The create time of the resource in the source system. |
| "description": "A String", # Description of the Entry. The maximum size of the field is 2000 characters. |
| "displayName": "A String", # User friendly display name. The maximum size of the field is 500 characters. |
| "labels": { # User-defined labels. The maximum size of keys and values is 128 characters each. |
| "a_key": "A String", |
| }, |
| "platform": "A String", # The platform containing the source system. The maximum size of the field is 64 characters. |
| "resource": "A String", # The name of the resource in the source system. The maximum size of the field is 4000 characters. |
| "system": "A String", # The name of the source system. The maximum size of the field is 64 characters. |
| "updateTime": "A String", # The update time of the resource in the source system. |
| }, |
| "entryType": "A String", # Required. Immutable. The resource name of the EntryType used to create this Entry. |
| "fullyQualifiedName": "A String", # Optional. A name for the entry that can reference it in an external system. The maximum size of the field is 4000 characters. |
| "name": "A String", # Identifier. The relative resource name of the Entry, of the form: projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}. |
| "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. |
| }, |
| "description": "A String", # Entry description. |
| "displayName": "A String", # Display name. |
| "entry": "A String", # Resource name of the entry. |
| "entryType": "A String", # The entry type. |
| "fullyQualifiedName": "A String", # Fully qualified name. |
| "linkedResource": "A String", # Linked resource name. |
| "modifyTime": "A String", # The last modification timestamp. |
| "relativeResource": "A String", # Relative 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 asset which can be described by various metadata. # Entry |
| "aspects": { # Optional. The Aspects attached to the Entry. The key is either the resource name of the aspect type (if the aspect is attached directly to the entry) or "aspectType@path" if the aspect is attached to an entry's path. |
| "a_key": { # An aspect is a single piece of metadata describing an entry. |
| "aspectSource": { # AspectSource contains source system related information for the aspect. |
| "createTime": "A String", # The create time of the aspect in the source system. |
| "updateTime": "A String", # The update time of the aspect 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. This will replace content. 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. |
| "entrySource": { # EntrySource contains source system related information for the entry. # Optional. Source system related information for an entry. |
| "ancestors": [ # Immutable. The ancestors of the Entry in the source system. |
| { # Ancestor contains information about individual items in the hierarchy of an Entry. |
| "name": "A String", # Optional. The name of the ancestor resource. |
| "type": "A String", # Optional. The type of the ancestor resource. |
| }, |
| ], |
| "createTime": "A String", # The create time of the resource in the source system. |
| "description": "A String", # Description of the Entry. The maximum size of the field is 2000 characters. |
| "displayName": "A String", # User friendly display name. The maximum size of the field is 500 characters. |
| "labels": { # User-defined labels. The maximum size of keys and values is 128 characters each. |
| "a_key": "A String", |
| }, |
| "platform": "A String", # The platform containing the source system. The maximum size of the field is 64 characters. |
| "resource": "A String", # The name of the resource in the source system. The maximum size of the field is 4000 characters. |
| "system": "A String", # The name of the source system. The maximum size of the field is 64 characters. |
| "updateTime": "A String", # The update time of the resource in the source system. |
| }, |
| "entryType": "A String", # Required. Immutable. The resource name of the EntryType used to create this Entry. |
| "fullyQualifiedName": "A String", # Optional. A name for the entry that can reference it in an external system. The maximum size of the field is 4000 characters. |
| "name": "A String", # Identifier. The relative resource name of the Entry, of the form: projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}. |
| "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. |
| }, |
| }, |
| }, |
| ], |
| "totalSize": 42, # The estimated total number of matching entries. Not guaranteed to be accurate. |
| "unreachable": [ # Unreachable locations. Search results don't include data from those locations. |
| "A String", |
| ], |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="searchEntries_next">searchEntries_next()</code> |
| <pre>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. |
| </pre> |
| </div> |
| |
| </body></html> |
