UNPKG

azure-arm-datalake-analytics

Version:

Microsoft Azure Data Lake Analytics Management Client Library for node

862 lines (811 loc) 27.9 kB
/* * Copyright (c) Microsoft Corporation. All rights reserved. * Licensed under the MIT License. See License.txt in the project root for * license information. * * Code generated by Microsoft (R) AutoRest Code Generator. * Changes may cause incorrect behavior and will be lost if the code is * regenerated. */ import { BaseResource } from 'ms-rest-azure'; import { CloudError } from 'ms-rest-azure'; import * as moment from 'moment'; export { BaseResource } from 'ms-rest-azure'; export { CloudError } from 'ms-rest-azure'; /** * @class * Initializes a new instance of the DataLakeAnalyticsCatalogSecretCreateOrUpdateParameters class. * @constructor * Data Lake Analytics catalog secret creation and update parameters. This is * deprecated and will be removed in the next release. Please use * DataLakeAnalyticsCatalogCredentialCreateOrUpdateParameters instead. * * @member {string} password the password for the secret to pass in * @member {string} [uri] the URI identifier for the secret in the format * <hostname>:<port> */ export interface DataLakeAnalyticsCatalogSecretCreateOrUpdateParameters { password: string; uri?: string; } /** * @class * Initializes a new instance of the DataLakeAnalyticsCatalogCredentialCreateParameters class. * @constructor * Data Lake Analytics catalog credential creation parameters. * * @member {string} password the password for the credential and user with * access to the data source. * @member {string} uri the URI identifier for the data source this credential * can connect to in the format <hostname>:<port> * @member {string} userId the object identifier for the user associated with * this credential with access to the data source. */ export interface DataLakeAnalyticsCatalogCredentialCreateParameters { password: string; uri: string; userId: string; } /** * @class * Initializes a new instance of the DataLakeAnalyticsCatalogCredentialDeleteParameters class. * @constructor * Data Lake Analytics catalog credential deletion parameters. * * @member {string} [password] the current password for the credential and user * with access to the data source. This is required if the requester is not the * account owner. */ export interface DataLakeAnalyticsCatalogCredentialDeleteParameters { password?: string; } /** * @class * Initializes a new instance of the DataLakeAnalyticsCatalogCredentialUpdateParameters class. * @constructor * Data Lake Analytics catalog credential update parameters. * * @member {string} [password] the current password for the credential and user * with access to the data source. This is required if the requester is not the * account owner. * @member {string} [newPassword] the new password for the credential and user * with access to the data source. * @member {string} [uri] the URI identifier for the data source this * credential can connect to in the format <hostname>:<port> * @member {string} [userId] the object identifier for the user associated with * this credential with access to the data source. */ export interface DataLakeAnalyticsCatalogCredentialUpdateParameters { password?: string; newPassword?: string; uri?: string; userId?: string; } /** * @class * Initializes a new instance of the CatalogItem class. * @constructor * A Data Lake Analytics catalog item. * * @member {string} [computeAccountName] the name of the Data Lake Analytics * account. * @member {uuid} [version] the version of the catalog item. */ export interface CatalogItem { computeAccountName?: string; version?: string; } /** * @class * Initializes a new instance of the USqlSecret class. * @constructor * A Data Lake Analytics catalog U-SQL secret item. * * @member {string} [databaseName] the name of the database. * @member {string} [name] the name of the secret. * @member {date} [creationTime] the creation time of the credential object. * This is the only information returned about a secret from a GET. * @member {string} [uri] the URI identifier for the secret in the format * <hostname>:<port> * @member {string} [password] the password for the secret to pass in */ export interface USqlSecret extends CatalogItem { databaseName?: string; name?: string; creationTime?: Date; uri?: string; password?: string; } /** * @class * Initializes a new instance of the USqlExternalDataSource class. * @constructor * A Data Lake Analytics catalog U-SQL external datasource item. * * @member {string} [databaseName] the name of the database. * @member {string} [name] the name of the external data source. * @member {string} [provider] the name of the provider for the external data * source. * @member {string} [providerString] the name of the provider string for the * external data source. * @member {array} [pushdownTypes] the list of types to push down from the * external data source. */ export interface USqlExternalDataSource extends CatalogItem { databaseName?: string; name?: string; provider?: string; providerString?: string; pushdownTypes?: string[]; } /** * @class * Initializes a new instance of the USqlCredential class. * @constructor * A Data Lake Analytics catalog U-SQL credential item. * * @member {string} [name] the name of the credential. */ export interface USqlCredential extends CatalogItem { name?: string; } /** * @class * Initializes a new instance of the USqlProcedure class. * @constructor * A Data Lake Analytics catalog U-SQL procedure item. * * @member {string} [databaseName] the name of the database. * @member {string} [schemaName] the name of the schema associated with this * procedure and database. * @member {string} [name] the name of the procedure. * @member {string} [definition] the defined query of the procedure. */ export interface USqlProcedure extends CatalogItem { databaseName?: string; schemaName?: string; name?: string; definition?: string; } /** * @class * Initializes a new instance of the USqlTableColumn class. * @constructor * A Data Lake Analytics catalog U-SQL table column item. * * @member {string} [name] the name of the column in the table. * @member {string} [type] the object type of the specified column (such as * System.String). */ export interface USqlTableColumn { name?: string; type?: string; } /** * @class * Initializes a new instance of the USqlDirectedColumn class. * @constructor * A Data Lake Analytics catalog U-SQL directed column item. * * @member {string} [name] the name of the index in the table. * @member {boolean} [descending] the switch indicating if the index is * descending or not. */ export interface USqlDirectedColumn { name?: string; descending?: boolean; } /** * @class * Initializes a new instance of the USqlDistributionInfo class. * @constructor * A Data Lake Analytics catalog U-SQL distribution information object. * * @member {number} [type] the type of this distribution. * @member {array} [keys] the list of directed columns in the distribution * @member {number} [count] the count of indices using this distribution. * @member {number} [dynamicCount] the dynamic count of indices using this * distribution. */ export interface USqlDistributionInfo { type?: number; keys?: USqlDirectedColumn[]; count?: number; dynamicCount?: number; } /** * @class * Initializes a new instance of the USqlIndex class. * @constructor * A Data Lake Analytics catalog U-SQL table index item. * * @member {string} [name] the name of the index in the table. * @member {array} [indexKeys] the list of directed columns in the index * @member {array} [columns] the list of columns in the index * @member {object} [distributionInfo] the distributions info of the index * @member {number} [distributionInfo.type] the type of this distribution. * @member {array} [distributionInfo.keys] the list of directed columns in the * distribution * @member {number} [distributionInfo.count] the count of indices using this * distribution. * @member {number} [distributionInfo.dynamicCount] the dynamic count of * indices using this distribution. * @member {uuid} [partitionFunction] partition function ID for the index. * @member {array} [partitionKeyList] the list of partion keys in the index * @member {array} [streamNames] the list of full paths to the streams that * contain this index in the DataLake account. * @member {boolean} [isColumnstore] the switch indicating if this index is a * columnstore index. * @member {number} [indexId] the ID of this index within the table. * @member {boolean} [isUnique] the switch indicating if this index is a unique * index. */ export interface USqlIndex { name?: string; indexKeys?: USqlDirectedColumn[]; columns?: string[]; distributionInfo?: USqlDistributionInfo; partitionFunction?: string; partitionKeyList?: string[]; streamNames?: string[]; isColumnstore?: boolean; indexId?: number; isUnique?: boolean; } /** * @class * Initializes a new instance of the DdlName class. * @constructor * A Data Lake Analytics DDL name item. * * @member {string} [firstPart] the name of the table associated with this * database and schema. * @member {string} [secondPart] the name of the table associated with this * database and schema. * @member {string} [thirdPart] the name of the table associated with this * database and schema. * @member {string} [server] the name of the table associated with this * database and schema. */ export interface DdlName { firstPart?: string; secondPart?: string; thirdPart?: string; server?: string; } /** * @class * Initializes a new instance of the EntityId class. * @constructor * A Data Lake Analytics catalog entity identifier object. * * @member {object} [name] the name of the external table associated with this * database, schema and table. * @member {string} [name.firstPart] the name of the table associated with this * database and schema. * @member {string} [name.secondPart] the name of the table associated with * this database and schema. * @member {string} [name.thirdPart] the name of the table associated with this * database and schema. * @member {string} [name.server] the name of the table associated with this * database and schema. * @member {uuid} [version] the version of the external data source. */ export interface EntityId { name?: DdlName; version?: string; } /** * @class * Initializes a new instance of the ExternalTable class. * @constructor * A Data Lake Analytics catalog external table item. * * @member {string} [tableName] the name of the table associated with this * database and schema. * @member {object} [dataSource] the data source associated with this external * table. * @member {object} [dataSource.name] the name of the external table associated * with this database, schema and table. * @member {string} [dataSource.name.firstPart] the name of the table * associated with this database and schema. * @member {string} [dataSource.name.secondPart] the name of the table * associated with this database and schema. * @member {string} [dataSource.name.thirdPart] the name of the table * associated with this database and schema. * @member {string} [dataSource.name.server] the name of the table associated * with this database and schema. * @member {uuid} [dataSource.version] the version of the external data source. */ export interface ExternalTable { tableName?: string; dataSource?: EntityId; } /** * @class * Initializes a new instance of the TypeFieldInfo class. * @constructor * A Data Lake Analytics catalog type field information item. * * @member {string} [name] the name of the field associated with this type. * @member {string} [type] the type of the field. */ export interface TypeFieldInfo { name?: string; type?: string; } /** * @class * Initializes a new instance of the USqlTable class. * @constructor * A Data Lake Analytics catalog U-SQL table item. * * @member {string} [databaseName] the name of the database. * @member {string} [schemaName] the name of the schema associated with this * table and database. * @member {string} [name] the name of the table. * @member {array} [columnList] the list of columns in this table * @member {array} [indexList] the list of indices in this table * @member {array} [partitionKeyList] the list of partition keys in the table * @member {object} [externalTable] the external table associated with the * table. * @member {string} [externalTable.tableName] the name of the table associated * with this database and schema. * @member {object} [externalTable.dataSource] the data source associated with * this external table. * @member {object} [externalTable.dataSource.name] the name of the external * table associated with this database, schema and table. * @member {string} [externalTable.dataSource.name.firstPart] the name of the * table associated with this database and schema. * @member {string} [externalTable.dataSource.name.secondPart] the name of the * table associated with this database and schema. * @member {string} [externalTable.dataSource.name.thirdPart] the name of the * table associated with this database and schema. * @member {string} [externalTable.dataSource.name.server] the name of the * table associated with this database and schema. * @member {uuid} [externalTable.dataSource.version] the version of the * external data source. * @member {object} [distributionInfo] the distributions info of the table * @member {number} [distributionInfo.type] the type of this distribution. * @member {array} [distributionInfo.keys] the list of directed columns in the * distribution * @member {number} [distributionInfo.count] the count of indices using this * distribution. * @member {number} [distributionInfo.dynamicCount] the dynamic count of * indices using this distribution. */ export interface USqlTable extends CatalogItem { databaseName?: string; schemaName?: string; name?: string; columnList?: USqlTableColumn[]; indexList?: USqlIndex[]; partitionKeyList?: string[]; externalTable?: ExternalTable; distributionInfo?: USqlDistributionInfo; } /** * @class * Initializes a new instance of the USqlType class. * @constructor * A Data Lake Analytics catalog U-SQL type item. * * @member {string} [databaseName] the name of the database. * @member {string} [schemaName] the name of the schema associated with this * table and database. * @member {string} [name] the name of type for this type. * @member {string} [typeFamily] the type family for this type. * @member {string} [cSharpName] the C# name for this type. * @member {string} [fullCSharpName] the fully qualified C# name for this type. * @member {number} [systemTypeId] the system type ID for this type. * @member {number} [userTypeId] the user type ID for this type. * @member {number} [schemaId] the schema ID for this type. * @member {number} [principalId] the principal ID for this type. * @member {boolean} [isNullable] the the switch indicating if this type is * nullable. * @member {boolean} [isUserDefined] the the switch indicating if this type is * user defined. * @member {boolean} [isAssemblyType] the the switch indicating if this type is * an assembly type. * @member {boolean} [isTableType] the the switch indicating if this type is a * table type. * @member {boolean} [isComplexType] the the switch indicating if this type is * a complex type. */ export interface USqlType extends CatalogItem { databaseName?: string; schemaName?: string; name?: string; typeFamily?: string; cSharpName?: string; fullCSharpName?: string; systemTypeId?: number; userTypeId?: number; schemaId?: number; principalId?: number; isNullable?: boolean; isUserDefined?: boolean; isAssemblyType?: boolean; isTableType?: boolean; isComplexType?: boolean; } /** * @class * Initializes a new instance of the USqlTableType class. * @constructor * A Data Lake Analytics catalog U-SQL table type item. * * @member {array} [columns] the type field information associated with this * table type. */ export interface USqlTableType extends USqlType { readonly columns?: TypeFieldInfo[]; } /** * @class * Initializes a new instance of the USqlView class. * @constructor * A Data Lake Analytics catalog U-SQL view item. * * @member {string} [databaseName] the name of the database. * @member {string} [schemaName] the name of the schema associated with this * view and database. * @member {string} [name] the name of the view. * @member {string} [definition] the defined query of the view. */ export interface USqlView extends CatalogItem { databaseName?: string; schemaName?: string; name?: string; definition?: string; } /** * @class * Initializes a new instance of the USqlPackage class. * @constructor * A Data Lake Analytics catalog U-SQL package item. * * @member {string} [databaseName] the name of the database containing the * package. * @member {string} [schemaName] the name of the schema associated with this * package and database. * @member {string} [name] the name of the package. * @member {string} [definition] the definition of the package. */ export interface USqlPackage extends CatalogItem { databaseName?: string; schemaName?: string; name?: string; definition?: string; } /** * @class * Initializes a new instance of the USqlTablePartition class. * @constructor * A Data Lake Analytics catalog U-SQL table partition item. * * @member {string} [databaseName] the name of the database. * @member {string} [schemaName] the name of the schema associated with this * table partition and database. * @member {string} [name] the name of the table partition. * @member {object} [parentName] the Ddl object of the partition's parent. * @member {string} [parentName.firstPart] the name of the table associated * with this database and schema. * @member {string} [parentName.secondPart] the name of the table associated * with this database and schema. * @member {string} [parentName.thirdPart] the name of the table associated * with this database and schema. * @member {string} [parentName.server] the name of the table associated with * this database and schema. * @member {number} [indexId] the index ID for this partition. * @member {array} [label] the list of labels associated with this partition. * @member {date} [createDate] the creation time of the partition */ export interface USqlTablePartition extends CatalogItem { databaseName?: string; schemaName?: string; name?: string; parentName?: DdlName; indexId?: number; label?: string[]; createDate?: Date; } /** * @class * Initializes a new instance of the USqlTableStatistics class. * @constructor * A Data Lake Analytics catalog U-SQL table statistics item. * * @member {string} [databaseName] the name of the database. * @member {string} [schemaName] the name of the schema associated with this * table and database. * @member {string} [tableName] the name of the table. * @member {string} [name] the name of the table statistics. * @member {string} [userStatName] the name of the user statistics. * @member {string} [statDataPath] the path to the statistics data. * @member {date} [createTime] the creation time of the statistics. * @member {date} [updateTime] the last time the statistics were updated. * @member {boolean} [isUserCreated] the switch indicating if these statistics * are user created. * @member {boolean} [isAutoCreated] the switch indicating if these statistics * are automatically created. * @member {boolean} [hasFilter] the switch indicating if these statistics have * a filter. * @member {string} [filterDefinition] the filter definition for the * statistics. * @member {array} [colNames] the list of column names associated with these * statistics. */ export interface USqlTableStatistics extends CatalogItem { databaseName?: string; schemaName?: string; tableName?: string; name?: string; userStatName?: string; statDataPath?: string; createTime?: Date; updateTime?: Date; isUserCreated?: boolean; isAutoCreated?: boolean; hasFilter?: boolean; filterDefinition?: string; colNames?: string[]; } /** * @class * Initializes a new instance of the USqlTableValuedFunction class. * @constructor * A Data Lake Analytics catalog U-SQL table valued function item. * * @member {string} [databaseName] the name of the database. * @member {string} [schemaName] the name of the schema associated with this * database. * @member {string} [name] the name of the table valued function. * @member {string} [definition] the definition of the table valued function. */ export interface USqlTableValuedFunction extends CatalogItem { databaseName?: string; schemaName?: string; name?: string; definition?: string; } /** * @class * Initializes a new instance of the USqlAssemblyFileInfo class. * @constructor * A Data Lake Analytics catalog U-SQL assembly file information item. * * @member {string} [type] the assembly file type. Possible values include: * 'Assembly', 'Resource', 'Nodeploy' * @member {string} [originalPath] the the original path to the assembly file. * @member {string} [contentPath] the the content path to the assembly file. */ export interface USqlAssemblyFileInfo { type?: string; originalPath?: string; contentPath?: string; } /** * @class * Initializes a new instance of the USqlAssemblyDependencyInfo class. * @constructor * A Data Lake Analytics catalog U-SQL dependency information item. * * @member {object} [entityId] the EntityId of the dependency. * @member {object} [entityId.name] the name of the external table associated * with this database, schema and table. * @member {string} [entityId.name.firstPart] the name of the table associated * with this database and schema. * @member {string} [entityId.name.secondPart] the name of the table associated * with this database and schema. * @member {string} [entityId.name.thirdPart] the name of the table associated * with this database and schema. * @member {string} [entityId.name.server] the name of the table associated * with this database and schema. * @member {uuid} [entityId.version] the version of the external data source. */ export interface USqlAssemblyDependencyInfo { entityId?: EntityId; } /** * @class * Initializes a new instance of the USqlAssembly class. * @constructor * A Data Lake Analytics catalog U-SQL Assembly. * * @member {string} [databaseName] the name of the database. * @member {string} [name] the name of the assembly. * @member {string} [clrName] the name of the CLR. * @member {boolean} [isVisible] the switch indicating if this assembly is * visible or not. * @member {boolean} [isUserDefined] the switch indicating if this assembly is * user defined or not. * @member {array} [files] the list of files associated with the assembly * @member {array} [dependencies] the list of dependencies associated with the * assembly */ export interface USqlAssembly extends CatalogItem { databaseName?: string; name?: string; clrName?: string; isVisible?: boolean; isUserDefined?: boolean; files?: USqlAssemblyFileInfo[]; dependencies?: USqlAssemblyDependencyInfo[]; } /** * @class * Initializes a new instance of the USqlAssemblyClr class. * @constructor * A Data Lake Analytics catalog U-SQL assembly CLR item. * * @member {string} [databaseName] the name of the database. * @member {string} [name] the name of the assembly. * @member {string} [clrName] the name of the CLR. */ export interface USqlAssemblyClr extends CatalogItem { databaseName?: string; name?: string; clrName?: string; } /** * @class * Initializes a new instance of the USqlSchema class. * @constructor * A Data Lake Analytics catalog U-SQL schema item. * * @member {string} [databaseName] the name of the database. * @member {string} [name] the name of the schema. */ export interface USqlSchema extends CatalogItem { databaseName?: string; name?: string; } /** * @class * Initializes a new instance of the USqlDatabase class. * @constructor * A Data Lake Analytics catalog U-SQL database item. * * @member {string} [name] the name of the database. */ export interface USqlDatabase extends CatalogItem { name?: string; } /** * @class * Initializes a new instance of the CatalogItemList class. * @constructor * A Data Lake Analytics catalog item list. * * @member {string} [nextLink] the link to the next page of results. */ export interface CatalogItemList { nextLink?: string; } /** * @class * Initializes a new instance of the USqlCredentialList class. * @constructor * A Data Lake Analytics catalog U-SQL credential item list. * */ export interface USqlCredentialList extends Array<USqlCredential> { } /** * @class * Initializes a new instance of the USqlExternalDataSourceList class. * @constructor * A Data Lake Analytics catalog U-SQL external datasource item list. * */ export interface USqlExternalDataSourceList extends Array<USqlExternalDataSource> { } /** * @class * Initializes a new instance of the USqlProcedureList class. * @constructor * A Data Lake Analytics catalog U-SQL procedure item list. * */ export interface USqlProcedureList extends Array<USqlProcedure> { } /** * @class * Initializes a new instance of the USqlTableList class. * @constructor * A Data Lake Analytics catalog U-SQL table item list. * */ export interface USqlTableList extends Array<USqlTable> { } /** * @class * Initializes a new instance of the USqlTableStatisticsList class. * @constructor * A Data Lake Analytics catalog U-SQL table statistics item list. * */ export interface USqlTableStatisticsList extends Array<USqlTableStatistics> { } /** * @class * Initializes a new instance of the USqlTableTypeList class. * @constructor * A Data Lake Analytics catalog U-SQL table type item list. * */ export interface USqlTableTypeList extends Array<USqlTableType> { } /** * @class * Initializes a new instance of the USqlPackageList class. * @constructor * A Data Lake Analytics catalog U-SQL package item list. * */ export interface USqlPackageList extends Array<USqlPackage> { } /** * @class * Initializes a new instance of the USqlViewList class. * @constructor * A Data Lake Analytics catalog U-SQL view item list. * */ export interface USqlViewList extends Array<USqlView> { } /** * @class * Initializes a new instance of the USqlTablePartitionList class. * @constructor * A Data Lake Analytics catalog U-SQL table partition item list. * */ export interface USqlTablePartitionList extends Array<USqlTablePartition> { } /** * @class * Initializes a new instance of the USqlTypeList class. * @constructor * A Data Lake Analytics catalog U-SQL type item list. * */ export interface USqlTypeList extends Array<USqlType> { } /** * @class * Initializes a new instance of the USqlTableValuedFunctionList class. * @constructor * A Data Lake Analytics catalog U-SQL table valued function item list. * */ export interface USqlTableValuedFunctionList extends Array<USqlTableValuedFunction> { } /** * @class * Initializes a new instance of the USqlAssemblyList class. * @constructor * A Data Lake Analytics catalog U-SQL assembly CLR item list. * */ export interface USqlAssemblyList extends Array<USqlAssemblyClr> { } /** * @class * Initializes a new instance of the USqlSchemaList class. * @constructor * A Data Lake Analytics catalog U-SQL schema item list. * */ export interface USqlSchemaList extends Array<USqlSchema> { } /** * @class * Initializes a new instance of the USqlDatabaseList class. * @constructor * A Data Lake Analytics catalog U-SQL database item list. * */ export interface USqlDatabaseList extends Array<USqlDatabase> { }