azure-arm-datalake-analytics/lib/catalog/models/uSqlTable.js

Microsoft Azure Data Lake Analytics Management Client Library for node

/*
 * 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.
 */

'use strict';

const models = require('./index');

/**
 * A Data Lake Analytics catalog U-SQL table item.
 *
 * @extends models['CatalogItem']
 */
class USqlTable extends models['CatalogItem'] {
  /**
   * Create a USqlTable.
   * @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.
   */
  constructor() {
    super();
  }

  /**
   * Defines the metadata of USqlTable
   *
   * @returns {object} metadata of USqlTable
   *
   */
  mapper() {
    return {
      required: false,
      serializedName: 'USqlTable',
      type: {
        name: 'Composite',
        className: 'USqlTable',
        modelProperties: {
          computeAccountName: {
            required: false,
            serializedName: 'computeAccountName',
            type: {
              name: 'String'
            }
          },
          version: {
            required: false,
            serializedName: 'version',
            type: {
              name: 'String'
            }
          },
          databaseName: {
            required: false,
            serializedName: 'databaseName',
            type: {
              name: 'String'
            }
          },
          schemaName: {
            required: false,
            serializedName: 'schemaName',
            type: {
              name: 'String'
            }
          },
          name: {
            required: false,
            serializedName: 'tableName',
            type: {
              name: 'String'
            }
          },
          columnList: {
            required: false,
            serializedName: 'columnList',
            type: {
              name: 'Sequence',
              element: {
                  required: false,
                  serializedName: 'USqlTableColumnElementType',
                  type: {
                    name: 'Composite',
                    className: 'USqlTableColumn'
                  }
              }
            }
          },
          indexList: {
            required: false,
            serializedName: 'indexList',
            type: {
              name: 'Sequence',
              element: {
                  required: false,
                  serializedName: 'USqlIndexElementType',
                  type: {
                    name: 'Composite',
                    className: 'USqlIndex'
                  }
              }
            }
          },
          partitionKeyList: {
            required: false,
            serializedName: 'partitionKeyList',
            type: {
              name: 'Sequence',
              element: {
                  required: false,
                  serializedName: 'StringElementType',
                  type: {
                    name: 'String'
                  }
              }
            }
          },
          externalTable: {
            required: false,
            serializedName: 'externalTable',
            type: {
              name: 'Composite',
              className: 'ExternalTable'
            }
          },
          distributionInfo: {
            required: false,
            serializedName: 'distributionInfo',
            type: {
              name: 'Composite',
              className: 'USqlDistributionInfo'
            }
          }
        }
      }
    };
  }
}

module.exports = USqlTable;