googleapis
Version:
Google APIs Client Library for Node.js
873 lines • 361 kB
TypeScript
import { OAuth2Client, JWT, Compute, UserRefreshClient, BaseExternalAccountClient, GaxiosResponseWithHTTP2, GoogleConfigurable, MethodOptions, StreamMethodOptions, GlobalOptions, GoogleAuth, BodyResponseCallback, APIRequestContext } from 'googleapis-common';
import { Readable } from 'stream';
export declare namespace datacatalog_v1beta1 {
export interface Options extends GlobalOptions {
version: 'v1beta1';
}
interface StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient | BaseExternalAccountClient | GoogleAuth;
/**
* V1 error format.
*/
'$.xgafv'?: string;
/**
* OAuth access token.
*/
access_token?: string;
/**
* Data format for response.
*/
alt?: string;
/**
* JSONP
*/
callback?: string;
/**
* Selector specifying which fields to include in a partial response.
*/
fields?: string;
/**
* API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
*/
key?: string;
/**
* OAuth 2.0 token for the current user.
*/
oauth_token?: string;
/**
* Returns response with indentations and line breaks.
*/
prettyPrint?: boolean;
/**
* Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
*/
quotaUser?: string;
/**
* Legacy upload protocol for media (e.g. "media", "multipart").
*/
uploadType?: string;
/**
* Upload protocol for media (e.g. "raw", "multipart").
*/
upload_protocol?: string;
}
/**
* Google Cloud Data Catalog API
*
* A fully managed and highly scalable data discovery and metadata management service.
*
* @example
* ```js
* const {google} = require('googleapis');
* const datacatalog = google.datacatalog('v1beta1');
* ```
*/
export class Datacatalog {
context: APIRequestContext;
catalog: Resource$Catalog;
entries: Resource$Entries;
projects: Resource$Projects;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
/**
* Associates `members`, or principals, with a `role`.
*/
export interface Schema$Binding {
/**
* 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).
*/
condition?: Schema$Expr;
/**
* Specifies the principals requesting access for a Google Cloud 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. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid\}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid\}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid\}.svc.id.goog[{namespace\}/{kubernetes-sa\}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid\}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain\}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id\}/subject/{subject_attribute_value\}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id\}/group/{group_id\}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id\}/attribute.{attribute_name\}/{attribute_value\}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id\}/x`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number\}/locations/global/workloadIdentityPools/{pool_id\}/subject/{subject_attribute_value\}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number\}/locations/global/workloadIdentityPools/{pool_id\}/group/{group_id\}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number\}/locations/global/workloadIdentityPools/{pool_id\}/attribute.{attribute_name\}/{attribute_value\}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number\}/locations/global/workloadIdentityPools/{pool_id\}/x`: All identities in a workload identity pool. * `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. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id\}/subject/{subject_attribute_value\}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
*/
members?: string[] | null;
/**
* Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).
*/
role?: string | null;
}
/**
* 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); \}
*/
export interface Schema$Empty {
}
/**
* 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.
*/
export interface Schema$Expr {
/**
* Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
*/
description?: string | null;
/**
* Textual representation of an expression in Common Expression Language syntax.
*/
expression?: string | null;
/**
* Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
*/
location?: string | null;
/**
* 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.
*/
title?: string | null;
}
/**
* Request message for `GetIamPolicy` method.
*/
export interface Schema$GetIamPolicyRequest {
/**
* OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`.
*/
options?: Schema$GetPolicyOptions;
}
/**
* Encapsulates settings provided to GetIamPolicy.
*/
export interface Schema$GetPolicyOptions {
/**
* Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
*/
requestedPolicyVersion?: number | null;
}
/**
* Spec for a group of BigQuery tables with name pattern `[prefix]YYYYMMDD`. Context: https://cloud.google.com/bigquery/docs/partitioned-tables#partitioning_versus_sharding
*/
export interface Schema$GoogleCloudDatacatalogV1beta1BigQueryDateShardedSpec {
/**
* 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\}`.
*/
dataset?: string | null;
/**
* Output only. Total number of shards.
*/
shardCount?: string | null;
/**
* Output only. The table name prefix of the shards. The name of any given shard is `[table_prefix]YYYYMMDD`, for example, for shard `MyTable20180101`, the `table_prefix` is `MyTable`.
*/
tablePrefix?: string | null;
}
/**
* Describes a BigQuery table.
*/
export interface Schema$GoogleCloudDatacatalogV1beta1BigQueryTableSpec {
/**
* Output only. The table source type.
*/
tableSourceType?: string | null;
/**
* Spec of a BigQuery table. This field should only be populated if `table_source_type` is `BIGQUERY_TABLE`.
*/
tableSpec?: Schema$GoogleCloudDatacatalogV1beta1TableSpec;
/**
* Table view specification. This field should only be populated if `table_source_type` is `BIGQUERY_VIEW`.
*/
viewSpec?: Schema$GoogleCloudDatacatalogV1beta1ViewSpec;
}
/**
* Representation of a column within a schema. Columns could be nested inside other columns.
*/
export interface Schema$GoogleCloudDatacatalogV1beta1ColumnSchema {
/**
* Required. Name of the column.
*/
column?: string | null;
/**
* Optional. Description of the column. Default value is an empty string.
*/
description?: string | null;
/**
* Optional. A column's mode indicates whether the values in this column are required, nullable, etc. Only `NULLABLE`, `REQUIRED` and `REPEATED` are supported. Default mode is `NULLABLE`.
*/
mode?: string | null;
/**
* Optional. Schema of sub-columns. A column can have zero or more sub-columns.
*/
subcolumns?: Schema$GoogleCloudDatacatalogV1beta1ColumnSchema[];
/**
* Required. Type of the column.
*/
type?: string | null;
}
/**
* Entry Metadata. A Data Catalog Entry resource represents another resource in Google Cloud Platform (such as a BigQuery dataset or a Pub/Sub topic), or outside of Google Cloud Platform. Clients 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, such as its schema. An Entry can also be used to attach flexible metadata, such as a Tag.
*/
export interface Schema$GoogleCloudDatacatalogV1beta1Entry {
/**
* Specification for a group of BigQuery tables with name pattern `[prefix]YYYYMMDD`. Context: https://cloud.google.com/bigquery/docs/partitioned-tables#partitioning_versus_sharding.
*/
bigqueryDateShardedSpec?: Schema$GoogleCloudDatacatalogV1beta1BigQueryDateShardedSpec;
/**
* Specification that applies to a BigQuery table. This is only valid on entries of type `TABLE`.
*/
bigqueryTableSpec?: Schema$GoogleCloudDatacatalogV1beta1BigQueryTableSpec;
/**
* Entry description, which can consist of several sentences or paragraphs that describe entry contents. Default value is an empty string.
*/
description?: string | null;
/**
* Display information such as title and description. A short name to identify the entry, for example, "Analytics Data - Jan 2011". Default value is an empty string.
*/
displayName?: string | null;
/**
* Specification that applies to a Cloud Storage fileset. This is only valid on entries of type FILESET.
*/
gcsFilesetSpec?: Schema$GoogleCloudDatacatalogV1beta1GcsFilesetSpec;
/**
* Output only. This field indicates the entry's source system that Data Catalog integrates with, such as BigQuery or Pub/Sub.
*/
integratedSystem?: string | null;
/**
* The resource this metadata entry refers to. For Google Cloud Platform resources, `linked_resource` is the [full name of the resource](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/projectId/datasets/datasetId/tables/tableId Output only when Entry is of type in the EntryType enum. For entries with user_specified_type, this field is optional and defaults to an empty string.
*/
linkedResource?: string | null;
/**
* Output only. Identifier. The Data Catalog resource name of the entry in URL format. Example: * projects/{project_id\}/locations/{location\}/entryGroups/{entry_group_id\}/entries/{entry_id\} Note that this Entry and its child resources may not actually be stored in the location in this name.
*/
name?: string | null;
/**
* Schema of the entry. An entry might not have any schema attached to it.
*/
schema?: Schema$GoogleCloudDatacatalogV1beta1Schema;
/**
* Output only. Timestamps about the underlying resource, not about this Data Catalog entry. Output only when Entry is of type in the EntryType enum. For entries with user_specified_type, this field is optional and defaults to an empty timestamp.
*/
sourceSystemTimestamps?: Schema$GoogleCloudDatacatalogV1beta1SystemTimestamps;
/**
* The type of the entry. Only used for Entries with types in the EntryType enum.
*/
type?: string | null;
/**
* Output only. Statistics on the usage level of the resource.
*/
usageSignal?: Schema$GoogleCloudDatacatalogV1beta1UsageSignal;
/**
* This field indicates the entry's source system that Data Catalog does not integrate with. `user_specified_system` strings must begin with a letter or underscore and can only contain letters, numbers, and underscores; are case insensitive; must be at least 1 character and at most 64 characters long.
*/
userSpecifiedSystem?: string | null;
/**
* Entry type if it does not fit any of the input-allowed values listed in `EntryType` enum above. When creating an entry, users should check the enum values first, if nothing matches the entry to be created, then provide a custom value, for example "my_special_type". `user_specified_type` strings must begin with a letter or underscore and can only contain letters, numbers, and underscores; are case insensitive; must be at least 1 character and at most 64 characters long. Currently, only FILESET enum value is allowed. All other entries created through Data Catalog must use `user_specified_type`.
*/
userSpecifiedType?: string | null;
}
/**
* EntryGroup Metadata. An EntryGroup resource represents a logical grouping of zero or more Data Catalog Entry resources.
*/
export interface Schema$GoogleCloudDatacatalogV1beta1EntryGroup {
/**
* Output only. Timestamps about this EntryGroup. Default value is empty timestamps.
*/
dataCatalogTimestamps?: Schema$GoogleCloudDatacatalogV1beta1SystemTimestamps;
/**
* Entry group description, which can consist of several sentences or paragraphs that describe entry group contents. Default value is an empty string.
*/
description?: string | null;
/**
* A short name to identify the entry group, for example, "analytics data - jan 2011". Default value is an empty string.
*/
displayName?: string | null;
/**
* Identifier. The resource name of the entry group in URL format. Example: * projects/{project_id\}/locations/{location\}/entryGroups/{entry_group_id\} Note that this EntryGroup and its child resources may not actually be stored in the location in this name.
*/
name?: string | null;
}
/**
* Response message for ExportTaxonomies.
*/
export interface Schema$GoogleCloudDatacatalogV1beta1ExportTaxonomiesResponse {
/**
* List of taxonomies and policy tags in a tree structure.
*/
taxonomies?: Schema$GoogleCloudDatacatalogV1beta1SerializedTaxonomy[];
}
export interface Schema$GoogleCloudDatacatalogV1beta1FieldType {
/**
* Represents an enum type.
*/
enumType?: Schema$GoogleCloudDatacatalogV1beta1FieldTypeEnumType;
/**
* Represents primitive types - string, bool etc.
*/
primitiveType?: string | null;
}
export interface Schema$GoogleCloudDatacatalogV1beta1FieldTypeEnumType {
allowedValues?: Schema$GoogleCloudDatacatalogV1beta1FieldTypeEnumTypeEnumValue[];
}
export interface Schema$GoogleCloudDatacatalogV1beta1FieldTypeEnumTypeEnumValue {
/**
* Required. The display name of the enum value. Must not be an empty string.
*/
displayName?: string | null;
}
/**
* Describes a Cloud Storage fileset entry.
*/
export interface Schema$GoogleCloudDatacatalogV1beta1GcsFilesetSpec {
/**
* Required. Patterns to identify a set of files in Google Cloud Storage. See [Cloud Storage documentation](https://cloud.google.com/storage/docs/wildcards) for more information. Note that bucket wildcards are currently not supported. Examples of valid file_patterns: * `gs://bucket_name/dir/x`: matches all files within `bucket_name/dir` directory. * `gs://bucket_name/dir/x*`: matches all files in `bucket_name/dir` spanning 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/x/b`: matches all files in `bucket_name` that match `a/x/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 provide more powerful matches, for example: * `gs://bucket_name/[a-m]??.j*g`
*/
filePatterns?: string[] | null;
/**
* Output only. Sample files contained in this fileset, not all files contained in this fileset are represented here.
*/
sampleGcsFileSpecs?: Schema$GoogleCloudDatacatalogV1beta1GcsFileSpec[];
}
/**
* Specifications of a single file in Cloud Storage.
*/
export interface Schema$GoogleCloudDatacatalogV1beta1GcsFileSpec {
/**
* Required. The full file path. Example: `gs://bucket_name/a/b.txt`.
*/
filePath?: string | null;
/**
* Output only. Timestamps about the Cloud Storage file.
*/
gcsTimestamps?: Schema$GoogleCloudDatacatalogV1beta1SystemTimestamps;
/**
* Output only. The size of the file, in bytes.
*/
sizeBytes?: string | null;
}
/**
* Request message for ImportTaxonomies.
*/
export interface Schema$GoogleCloudDatacatalogV1beta1ImportTaxonomiesRequest {
/**
* Inline source used for taxonomies to be imported.
*/
inlineSource?: Schema$GoogleCloudDatacatalogV1beta1InlineSource;
}
/**
* Response message for ImportTaxonomies.
*/
export interface Schema$GoogleCloudDatacatalogV1beta1ImportTaxonomiesResponse {
/**
* Taxonomies that were imported.
*/
taxonomies?: Schema$GoogleCloudDatacatalogV1beta1Taxonomy[];
}
/**
* Inline source used for taxonomies import.
*/
export interface Schema$GoogleCloudDatacatalogV1beta1InlineSource {
/**
* Required. Taxonomies to be imported.
*/
taxonomies?: Schema$GoogleCloudDatacatalogV1beta1SerializedTaxonomy[];
}
/**
* Response message for ListEntries.
*/
export interface Schema$GoogleCloudDatacatalogV1beta1ListEntriesResponse {
/**
* Entry details.
*/
entries?: Schema$GoogleCloudDatacatalogV1beta1Entry[];
/**
* Token to retrieve the next page of results. It is set to empty if no items remain in results.
*/
nextPageToken?: string | null;
}
/**
* Response message for ListEntryGroups.
*/
export interface Schema$GoogleCloudDatacatalogV1beta1ListEntryGroupsResponse {
/**
* EntryGroup details.
*/
entryGroups?: Schema$GoogleCloudDatacatalogV1beta1EntryGroup[];
/**
* Token to retrieve the next page of results. It is set to empty if no items remain in results.
*/
nextPageToken?: string | null;
}
/**
* Response message for ListPolicyTags.
*/
export interface Schema$GoogleCloudDatacatalogV1beta1ListPolicyTagsResponse {
/**
* Token used to retrieve the next page of results, or empty if there are no more results in the list.
*/
nextPageToken?: string | null;
/**
* The policy tags that are in the requested taxonomy.
*/
policyTags?: Schema$GoogleCloudDatacatalogV1beta1PolicyTag[];
}
/**
* Response message for ListTags.
*/
export interface Schema$GoogleCloudDatacatalogV1beta1ListTagsResponse {
/**
* Token to retrieve the next page of results. It is set to empty if no items remain in results.
*/
nextPageToken?: string | null;
/**
* Tag details.
*/
tags?: Schema$GoogleCloudDatacatalogV1beta1Tag[];
}
/**
* Response message for ListTaxonomies.
*/
export interface Schema$GoogleCloudDatacatalogV1beta1ListTaxonomiesResponse {
/**
* Token used to retrieve the next page of results, or empty if there are no more results in the list.
*/
nextPageToken?: string | null;
/**
* Taxonomies that the project contains.
*/
taxonomies?: Schema$GoogleCloudDatacatalogV1beta1Taxonomy[];
}
/**
* Denotes one policy tag in a taxonomy (e.g. ssn). Policy Tags can be defined in a hierarchy. For example, consider the following hierarchy: Geolocation -\> (LatLong, City, ZipCode). PolicyTag "Geolocation" contains three child policy tags: "LatLong", "City", and "ZipCode".
*/
export interface Schema$GoogleCloudDatacatalogV1beta1PolicyTag {
/**
* Output only. Resource names of child policy tags of this policy tag.
*/
childPolicyTags?: string[] | null;
/**
* Description of this policy tag. It must: contain only unicode characters, tabs, newlines, carriage returns and page breaks; and be at most 2000 bytes long when encoded in UTF-8. If not set, defaults to an empty description. If not set, defaults to an empty description.
*/
description?: string | null;
/**
* Required. User defined name of this policy tag. It must: be unique within the parent taxonomy; contain only unicode letters, numbers, underscores, dashes and spaces; not start or end with spaces; and be at most 200 bytes long when encoded in UTF-8.
*/
displayName?: string | null;
/**
* Identifier. Resource name of this policy tag, whose format is: "projects/{project_number\}/locations/{location_id\}/taxonomies/{taxonomy_id\}/policyTags/{id\}".
*/
name?: string | null;
/**
* Resource name of this policy tag's parent policy tag (e.g. for the "LatLong" policy tag in the example above, this field contains the resource name of the "Geolocation" policy tag). If empty, it means this policy tag is a top level policy tag (e.g. this field is empty for the "Geolocation" policy tag in the example above). If not set, defaults to an empty string.
*/
parentPolicyTag?: string | null;
}
/**
* Request message for RenameTagTemplateFieldEnumValue.
*/
export interface Schema$GoogleCloudDatacatalogV1beta1RenameTagTemplateFieldEnumValueRequest {
/**
* Required. The new display name of the enum value. For example, `my_new_enum_value`.
*/
newEnumValueDisplayName?: string | null;
}
/**
* Request message for RenameTagTemplateField.
*/
export interface Schema$GoogleCloudDatacatalogV1beta1RenameTagTemplateFieldRequest {
/**
* Required. The new ID of this tag template field. For example, `my_new_field`.
*/
newTagTemplateFieldId?: string | null;
}
/**
* Represents a schema (e.g. BigQuery, GoogleSQL, Avro schema).
*/
export interface Schema$GoogleCloudDatacatalogV1beta1Schema {
/**
* Required. Schema of columns. A maximum of 10,000 columns and sub-columns can be specified.
*/
columns?: Schema$GoogleCloudDatacatalogV1beta1ColumnSchema[];
}
/**
* Request message for SearchCatalog.
*/
export interface Schema$GoogleCloudDatacatalogV1beta1SearchCatalogRequest {
/**
* Specifies the ordering of results, currently supported case-sensitive choices are: * `relevance`, only supports descending * `last_modified_timestamp [asc|desc]`, defaults to descending if not specified * `default` that can only be descending If not specified, defaults to `relevance` descending.
*/
orderBy?: string | null;
/**
* Number of results in the search page. If <=0 then defaults to 10. Max limit for page_size is 1000. Throws an invalid argument for page_size \> 1000.
*/
pageSize?: number | null;
/**
* Optional. Pagination token returned in an earlier SearchCatalogResponse.next_page_token, which indicates that this is a continuation of a prior SearchCatalogRequest call, and that the system should return the next page of data. If empty, the first page is returned.
*/
pageToken?: string | null;
/**
* Optional. The query string in search query syntax. An empty query string will result in all data assets (in the specified scope) that the user has access to. Query strings can be simple as "x" or more qualified as: * name:x * column:x * description:y Note: Query tokens need to have a minimum of 3 characters for substring matching to work correctly. See [Data Catalog Search Syntax](https://cloud.google.com/data-catalog/docs/how-to/search-reference) for more information.
*/
query?: string | null;
/**
* Required. The scope of this search request. A `scope` that has empty `include_org_ids`, `include_project_ids` AND false `include_gcp_public_datasets` is considered invalid. Data Catalog will return an error in such a case.
*/
scope?: Schema$GoogleCloudDatacatalogV1beta1SearchCatalogRequestScope;
}
/**
* The criteria that select the subspace used for query matching.
*/
export interface Schema$GoogleCloudDatacatalogV1beta1SearchCatalogRequestScope {
/**
* If `true`, include Google Cloud public datasets in the search results. Info on Google Cloud public datasets is available at https://cloud.google.com/public-datasets/. By default, Google Cloud public datasets are excluded.
*/
includeGcpPublicDatasets?: boolean | null;
/**
* The list of organization IDs to search within. To find your organization ID, follow instructions in https://cloud.google.com/resource-manager/docs/creating-managing-organization.
*/
includeOrgIds?: string[] | null;
/**
* The list of project IDs to search within. To learn more about the distinction between project names/IDs/numbers, go to https://cloud.google.com/docs/overview/#projects.
*/
includeProjectIds?: string[] | null;
/**
* Optional. The list of locations to search within. 1. If empty, search will be performed in all locations; 2. If any of the locations are NOT in the valid locations list, error will be returned; 3. Otherwise, search only the given locations for matching results. Typical usage is to leave this field empty. When a location is unreachable as returned in the `SearchCatalogResponse.unreachable` field, users can repeat the search request with this parameter set to get additional information on the error. Valid locations: * asia-east1 * asia-east2 * asia-northeast1 * asia-northeast2 * asia-northeast3 * asia-south1 * asia-southeast1 * australia-southeast1 * eu * europe-north1 * europe-west1 * europe-west2 * europe-west3 * europe-west4 * europe-west6 * global * northamerica-northeast1 * southamerica-east1 * us * us-central1 * us-east1 * us-east4 * us-west1 * us-west2
*/
restrictedLocations?: string[] | null;
}
/**
* Response message for SearchCatalog.
*/
export interface Schema$GoogleCloudDatacatalogV1beta1SearchCatalogResponse {
/**
* The token that can be used to retrieve the next page of results.
*/
nextPageToken?: string | null;
/**
* Search results.
*/
results?: Schema$GoogleCloudDatacatalogV1beta1SearchCatalogResult[];
/**
* The approximate total number of entries matched by the query.
*/
totalSize?: number | null;
/**
* Unreachable locations. Search result does not include data from those locations. Users can get additional information on the error by repeating the search request with a more restrictive parameter -- setting the value for `SearchDataCatalogRequest.scope.restricted_locations`.
*/
unreachable?: string[] | null;
}
/**
* A result that appears in the response of a search request. Each result captures details of one entry that matches the search.
*/
export interface Schema$GoogleCloudDatacatalogV1beta1SearchCatalogResult {
/**
* The full name of the cloud resource the entry belongs to. See: https://cloud.google.com/apis/design/resource_names#full_resource_name. Example: * `//bigquery.googleapis.com/projects/projectId/datasets/datasetId/tables/tableId`
*/
linkedResource?: string | null;
/**
* Last-modified timestamp of the entry from the managing system.
*/
modifyTime?: string | null;
/**
* The relative resource name of the resource in URL format. Examples: * `projects/{project_id\}/locations/{location_id\}/entryGroups/{entry_group_id\}/entries/{entry_id\}` * `projects/{project_id\}/tagTemplates/{tag_template_id\}`
*/
relativeResourceName?: string | null;
/**
* Sub-type of the search result. This is a dot-delimited description of the resource's full type, and is the same as the value callers would provide in the "type" search facet. Examples: `entry.table`, `entry.dataStream`, `tagTemplate`.
*/
searchResultSubtype?: string | null;
/**
* Type of the search result. This field can be used to determine which Get method to call to fetch the full resource.
*/
searchResultType?: string | null;
}
/**
* Message representing one policy tag when exported as a nested proto.
*/
export interface Schema$GoogleCloudDatacatalogV1beta1SerializedPolicyTag {
/**
* Children of the policy tag if any.
*/
childPolicyTags?: Schema$GoogleCloudDatacatalogV1beta1SerializedPolicyTag[];
/**
* Description of the serialized policy tag. The length of the description is limited to 2000 bytes when encoded in UTF-8. If not set, defaults to an empty description.
*/
description?: string | null;
/**
* Required. Display name of the policy tag. Max 200 bytes when encoded in UTF-8.
*/
displayName?: string | null;
/**
* Resource name of the policy tag. This field will be ignored when calling ImportTaxonomies.
*/
policyTag?: string | null;
}
/**
* Message capturing a taxonomy and its policy tag hierarchy as a nested proto. Used for taxonomy import/export and mutation.
*/
export interface Schema$GoogleCloudDatacatalogV1beta1SerializedTaxonomy {
/**
* A list of policy types that are activated for a taxonomy.
*/
activatedPolicyTypes?: string[] | null;
/**
* Description of the serialized taxonomy. The length of the description is limited to 2000 bytes when encoded in UTF-8. If not set, defaults to an empty description.
*/
description?: string | null;
/**
* Required. Display name of the taxonomy. Max 200 bytes when encoded in UTF-8.
*/
displayName?: string | null;
/**
* Top level policy tags associated with the taxonomy if any.
*/
policyTags?: Schema$GoogleCloudDatacatalogV1beta1SerializedPolicyTag[];
}
/**
* Timestamps about this resource according to a particular system.
*/
export interface Schema$GoogleCloudDatacatalogV1beta1SystemTimestamps {
/**
* The creation time of the resource within the given system.
*/
createTime?: string | null;
/**
* Output only. The expiration time of the resource within the given system. Currently only apllicable to BigQuery resources.
*/
expireTime?: string | null;
/**
* The last-modified time of the resource within the given system.
*/
updateTime?: string | null;
}
/**
* Normal BigQuery table spec.
*/
export interface Schema$GoogleCloudDatacatalogV1beta1TableSpec {
/**
* Output only. If the table is a dated shard, i.e., with name pattern `[prefix]YYYYMMDD`, `grouped_entry` 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.
*/
groupedEntry?: string | null;
}
/**
* Tags are used to attach custom metadata to Data Catalog resources. Tags conform to the specifications within their tag template. See [Data Catalog IAM](https://cloud.google.com/data-catalog/docs/concepts/iam) for information on the permissions needed to create or view tags.
*/
export interface Schema$GoogleCloudDatacatalogV1beta1Tag {
/**
* Resources like Entry can have schemas associated with them. This scope allows users to attach tags to an individual column based on that schema. For attaching a tag to a nested column, use `.` to separate the column names. Example: * `outer_column.inner_column`
*/
column?: string | null;
/**
* Required. This maps the ID of a tag field to the value of and additional information about that field. Valid field IDs are defined by the tag's template. A tag must have at least 1 field and at most 500 fields.
*/
fields?: {
[key: string]: Schema$GoogleCloudDatacatalogV1beta1TagField;
} | null;
/**
* Identifier. The resource name of the tag in URL format. Example: * projects/{project_id\}/locations/{location\}/entrygroups/{entry_group_id\}/entries/{entry_id\}/tags/{tag_id\} where `tag_id` is a system-generated identifier. Note that this Tag may not actually be stored in the location in this name.
*/
name?: string | null;
/**
* Required. The resource name of the tag template that this tag uses. Example: * projects/{project_id\}/locations/{location\}/tagTemplates/{tag_template_id\} This field cannot be modified after creation.
*/
template?: string | null;
/**
* Output only. The display name of the tag template.
*/
templateDisplayName?: string | null;
}
/**
* Contains the value and supporting information for a field within a Tag.
*/
export interface Schema$GoogleCloudDatacatalogV1beta1TagField {
/**
* Holds the value for a tag field with boolean type.
*/
boolValue?: boolean | null;
/**
* Output only. The display name of this field.
*/
displayName?: string | null;
/**
* Holds the value for a tag field with double type.
*/
doubleValue?: number | null;
/**
* Holds the value for a tag field with enum type. This value must be one of the allowed values in the definition of this enum.
*/
enumValue?: Schema$GoogleCloudDatacatalogV1beta1TagFieldEnumValue;
/**
* Output only. The order of this field with respect to other fields in this tag. It can be set in Tag. For example, a higher value can indicate a more important field. The value can be negative. Multiple fields can have the same order, and field orders within a tag do not have to be sequential.
*/
order?: number | null;
/**
* Holds the value for a tag field with string type.
*/
stringValue?: string | null;
/**
* Holds the value for a tag field with timestamp type.
*/
timestampValue?: string | null;
}
/**
* Holds an enum value.
*/
export interface Schema$GoogleCloudDatacatalogV1beta1TagFieldEnumValue {
/**
* The display name of the enum value.
*/
displayName?: string | null;
}
/**
* A tag template defines a tag, which can have one or more typed fields. The template is used to create and attach the tag to Google Cloud resources. [Tag template roles](https://cloud.google.com/iam/docs/understanding-roles#data-catalog-roles) provide permissions to create, edit, and use the template. See, for example, the [TagTemplate User](https://cloud.google.com/data-catalog/docs/how-to/template-user) role, which includes permission to use the tag template to tag resources.
*/
export interface Schema$GoogleCloudDatacatalogV1beta1TagTemplate {
/**
* Output only. Transfer status of the TagTemplate
*/
dataplexTransferStatus?: string | null;
/**
* The display name for this template. Defaults to an empty string.
*/
displayName?: string | null;
/**
* Required. Map of tag template field IDs to the settings for the field. This map is an exhaustive list of the allowed fields. This map must contain at least one field and at most 500 fields. The keys to this map are tag template field IDs. Field IDs can contain letters (both uppercase and lowercase), numbers (0-9) and underscores (_). Field IDs must be at least 1 character long and at most 64 characters long. Field IDs must start with a letter or underscore.
*/
fields?: {
[key: string]: Schema$GoogleCloudDatacatalogV1beta1TagTemplateField;
} | null;
/**
* Identifier. The resource name of the tag template in URL format. Example: * projects/{project_id\}/locations/{location\}/tagTemplates/{tag_template_id\} Note that this TagTemplate and its child resources may not actually be stored in the location in this name.
*/
name?: string | null;
}
/**
* The template for an individual field within a tag template.
*/
export interface Schema$GoogleCloudDatacatalogV1beta1TagTemplateField {
/**
* The description for this field. Defaults to an empty string.
*/
description?: string | null;
/**
* The display name for this field. Defaults to an empty string.
*/
displayName?: string | null;
/**
* Whether this is a required field. Defaults to false.
*/
isRequired?: boolean | null;
/**
* Output only. Identifier. The resource name of the tag template field in URL format. Example: * projects/{project_id\}/locations/{location\}/tagTemplates/{tag_template\}/fields/{field\} Note that this TagTemplateField may not actually be stored in the location in this name.
*/
name?: string | null;
/**
* The order of this field with respect to other fields in this tag template. A higher value indicates a more important field. The value can be negative. Multiple fields can have the same order, and field orders within a tag do not have to be sequential.
*/
order?: number | null;
/**
* Required. The type of value this tag field can contain.
*/
type?: Schema$GoogleCloudDatacatalogV1beta1FieldType;
}
/**
* A taxonomy is a collection of policy tags that classify data along a common axis. For instance a data *sensitivity* taxonomy could contain policy tags denoting PII such as age, zipcode, and SSN. A data *origin* taxonomy could contain policy tags to distinguish user data, employee data, partner data, public data.
*/
export interface Schema$GoogleCloudDatacatalogV1beta1Taxonomy {
/**
* Optional. A list of policy types that are activated for this taxonomy. If not set, defaults to an empty list.
*/
activatedPolicyTypes?: string[] | null;
/**
* Optional. Description of this taxonomy. It must: contain only unicode characters, tabs, newlines, carriage returns and page breaks; and be at most 2000 bytes long when encoded in UTF-8. If not set, defaults to an empty description.
*/
description?: string | null;
/**
* Required. User defined name of this taxonomy. It must: contain only unicode letters, numbers, underscores, dashes and spaces; not start or end with spaces; and be at most 200 bytes long when encoded in UTF-8. The taxonomy display name must be unique within an organization.
*/
displayName?: string | null;
/**
* Identifier. Resource name of this taxonomy, whose format is: "projects/{project_number\}/locations/{location_id\}/taxonomies/{id\}".
*/
name?: string | null;
/**
* Output only. Number of policy tags contained in this taxonomy.
*/
policyTagCount?: number | null;
/**
* Output only. Identity of the service which owns the Taxonomy. This field is only populated when the taxonomy is created by a Google Cloud service. Currently only 'DATAPLEX' is supported.
*/
service?: Schema$GoogleCloudDatacatalogV1beta1TaxonomyService;
/**
* Output only. Timestamps about this taxonomy. Only create_time and update_time are used.
*/
taxonomyTimestamps?: Schema$GoogleCloudDatacatalogV1beta1SystemTimestamps;
}
/**
* The source system of the Taxonomy.
*/
export interface Schema$GoogleCloudDatacatalogV1beta1TaxonomyService {
/**
* The service agent for the service.
*/
identity?: string | null;
/**
* The Google Cloud service name.
*/
name?: string | null;
}
/**
* The set of all usage signals that we store in Data Catalog.
*/
export interface Schema$GoogleCloudDatacatalogV1beta1UsageSignal {
/**
* The timestamp of the end of the usage statistics duration.
*/
updateTime?: string | null;
/**
* Usage statistics over each of the pre-defined time ranges, supported strings for time ranges are {"24H", "7D", "30D"\}.
*/
usageWithinTimeRange?: {
[key: string]: Schema$GoogleCloudDatacatalogV1beta1UsageStats;
} | null;
}
/**
* Detailed counts on the entry's usage. Caveats: - Only BigQuery tables have usage stats - The usage stats only include BigQuery query jobs - The usage stats might be underestimated, e.g. wildcard table references are not yet counted in usage computation https://cloud.google.com/bigquery/docs/querying-wildcard-tables
*/
export interface Schema$GoogleCloudDatacatalogV1beta1UsageStats {
/**
* The number of times that the underlying entry was attempted to be used but was cancelled by the user.
*/
totalCancellations?: number | null;
/**
* The number of times that the underlying entry was successfully used.
*/
totalCompletions?: number | null;
/**
* Total time spent (in milliseconds) during uses the resulted in completions.
*/
totalExecutionTimeForCompletionsMillis?: number | null;
/**
* The number of times that the underlying entry was attempted to be used but failed.
*/
totalFailures?: number | null;
}
/**
* Table view specification.
*/
export interface Schema$GoogleCloudDatacatalogV1beta1ViewSpec {
/**
* Output only. The query that defines the table view.
*/
viewQuery?: string | null;
}
/**
* Specification for the BigQuery connection.
*/
export interface Schema$GoogleCloudDatacatalogV1BigQueryConnectionSpec {
/**
* Specification for the BigQuery connection to a Cloud SQL instance.
*/
cloudSql?: Schema$GoogleCloudDatacatalogV1CloudSqlBigQueryConnectionSpec;
/**
* The type of the BigQuery connection.
*/
connectionType?: string | null;
/**
* True if there are credentials attached to the BigQuery connection; false otherwise.
*/
hasCredential?: boolean | null;
}
/**
* 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).
*/
export interface Schema$GoogleCloudDatacatalogV1BigQueryDateShardedSpec {
/**
* Output only.