UNPKG

1.5 kBTypeScriptView Raw
1/*!
2 * Copyright 2020 Google LLC
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16import { ServiceObject, ResponseCallback, SetMetadataResponse } from '@google-cloud/common';
17import { Dataset, RoutineMetadata } from './dataset';
18/**
19 * Routine objects are returned by methods such as
20 * {@link Dataset#routine}, {@link Dataset#createRoutine}, and
21 * {@link Dataset#getRoutines}.
22 *
23 * @class
24 * @param {Dataset} dataset {@link Dataset} instance.
25 * @param {string} id The ID of the routine.
26 *
27 * @example
28 * ```
29 * const {BigQuery} = require('@google-cloud/bigquery');
30 * const bigquery = new BigQuery();
31 * const dataset = bigquery.dataset('my-dataset');
32 *
33 * const routine = dataset.routine('my_routine');
34 * ```
35 */
36declare class Routine extends ServiceObject {
37 constructor(dataset: Dataset, id: string);
38 setMetadata(metadata: RoutineMetadata): Promise<SetMetadataResponse>;
39 setMetadata(metadata: RoutineMetadata, callback: ResponseCallback): void;
40}
41export { Routine };