| <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="datacatalog_v1.html">Google Cloud Data Catalog API</a> . <a href="datacatalog_v1.projects.html">projects</a> . <a href="datacatalog_v1.projects.locations.html">locations</a> . <a href="datacatalog_v1.projects.locations.entryGroups.html">entryGroups</a> . <a href="datacatalog_v1.projects.locations.entryGroups.entries.html">entries</a></h1> |
| <h2>Instance Methods</h2> |
| <p class="toc_element"> |
| <code><a href="datacatalog_v1.projects.locations.entryGroups.entries.tags.html">tags()</a></code> |
| </p> |
| <p class="firstline">Returns the tags 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="#create">create(parent, body=None, entryId=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Creates an entry. You can create entries only with 'FILESET', 'CLUSTER', 'DATA_STREAM', or custom types. Data Catalog automatically creates entries with other types during metadata ingestion from integrated systems. You must enable the Data Catalog API in the project identified by the `parent` parameter. For more information, see [Data Catalog resource project](https://cloud.google.com/data-catalog/docs/concepts/resource-project). An entry group can have a maximum of 100,000 entries.</p> |
| <p class="toc_element"> |
| <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> |
| <p class="firstline">Deletes an existing entry. You can delete only the entries created by the CreateEntry method. You must enable the Data Catalog API in the project identified by the `name` parameter. For more information, see [Data Catalog resource project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).</p> |
| <p class="toc_element"> |
| <code><a href="#get">get(name, x__xgafv=None)</a></code></p> |
| <p class="firstline">Gets an entry.</p> |
| <p class="toc_element"> |
| <code><a href="#getIamPolicy">getIamPolicy(resource, body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Gets the access control policy for a resource. May return: * A`NOT_FOUND` error if the resource doesn't exist or you don't have the permission to view it. * An empty policy if the resource exists but doesn't have a set policy. Supported resources are: - Tag templates - Entry groups Note: This method doesn't get policies from Google Cloud Platform resources ingested into Data Catalog. To call this method, you must have the following Google IAM permissions: - `datacatalog.tagTemplates.getIamPolicy` to get policies on tag templates. - `datacatalog.entryGroups.getIamPolicy` to get policies on entry groups.</p> |
| <p class="toc_element"> |
| <code><a href="#list">list(parent, pageSize=None, pageToken=None, readMask=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Lists entries. Note: Currently, this method can list only custom entries. To get a list of both custom and automatically created entries, use SearchCatalog.</p> |
| <p class="toc_element"> |
| <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| <p class="firstline">Retrieves the next page of results.</p> |
| <p class="toc_element"> |
| <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Updates an existing entry. You must enable the Data Catalog API in the project identified by the `entry.name` parameter. For more information, see [Data Catalog resource project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).</p> |
| <p class="toc_element"> |
| <code><a href="#testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Gets your permissions on a resource. Returns an empty set of permissions if the resource doesn't exist. Supported resources are: - Tag templates - Entry groups Note: This method gets policies only within Data Catalog and can't be used to get policies from BigQuery, Pub/Sub, Dataproc Metastore, and any external Google Cloud Platform resources ingested into Data Catalog. No Google IAM permissions are required to call this method.</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="create">create(parent, body=None, entryId=None, x__xgafv=None)</code> |
| <pre>Creates an entry. You can create entries only with 'FILESET', 'CLUSTER', 'DATA_STREAM', or custom types. Data Catalog automatically creates entries with other types during metadata ingestion from integrated systems. You must enable the Data Catalog API in the project identified by the `parent` parameter. For more information, see [Data Catalog resource project](https://cloud.google.com/data-catalog/docs/concepts/resource-project). An entry group can have a maximum of 100,000 entries. |
| |
| Args: |
| parent: string, Required. The name of the entry group this entry belongs to. Note: The entry itself and its child resources might not be stored in the location specified in its name. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # Entry metadata. A Data Catalog entry represents another resource in Google Cloud Platform (such as a BigQuery dataset or a Pub/Sub topic) or outside of it. You can use the `linked_resource` field in the entry resource to refer to the original resource ID of the source system. An entry resource contains resource details, for example, its schema. Additionally, you can attach flexible metadata to an entry in the form of a Tag. |
| "bigqueryDateShardedSpec": { # Specification for a group of BigQuery tables with the `[prefix]YYYYMMDD` name pattern. For more information, see [Introduction to partitioned tables] (https://cloud.google.com/bigquery/docs/partitioned-tables#partitioning_versus_sharding). # Specification for a group of BigQuery tables with the `[prefix]YYYYMMDD` name pattern. For more information, see [Introduction to partitioned tables] (https://cloud.google.com/bigquery/docs/partitioned-tables#partitioning_versus_sharding). |
| "dataset": "A String", # Output only. The Data Catalog resource name of the dataset entry the current table belongs to. For example: `projects/{PROJECT_ID}/locations/{LOCATION}/entrygroups/{ENTRY_GROUP_ID}/entries/{ENTRY_ID}`. |
| "latestShardResource": "A String", # Output only. BigQuery resource name of the latest shard. |
| "shardCount": "A String", # Output only. Total number of shards. |
| "tablePrefix": "A String", # Output only. The table name prefix of the shards. The name of any given shard is `[table_prefix]YYYYMMDD`. For example, for the `MyTable20180101` shard, the `table_prefix` is `MyTable`. |
| }, |
| "bigqueryTableSpec": { # Describes a BigQuery table. # Specification that applies to a BigQuery table. Valid only for entries with the `TABLE` type. |
| "tableSourceType": "A String", # Output only. The table source type. |
| "tableSpec": { # Normal BigQuery table specification. # Specification of a BigQuery table. Populated only if the `table_source_type` is `BIGQUERY_TABLE`. |
| "groupedEntry": "A String", # Output only. If the table is date-sharded, that is, it matches the `[prefix]YYYYMMDD` name pattern, this field is the Data Catalog resource name of the date-sharded grouped entry. For example: `projects/{PROJECT_ID}/locations/{LOCATION}/entrygroups/{ENTRY_GROUP_ID}/entries/{ENTRY_ID}`. Otherwise, `grouped_entry` is empty. |
| }, |
| "viewSpec": { # Table view specification. # Table view specification. Populated only if the `table_source_type` is `BIGQUERY_VIEW`. |
| "viewQuery": "A String", # Output only. The query that defines the table view. |
| }, |
| }, |
| "dataSource": { # Physical location of an entry. # Output only. Physical location of the entry. |
| "resource": "A String", # Full name of a resource as defined by the service. For example: `//bigquery.googleapis.com/projects/{PROJECT_ID}/locations/{LOCATION}/datasets/{DATASET_ID}/tables/{TABLE_ID}` |
| "service": "A String", # Service that physically stores the data. |
| }, |
| "dataSourceConnectionSpec": { # Specification that applies to a data source connection. Valid only for entries with the `DATA_SOURCE_CONNECTION` type. # Specification that applies to a data source connection. Valid only for entries with the `DATA_SOURCE_CONNECTION` type. |
| "bigqueryConnectionSpec": { # Specification for the BigQuery connection. # Fields specific to BigQuery connections. |
| "cloudSql": { # Specification for the BigQuery connection to a Cloud SQL instance. # Specification for the BigQuery connection to a Cloud SQL instance. |
| "database": "A String", # Database name. |
| "instanceId": "A String", # Cloud SQL instance ID in the format of `project:location:instance`. |
| "type": "A String", # Type of the Cloud SQL database. |
| }, |
| "connectionType": "A String", # The type of the BigQuery connection. |
| "hasCredential": True or False, # True if there are credentials attached to the BigQuery connection; false otherwise. |
| }, |
| }, |
| "databaseTableSpec": { # Specification that applies to a table resource. Valid only for entries with the `TABLE` type. # Specification that applies to a table resource. Valid only for entries with the `TABLE` type. |
| "type": "A String", # Type of this table. |
| }, |
| "description": "A String", # Entry description that can consist of several sentences or paragraphs that describe entry contents. The description must not contain Unicode non-characters as well as C0 and C1 control codes except tabs (HT), new lines (LF), carriage returns (CR), and page breaks (FF). The maximum size is 2000 bytes when encoded in UTF-8. Default value is an empty string. |
| "displayName": "A String", # Display name of an entry. The name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), and can't start or end with spaces. The maximum size is 200 bytes when encoded in UTF-8. Default value is an empty string. |
| "fullyQualifiedName": "A String", # Fully qualified name (FQN) of the resource. Set automatically for entries representing resources from synced systems. Settable only during creation and read-only afterwards. Can be used for search and lookup of the entries. 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}` |
| "gcsFilesetSpec": { # Describes a Cloud Storage fileset entry. # Specification that applies to a Cloud Storage fileset. Valid only for entries with the `FILESET` type. |
| "filePatterns": [ # Required. Patterns to identify a set of files in Google Cloud Storage. For more information, see [Wildcard Names] (https://cloud.google.com/storage/docs/gsutil/addlhelp/WildcardNames). Note: Currently, bucket wildcards are not supported. Examples of valid `file_patterns`: * `gs://bucket_name/dir/*`: matches all files in `bucket_name/dir` directory * `gs://bucket_name/dir/**`: matches all files in `bucket_name/dir` and all subdirectories * `gs://bucket_name/file*`: matches files prefixed by `file` in `bucket_name` * `gs://bucket_name/??.txt`: matches files with two characters followed by `.txt` in `bucket_name` * `gs://bucket_name/[aeiou].txt`: matches files that contain a single vowel character followed by `.txt` in `bucket_name` * `gs://bucket_name/[a-m].txt`: matches files that contain `a`, `b`, ... or `m` followed by `.txt` in `bucket_name` * `gs://bucket_name/a/*/b`: matches all files in `bucket_name` that match the `a/*/b` pattern, such as `a/c/b`, `a/d/b` * `gs://another_bucket/a.txt`: matches `gs://another_bucket/a.txt` You can combine wildcards to match complex sets of files, for example: `gs://bucket_name/[a-m]??.j*g` |
| "A String", |
| ], |
| "sampleGcsFileSpecs": [ # Output only. Sample files contained in this fileset, not all files contained in this fileset are represented here. |
| { # Specification of a single file in Cloud Storage. |
| "filePath": "A String", # Required. Full file path. Example: `gs://bucket_name/a/b.txt`. |
| "gcsTimestamps": { # Timestamps associated with this resource in a particular system. # Output only. Creation, modification, and expiration timestamps of a Cloud Storage file. |
| "createTime": "A String", # Creation timestamp of the resource within the given system. |
| "expireTime": "A String", # Output only. Expiration timestamp of the resource within the given system. Currently only applicable to BigQuery resources. |
| "updateTime": "A 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. |
| }, |
| "sizeBytes": "A String", # Output only. File size in bytes. |
| }, |
| ], |
| }, |
| "integratedSystem": "A String", # Output only. Indicates the entry's source system that Data Catalog integrates with, such as BigQuery, Pub/Sub, or Dataproc Metastore. |
| "labels": { # Cloud labels attached to the entry. In Data Catalog, you can create and modify labels attached only to custom entries. Synced entries have unmodifiable labels that come from the source system. |
| "a_key": "A String", |
| }, |
| "linkedResource": "A String", # The resource this metadata entry refers to. For Google Cloud Platform resources, `linked_resource` is the [Full Resource Name] (https://cloud.google.com/apis/design/resource_names#full_resource_name). For example, the `linked_resource` for a table resource from BigQuery is: `//bigquery.googleapis.com/projects/{PROJECT_ID}/datasets/{DATASET_ID}/tables/{TABLE_ID}` Output only when the entry is one of the types in the `EntryType` enum. For entries with a `user_specified_type`, this field is optional and defaults to an empty string. The resource string must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), periods (.), colons (:), slashes (/), dashes (-), and hashes (#). The maximum size is 200 bytes when encoded in UTF-8. |
| "name": "A String", # Output only. The resource name of an entry in URL format. Note: The entry itself and its child resources might not be stored in the location specified in its name. |
| "routineSpec": { # Specification that applies to a routine. Valid only for entries with the `ROUTINE` type. # Specification that applies to a user-defined function or procedure. Valid only for entries with the `ROUTINE` type. |
| "bigqueryRoutineSpec": { # Fields specific for BigQuery routines. # Fields specific for BigQuery routines. |
| "importedLibraries": [ # Paths of the imported libraries. |
| "A String", |
| ], |
| }, |
| "definitionBody": "A String", # The body of the routine. |
| "language": "A String", # The language the routine is written in. The exact value depends on the source system. For BigQuery routines, possible values are: * `SQL` * `JAVASCRIPT` |
| "returnType": "A String", # Return type of the argument. The exact value depends on the source system and the language. |
| "routineArguments": [ # Arguments of the routine. |
| { # Input or output argument of a function or stored procedure. |
| "mode": "A String", # Specifies whether the argument is input or output. |
| "name": "A String", # The name of the argument. A return argument of a function might not have a name. |
| "type": "A String", # Type of the argument. The exact value depends on the source system and the language. |
| }, |
| ], |
| "routineType": "A String", # The type of the routine. |
| }, |
| "schema": { # Represents a schema, for example, a BigQuery, GoogleSQL, or Avro schema. # Schema of the entry. An entry might not have any schema attached to it. |
| "columns": [ # The unified GoogleSQL-like schema of columns. The overall maximum number of columns and nested columns is 10,000. The maximum nested depth is 15 levels. |
| { # A column within a schema. Columns can be nested inside other columns. |
| "column": "A String", # Required. Name of the column. Must be a UTF-8 string without dots (.). The maximum size is 64 bytes. |
| "description": "A String", # Optional. Description of the column. Default value is an empty string. The description must be a UTF-8 string with the maximum size of 2000 bytes. |
| "mode": "A String", # Optional. A column's mode indicates whether values in this column are required, nullable, or repeated. Only `NULLABLE`, `REQUIRED`, and `REPEATED` values are supported. Default mode is `NULLABLE`. |
| "subcolumns": [ # Optional. Schema of sub-columns. A column can have zero or more sub-columns. |
| # Object with schema name: GoogleCloudDatacatalogV1ColumnSchema |
| ], |
| "type": "A String", # Required. Type of the column. Must be a UTF-8 string with the maximum size of 128 bytes. |
| }, |
| ], |
| }, |
| "sourceSystemTimestamps": { # Timestamps associated with this resource in a particular system. # Timestamps from the underlying resource, not from the Data Catalog entry. Output only when the entry has a type listed in the `EntryType` enum. For entries with `user_specified_type`, this field is optional and defaults to an empty timestamp. |
| "createTime": "A String", # Creation timestamp of the resource within the given system. |
| "expireTime": "A String", # Output only. Expiration timestamp of the resource within the given system. Currently only applicable to BigQuery resources. |
| "updateTime": "A 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. |
| }, |
| "type": "A String", # The type of the entry. Only used for entries with types listed in the `EntryType` enum. Currently, only `FILESET` enum value is allowed. All other entries created in Data Catalog must use the `user_specified_type`. |
| "usageSignal": { # The set of all usage signals that Data Catalog stores. Note: Usually, these signals are updated daily. In rare cases, an update may fail but will be performed again on the next day. # Output only. Resource usage statistics. |
| "updateTime": "A String", # The end timestamp of the duration of usage statistics. |
| "usageWithinTimeRange": { # Usage statistics over each of the predefined time ranges. Supported time ranges are `{"24H", "7D", "30D"}`. |
| "a_key": { # Detailed statistics on the entry's usage. Usage statistics have the following limitations: - Only BigQuery tables have them. - They only include BigQuery query jobs. - They might be underestimated because wildcard table references are not yet counted. For more information, see [Querying multiple tables using a wildcard table] (https://cloud.google.com/bigquery/docs/querying-wildcard-tables) |
| "totalCancellations": 3.14, # The number of cancelled attempts to use the underlying entry. |
| "totalCompletions": 3.14, # The number of successful uses of the underlying entry. |
| "totalExecutionTimeForCompletionsMillis": 3.14, # Total time spent only on successful uses, in milliseconds. |
| "totalFailures": 3.14, # The number of failed attempts to use the underlying entry. |
| }, |
| }, |
| }, |
| "userSpecifiedSystem": "A String", # Indicates the entry's source system that Data Catalog doesn't automatically integrate with. The `user_specified_system` string has the following limitations: * Is case insensitive. * Must begin with a letter or underscore. * Can only contain letters, numbers, and underscores. * Must be at least 1 character and at most 64 characters long. |
| "userSpecifiedType": "A String", # Custom entry type that doesn't match any of the values allowed for input and listed in the `EntryType` enum. When creating an entry, first check the type values in the enum. If there are no appropriate types for the new entry, provide a custom value, for example, `my_special_type`. The `user_specified_type` string has the following limitations: * Is case insensitive. * Must begin with a letter or underscore. * Can only contain letters, numbers, and underscores. * Must be at least 1 character and at most 64 characters long. |
| } |
| |
| entryId: string, Required. The ID of the entry to create. The ID must contain only letters (a-z, A-Z), numbers (0-9), and underscores (_). The maximum size is 64 bytes when encoded in UTF-8. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Entry metadata. A Data Catalog entry represents another resource in Google Cloud Platform (such as a BigQuery dataset or a Pub/Sub topic) or outside of it. You can use the `linked_resource` field in the entry resource to refer to the original resource ID of the source system. An entry resource contains resource details, for example, its schema. Additionally, you can attach flexible metadata to an entry in the form of a Tag. |
| "bigqueryDateShardedSpec": { # Specification for a group of BigQuery tables with the `[prefix]YYYYMMDD` name pattern. For more information, see [Introduction to partitioned tables] (https://cloud.google.com/bigquery/docs/partitioned-tables#partitioning_versus_sharding). # Specification for a group of BigQuery tables with the `[prefix]YYYYMMDD` name pattern. For more information, see [Introduction to partitioned tables] (https://cloud.google.com/bigquery/docs/partitioned-tables#partitioning_versus_sharding). |
| "dataset": "A String", # Output only. The Data Catalog resource name of the dataset entry the current table belongs to. For example: `projects/{PROJECT_ID}/locations/{LOCATION}/entrygroups/{ENTRY_GROUP_ID}/entries/{ENTRY_ID}`. |
| "latestShardResource": "A String", # Output only. BigQuery resource name of the latest shard. |
| "shardCount": "A String", # Output only. Total number of shards. |
| "tablePrefix": "A String", # Output only. The table name prefix of the shards. The name of any given shard is `[table_prefix]YYYYMMDD`. For example, for the `MyTable20180101` shard, the `table_prefix` is `MyTable`. |
| }, |
| "bigqueryTableSpec": { # Describes a BigQuery table. # Specification that applies to a BigQuery table. Valid only for entries with the `TABLE` type. |
| "tableSourceType": "A String", # Output only. The table source type. |
| "tableSpec": { # Normal BigQuery table specification. # Specification of a BigQuery table. Populated only if the `table_source_type` is `BIGQUERY_TABLE`. |
| "groupedEntry": "A String", # Output only. If the table is date-sharded, that is, it matches the `[prefix]YYYYMMDD` name pattern, this field is the Data Catalog resource name of the date-sharded grouped entry. For example: `projects/{PROJECT_ID}/locations/{LOCATION}/entrygroups/{ENTRY_GROUP_ID}/entries/{ENTRY_ID}`. Otherwise, `grouped_entry` is empty. |
| }, |
| "viewSpec": { # Table view specification. # Table view specification. Populated only if the `table_source_type` is `BIGQUERY_VIEW`. |
| "viewQuery": "A String", # Output only. The query that defines the table view. |
| }, |
| }, |
| "dataSource": { # Physical location of an entry. # Output only. Physical location of the entry. |
| "resource": "A String", # Full name of a resource as defined by the service. For example: `//bigquery.googleapis.com/projects/{PROJECT_ID}/locations/{LOCATION}/datasets/{DATASET_ID}/tables/{TABLE_ID}` |
| "service": "A String", # Service that physically stores the data. |
| }, |
| "dataSourceConnectionSpec": { # Specification that applies to a data source connection. Valid only for entries with the `DATA_SOURCE_CONNECTION` type. # Specification that applies to a data source connection. Valid only for entries with the `DATA_SOURCE_CONNECTION` type. |
| "bigqueryConnectionSpec": { # Specification for the BigQuery connection. # Fields specific to BigQuery connections. |
| "cloudSql": { # Specification for the BigQuery connection to a Cloud SQL instance. # Specification for the BigQuery connection to a Cloud SQL instance. |
| "database": "A String", # Database name. |
| "instanceId": "A String", # Cloud SQL instance ID in the format of `project:location:instance`. |
| "type": "A String", # Type of the Cloud SQL database. |
| }, |
| "connectionType": "A String", # The type of the BigQuery connection. |
| "hasCredential": True or False, # True if there are credentials attached to the BigQuery connection; false otherwise. |
| }, |
| }, |
| "databaseTableSpec": { # Specification that applies to a table resource. Valid only for entries with the `TABLE` type. # Specification that applies to a table resource. Valid only for entries with the `TABLE` type. |
| "type": "A String", # Type of this table. |
| }, |
| "description": "A String", # Entry description that can consist of several sentences or paragraphs that describe entry contents. The description must not contain Unicode non-characters as well as C0 and C1 control codes except tabs (HT), new lines (LF), carriage returns (CR), and page breaks (FF). The maximum size is 2000 bytes when encoded in UTF-8. Default value is an empty string. |
| "displayName": "A String", # Display name of an entry. The name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), and can't start or end with spaces. The maximum size is 200 bytes when encoded in UTF-8. Default value is an empty string. |
| "fullyQualifiedName": "A String", # Fully qualified name (FQN) of the resource. Set automatically for entries representing resources from synced systems. Settable only during creation and read-only afterwards. Can be used for search and lookup of the entries. 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}` |
| "gcsFilesetSpec": { # Describes a Cloud Storage fileset entry. # Specification that applies to a Cloud Storage fileset. Valid only for entries with the `FILESET` type. |
| "filePatterns": [ # Required. Patterns to identify a set of files in Google Cloud Storage. For more information, see [Wildcard Names] (https://cloud.google.com/storage/docs/gsutil/addlhelp/WildcardNames). Note: Currently, bucket wildcards are not supported. Examples of valid `file_patterns`: * `gs://bucket_name/dir/*`: matches all files in `bucket_name/dir` directory * `gs://bucket_name/dir/**`: matches all files in `bucket_name/dir` and all subdirectories * `gs://bucket_name/file*`: matches files prefixed by `file` in `bucket_name` * `gs://bucket_name/??.txt`: matches files with two characters followed by `.txt` in `bucket_name` * `gs://bucket_name/[aeiou].txt`: matches files that contain a single vowel character followed by `.txt` in `bucket_name` * `gs://bucket_name/[a-m].txt`: matches files that contain `a`, `b`, ... or `m` followed by `.txt` in `bucket_name` * `gs://bucket_name/a/*/b`: matches all files in `bucket_name` that match the `a/*/b` pattern, such as `a/c/b`, `a/d/b` * `gs://another_bucket/a.txt`: matches `gs://another_bucket/a.txt` You can combine wildcards to match complex sets of files, for example: `gs://bucket_name/[a-m]??.j*g` |
| "A String", |
| ], |
| "sampleGcsFileSpecs": [ # Output only. Sample files contained in this fileset, not all files contained in this fileset are represented here. |
| { # Specification of a single file in Cloud Storage. |
| "filePath": "A String", # Required. Full file path. Example: `gs://bucket_name/a/b.txt`. |
| "gcsTimestamps": { # Timestamps associated with this resource in a particular system. # Output only. Creation, modification, and expiration timestamps of a Cloud Storage file. |
| "createTime": "A String", # Creation timestamp of the resource within the given system. |
| "expireTime": "A String", # Output only. Expiration timestamp of the resource within the given system. Currently only applicable to BigQuery resources. |
| "updateTime": "A 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. |
| }, |
| "sizeBytes": "A String", # Output only. File size in bytes. |
| }, |
| ], |
| }, |
| "integratedSystem": "A String", # Output only. Indicates the entry's source system that Data Catalog integrates with, such as BigQuery, Pub/Sub, or Dataproc Metastore. |
| "labels": { # Cloud labels attached to the entry. In Data Catalog, you can create and modify labels attached only to custom entries. Synced entries have unmodifiable labels that come from the source system. |
| "a_key": "A String", |
| }, |
| "linkedResource": "A String", # The resource this metadata entry refers to. For Google Cloud Platform resources, `linked_resource` is the [Full Resource Name] (https://cloud.google.com/apis/design/resource_names#full_resource_name). For example, the `linked_resource` for a table resource from BigQuery is: `//bigquery.googleapis.com/projects/{PROJECT_ID}/datasets/{DATASET_ID}/tables/{TABLE_ID}` Output only when the entry is one of the types in the `EntryType` enum. For entries with a `user_specified_type`, this field is optional and defaults to an empty string. The resource string must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), periods (.), colons (:), slashes (/), dashes (-), and hashes (#). The maximum size is 200 bytes when encoded in UTF-8. |
| "name": "A String", # Output only. The resource name of an entry in URL format. Note: The entry itself and its child resources might not be stored in the location specified in its name. |
| "routineSpec": { # Specification that applies to a routine. Valid only for entries with the `ROUTINE` type. # Specification that applies to a user-defined function or procedure. Valid only for entries with the `ROUTINE` type. |
| "bigqueryRoutineSpec": { # Fields specific for BigQuery routines. # Fields specific for BigQuery routines. |
| "importedLibraries": [ # Paths of the imported libraries. |
| "A String", |
| ], |
| }, |
| "definitionBody": "A String", # The body of the routine. |
| "language": "A String", # The language the routine is written in. The exact value depends on the source system. For BigQuery routines, possible values are: * `SQL` * `JAVASCRIPT` |
| "returnType": "A String", # Return type of the argument. The exact value depends on the source system and the language. |
| "routineArguments": [ # Arguments of the routine. |
| { # Input or output argument of a function or stored procedure. |
| "mode": "A String", # Specifies whether the argument is input or output. |
| "name": "A String", # The name of the argument. A return argument of a function might not have a name. |
| "type": "A String", # Type of the argument. The exact value depends on the source system and the language. |
| }, |
| ], |
| "routineType": "A String", # The type of the routine. |
| }, |
| "schema": { # Represents a schema, for example, a BigQuery, GoogleSQL, or Avro schema. # Schema of the entry. An entry might not have any schema attached to it. |
| "columns": [ # The unified GoogleSQL-like schema of columns. The overall maximum number of columns and nested columns is 10,000. The maximum nested depth is 15 levels. |
| { # A column within a schema. Columns can be nested inside other columns. |
| "column": "A String", # Required. Name of the column. Must be a UTF-8 string without dots (.). The maximum size is 64 bytes. |
| "description": "A String", # Optional. Description of the column. Default value is an empty string. The description must be a UTF-8 string with the maximum size of 2000 bytes. |
| "mode": "A String", # Optional. A column's mode indicates whether values in this column are required, nullable, or repeated. Only `NULLABLE`, `REQUIRED`, and `REPEATED` values are supported. Default mode is `NULLABLE`. |
| "subcolumns": [ # Optional. Schema of sub-columns. A column can have zero or more sub-columns. |
| # Object with schema name: GoogleCloudDatacatalogV1ColumnSchema |
| ], |
| "type": "A String", # Required. Type of the column. Must be a UTF-8 string with the maximum size of 128 bytes. |
| }, |
| ], |
| }, |
| "sourceSystemTimestamps": { # Timestamps associated with this resource in a particular system. # Timestamps from the underlying resource, not from the Data Catalog entry. Output only when the entry has a type listed in the `EntryType` enum. For entries with `user_specified_type`, this field is optional and defaults to an empty timestamp. |
| "createTime": "A String", # Creation timestamp of the resource within the given system. |
| "expireTime": "A String", # Output only. Expiration timestamp of the resource within the given system. Currently only applicable to BigQuery resources. |
| "updateTime": "A 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. |
| }, |
| "type": "A String", # The type of the entry. Only used for entries with types listed in the `EntryType` enum. Currently, only `FILESET` enum value is allowed. All other entries created in Data Catalog must use the `user_specified_type`. |
| "usageSignal": { # The set of all usage signals that Data Catalog stores. Note: Usually, these signals are updated daily. In rare cases, an update may fail but will be performed again on the next day. # Output only. Resource usage statistics. |
| "updateTime": "A String", # The end timestamp of the duration of usage statistics. |
| "usageWithinTimeRange": { # Usage statistics over each of the predefined time ranges. Supported time ranges are `{"24H", "7D", "30D"}`. |
| "a_key": { # Detailed statistics on the entry's usage. Usage statistics have the following limitations: - Only BigQuery tables have them. - They only include BigQuery query jobs. - They might be underestimated because wildcard table references are not yet counted. For more information, see [Querying multiple tables using a wildcard table] (https://cloud.google.com/bigquery/docs/querying-wildcard-tables) |
| "totalCancellations": 3.14, # The number of cancelled attempts to use the underlying entry. |
| "totalCompletions": 3.14, # The number of successful uses of the underlying entry. |
| "totalExecutionTimeForCompletionsMillis": 3.14, # Total time spent only on successful uses, in milliseconds. |
| "totalFailures": 3.14, # The number of failed attempts to use the underlying entry. |
| }, |
| }, |
| }, |
| "userSpecifiedSystem": "A String", # Indicates the entry's source system that Data Catalog doesn't automatically integrate with. The `user_specified_system` string has the following limitations: * Is case insensitive. * Must begin with a letter or underscore. * Can only contain letters, numbers, and underscores. * Must be at least 1 character and at most 64 characters long. |
| "userSpecifiedType": "A String", # Custom entry type that doesn't match any of the values allowed for input and listed in the `EntryType` enum. When creating an entry, first check the type values in the enum. If there are no appropriate types for the new entry, provide a custom value, for example, `my_special_type`. The `user_specified_type` string has the following limitations: * Is case insensitive. * Must begin with a letter or underscore. * Can only contain letters, numbers, and underscores. * Must be at least 1 character and at most 64 characters long. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="delete">delete(name, x__xgafv=None)</code> |
| <pre>Deletes an existing entry. You can delete only the entries created by the CreateEntry method. You must enable the Data Catalog API in the project identified by the `name` parameter. For more information, see [Data Catalog resource project](https://cloud.google.com/data-catalog/docs/concepts/resource-project). |
| |
| Args: |
| name: string, Required. The name of the entry to delete. (required) |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="get">get(name, x__xgafv=None)</code> |
| <pre>Gets an entry. |
| |
| Args: |
| name: string, Required. The name of the entry to get. (required) |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Entry metadata. A Data Catalog entry represents another resource in Google Cloud Platform (such as a BigQuery dataset or a Pub/Sub topic) or outside of it. You can use the `linked_resource` field in the entry resource to refer to the original resource ID of the source system. An entry resource contains resource details, for example, its schema. Additionally, you can attach flexible metadata to an entry in the form of a Tag. |
| "bigqueryDateShardedSpec": { # Specification for a group of BigQuery tables with the `[prefix]YYYYMMDD` name pattern. For more information, see [Introduction to partitioned tables] (https://cloud.google.com/bigquery/docs/partitioned-tables#partitioning_versus_sharding). # Specification for a group of BigQuery tables with the `[prefix]YYYYMMDD` name pattern. For more information, see [Introduction to partitioned tables] (https://cloud.google.com/bigquery/docs/partitioned-tables#partitioning_versus_sharding). |
| "dataset": "A String", # Output only. The Data Catalog resource name of the dataset entry the current table belongs to. For example: `projects/{PROJECT_ID}/locations/{LOCATION}/entrygroups/{ENTRY_GROUP_ID}/entries/{ENTRY_ID}`. |
| "latestShardResource": "A String", # Output only. BigQuery resource name of the latest shard. |
| "shardCount": "A String", # Output only. Total number of shards. |
| "tablePrefix": "A String", # Output only. The table name prefix of the shards. The name of any given shard is `[table_prefix]YYYYMMDD`. For example, for the `MyTable20180101` shard, the `table_prefix` is `MyTable`. |
| }, |
| "bigqueryTableSpec": { # Describes a BigQuery table. # Specification that applies to a BigQuery table. Valid only for entries with the `TABLE` type. |
| "tableSourceType": "A String", # Output only. The table source type. |
| "tableSpec": { # Normal BigQuery table specification. # Specification of a BigQuery table. Populated only if the `table_source_type` is `BIGQUERY_TABLE`. |
| "groupedEntry": "A String", # Output only. If the table is date-sharded, that is, it matches the `[prefix]YYYYMMDD` name pattern, this field is the Data Catalog resource name of the date-sharded grouped entry. For example: `projects/{PROJECT_ID}/locations/{LOCATION}/entrygroups/{ENTRY_GROUP_ID}/entries/{ENTRY_ID}`. Otherwise, `grouped_entry` is empty. |
| }, |
| "viewSpec": { # Table view specification. # Table view specification. Populated only if the `table_source_type` is `BIGQUERY_VIEW`. |
| "viewQuery": "A String", # Output only. The query that defines the table view. |
| }, |
| }, |
| "dataSource": { # Physical location of an entry. # Output only. Physical location of the entry. |
| "resource": "A String", # Full name of a resource as defined by the service. For example: `//bigquery.googleapis.com/projects/{PROJECT_ID}/locations/{LOCATION}/datasets/{DATASET_ID}/tables/{TABLE_ID}` |
| "service": "A String", # Service that physically stores the data. |
| }, |
| "dataSourceConnectionSpec": { # Specification that applies to a data source connection. Valid only for entries with the `DATA_SOURCE_CONNECTION` type. # Specification that applies to a data source connection. Valid only for entries with the `DATA_SOURCE_CONNECTION` type. |
| "bigqueryConnectionSpec": { # Specification for the BigQuery connection. # Fields specific to BigQuery connections. |
| "cloudSql": { # Specification for the BigQuery connection to a Cloud SQL instance. # Specification for the BigQuery connection to a Cloud SQL instance. |
| "database": "A String", # Database name. |
| "instanceId": "A String", # Cloud SQL instance ID in the format of `project:location:instance`. |
| "type": "A String", # Type of the Cloud SQL database. |
| }, |
| "connectionType": "A String", # The type of the BigQuery connection. |
| "hasCredential": True or False, # True if there are credentials attached to the BigQuery connection; false otherwise. |
| }, |
| }, |
| "databaseTableSpec": { # Specification that applies to a table resource. Valid only for entries with the `TABLE` type. # Specification that applies to a table resource. Valid only for entries with the `TABLE` type. |
| "type": "A String", # Type of this table. |
| }, |
| "description": "A String", # Entry description that can consist of several sentences or paragraphs that describe entry contents. The description must not contain Unicode non-characters as well as C0 and C1 control codes except tabs (HT), new lines (LF), carriage returns (CR), and page breaks (FF). The maximum size is 2000 bytes when encoded in UTF-8. Default value is an empty string. |
| "displayName": "A String", # Display name of an entry. The name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), and can't start or end with spaces. The maximum size is 200 bytes when encoded in UTF-8. Default value is an empty string. |
| "fullyQualifiedName": "A String", # Fully qualified name (FQN) of the resource. Set automatically for entries representing resources from synced systems. Settable only during creation and read-only afterwards. Can be used for search and lookup of the entries. 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}` |
| "gcsFilesetSpec": { # Describes a Cloud Storage fileset entry. # Specification that applies to a Cloud Storage fileset. Valid only for entries with the `FILESET` type. |
| "filePatterns": [ # Required. Patterns to identify a set of files in Google Cloud Storage. For more information, see [Wildcard Names] (https://cloud.google.com/storage/docs/gsutil/addlhelp/WildcardNames). Note: Currently, bucket wildcards are not supported. Examples of valid `file_patterns`: * `gs://bucket_name/dir/*`: matches all files in `bucket_name/dir` directory * `gs://bucket_name/dir/**`: matches all files in `bucket_name/dir` and all subdirectories * `gs://bucket_name/file*`: matches files prefixed by `file` in `bucket_name` * `gs://bucket_name/??.txt`: matches files with two characters followed by `.txt` in `bucket_name` * `gs://bucket_name/[aeiou].txt`: matches files that contain a single vowel character followed by `.txt` in `bucket_name` * `gs://bucket_name/[a-m].txt`: matches files that contain `a`, `b`, ... or `m` followed by `.txt` in `bucket_name` * `gs://bucket_name/a/*/b`: matches all files in `bucket_name` that match the `a/*/b` pattern, such as `a/c/b`, `a/d/b` * `gs://another_bucket/a.txt`: matches `gs://another_bucket/a.txt` You can combine wildcards to match complex sets of files, for example: `gs://bucket_name/[a-m]??.j*g` |
| "A String", |
| ], |
| "sampleGcsFileSpecs": [ # Output only. Sample files contained in this fileset, not all files contained in this fileset are represented here. |
| { # Specification of a single file in Cloud Storage. |
| "filePath": "A String", # Required. Full file path. Example: `gs://bucket_name/a/b.txt`. |
| "gcsTimestamps": { # Timestamps associated with this resource in a particular system. # Output only. Creation, modification, and expiration timestamps of a Cloud Storage file. |
| "createTime": "A String", # Creation timestamp of the resource within the given system. |
| "expireTime": "A String", # Output only. Expiration timestamp of the resource within the given system. Currently only applicable to BigQuery resources. |
| "updateTime": "A 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. |
| }, |
| "sizeBytes": "A String", # Output only. File size in bytes. |
| }, |
| ], |
| }, |
| "integratedSystem": "A String", # Output only. Indicates the entry's source system that Data Catalog integrates with, such as BigQuery, Pub/Sub, or Dataproc Metastore. |
| "labels": { # Cloud labels attached to the entry. In Data Catalog, you can create and modify labels attached only to custom entries. Synced entries have unmodifiable labels that come from the source system. |
| "a_key": "A String", |
| }, |
| "linkedResource": "A String", # The resource this metadata entry refers to. For Google Cloud Platform resources, `linked_resource` is the [Full Resource Name] (https://cloud.google.com/apis/design/resource_names#full_resource_name). For example, the `linked_resource` for a table resource from BigQuery is: `//bigquery.googleapis.com/projects/{PROJECT_ID}/datasets/{DATASET_ID}/tables/{TABLE_ID}` Output only when the entry is one of the types in the `EntryType` enum. For entries with a `user_specified_type`, this field is optional and defaults to an empty string. The resource string must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), periods (.), colons (:), slashes (/), dashes (-), and hashes (#). The maximum size is 200 bytes when encoded in UTF-8. |
| "name": "A String", # Output only. The resource name of an entry in URL format. Note: The entry itself and its child resources might not be stored in the location specified in its name. |
| "routineSpec": { # Specification that applies to a routine. Valid only for entries with the `ROUTINE` type. # Specification that applies to a user-defined function or procedure. Valid only for entries with the `ROUTINE` type. |
| "bigqueryRoutineSpec": { # Fields specific for BigQuery routines. # Fields specific for BigQuery routines. |
| "importedLibraries": [ # Paths of the imported libraries. |
| "A String", |
| ], |
| }, |
| "definitionBody": "A String", # The body of the routine. |
| "language": "A String", # The language the routine is written in. The exact value depends on the source system. For BigQuery routines, possible values are: * `SQL` * `JAVASCRIPT` |
| "returnType": "A String", # Return type of the argument. The exact value depends on the source system and the language. |
| "routineArguments": [ # Arguments of the routine. |
| { # Input or output argument of a function or stored procedure. |
| "mode": "A String", # Specifies whether the argument is input or output. |
| "name": "A String", # The name of the argument. A return argument of a function might not have a name. |
| "type": "A String", # Type of the argument. The exact value depends on the source system and the language. |
| }, |
| ], |
| "routineType": "A String", # The type of the routine. |
| }, |
| "schema": { # Represents a schema, for example, a BigQuery, GoogleSQL, or Avro schema. # Schema of the entry. An entry might not have any schema attached to it. |
| "columns": [ # The unified GoogleSQL-like schema of columns. The overall maximum number of columns and nested columns is 10,000. The maximum nested depth is 15 levels. |
| { # A column within a schema. Columns can be nested inside other columns. |
| "column": "A String", # Required. Name of the column. Must be a UTF-8 string without dots (.). The maximum size is 64 bytes. |
| "description": "A String", # Optional. Description of the column. Default value is an empty string. The description must be a UTF-8 string with the maximum size of 2000 bytes. |
| "mode": "A String", # Optional. A column's mode indicates whether values in this column are required, nullable, or repeated. Only `NULLABLE`, `REQUIRED`, and `REPEATED` values are supported. Default mode is `NULLABLE`. |
| "subcolumns": [ # Optional. Schema of sub-columns. A column can have zero or more sub-columns. |
| # Object with schema name: GoogleCloudDatacatalogV1ColumnSchema |
| ], |
| "type": "A String", # Required. Type of the column. Must be a UTF-8 string with the maximum size of 128 bytes. |
| }, |
| ], |
| }, |
| "sourceSystemTimestamps": { # Timestamps associated with this resource in a particular system. # Timestamps from the underlying resource, not from the Data Catalog entry. Output only when the entry has a type listed in the `EntryType` enum. For entries with `user_specified_type`, this field is optional and defaults to an empty timestamp. |
| "createTime": "A String", # Creation timestamp of the resource within the given system. |
| "expireTime": "A String", # Output only. Expiration timestamp of the resource within the given system. Currently only applicable to BigQuery resources. |
| "updateTime": "A 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. |
| }, |
| "type": "A String", # The type of the entry. Only used for entries with types listed in the `EntryType` enum. Currently, only `FILESET` enum value is allowed. All other entries created in Data Catalog must use the `user_specified_type`. |
| "usageSignal": { # The set of all usage signals that Data Catalog stores. Note: Usually, these signals are updated daily. In rare cases, an update may fail but will be performed again on the next day. # Output only. Resource usage statistics. |
| "updateTime": "A String", # The end timestamp of the duration of usage statistics. |
| "usageWithinTimeRange": { # Usage statistics over each of the predefined time ranges. Supported time ranges are `{"24H", "7D", "30D"}`. |
| "a_key": { # Detailed statistics on the entry's usage. Usage statistics have the following limitations: - Only BigQuery tables have them. - They only include BigQuery query jobs. - They might be underestimated because wildcard table references are not yet counted. For more information, see [Querying multiple tables using a wildcard table] (https://cloud.google.com/bigquery/docs/querying-wildcard-tables) |
| "totalCancellations": 3.14, # The number of cancelled attempts to use the underlying entry. |
| "totalCompletions": 3.14, # The number of successful uses of the underlying entry. |
| "totalExecutionTimeForCompletionsMillis": 3.14, # Total time spent only on successful uses, in milliseconds. |
| "totalFailures": 3.14, # The number of failed attempts to use the underlying entry. |
| }, |
| }, |
| }, |
| "userSpecifiedSystem": "A String", # Indicates the entry's source system that Data Catalog doesn't automatically integrate with. The `user_specified_system` string has the following limitations: * Is case insensitive. * Must begin with a letter or underscore. * Can only contain letters, numbers, and underscores. * Must be at least 1 character and at most 64 characters long. |
| "userSpecifiedType": "A String", # Custom entry type that doesn't match any of the values allowed for input and listed in the `EntryType` enum. When creating an entry, first check the type values in the enum. If there are no appropriate types for the new entry, provide a custom value, for example, `my_special_type`. The `user_specified_type` string has the following limitations: * Is case insensitive. * Must begin with a letter or underscore. * Can only contain letters, numbers, and underscores. * Must be at least 1 character and at most 64 characters long. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="getIamPolicy">getIamPolicy(resource, body=None, x__xgafv=None)</code> |
| <pre>Gets the access control policy for a resource. May return: * A`NOT_FOUND` error if the resource doesn't exist or you don't have the permission to view it. * An empty policy if the resource exists but doesn't have a set policy. Supported resources are: - Tag templates - Entry groups Note: This method doesn't get policies from Google Cloud Platform resources ingested into Data Catalog. To call this method, you must have the following Google IAM permissions: - `datacatalog.tagTemplates.getIamPolicy` to get policies on tag templates. - `datacatalog.entryGroups.getIamPolicy` to get policies on entry groups. |
| |
| Args: |
| resource: string, REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # Request message for `GetIamPolicy` method. |
| "options": { # Encapsulates settings provided to GetIamPolicy. # OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`. |
| "requestedPolicyVersion": 42, # Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). |
| }, |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). |
| "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. |
| { # Associates `members`, or principals, with a `role`. |
| "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). |
| "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. |
| "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. |
| "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. |
| "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. |
| }, |
| "members": [ # Specifies the principals requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. |
| "A String", |
| ], |
| "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. |
| }, |
| ], |
| "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. |
| "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list">list(parent, pageSize=None, pageToken=None, readMask=None, x__xgafv=None)</code> |
| <pre>Lists entries. Note: Currently, this method can list only custom entries. To get a list of both custom and automatically created entries, use SearchCatalog. |
| |
| Args: |
| parent: string, Required. The name of the entry group that contains the entries to list. Can be provided in URL format. (required) |
| pageSize: integer, The maximum number of items to return. Default is 10. Maximum limit is 1000. Throws an invalid argument if `page_size` is more than 1000. |
| pageToken: string, Pagination token that specifies the next page to return. If empty, the first page is returned. |
| readMask: string, The fields to return for each entry. If empty or omitted, all fields are returned. For example, to return a list of entries with only the `name` field, set `read_mask` to only one path with the `name` value. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Response message for ListEntries. |
| "entries": [ # Entry details. |
| { # Entry metadata. A Data Catalog entry represents another resource in Google Cloud Platform (such as a BigQuery dataset or a Pub/Sub topic) or outside of it. You can use the `linked_resource` field in the entry resource to refer to the original resource ID of the source system. An entry resource contains resource details, for example, its schema. Additionally, you can attach flexible metadata to an entry in the form of a Tag. |
| "bigqueryDateShardedSpec": { # Specification for a group of BigQuery tables with the `[prefix]YYYYMMDD` name pattern. For more information, see [Introduction to partitioned tables] (https://cloud.google.com/bigquery/docs/partitioned-tables#partitioning_versus_sharding). # Specification for a group of BigQuery tables with the `[prefix]YYYYMMDD` name pattern. For more information, see [Introduction to partitioned tables] (https://cloud.google.com/bigquery/docs/partitioned-tables#partitioning_versus_sharding). |
| "dataset": "A String", # Output only. The Data Catalog resource name of the dataset entry the current table belongs to. For example: `projects/{PROJECT_ID}/locations/{LOCATION}/entrygroups/{ENTRY_GROUP_ID}/entries/{ENTRY_ID}`. |
| "latestShardResource": "A String", # Output only. BigQuery resource name of the latest shard. |
| "shardCount": "A String", # Output only. Total number of shards. |
| "tablePrefix": "A String", # Output only. The table name prefix of the shards. The name of any given shard is `[table_prefix]YYYYMMDD`. For example, for the `MyTable20180101` shard, the `table_prefix` is `MyTable`. |
| }, |
| "bigqueryTableSpec": { # Describes a BigQuery table. # Specification that applies to a BigQuery table. Valid only for entries with the `TABLE` type. |
| "tableSourceType": "A String", # Output only. The table source type. |
| "tableSpec": { # Normal BigQuery table specification. # Specification of a BigQuery table. Populated only if the `table_source_type` is `BIGQUERY_TABLE`. |
| "groupedEntry": "A String", # Output only. If the table is date-sharded, that is, it matches the `[prefix]YYYYMMDD` name pattern, this field is the Data Catalog resource name of the date-sharded grouped entry. For example: `projects/{PROJECT_ID}/locations/{LOCATION}/entrygroups/{ENTRY_GROUP_ID}/entries/{ENTRY_ID}`. Otherwise, `grouped_entry` is empty. |
| }, |
| "viewSpec": { # Table view specification. # Table view specification. Populated only if the `table_source_type` is `BIGQUERY_VIEW`. |
| "viewQuery": "A String", # Output only. The query that defines the table view. |
| }, |
| }, |
| "dataSource": { # Physical location of an entry. # Output only. Physical location of the entry. |
| "resource": "A String", # Full name of a resource as defined by the service. For example: `//bigquery.googleapis.com/projects/{PROJECT_ID}/locations/{LOCATION}/datasets/{DATASET_ID}/tables/{TABLE_ID}` |
| "service": "A String", # Service that physically stores the data. |
| }, |
| "dataSourceConnectionSpec": { # Specification that applies to a data source connection. Valid only for entries with the `DATA_SOURCE_CONNECTION` type. # Specification that applies to a data source connection. Valid only for entries with the `DATA_SOURCE_CONNECTION` type. |
| "bigqueryConnectionSpec": { # Specification for the BigQuery connection. # Fields specific to BigQuery connections. |
| "cloudSql": { # Specification for the BigQuery connection to a Cloud SQL instance. # Specification for the BigQuery connection to a Cloud SQL instance. |
| "database": "A String", # Database name. |
| "instanceId": "A String", # Cloud SQL instance ID in the format of `project:location:instance`. |
| "type": "A String", # Type of the Cloud SQL database. |
| }, |
| "connectionType": "A String", # The type of the BigQuery connection. |
| "hasCredential": True or False, # True if there are credentials attached to the BigQuery connection; false otherwise. |
| }, |
| }, |
| "databaseTableSpec": { # Specification that applies to a table resource. Valid only for entries with the `TABLE` type. # Specification that applies to a table resource. Valid only for entries with the `TABLE` type. |
| "type": "A String", # Type of this table. |
| }, |
| "description": "A String", # Entry description that can consist of several sentences or paragraphs that describe entry contents. The description must not contain Unicode non-characters as well as C0 and C1 control codes except tabs (HT), new lines (LF), carriage returns (CR), and page breaks (FF). The maximum size is 2000 bytes when encoded in UTF-8. Default value is an empty string. |
| "displayName": "A String", # Display name of an entry. The name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), and can't start or end with spaces. The maximum size is 200 bytes when encoded in UTF-8. Default value is an empty string. |
| "fullyQualifiedName": "A String", # Fully qualified name (FQN) of the resource. Set automatically for entries representing resources from synced systems. Settable only during creation and read-only afterwards. Can be used for search and lookup of the entries. 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}` |
| "gcsFilesetSpec": { # Describes a Cloud Storage fileset entry. # Specification that applies to a Cloud Storage fileset. Valid only for entries with the `FILESET` type. |
| "filePatterns": [ # Required. Patterns to identify a set of files in Google Cloud Storage. For more information, see [Wildcard Names] (https://cloud.google.com/storage/docs/gsutil/addlhelp/WildcardNames). Note: Currently, bucket wildcards are not supported. Examples of valid `file_patterns`: * `gs://bucket_name/dir/*`: matches all files in `bucket_name/dir` directory * `gs://bucket_name/dir/**`: matches all files in `bucket_name/dir` and all subdirectories * `gs://bucket_name/file*`: matches files prefixed by `file` in `bucket_name` * `gs://bucket_name/??.txt`: matches files with two characters followed by `.txt` in `bucket_name` * `gs://bucket_name/[aeiou].txt`: matches files that contain a single vowel character followed by `.txt` in `bucket_name` * `gs://bucket_name/[a-m].txt`: matches files that contain `a`, `b`, ... or `m` followed by `.txt` in `bucket_name` * `gs://bucket_name/a/*/b`: matches all files in `bucket_name` that match the `a/*/b` pattern, such as `a/c/b`, `a/d/b` * `gs://another_bucket/a.txt`: matches `gs://another_bucket/a.txt` You can combine wildcards to match complex sets of files, for example: `gs://bucket_name/[a-m]??.j*g` |
| "A String", |
| ], |
| "sampleGcsFileSpecs": [ # Output only. Sample files contained in this fileset, not all files contained in this fileset are represented here. |
| { # Specification of a single file in Cloud Storage. |
| "filePath": "A String", # Required. Full file path. Example: `gs://bucket_name/a/b.txt`. |
| "gcsTimestamps": { # Timestamps associated with this resource in a particular system. # Output only. Creation, modification, and expiration timestamps of a Cloud Storage file. |
| "createTime": "A String", # Creation timestamp of the resource within the given system. |
| "expireTime": "A String", # Output only. Expiration timestamp of the resource within the given system. Currently only applicable to BigQuery resources. |
| "updateTime": "A 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. |
| }, |
| "sizeBytes": "A String", # Output only. File size in bytes. |
| }, |
| ], |
| }, |
| "integratedSystem": "A String", # Output only. Indicates the entry's source system that Data Catalog integrates with, such as BigQuery, Pub/Sub, or Dataproc Metastore. |
| "labels": { # Cloud labels attached to the entry. In Data Catalog, you can create and modify labels attached only to custom entries. Synced entries have unmodifiable labels that come from the source system. |
| "a_key": "A String", |
| }, |
| "linkedResource": "A String", # The resource this metadata entry refers to. For Google Cloud Platform resources, `linked_resource` is the [Full Resource Name] (https://cloud.google.com/apis/design/resource_names#full_resource_name). For example, the `linked_resource` for a table resource from BigQuery is: `//bigquery.googleapis.com/projects/{PROJECT_ID}/datasets/{DATASET_ID}/tables/{TABLE_ID}` Output only when the entry is one of the types in the `EntryType` enum. For entries with a `user_specified_type`, this field is optional and defaults to an empty string. The resource string must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), periods (.), colons (:), slashes (/), dashes (-), and hashes (#). The maximum size is 200 bytes when encoded in UTF-8. |
| "name": "A String", # Output only. The resource name of an entry in URL format. Note: The entry itself and its child resources might not be stored in the location specified in its name. |
| "routineSpec": { # Specification that applies to a routine. Valid only for entries with the `ROUTINE` type. # Specification that applies to a user-defined function or procedure. Valid only for entries with the `ROUTINE` type. |
| "bigqueryRoutineSpec": { # Fields specific for BigQuery routines. # Fields specific for BigQuery routines. |
| "importedLibraries": [ # Paths of the imported libraries. |
| "A String", |
| ], |
| }, |
| "definitionBody": "A String", # The body of the routine. |
| "language": "A String", # The language the routine is written in. The exact value depends on the source system. For BigQuery routines, possible values are: * `SQL` * `JAVASCRIPT` |
| "returnType": "A String", # Return type of the argument. The exact value depends on the source system and the language. |
| "routineArguments": [ # Arguments of the routine. |
| { # Input or output argument of a function or stored procedure. |
| "mode": "A String", # Specifies whether the argument is input or output. |
| "name": "A String", # The name of the argument. A return argument of a function might not have a name. |
| "type": "A String", # Type of the argument. The exact value depends on the source system and the language. |
| }, |
| ], |
| "routineType": "A String", # The type of the routine. |
| }, |
| "schema": { # Represents a schema, for example, a BigQuery, GoogleSQL, or Avro schema. # Schema of the entry. An entry might not have any schema attached to it. |
| "columns": [ # The unified GoogleSQL-like schema of columns. The overall maximum number of columns and nested columns is 10,000. The maximum nested depth is 15 levels. |
| { # A column within a schema. Columns can be nested inside other columns. |
| "column": "A String", # Required. Name of the column. Must be a UTF-8 string without dots (.). The maximum size is 64 bytes. |
| "description": "A String", # Optional. Description of the column. Default value is an empty string. The description must be a UTF-8 string with the maximum size of 2000 bytes. |
| "mode": "A String", # Optional. A column's mode indicates whether values in this column are required, nullable, or repeated. Only `NULLABLE`, `REQUIRED`, and `REPEATED` values are supported. Default mode is `NULLABLE`. |
| "subcolumns": [ # Optional. Schema of sub-columns. A column can have zero or more sub-columns. |
| # Object with schema name: GoogleCloudDatacatalogV1ColumnSchema |
| ], |
| "type": "A String", # Required. Type of the column. Must be a UTF-8 string with the maximum size of 128 bytes. |
| }, |
| ], |
| }, |
| "sourceSystemTimestamps": { # Timestamps associated with this resource in a particular system. # Timestamps from the underlying resource, not from the Data Catalog entry. Output only when the entry has a type listed in the `EntryType` enum. For entries with `user_specified_type`, this field is optional and defaults to an empty timestamp. |
| "createTime": "A String", # Creation timestamp of the resource within the given system. |
| "expireTime": "A String", # Output only. Expiration timestamp of the resource within the given system. Currently only applicable to BigQuery resources. |
| "updateTime": "A 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. |
| }, |
| "type": "A String", # The type of the entry. Only used for entries with types listed in the `EntryType` enum. Currently, only `FILESET` enum value is allowed. All other entries created in Data Catalog must use the `user_specified_type`. |
| "usageSignal": { # The set of all usage signals that Data Catalog stores. Note: Usually, these signals are updated daily. In rare cases, an update may fail but will be performed again on the next day. # Output only. Resource usage statistics. |
| "updateTime": "A String", # The end timestamp of the duration of usage statistics. |
| "usageWithinTimeRange": { # Usage statistics over each of the predefined time ranges. Supported time ranges are `{"24H", "7D", "30D"}`. |
| "a_key": { # Detailed statistics on the entry's usage. Usage statistics have the following limitations: - Only BigQuery tables have them. - They only include BigQuery query jobs. - They might be underestimated because wildcard table references are not yet counted. For more information, see [Querying multiple tables using a wildcard table] (https://cloud.google.com/bigquery/docs/querying-wildcard-tables) |
| "totalCancellations": 3.14, # The number of cancelled attempts to use the underlying entry. |
| "totalCompletions": 3.14, # The number of successful uses of the underlying entry. |
| "totalExecutionTimeForCompletionsMillis": 3.14, # Total time spent only on successful uses, in milliseconds. |
| "totalFailures": 3.14, # The number of failed attempts to use the underlying entry. |
| }, |
| }, |
| }, |
| "userSpecifiedSystem": "A String", # Indicates the entry's source system that Data Catalog doesn't automatically integrate with. The `user_specified_system` string has the following limitations: * Is case insensitive. * Must begin with a letter or underscore. * Can only contain letters, numbers, and underscores. * Must be at least 1 character and at most 64 characters long. |
| "userSpecifiedType": "A String", # Custom entry type that doesn't match any of the values allowed for input and listed in the `EntryType` enum. When creating an entry, first check the type values in the enum. If there are no appropriate types for the new entry, provide a custom value, for example, `my_special_type`. The `user_specified_type` string has the following limitations: * Is case insensitive. * Must begin with a letter or underscore. * Can only contain letters, numbers, and underscores. * Must be at least 1 character and at most 64 characters long. |
| }, |
| ], |
| "nextPageToken": "A String", # Pagination token of the next results page. Empty if there are no more items in results. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list_next">list_next(previous_request, previous_response)</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="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code> |
| <pre>Updates an existing entry. You must enable the Data Catalog API in the project identified by the `entry.name` parameter. For more information, see [Data Catalog resource project](https://cloud.google.com/data-catalog/docs/concepts/resource-project). |
| |
| Args: |
| name: string, Output only. The resource name of an entry in URL format. Note: The entry itself and its child resources might not be stored in the location specified in its name. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # Entry metadata. A Data Catalog entry represents another resource in Google Cloud Platform (such as a BigQuery dataset or a Pub/Sub topic) or outside of it. You can use the `linked_resource` field in the entry resource to refer to the original resource ID of the source system. An entry resource contains resource details, for example, its schema. Additionally, you can attach flexible metadata to an entry in the form of a Tag. |
| "bigqueryDateShardedSpec": { # Specification for a group of BigQuery tables with the `[prefix]YYYYMMDD` name pattern. For more information, see [Introduction to partitioned tables] (https://cloud.google.com/bigquery/docs/partitioned-tables#partitioning_versus_sharding). # Specification for a group of BigQuery tables with the `[prefix]YYYYMMDD` name pattern. For more information, see [Introduction to partitioned tables] (https://cloud.google.com/bigquery/docs/partitioned-tables#partitioning_versus_sharding). |
| "dataset": "A String", # Output only. The Data Catalog resource name of the dataset entry the current table belongs to. For example: `projects/{PROJECT_ID}/locations/{LOCATION}/entrygroups/{ENTRY_GROUP_ID}/entries/{ENTRY_ID}`. |
| "latestShardResource": "A String", # Output only. BigQuery resource name of the latest shard. |
| "shardCount": "A String", # Output only. Total number of shards. |
| "tablePrefix": "A String", # Output only. The table name prefix of the shards. The name of any given shard is `[table_prefix]YYYYMMDD`. For example, for the `MyTable20180101` shard, the `table_prefix` is `MyTable`. |
| }, |
| "bigqueryTableSpec": { # Describes a BigQuery table. # Specification that applies to a BigQuery table. Valid only for entries with the `TABLE` type. |
| "tableSourceType": "A String", # Output only. The table source type. |
| "tableSpec": { # Normal BigQuery table specification. # Specification of a BigQuery table. Populated only if the `table_source_type` is `BIGQUERY_TABLE`. |
| "groupedEntry": "A String", # Output only. If the table is date-sharded, that is, it matches the `[prefix]YYYYMMDD` name pattern, this field is the Data Catalog resource name of the date-sharded grouped entry. For example: `projects/{PROJECT_ID}/locations/{LOCATION}/entrygroups/{ENTRY_GROUP_ID}/entries/{ENTRY_ID}`. Otherwise, `grouped_entry` is empty. |
| }, |
| "viewSpec": { # Table view specification. # Table view specification. Populated only if the `table_source_type` is `BIGQUERY_VIEW`. |
| "viewQuery": "A String", # Output only. The query that defines the table view. |
| }, |
| }, |
| "dataSource": { # Physical location of an entry. # Output only. Physical location of the entry. |
| "resource": "A String", # Full name of a resource as defined by the service. For example: `//bigquery.googleapis.com/projects/{PROJECT_ID}/locations/{LOCATION}/datasets/{DATASET_ID}/tables/{TABLE_ID}` |
| "service": "A String", # Service that physically stores the data. |
| }, |
| "dataSourceConnectionSpec": { # Specification that applies to a data source connection. Valid only for entries with the `DATA_SOURCE_CONNECTION` type. # Specification that applies to a data source connection. Valid only for entries with the `DATA_SOURCE_CONNECTION` type. |
| "bigqueryConnectionSpec": { # Specification for the BigQuery connection. # Fields specific to BigQuery connections. |
| "cloudSql": { # Specification for the BigQuery connection to a Cloud SQL instance. # Specification for the BigQuery connection to a Cloud SQL instance. |
| "database": "A String", # Database name. |
| "instanceId": "A String", # Cloud SQL instance ID in the format of `project:location:instance`. |
| "type": "A String", # Type of the Cloud SQL database. |
| }, |
| "connectionType": "A String", # The type of the BigQuery connection. |
| "hasCredential": True or False, # True if there are credentials attached to the BigQuery connection; false otherwise. |
| }, |
| }, |
| "databaseTableSpec": { # Specification that applies to a table resource. Valid only for entries with the `TABLE` type. # Specification that applies to a table resource. Valid only for entries with the `TABLE` type. |
| "type": "A String", # Type of this table. |
| }, |
| "description": "A String", # Entry description that can consist of several sentences or paragraphs that describe entry contents. The description must not contain Unicode non-characters as well as C0 and C1 control codes except tabs (HT), new lines (LF), carriage returns (CR), and page breaks (FF). The maximum size is 2000 bytes when encoded in UTF-8. Default value is an empty string. |
| "displayName": "A String", # Display name of an entry. The name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), and can't start or end with spaces. The maximum size is 200 bytes when encoded in UTF-8. Default value is an empty string. |
| "fullyQualifiedName": "A String", # Fully qualified name (FQN) of the resource. Set automatically for entries representing resources from synced systems. Settable only during creation and read-only afterwards. Can be used for search and lookup of the entries. 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}` |
| "gcsFilesetSpec": { # Describes a Cloud Storage fileset entry. # Specification that applies to a Cloud Storage fileset. Valid only for entries with the `FILESET` type. |
| "filePatterns": [ # Required. Patterns to identify a set of files in Google Cloud Storage. For more information, see [Wildcard Names] (https://cloud.google.com/storage/docs/gsutil/addlhelp/WildcardNames). Note: Currently, bucket wildcards are not supported. Examples of valid `file_patterns`: * `gs://bucket_name/dir/*`: matches all files in `bucket_name/dir` directory * `gs://bucket_name/dir/**`: matches all files in `bucket_name/dir` and all subdirectories * `gs://bucket_name/file*`: matches files prefixed by `file` in `bucket_name` * `gs://bucket_name/??.txt`: matches files with two characters followed by `.txt` in `bucket_name` * `gs://bucket_name/[aeiou].txt`: matches files that contain a single vowel character followed by `.txt` in `bucket_name` * `gs://bucket_name/[a-m].txt`: matches files that contain `a`, `b`, ... or `m` followed by `.txt` in `bucket_name` * `gs://bucket_name/a/*/b`: matches all files in `bucket_name` that match the `a/*/b` pattern, such as `a/c/b`, `a/d/b` * `gs://another_bucket/a.txt`: matches `gs://another_bucket/a.txt` You can combine wildcards to match complex sets of files, for example: `gs://bucket_name/[a-m]??.j*g` |
| "A String", |
| ], |
| "sampleGcsFileSpecs": [ # Output only. Sample files contained in this fileset, not all files contained in this fileset are represented here. |
| { # Specification of a single file in Cloud Storage. |
| "filePath": "A String", # Required. Full file path. Example: `gs://bucket_name/a/b.txt`. |
| "gcsTimestamps": { # Timestamps associated with this resource in a particular system. # Output only. Creation, modification, and expiration timestamps of a Cloud Storage file. |
| "createTime": "A String", # Creation timestamp of the resource within the given system. |
| "expireTime": "A String", # Output only. Expiration timestamp of the resource within the given system. Currently only applicable to BigQuery resources. |
| "updateTime": "A 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. |
| }, |
| "sizeBytes": "A String", # Output only. File size in bytes. |
| }, |
| ], |
| }, |
| "integratedSystem": "A String", # Output only. Indicates the entry's source system that Data Catalog integrates with, such as BigQuery, Pub/Sub, or Dataproc Metastore. |
| "labels": { # Cloud labels attached to the entry. In Data Catalog, you can create and modify labels attached only to custom entries. Synced entries have unmodifiable labels that come from the source system. |
| "a_key": "A String", |
| }, |
| "linkedResource": "A String", # The resource this metadata entry refers to. For Google Cloud Platform resources, `linked_resource` is the [Full Resource Name] (https://cloud.google.com/apis/design/resource_names#full_resource_name). For example, the `linked_resource` for a table resource from BigQuery is: `//bigquery.googleapis.com/projects/{PROJECT_ID}/datasets/{DATASET_ID}/tables/{TABLE_ID}` Output only when the entry is one of the types in the `EntryType` enum. For entries with a `user_specified_type`, this field is optional and defaults to an empty string. The resource string must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), periods (.), colons (:), slashes (/), dashes (-), and hashes (#). The maximum size is 200 bytes when encoded in UTF-8. |
| "name": "A String", # Output only. The resource name of an entry in URL format. Note: The entry itself and its child resources might not be stored in the location specified in its name. |
| "routineSpec": { # Specification that applies to a routine. Valid only for entries with the `ROUTINE` type. # Specification that applies to a user-defined function or procedure. Valid only for entries with the `ROUTINE` type. |
| "bigqueryRoutineSpec": { # Fields specific for BigQuery routines. # Fields specific for BigQuery routines. |
| "importedLibraries": [ # Paths of the imported libraries. |
| "A String", |
| ], |
| }, |
| "definitionBody": "A String", # The body of the routine. |
| "language": "A String", # The language the routine is written in. The exact value depends on the source system. For BigQuery routines, possible values are: * `SQL` * `JAVASCRIPT` |
| "returnType": "A String", # Return type of the argument. The exact value depends on the source system and the language. |
| "routineArguments": [ # Arguments of the routine. |
| { # Input or output argument of a function or stored procedure. |
| "mode": "A String", # Specifies whether the argument is input or output. |
| "name": "A String", # The name of the argument. A return argument of a function might not have a name. |
| "type": "A String", # Type of the argument. The exact value depends on the source system and the language. |
| }, |
| ], |
| "routineType": "A String", # The type of the routine. |
| }, |
| "schema": { # Represents a schema, for example, a BigQuery, GoogleSQL, or Avro schema. # Schema of the entry. An entry might not have any schema attached to it. |
| "columns": [ # The unified GoogleSQL-like schema of columns. The overall maximum number of columns and nested columns is 10,000. The maximum nested depth is 15 levels. |
| { # A column within a schema. Columns can be nested inside other columns. |
| "column": "A String", # Required. Name of the column. Must be a UTF-8 string without dots (.). The maximum size is 64 bytes. |
| "description": "A String", # Optional. Description of the column. Default value is an empty string. The description must be a UTF-8 string with the maximum size of 2000 bytes. |
| "mode": "A String", # Optional. A column's mode indicates whether values in this column are required, nullable, or repeated. Only `NULLABLE`, `REQUIRED`, and `REPEATED` values are supported. Default mode is `NULLABLE`. |
| "subcolumns": [ # Optional. Schema of sub-columns. A column can have zero or more sub-columns. |
| # Object with schema name: GoogleCloudDatacatalogV1ColumnSchema |
| ], |
| "type": "A String", # Required. Type of the column. Must be a UTF-8 string with the maximum size of 128 bytes. |
| }, |
| ], |
| }, |
| "sourceSystemTimestamps": { # Timestamps associated with this resource in a particular system. # Timestamps from the underlying resource, not from the Data Catalog entry. Output only when the entry has a type listed in the `EntryType` enum. For entries with `user_specified_type`, this field is optional and defaults to an empty timestamp. |
| "createTime": "A String", # Creation timestamp of the resource within the given system. |
| "expireTime": "A String", # Output only. Expiration timestamp of the resource within the given system. Currently only applicable to BigQuery resources. |
| "updateTime": "A 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. |
| }, |
| "type": "A String", # The type of the entry. Only used for entries with types listed in the `EntryType` enum. Currently, only `FILESET` enum value is allowed. All other entries created in Data Catalog must use the `user_specified_type`. |
| "usageSignal": { # The set of all usage signals that Data Catalog stores. Note: Usually, these signals are updated daily. In rare cases, an update may fail but will be performed again on the next day. # Output only. Resource usage statistics. |
| "updateTime": "A String", # The end timestamp of the duration of usage statistics. |
| "usageWithinTimeRange": { # Usage statistics over each of the predefined time ranges. Supported time ranges are `{"24H", "7D", "30D"}`. |
| "a_key": { # Detailed statistics on the entry's usage. Usage statistics have the following limitations: - Only BigQuery tables have them. - They only include BigQuery query jobs. - They might be underestimated because wildcard table references are not yet counted. For more information, see [Querying multiple tables using a wildcard table] (https://cloud.google.com/bigquery/docs/querying-wildcard-tables) |
| "totalCancellations": 3.14, # The number of cancelled attempts to use the underlying entry. |
| "totalCompletions": 3.14, # The number of successful uses of the underlying entry. |
| "totalExecutionTimeForCompletionsMillis": 3.14, # Total time spent only on successful uses, in milliseconds. |
| "totalFailures": 3.14, # The number of failed attempts to use the underlying entry. |
| }, |
| }, |
| }, |
| "userSpecifiedSystem": "A String", # Indicates the entry's source system that Data Catalog doesn't automatically integrate with. The `user_specified_system` string has the following limitations: * Is case insensitive. * Must begin with a letter or underscore. * Can only contain letters, numbers, and underscores. * Must be at least 1 character and at most 64 characters long. |
| "userSpecifiedType": "A String", # Custom entry type that doesn't match any of the values allowed for input and listed in the `EntryType` enum. When creating an entry, first check the type values in the enum. If there are no appropriate types for the new entry, provide a custom value, for example, `my_special_type`. The `user_specified_type` string has the following limitations: * Is case insensitive. * Must begin with a letter or underscore. * Can only contain letters, numbers, and underscores. * Must be at least 1 character and at most 64 characters long. |
| } |
| |
| updateMask: string, Names of fields whose values to overwrite on an entry. If this parameter is absent or empty, all modifiable fields are overwritten. If such fields are non-required and omitted in the request body, their values are emptied. You can modify only the fields listed below. For entries with type `DATA_STREAM`: * `schema` For entries with type `FILESET`: * `schema` * `display_name` * `description` * `gcs_fileset_spec` * `gcs_fileset_spec.file_patterns` For entries with `user_specified_type`: * `schema` * `display_name` * `description` * `user_specified_type` * `user_specified_system` * `linked_resource` * `source_system_timestamps` |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Entry metadata. A Data Catalog entry represents another resource in Google Cloud Platform (such as a BigQuery dataset or a Pub/Sub topic) or outside of it. You can use the `linked_resource` field in the entry resource to refer to the original resource ID of the source system. An entry resource contains resource details, for example, its schema. Additionally, you can attach flexible metadata to an entry in the form of a Tag. |
| "bigqueryDateShardedSpec": { # Specification for a group of BigQuery tables with the `[prefix]YYYYMMDD` name pattern. For more information, see [Introduction to partitioned tables] (https://cloud.google.com/bigquery/docs/partitioned-tables#partitioning_versus_sharding). # Specification for a group of BigQuery tables with the `[prefix]YYYYMMDD` name pattern. For more information, see [Introduction to partitioned tables] (https://cloud.google.com/bigquery/docs/partitioned-tables#partitioning_versus_sharding). |
| "dataset": "A String", # Output only. The Data Catalog resource name of the dataset entry the current table belongs to. For example: `projects/{PROJECT_ID}/locations/{LOCATION}/entrygroups/{ENTRY_GROUP_ID}/entries/{ENTRY_ID}`. |
| "latestShardResource": "A String", # Output only. BigQuery resource name of the latest shard. |
| "shardCount": "A String", # Output only. Total number of shards. |
| "tablePrefix": "A String", # Output only. The table name prefix of the shards. The name of any given shard is `[table_prefix]YYYYMMDD`. For example, for the `MyTable20180101` shard, the `table_prefix` is `MyTable`. |
| }, |
| "bigqueryTableSpec": { # Describes a BigQuery table. # Specification that applies to a BigQuery table. Valid only for entries with the `TABLE` type. |
| "tableSourceType": "A String", # Output only. The table source type. |
| "tableSpec": { # Normal BigQuery table specification. # Specification of a BigQuery table. Populated only if the `table_source_type` is `BIGQUERY_TABLE`. |
| "groupedEntry": "A String", # Output only. If the table is date-sharded, that is, it matches the `[prefix]YYYYMMDD` name pattern, this field is the Data Catalog resource name of the date-sharded grouped entry. For example: `projects/{PROJECT_ID}/locations/{LOCATION}/entrygroups/{ENTRY_GROUP_ID}/entries/{ENTRY_ID}`. Otherwise, `grouped_entry` is empty. |
| }, |
| "viewSpec": { # Table view specification. # Table view specification. Populated only if the `table_source_type` is `BIGQUERY_VIEW`. |
| "viewQuery": "A String", # Output only. The query that defines the table view. |
| }, |
| }, |
| "dataSource": { # Physical location of an entry. # Output only. Physical location of the entry. |
| "resource": "A String", # Full name of a resource as defined by the service. For example: `//bigquery.googleapis.com/projects/{PROJECT_ID}/locations/{LOCATION}/datasets/{DATASET_ID}/tables/{TABLE_ID}` |
| "service": "A String", # Service that physically stores the data. |
| }, |
| "dataSourceConnectionSpec": { # Specification that applies to a data source connection. Valid only for entries with the `DATA_SOURCE_CONNECTION` type. # Specification that applies to a data source connection. Valid only for entries with the `DATA_SOURCE_CONNECTION` type. |
| "bigqueryConnectionSpec": { # Specification for the BigQuery connection. # Fields specific to BigQuery connections. |
| "cloudSql": { # Specification for the BigQuery connection to a Cloud SQL instance. # Specification for the BigQuery connection to a Cloud SQL instance. |
| "database": "A String", # Database name. |
| "instanceId": "A String", # Cloud SQL instance ID in the format of `project:location:instance`. |
| "type": "A String", # Type of the Cloud SQL database. |
| }, |
| "connectionType": "A String", # The type of the BigQuery connection. |
| "hasCredential": True or False, # True if there are credentials attached to the BigQuery connection; false otherwise. |
| }, |
| }, |
| "databaseTableSpec": { # Specification that applies to a table resource. Valid only for entries with the `TABLE` type. # Specification that applies to a table resource. Valid only for entries with the `TABLE` type. |
| "type": "A String", # Type of this table. |
| }, |
| "description": "A String", # Entry description that can consist of several sentences or paragraphs that describe entry contents. The description must not contain Unicode non-characters as well as C0 and C1 control codes except tabs (HT), new lines (LF), carriage returns (CR), and page breaks (FF). The maximum size is 2000 bytes when encoded in UTF-8. Default value is an empty string. |
| "displayName": "A String", # Display name of an entry. The name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), and can't start or end with spaces. The maximum size is 200 bytes when encoded in UTF-8. Default value is an empty string. |
| "fullyQualifiedName": "A String", # Fully qualified name (FQN) of the resource. Set automatically for entries representing resources from synced systems. Settable only during creation and read-only afterwards. Can be used for search and lookup of the entries. 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}` |
| "gcsFilesetSpec": { # Describes a Cloud Storage fileset entry. # Specification that applies to a Cloud Storage fileset. Valid only for entries with the `FILESET` type. |
| "filePatterns": [ # Required. Patterns to identify a set of files in Google Cloud Storage. For more information, see [Wildcard Names] (https://cloud.google.com/storage/docs/gsutil/addlhelp/WildcardNames). Note: Currently, bucket wildcards are not supported. Examples of valid `file_patterns`: * `gs://bucket_name/dir/*`: matches all files in `bucket_name/dir` directory * `gs://bucket_name/dir/**`: matches all files in `bucket_name/dir` and all subdirectories * `gs://bucket_name/file*`: matches files prefixed by `file` in `bucket_name` * `gs://bucket_name/??.txt`: matches files with two characters followed by `.txt` in `bucket_name` * `gs://bucket_name/[aeiou].txt`: matches files that contain a single vowel character followed by `.txt` in `bucket_name` * `gs://bucket_name/[a-m].txt`: matches files that contain `a`, `b`, ... or `m` followed by `.txt` in `bucket_name` * `gs://bucket_name/a/*/b`: matches all files in `bucket_name` that match the `a/*/b` pattern, such as `a/c/b`, `a/d/b` * `gs://another_bucket/a.txt`: matches `gs://another_bucket/a.txt` You can combine wildcards to match complex sets of files, for example: `gs://bucket_name/[a-m]??.j*g` |
| "A String", |
| ], |
| "sampleGcsFileSpecs": [ # Output only. Sample files contained in this fileset, not all files contained in this fileset are represented here. |
| { # Specification of a single file in Cloud Storage. |
| "filePath": "A String", # Required. Full file path. Example: `gs://bucket_name/a/b.txt`. |
| "gcsTimestamps": { # Timestamps associated with this resource in a particular system. # Output only. Creation, modification, and expiration timestamps of a Cloud Storage file. |
| "createTime": "A String", # Creation timestamp of the resource within the given system. |
| "expireTime": "A String", # Output only. Expiration timestamp of the resource within the given system. Currently only applicable to BigQuery resources. |
| "updateTime": "A 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. |
| }, |
| "sizeBytes": "A String", # Output only. File size in bytes. |
| }, |
| ], |
| }, |
| "integratedSystem": "A String", # Output only. Indicates the entry's source system that Data Catalog integrates with, such as BigQuery, Pub/Sub, or Dataproc Metastore. |
| "labels": { # Cloud labels attached to the entry. In Data Catalog, you can create and modify labels attached only to custom entries. Synced entries have unmodifiable labels that come from the source system. |
| "a_key": "A String", |
| }, |
| "linkedResource": "A String", # The resource this metadata entry refers to. For Google Cloud Platform resources, `linked_resource` is the [Full Resource Name] (https://cloud.google.com/apis/design/resource_names#full_resource_name). For example, the `linked_resource` for a table resource from BigQuery is: `//bigquery.googleapis.com/projects/{PROJECT_ID}/datasets/{DATASET_ID}/tables/{TABLE_ID}` Output only when the entry is one of the types in the `EntryType` enum. For entries with a `user_specified_type`, this field is optional and defaults to an empty string. The resource string must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), periods (.), colons (:), slashes (/), dashes (-), and hashes (#). The maximum size is 200 bytes when encoded in UTF-8. |
| "name": "A String", # Output only. The resource name of an entry in URL format. Note: The entry itself and its child resources might not be stored in the location specified in its name. |
| "routineSpec": { # Specification that applies to a routine. Valid only for entries with the `ROUTINE` type. # Specification that applies to a user-defined function or procedure. Valid only for entries with the `ROUTINE` type. |
| "bigqueryRoutineSpec": { # Fields specific for BigQuery routines. # Fields specific for BigQuery routines. |
| "importedLibraries": [ # Paths of the imported libraries. |
| "A String", |
| ], |
| }, |
| "definitionBody": "A String", # The body of the routine. |
| "language": "A String", # The language the routine is written in. The exact value depends on the source system. For BigQuery routines, possible values are: * `SQL` * `JAVASCRIPT` |
| "returnType": "A String", # Return type of the argument. The exact value depends on the source system and the language. |
| "routineArguments": [ # Arguments of the routine. |
| { # Input or output argument of a function or stored procedure. |
| "mode": "A String", # Specifies whether the argument is input or output. |
| "name": "A String", # The name of the argument. A return argument of a function might not have a name. |
| "type": "A String", # Type of the argument. The exact value depends on the source system and the language. |
| }, |
| ], |
| "routineType": "A String", # The type of the routine. |
| }, |
| "schema": { # Represents a schema, for example, a BigQuery, GoogleSQL, or Avro schema. # Schema of the entry. An entry might not have any schema attached to it. |
| "columns": [ # The unified GoogleSQL-like schema of columns. The overall maximum number of columns and nested columns is 10,000. The maximum nested depth is 15 levels. |
| { # A column within a schema. Columns can be nested inside other columns. |
| "column": "A String", # Required. Name of the column. Must be a UTF-8 string without dots (.). The maximum size is 64 bytes. |
| "description": "A String", # Optional. Description of the column. Default value is an empty string. The description must be a UTF-8 string with the maximum size of 2000 bytes. |
| "mode": "A String", # Optional. A column's mode indicates whether values in this column are required, nullable, or repeated. Only `NULLABLE`, `REQUIRED`, and `REPEATED` values are supported. Default mode is `NULLABLE`. |
| "subcolumns": [ # Optional. Schema of sub-columns. A column can have zero or more sub-columns. |
| # Object with schema name: GoogleCloudDatacatalogV1ColumnSchema |
| ], |
| "type": "A String", # Required. Type of the column. Must be a UTF-8 string with the maximum size of 128 bytes. |
| }, |
| ], |
| }, |
| "sourceSystemTimestamps": { # Timestamps associated with this resource in a particular system. # Timestamps from the underlying resource, not from the Data Catalog entry. Output only when the entry has a type listed in the `EntryType` enum. For entries with `user_specified_type`, this field is optional and defaults to an empty timestamp. |
| "createTime": "A String", # Creation timestamp of the resource within the given system. |
| "expireTime": "A String", # Output only. Expiration timestamp of the resource within the given system. Currently only applicable to BigQuery resources. |
| "updateTime": "A 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. |
| }, |
| "type": "A String", # The type of the entry. Only used for entries with types listed in the `EntryType` enum. Currently, only `FILESET` enum value is allowed. All other entries created in Data Catalog must use the `user_specified_type`. |
| "usageSignal": { # The set of all usage signals that Data Catalog stores. Note: Usually, these signals are updated daily. In rare cases, an update may fail but will be performed again on the next day. # Output only. Resource usage statistics. |
| "updateTime": "A String", # The end timestamp of the duration of usage statistics. |
| "usageWithinTimeRange": { # Usage statistics over each of the predefined time ranges. Supported time ranges are `{"24H", "7D", "30D"}`. |
| "a_key": { # Detailed statistics on the entry's usage. Usage statistics have the following limitations: - Only BigQuery tables have them. - They only include BigQuery query jobs. - They might be underestimated because wildcard table references are not yet counted. For more information, see [Querying multiple tables using a wildcard table] (https://cloud.google.com/bigquery/docs/querying-wildcard-tables) |
| "totalCancellations": 3.14, # The number of cancelled attempts to use the underlying entry. |
| "totalCompletions": 3.14, # The number of successful uses of the underlying entry. |
| "totalExecutionTimeForCompletionsMillis": 3.14, # Total time spent only on successful uses, in milliseconds. |
| "totalFailures": 3.14, # The number of failed attempts to use the underlying entry. |
| }, |
| }, |
| }, |
| "userSpecifiedSystem": "A String", # Indicates the entry's source system that Data Catalog doesn't automatically integrate with. The `user_specified_system` string has the following limitations: * Is case insensitive. * Must begin with a letter or underscore. * Can only contain letters, numbers, and underscores. * Must be at least 1 character and at most 64 characters long. |
| "userSpecifiedType": "A String", # Custom entry type that doesn't match any of the values allowed for input and listed in the `EntryType` enum. When creating an entry, first check the type values in the enum. If there are no appropriate types for the new entry, provide a custom value, for example, `my_special_type`. The `user_specified_type` string has the following limitations: * Is case insensitive. * Must begin with a letter or underscore. * Can only contain letters, numbers, and underscores. * Must be at least 1 character and at most 64 characters long. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</code> |
| <pre>Gets your permissions on a resource. Returns an empty set of permissions if the resource doesn't exist. Supported resources are: - Tag templates - Entry groups Note: This method gets policies only within Data Catalog and can't be used to get policies from BigQuery, Pub/Sub, Dataproc Metastore, and any external Google Cloud Platform resources ingested into Data Catalog. No Google IAM permissions are required to call this method. |
| |
| Args: |
| resource: string, REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # Request message for `TestIamPermissions` method. |
| "permissions": [ # The set of permissions to check for the `resource`. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). |
| "A String", |
| ], |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Response message for `TestIamPermissions` method. |
| "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed. |
| "A String", |
| ], |
| }</pre> |
| </div> |
| |
| </body></html> |
