googleapis
Version:
Google APIs Client Library for Node.js
1,307 lines • 449 kB
TypeScript
/// <reference types="node" />
import { OAuth2Client, JWT, Compute, UserRefreshClient, BaseExternalAccountClient, GaxiosPromise, GoogleConfigurable, MethodOptions, StreamMethodOptions, GlobalOptions, GoogleAuth, BodyResponseCallback, APIRequestContext } from 'googleapis-common';
import { Readable } from 'stream';
export declare namespace dataplex_v1 {
export interface Options extends GlobalOptions {
version: 'v1';
}
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;
}
/**
* Cloud Dataplex API
*
* Dataplex API is used to manage the lifecycle of data lakes.
*
* @example
* ```js
* const {google} = require('googleapis');
* const dataplex = google.dataplex('v1');
* ```
*/
export class Dataplex {
context: APIRequestContext;
projects: Resource$Projects;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
/**
* 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 {
}
/**
* Action represents an issue requiring administrator action for resolution.
*/
export interface Schema$GoogleCloudDataplexV1Action {
/**
* Output only. The relative resource name of the asset, of the form: projects/{project_number\}/locations/{location_id\}/lakes/{lake_id\}/zones/{zone_id\}/assets/{asset_id\}.
*/
asset?: string | null;
/**
* The category of issue associated with the action.
*/
category?: string | null;
/**
* The list of data locations associated with this action. Cloud Storage locations are represented as URI paths(E.g. gs://bucket/table1/year=2020/month=Jan/). BigQuery locations refer to resource names(E.g. bigquery.googleapis.com/projects/project-id/datasets/dataset-id).
*/
dataLocations?: string[] | null;
/**
* The time that the issue was detected.
*/
detectTime?: string | null;
/**
* Details for issues related to applying security policy.
*/
failedSecurityPolicyApply?: Schema$GoogleCloudDataplexV1ActionFailedSecurityPolicyApply;
/**
* Details for issues related to incompatible schemas detected within data.
*/
incompatibleDataSchema?: Schema$GoogleCloudDataplexV1ActionIncompatibleDataSchema;
/**
* Details for issues related to invalid or unsupported data formats.
*/
invalidDataFormat?: Schema$GoogleCloudDataplexV1ActionInvalidDataFormat;
/**
* Details for issues related to invalid data arrangement.
*/
invalidDataOrganization?: Schema$GoogleCloudDataplexV1ActionInvalidDataOrganization;
/**
* Details for issues related to invalid or unsupported data partition structure.
*/
invalidDataPartition?: Schema$GoogleCloudDataplexV1ActionInvalidDataPartition;
/**
* Detailed description of the issue requiring action.
*/
issue?: string | null;
/**
* Output only. The relative resource name of the lake, of the form: projects/{project_number\}/locations/{location_id\}/lakes/{lake_id\}.
*/
lake?: string | null;
/**
* Details for issues related to absence of data within managed resources.
*/
missingData?: Schema$GoogleCloudDataplexV1ActionMissingData;
/**
* Details for issues related to absence of a managed resource.
*/
missingResource?: Schema$GoogleCloudDataplexV1ActionMissingResource;
/**
* Output only. The relative resource name of the action, of the form: projects/{project\}/locations/{location\}/lakes/{lake\}/actions/{action\} projects/{project\}/locations/{location\}/lakes/{lake\}/zones/{zone\}/actions/{action\} projects/{project\}/locations/{location\}/lakes/{lake\}/zones/{zone\}/assets/{asset\}/actions/{action\}.
*/
name?: string | null;
/**
* Details for issues related to lack of permissions to access data resources.
*/
unauthorizedResource?: Schema$GoogleCloudDataplexV1ActionUnauthorizedResource;
/**
* Output only. The relative resource name of the zone, of the form: projects/{project_number\}/locations/{location_id\}/lakes/{lake_id\}/zones/{zone_id\}.
*/
zone?: string | null;
}
/**
* Failed to apply security policy to the managed resource(s) under a lake, zone or an asset. For a lake or zone resource, one or more underlying assets has a failure applying security policy to the associated managed resource.
*/
export interface Schema$GoogleCloudDataplexV1ActionFailedSecurityPolicyApply {
/**
* Resource name of one of the assets with failing security policy application. Populated for a lake or zone resource only.
*/
asset?: string | null;
}
/**
* Action details for incompatible schemas detected by discovery.
*/
export interface Schema$GoogleCloudDataplexV1ActionIncompatibleDataSchema {
/**
* The existing and expected schema of the table. The schema is provided as a JSON formatted structure listing columns and data types.
*/
existingSchema?: string | null;
/**
* The new and incompatible schema within the table. The schema is provided as a JSON formatted structured listing columns and data types.
*/
newSchema?: string | null;
/**
* The list of data locations sampled and used for format/schema inference.
*/
sampledDataLocations?: string[] | null;
/**
* Whether the action relates to a schema that is incompatible or modified.
*/
schemaChange?: string | null;
/**
* The name of the table containing invalid data.
*/
table?: string | null;
}
/**
* Action details for invalid or unsupported data files detected by discovery.
*/
export interface Schema$GoogleCloudDataplexV1ActionInvalidDataFormat {
/**
* The expected data format of the entity.
*/
expectedFormat?: string | null;
/**
* The new unexpected data format within the entity.
*/
newFormat?: string | null;
/**
* The list of data locations sampled and used for format/schema inference.
*/
sampledDataLocations?: string[] | null;
}
/**
* Action details for invalid data arrangement.
*/
export interface Schema$GoogleCloudDataplexV1ActionInvalidDataOrganization {
}
/**
* Action details for invalid or unsupported partitions detected by discovery.
*/
export interface Schema$GoogleCloudDataplexV1ActionInvalidDataPartition {
/**
* The issue type of InvalidDataPartition.
*/
expectedStructure?: string | null;
}
/**
* Action details for absence of data detected by discovery.
*/
export interface Schema$GoogleCloudDataplexV1ActionMissingData {
}
/**
* Action details for resource references in assets that cannot be located.
*/
export interface Schema$GoogleCloudDataplexV1ActionMissingResource {
}
/**
* Action details for unauthorized resource issues raised to indicate that the service account associated with the lake instance is not authorized to access or manage the resource associated with an asset.
*/
export interface Schema$GoogleCloudDataplexV1ActionUnauthorizedResource {
}
/**
* An asset represents a cloud resource that is being managed within a lake as a member of a zone.
*/
export interface Schema$GoogleCloudDataplexV1Asset {
/**
* Output only. The time when the asset was created.
*/
createTime?: string | null;
/**
* Optional. Description of the asset.
*/
description?: string | null;
/**
* Optional. Specification of the discovery feature applied to data referenced by this asset. When this spec is left unset, the asset will use the spec set on the parent zone.
*/
discoverySpec?: Schema$GoogleCloudDataplexV1AssetDiscoverySpec;
/**
* Output only. Status of the discovery feature applied to data referenced by this asset.
*/
discoveryStatus?: Schema$GoogleCloudDataplexV1AssetDiscoveryStatus;
/**
* Optional. User friendly display name.
*/
displayName?: string | null;
/**
* Optional. User defined labels for the asset.
*/
labels?: {
[key: string]: string;
} | null;
/**
* Output only. The relative resource name of the asset, of the form: projects/{project_number\}/locations/{location_id\}/lakes/{lake_id\}/zones/{zone_id\}/assets/{asset_id\}.
*/
name?: string | null;
/**
* Required. Specification of the resource that is referenced by this asset.
*/
resourceSpec?: Schema$GoogleCloudDataplexV1AssetResourceSpec;
/**
* Output only. Status of the resource referenced by this asset.
*/
resourceStatus?: Schema$GoogleCloudDataplexV1AssetResourceStatus;
/**
* Output only. Status of the security policy applied to resource referenced by this asset.
*/
securityStatus?: Schema$GoogleCloudDataplexV1AssetSecurityStatus;
/**
* Output only. Current state of the asset.
*/
state?: string | null;
/**
* Output only. System generated globally unique ID for the asset. This ID will be different if the asset is deleted and re-created with the same name.
*/
uid?: string | null;
/**
* Output only. The time when the asset was last updated.
*/
updateTime?: string | null;
}
/**
* Settings to manage the metadata discovery and publishing for an asset.
*/
export interface Schema$GoogleCloudDataplexV1AssetDiscoverySpec {
/**
* Optional. Configuration for CSV data.
*/
csvOptions?: Schema$GoogleCloudDataplexV1AssetDiscoverySpecCsvOptions;
/**
* Optional. Whether discovery is enabled.
*/
enabled?: boolean | null;
/**
* Optional. The list of patterns to apply for selecting data to exclude during discovery. For Cloud Storage bucket assets, these are interpreted as glob patterns used to match object names. For BigQuery dataset assets, these are interpreted as patterns to match table names.
*/
excludePatterns?: string[] | null;
/**
* Optional. The list of patterns to apply for selecting data to include during discovery if only a subset of the data should considered. For Cloud Storage bucket assets, these are interpreted as glob patterns used to match object names. For BigQuery dataset assets, these are interpreted as patterns to match table names.
*/
includePatterns?: string[] | null;
/**
* Optional. Configuration for Json data.
*/
jsonOptions?: Schema$GoogleCloudDataplexV1AssetDiscoverySpecJsonOptions;
/**
* Optional. Cron schedule (https://en.wikipedia.org/wiki/Cron) for running discovery periodically. Successive discovery runs must be scheduled at least 60 minutes apart. The default value is to run discovery every 60 minutes. To explicitly set a timezone to the cron tab, apply a prefix in the cron tab: "CRON_TZ=${IANA_TIME_ZONE\}" or TZ=${IANA_TIME_ZONE\}". The ${IANA_TIME_ZONE\} may only be a valid string from IANA time zone database. For example, "CRON_TZ=America/New_York 1 * * * *", or "TZ=America/New_York 1 * * * *".
*/
schedule?: string | null;
}
/**
* Describe CSV and similar semi-structured data formats.
*/
export interface Schema$GoogleCloudDataplexV1AssetDiscoverySpecCsvOptions {
/**
* Optional. The delimiter being used to separate values. This defaults to ','.
*/
delimiter?: string | null;
/**
* Optional. Whether to disable the inference of data type for CSV data. If true, all columns will be registered as strings.
*/
disableTypeInference?: boolean | null;
/**
* Optional. The character encoding of the data. The default is UTF-8.
*/
encoding?: string | null;
/**
* Optional. The number of rows to interpret as header rows that should be skipped when reading data rows.
*/
headerRows?: number | null;
}
/**
* Describe JSON data format.
*/
export interface Schema$GoogleCloudDataplexV1AssetDiscoverySpecJsonOptions {
/**
* Optional. Whether to disable the inference of data type for Json data. If true, all columns will be registered as their primitive types (strings, number or boolean).
*/
disableTypeInference?: boolean | null;
/**
* Optional. The character encoding of the data. The default is UTF-8.
*/
encoding?: string | null;
}
/**
* Status of discovery for an asset.
*/
export interface Schema$GoogleCloudDataplexV1AssetDiscoveryStatus {
/**
* The duration of the last discovery run.
*/
lastRunDuration?: string | null;
/**
* The start time of the last discovery run.
*/
lastRunTime?: string | null;
/**
* Additional information about the current state.
*/
message?: string | null;
/**
* The current status of the discovery feature.
*/
state?: string | null;
/**
* Data Stats of the asset reported by discovery.
*/
stats?: Schema$GoogleCloudDataplexV1AssetDiscoveryStatusStats;
/**
* Last update time of the status.
*/
updateTime?: string | null;
}
/**
* The aggregated data statistics for the asset reported by discovery.
*/
export interface Schema$GoogleCloudDataplexV1AssetDiscoveryStatusStats {
/**
* The count of data items within the referenced resource.
*/
dataItems?: string | null;
/**
* The number of stored data bytes within the referenced resource.
*/
dataSize?: string | null;
/**
* The count of fileset entities within the referenced resource.
*/
filesets?: string | null;
/**
* The count of table entities within the referenced resource.
*/
tables?: string | null;
}
/**
* Identifies the cloud resource that is referenced by this asset.
*/
export interface Schema$GoogleCloudDataplexV1AssetResourceSpec {
/**
* Immutable. Relative name of the cloud resource that contains the data that is being managed within a lake. For example: projects/{project_number\}/buckets/{bucket_id\} projects/{project_number\}/datasets/{dataset_id\}
*/
name?: string | null;
/**
* Required. Immutable. Type of resource.
*/
type?: string | null;
}
/**
* Status of the resource referenced by an asset.
*/
export interface Schema$GoogleCloudDataplexV1AssetResourceStatus {
/**
* Additional information about the current state.
*/
message?: string | null;
/**
* The current state of the managed resource.
*/
state?: string | null;
/**
* Last update time of the status.
*/
updateTime?: string | null;
}
/**
* Security policy status of the asset. Data security policy, i.e., readers, writers & owners, should be specified in the lake/zone/asset IAM policy.
*/
export interface Schema$GoogleCloudDataplexV1AssetSecurityStatus {
/**
* Additional information about the current state.
*/
message?: string | null;
/**
* The current state of the security policy applied to the attached resource.
*/
state?: string | null;
/**
* Last update time of the status.
*/
updateTime?: string | null;
}
/**
* Aggregated status of the underlying assets of a lake or zone.
*/
export interface Schema$GoogleCloudDataplexV1AssetStatus {
/**
* Number of active assets.
*/
activeAssets?: number | null;
/**
* Number of assets that are in process of updating the security policy on attached resources.
*/
securityPolicyApplyingAssets?: number | null;
/**
* Last update time of the status.
*/
updateTime?: string | null;
}
/**
* Cancel task jobs.
*/
export interface Schema$GoogleCloudDataplexV1CancelJobRequest {
}
/**
* Content represents a user-visible notebook or a sql script
*/
export interface Schema$GoogleCloudDataplexV1Content {
/**
* Output only. Content creation time.
*/
createTime?: string | null;
/**
* Required. Content data in string format.
*/
dataText?: string | null;
/**
* Optional. Description of the content.
*/
description?: string | null;
/**
* Optional. User defined labels for the content.
*/
labels?: {
[key: string]: string;
} | null;
/**
* Output only. The relative resource name of the content, of the form: projects/{project_id\}/locations/{location_id\}/lakes/{lake_id\}/content/{content_id\}
*/
name?: string | null;
/**
* Notebook related configurations.
*/
notebook?: Schema$GoogleCloudDataplexV1ContentNotebook;
/**
* Required. The path for the Content file, represented as directory structure. Unique within a lake. Limited to alphanumerics, hyphens, underscores, dots and slashes.
*/
path?: string | null;
/**
* Sql Script related configurations.
*/
sqlScript?: Schema$GoogleCloudDataplexV1ContentSqlScript;
/**
* Output only. System generated globally unique ID for the content. This ID will be different if the content is deleted and re-created with the same name.
*/
uid?: string | null;
/**
* Output only. The time when the content was last updated.
*/
updateTime?: string | null;
}
/**
* Configuration for Notebook content.
*/
export interface Schema$GoogleCloudDataplexV1ContentNotebook {
/**
* Required. Kernel Type of the notebook.
*/
kernelType?: string | null;
}
/**
* Configuration for the Sql Script content.
*/
export interface Schema$GoogleCloudDataplexV1ContentSqlScript {
/**
* Required. Query Engine to be used for the Sql Query.
*/
engine?: string | null;
}
/**
* These messages contain information about the execution of a datascan. The monitored resource is 'DataScan'
*/
export interface Schema$GoogleCloudDataplexV1DataScanEvent {
/**
* Data profile result for data profile type data scan.
*/
dataProfile?: Schema$GoogleCloudDataplexV1DataScanEventDataProfileResult;
/**
* Data quality result for data quality type data scan.
*/
dataQuality?: Schema$GoogleCloudDataplexV1DataScanEventDataQualityResult;
/**
* The data source of the data scan
*/
dataSource?: string | null;
/**
* The time when the data scan job finished.
*/
endTime?: string | null;
/**
* The identifier of the specific data scan job this log entry is for.
*/
jobId?: string | null;
/**
* The message describing the data scan job event.
*/
message?: string | null;
/**
* The scope of the data scan (e.g. full, incremental).
*/
scope?: string | null;
/**
* A version identifier of the spec which was used to execute this job.
*/
specVersion?: string | null;
/**
* The time when the data scan job started to run.
*/
startTime?: string | null;
/**
* The status of the data scan job.
*/
state?: string | null;
/**
* The trigger type of the data scan job.
*/
trigger?: string | null;
/**
* The type of the data scan.
*/
type?: string | null;
}
/**
* Data profile result for data scan job.
*/
export interface Schema$GoogleCloudDataplexV1DataScanEventDataProfileResult {
/**
* The count of rows processed in the data scan job.
*/
rowCount?: string | null;
}
/**
* Data quality result for data scan job.
*/
export interface Schema$GoogleCloudDataplexV1DataScanEventDataQualityResult {
/**
* The result of each dimension for data quality result. The key of the map is the name of the dimension. The value is the bool value depicting whether the dimension result was pass or not.
*/
dimensionPassed?: {
[key: string]: boolean;
} | null;
/**
* Whether the data quality result was pass or not.
*/
passed?: boolean | null;
/**
* The count of rows processed in the data scan job.
*/
rowCount?: string | null;
}
/**
* The payload associated with Discovery data processing.
*/
export interface Schema$GoogleCloudDataplexV1DiscoveryEvent {
/**
* Details about the action associated with the event.
*/
action?: Schema$GoogleCloudDataplexV1DiscoveryEventActionDetails;
/**
* The id of the associated asset.
*/
assetId?: string | null;
/**
* Details about discovery configuration in effect.
*/
config?: Schema$GoogleCloudDataplexV1DiscoveryEventConfigDetails;
/**
* The data location associated with the event.
*/
dataLocation?: string | null;
/**
* Details about the entity associated with the event.
*/
entity?: Schema$GoogleCloudDataplexV1DiscoveryEventEntityDetails;
/**
* The id of the associated lake.
*/
lakeId?: string | null;
/**
* The log message.
*/
message?: string | null;
/**
* Details about the partition associated with the event.
*/
partition?: Schema$GoogleCloudDataplexV1DiscoveryEventPartitionDetails;
/**
* The type of the event being logged.
*/
type?: string | null;
/**
* The id of the associated zone.
*/
zoneId?: string | null;
}
/**
* Details about the action.
*/
export interface Schema$GoogleCloudDataplexV1DiscoveryEventActionDetails {
/**
* The type of action. Eg. IncompatibleDataSchema, InvalidDataFormat
*/
type?: string | null;
}
/**
* Details about configuration events.
*/
export interface Schema$GoogleCloudDataplexV1DiscoveryEventConfigDetails {
/**
* A list of discovery configuration parameters in effect. The keys are the field paths within DiscoverySpec. Eg. includePatterns, excludePatterns, csvOptions.disableTypeInference, etc.
*/
parameters?: {
[key: string]: string;
} | null;
}
/**
* Details about the entity.
*/
export interface Schema$GoogleCloudDataplexV1DiscoveryEventEntityDetails {
/**
* The name of the entity resource. The name is the fully-qualified resource name.
*/
entity?: string | null;
/**
* The type of the entity resource.
*/
type?: string | null;
}
/**
* Details about the partition.
*/
export interface Schema$GoogleCloudDataplexV1DiscoveryEventPartitionDetails {
/**
* The name to the containing entity resource. The name is the fully-qualified resource name.
*/
entity?: string | null;
/**
* The name to the partition resource. The name is the fully-qualified resource name.
*/
partition?: string | null;
/**
* The locations of the data items (e.g., a Cloud Storage objects) sampled for metadata inference.
*/
sampledDataLocations?: string[] | null;
/**
* The type of the containing entity resource.
*/
type?: string | null;
}
/**
* Represents tables and fileset metadata contained within a zone.
*/
export interface Schema$GoogleCloudDataplexV1Entity {
/**
* Required. Immutable. The ID of the asset associated with the storage location containing the entity data. The entity must be with in the same zone with the asset.
*/
asset?: string | null;
/**
* Output only. The name of the associated Data Catalog entry.
*/
catalogEntry?: string | null;
/**
* Output only. Metadata stores that the entity is compatible with.
*/
compatibility?: Schema$GoogleCloudDataplexV1EntityCompatibilityStatus;
/**
* Output only. The time when the entity was created.
*/
createTime?: string | null;
/**
* Required. Immutable. The storage path of the entity data. For Cloud Storage data, this is the fully-qualified path to the entity, such as gs://bucket/path/to/data. For BigQuery data, this is the name of the table resource, such as projects/project_id/datasets/dataset_id/tables/table_id.
*/
dataPath?: string | null;
/**
* Optional. The set of items within the data path constituting the data in the entity, represented as a glob path. Example: gs://bucket/path/to/data/xx/x.csv.
*/
dataPathPattern?: string | null;
/**
* Optional. User friendly longer description text. Must be shorter than or equal to 1024 characters.
*/
description?: string | null;
/**
* Optional. Display name must be shorter than or equal to 256 characters.
*/
displayName?: string | null;
/**
* Optional. The etag associated with the entity, which can be retrieved with a GetEntity request. Required for update and delete requests.
*/
etag?: string | null;
/**
* Required. Identifies the storage format of the entity data. It does not apply to entities with data stored in BigQuery.
*/
format?: Schema$GoogleCloudDataplexV1StorageFormat;
/**
* Required. A user-provided entity ID. It is mutable, and will be used as the published table name. Specifying a new ID in an update entity request will override the existing value. The ID must contain only letters (a-z, A-Z), numbers (0-9), and underscores. Must begin with a letter and consist of 256 or fewer characters.
*/
id?: string | null;
/**
* Output only. The resource name of the entity, of the form: projects/{project_number\}/locations/{location_id\}/lakes/{lake_id\}/zones/{zone_id\}/entities/{id\}.
*/
name?: string | null;
/**
* Required. The description of the data structure and layout. The schema is not included in list responses. It is only included in SCHEMA and FULL entity views of a GetEntity response.
*/
schema?: Schema$GoogleCloudDataplexV1Schema;
/**
* Required. Immutable. Identifies the storage system of the entity data.
*/
system?: string | null;
/**
* Required. Immutable. The type of entity.
*/
type?: string | null;
/**
* Output only. The time when the entity was last updated.
*/
updateTime?: string | null;
}
/**
* Provides compatibility information for various metadata stores.
*/
export interface Schema$GoogleCloudDataplexV1EntityCompatibilityStatus {
/**
* Output only. Whether this entity is compatible with BigQuery.
*/
bigquery?: Schema$GoogleCloudDataplexV1EntityCompatibilityStatusCompatibility;
/**
* Output only. Whether this entity is compatible with Hive Metastore.
*/
hiveMetastore?: Schema$GoogleCloudDataplexV1EntityCompatibilityStatusCompatibility;
}
/**
* Provides compatibility information for a specific metadata store.
*/
export interface Schema$GoogleCloudDataplexV1EntityCompatibilityStatusCompatibility {
/**
* Output only. Whether the entity is compatible and can be represented in the metadata store.
*/
compatible?: boolean | null;
/**
* Output only. Provides additional detail if the entity is incompatible with the metadata store.
*/
reason?: string | null;
}
/**
* Environment represents a user-visible compute infrastructure for analytics within a lake.
*/
export interface Schema$GoogleCloudDataplexV1Environment {
/**
* Output only. Environment creation time.
*/
createTime?: string | null;
/**
* Optional. Description of the environment.
*/
description?: string | null;
/**
* Optional. User friendly display name.
*/
displayName?: string | null;
/**
* Output only. URI Endpoints to access sessions associated with the Environment.
*/
endpoints?: Schema$GoogleCloudDataplexV1EnvironmentEndpoints;
/**
* Required. Infrastructure specification for the Environment.
*/
infrastructureSpec?: Schema$GoogleCloudDataplexV1EnvironmentInfrastructureSpec;
/**
* Optional. User defined labels for the environment.
*/
labels?: {
[key: string]: string;
} | null;
/**
* Output only. The relative resource name of the environment, of the form: projects/{project_id\}/locations/{location_id\}/lakes/{lake_id\}/environment/{environment_id\}
*/
name?: string | null;
/**
* Optional. Configuration for sessions created for this environment.
*/
sessionSpec?: Schema$GoogleCloudDataplexV1EnvironmentSessionSpec;
/**
* Output only. Status of sessions created for this environment.
*/
sessionStatus?: Schema$GoogleCloudDataplexV1EnvironmentSessionStatus;
/**
* Output only. Current state of the environment.
*/
state?: string | null;
/**
* Output only. System generated globally unique ID for the environment. This ID will be different if the environment is deleted and re-created with the same name.
*/
uid?: string | null;
/**
* Output only. The time when the environment was last updated.
*/
updateTime?: string | null;
}
export interface Schema$GoogleCloudDataplexV1EnvironmentEndpoints {
/**
* Output only. URI to serve notebook APIs
*/
notebooks?: string | null;
/**
* Output only. URI to serve SQL APIs
*/
sql?: string | null;
}
/**
* Configuration for the underlying infrastructure used to run workloads.
*/
export interface Schema$GoogleCloudDataplexV1EnvironmentInfrastructureSpec {
/**
* Optional. Compute resources needed for analyze interactive workloads.
*/
compute?: Schema$GoogleCloudDataplexV1EnvironmentInfrastructureSpecComputeResources;
/**
* Required. Software Runtime Configuration for analyze interactive workloads.
*/
osImage?: Schema$GoogleCloudDataplexV1EnvironmentInfrastructureSpecOsImageRuntime;
}
/**
* Compute resources associated with the analyze interactive workloads.
*/
export interface Schema$GoogleCloudDataplexV1EnvironmentInfrastructureSpecComputeResources {
/**
* Optional. Size in GB of the disk. Default is 100 GB.
*/
diskSizeGb?: number | null;
/**
* Optional. Max configurable nodes. If max_node_count \> node_count, then auto-scaling is enabled.
*/
maxNodeCount?: number | null;
/**
* Optional. Total number of nodes in the sessions created for this environment.
*/
nodeCount?: number | null;
}
/**
* Software Runtime Configuration to run Analyze.
*/
export interface Schema$GoogleCloudDataplexV1EnvironmentInfrastructureSpecOsImageRuntime {
/**
* Required. Dataplex Image version.
*/
imageVersion?: string | null;
/**
* Optional. List of Java jars to be included in the runtime environment. Valid input includes Cloud Storage URIs to Jar binaries. For example, gs://bucket-name/my/path/to/file.jar
*/
javaLibraries?: string[] | null;
/**
* Optional. Spark properties to provide configuration for use in sessions created for this environment. The properties to set on daemon config files. Property keys are specified in prefix:property format. The prefix must be "spark".
*/
properties?: {
[key: string]: string;
} | null;
/**
* Optional. A list of python packages to be installed. Valid formats include Cloud Storage URI to a PIP installable library. For example, gs://bucket-name/my/path/to/lib.tar.gz
*/
pythonPackages?: string[] | null;
}
export interface Schema$GoogleCloudDataplexV1EnvironmentSessionSpec {
/**
* Optional. If True, this causes sessions to be pre-created and available for faster startup to enable interactive exploration use-cases. This defaults to False to avoid additional billed charges. These can only be set to True for the environment with name set to "default", and with default configuration.
*/
enableFastStartup?: boolean | null;
/**
* Optional. The idle time configuration of the session. The session will be auto-terminated at the end of this period.
*/
maxIdleDuration?: string | null;
}
export interface Schema$GoogleCloudDataplexV1EnvironmentSessionStatus {
/**
* Output only. Queries over sessions to mark whether the environment is currently active or not
*/
active?: boolean | null;
}
/**
* A job represents an instance of a task.
*/
export interface Schema$GoogleCloudDataplexV1Job {
/**
* Output only. The time when the job ended.
*/
endTime?: string | null;
/**
* Output only. Additional information about the current state.
*/
message?: string | null;
/**
* Output only. The relative resource name of the job, of the form: projects/{project_number\}/locations/{location_id\}/lakes/{lake_id\}/tasks/{task_id\}/jobs/{job_id\}.
*/
name?: string | null;
/**
* Output only. The number of times the job has been retried (excluding the initial attempt).
*/
retryCount?: number | null;
/**
* Output only. The underlying service running a job.
*/
service?: string | null;
/**
* Output only. The full resource name for the job run under a particular service.
*/
serviceJob?: string | null;
/**
* Output only. The time when the job was started.
*/
startTime?: string | null;
/**
* Output only. Execution state for the job.
*/
state?: string | null;
/**
* Output only. System generated globally unique ID for the job.
*/
uid?: string | null;
}
/**
* The payload associated with Job logs that contains events describing jobs that have run within a Lake.
*/
export interface Schema$GoogleCloudDataplexV1JobEvent {
/**
* The time when the job ended running.
*/
endTime?: string | null;
/**
* The unique id identifying the job.
*/
jobId?: string | null;
/**
* The log message.
*/
message?: string | null;
/**
* The number of retries.
*/
retries?: number | null;
/**
* The service used to execute the job.
*/
service?: string | null;
/**
* The reference to the job within the service.
*/
serviceJob?: string | null;
/**
* The time when the job started running.
*/
startTime?: string | null;
/**
* The job state on completion.
*/
state?: string | null;
/**
* The type of the job.
*/
type?: string | null;
}
/**
* A lake is a centralized repository for managing enterprise data across the organization distributed across many cloud projects, and stored in a variety of storage services such as Google Cloud Storage and BigQuery. The resources attached to a lake are referred to as managed resources. Data within these managed resources can be structured or unstructured. A lake provides data admins with tools to organize, secure and manage their data at scale, and provides data scientists and data engineers an integrated experience to easily search, discover, analyze and transform data and associated metadata.
*/
export interface Schema$GoogleCloudDataplexV1Lake {
/**
* Output only. Aggregated status of the underlying assets of the lake.
*/
assetStatus?: Schema$GoogleCloudDataplexV1AssetStatus;
/**
* Output only. The time when the lake was created.
*/
createTime?: string | null;
/**
* Optional. Description of the lake.
*/
description?: string | null;
/**
* Optional. User friendly display name.
*/
displayName?: string | null;
/**
* Optional. User-defined labels for the lake.
*/
labels?: {
[key: string]: string;
} | null;
/**
* Optional. Settings to manage lake and Dataproc Metastore service instance association.
*/
metastore?: Schema$GoogleCloudDataplexV1LakeMetastore;
/**
* Output only. Metastore status of the lake.
*/
metastoreStatus?: Schema$GoogleCloudDataplexV1LakeMetastoreStatus;
/**
* Output only. The relative resource name of the lake, of the form: projects/{project_number\}/locations/{location_id\}/lakes/{lake_id\}.
*/
name?: string | null;
/**
* Output only. Service account associated with this lake. This service account must be authorized to access or operate on resources managed by the lake.
*/
serviceAccount?: string | null;
/**
* Output only. Current state of the lake.
*/
state?: string | null;
/**
* Output only. System generated globally unique ID for the lake. This ID will be different if the lake is deleted and re-created with the same name.
*/
uid?: string | null;
/**
* Output only. The time when the lake was last updated.
*/
updateTime?: string | null;
}
/**
* Settings to manage association of Dataproc Metastore with a lake.
*/
export interface Schema$GoogleCloudDataplexV1LakeMetastore {
/**
* Optional. A relative reference to the Dataproc Metastore (https://cloud.google.com/dataproc-metastore/docs) service associated with the lake: projects/{project_id\}/locations/{location_id\}/services/{service_id\}
*/
service?: string | null;
}
/**
* Status of Lake and Dataproc Metastore service instance association.
*/
export interface Schema$GoogleCloudDataplexV1LakeMetastoreStatus {
/**
* The URI of the endpoint used to access the Metastore service.
*/
endpoint?: string | null;
/**
* Additional information about the current status.
*/
message?: string | null;
/**
* Current state of association.
*/
state?: string | null;
/**
* Last update time of the metastore status of the lake.
*/
updateTime?: string | null;
}
/**
* List actions response.
*/
export interface Schema$GoogleCloudDataplexV1ListActionsResponse {
/**
* Actions under the given parent lake/zone/asset.
*/
actions?: Schema$GoogleCloudDataplexV1Action[];
/**
* Token to retrieve the next page of results, or empty if there are no more results in the list.
*/
nextPageToken?: string | null;
}
/**
* List assets response.
*/
export interface Schema$GoogleCloudDataplexV1ListAssetsResponse {
/**
* Asset under the given parent zone.
*/
assets?: Schema$GoogleCloudDataplexV1Asset[];
/**
* Token to retrieve the next page of results, or empty if there are no more results in the list.
*/
nextPageToken?: string | null;
}
/**
* List content response.
*/
export interface Schema$GoogleCloudDataplexV1ListContentResponse {
/**
* Content under the given parent lake.
*/
content?: Schema$GoogleCloudDataplexV1Content[];
/**
* Token to retrieve the next page of results, or empty if there are no more results in the list.
*/
nextPageToken?: string | null;
}
/**
* List metadata entities response.
*/
export interface Schema$GoogleCloudDataplexV1ListEntitiesResponse {
/**
* Entities in the specified parent zone.
*/
entities?: Schema$GoogleCloudDataplexV1Entity[];
/**
* Token to retrieve the next page of results, or empty if there are no remaining results in the list.
*/
nextPageToken?: string | null;
}
/**
* List environments response.
*/
export interface Schema$GoogleCloudDataplexV1ListEnvironmentsResponse {
/**
* Environments under the given parent lake.
*/
environments?: Schema$GoogleCloudDataplexV1Environment[];
/**
* Token to retrieve the next page of results, or empty if there are no more results in the list.
*/
nextPageToken?: string | null;
}
/**
* List jobs response.
*/
export interface Schema$GoogleCloudDataplexV1ListJobsResponse {
/**
* Jobs under a given task.
*/
jobs?: Schema$GoogleCloudDataplexV1Job[];
/**
* Token to retrieve the next page of results, or empty if there are no more results in the list.
*/
nextPageToken?: string | null;
}
/**
* List lakes response.
*/
export interface Schema$GoogleCloudDataplexV1ListLakesResponse {
/**
* Lakes under the given parent location.
*/
lakes?: Schema$GoogleCloudDataplexV1Lake[];
/**
* Token to retrieve the next page of results, or empty if there are no more results in the list.
*/
nextPageToken?: string | null;
/**
* Locations that could not be reached.
*/
unreachableLocations?: string[] | null;
}
/**
* List metadata partitions response.
*/
export interface Schema$GoogleCloudDataplexV1ListPartitionsResponse {
/**
* Token to retrieve the next page of results, or empty if there are no remaining results in the list.
*/
nextPageToken?: string | null;
/**
* Partitions under the specified parent entity.
*/
partitions?: Schema$GoogleCloudDataplexV1Partition[];
}
/**
* List sessions response.
*/
export interface Schema$GoogleCloudDataplexV1ListSessionsResponse {
/**
* Token to retrieve the next page of results, or empty if there are no more results in the list.
*/
nextPageToken?: string | null;
/**
* Sessions under a given environment.
*/
sessions?: Schema$GoogleCloudDataplexV1Session[];
}
/**
* List tasks response.
*/
export interface Schema$GoogleCloudDataplexV1ListTasksResponse {
/**
* Token to retrieve the next page of results, or empty if there are no more results in the list.
*/
nextPageToken?: string | null;
/**
* Tasks under the given parent lake.
*/
tasks?: Schema$GoogleCloudDataplexV1Task[];
/**
* Locations that could not be reached.
*/
unreachableLocations?: string[] | null;
}
/**
* List zones response.
*/
export interface Schema$GoogleCloudDataplexV1ListZonesResponse {
/**
* Token to retrieve the next page of results, or empty if there are no more results in the list.
*/
nextPageToken?: string | null;
/**
* Zones under the given parent lake.
*/
zones?: Schema$GoogleCloudDataplexV1Zone[];
}
/**
* Represents the metadata of a long-running operation.
*/
export interface Schema$GoogleCloudDataplexV1OperationMetadata {
/**
* Output only. API version used to start the operation.
*/
apiVersion?: string | null;
/**
* Output only. The time the operation was created.
*/
createTime?: string | null;
/**
* Output only. The time the operation finished running.
*/
endTime?: string | null;
/**
* Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.
*/
requestedCancellation?: boolean | null;
/**
* Output only. Human-readable status of the operation, if any.
*/
statusMessage?: string | null;
/**
* Output only. Server-defined resource path for the target of the operation.
*/
target?: string | null;
/**
* Output only. Name of the verb executed by the operation.
*/
verb?: string | null;
}
/**
* Represents partition metadata contained within entity instances.
*/
export interface Schema$GoogleCloudDataplexV1Partition {
/**
* Optional. The etag for this partition.
*/
etag?: string | null;
/**
* Required. Immutable. The location of the entity data within the partition, for example, gs://bucket/path/to/entity/key1=value1/key2=value2. Or projects//datasets//tables/
*/
location?: string | null;
/**
* Output only. Partition values used in the HTTP URL must be double encoded. For example, url_encode(url_encode(value)) can be used to encode "US:CA/CA#Sunnyvale so that the request URL ends with "/partitions/US%253ACA/CA%2523Sunnyvale". The name field in the respon