@google-cloud/bigquery-data-transfer
Version:
BigQuery Data Transfer API client for Node.js
861 lines (696 loc) • 637 kB
TypeScript
// Copyright 2025 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
import type {protobuf as $protobuf} from "google-gax";
import Long = require("long");
/** Namespace google. */
export namespace google {
/** Namespace cloud. */
namespace cloud {
/** Namespace bigquery. */
namespace bigquery {
/** Namespace datatransfer. */
namespace datatransfer {
/** Namespace v1. */
namespace v1 {
/** Represents a DataTransferService */
class DataTransferService extends $protobuf.rpc.Service {
/**
* Constructs a new DataTransferService service.
* @param rpcImpl RPC implementation
* @param [requestDelimited=false] Whether requests are length-delimited
* @param [responseDelimited=false] Whether responses are length-delimited
*/
constructor(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean);
/**
* Creates new DataTransferService service using the specified rpc implementation.
* @param rpcImpl RPC implementation
* @param [requestDelimited=false] Whether requests are length-delimited
* @param [responseDelimited=false] Whether responses are length-delimited
* @returns RPC service. Useful where requests and/or responses are streamed.
*/
public static create(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean): DataTransferService;
/**
* Calls GetDataSource.
* @param request GetDataSourceRequest message or plain object
* @param callback Node-style callback called with the error, if any, and DataSource
*/
public getDataSource(request: google.cloud.bigquery.datatransfer.v1.IGetDataSourceRequest, callback: google.cloud.bigquery.datatransfer.v1.DataTransferService.GetDataSourceCallback): void;
/**
* Calls GetDataSource.
* @param request GetDataSourceRequest message or plain object
* @returns Promise
*/
public getDataSource(request: google.cloud.bigquery.datatransfer.v1.IGetDataSourceRequest): Promise<google.cloud.bigquery.datatransfer.v1.DataSource>;
/**
* Calls ListDataSources.
* @param request ListDataSourcesRequest message or plain object
* @param callback Node-style callback called with the error, if any, and ListDataSourcesResponse
*/
public listDataSources(request: google.cloud.bigquery.datatransfer.v1.IListDataSourcesRequest, callback: google.cloud.bigquery.datatransfer.v1.DataTransferService.ListDataSourcesCallback): void;
/**
* Calls ListDataSources.
* @param request ListDataSourcesRequest message or plain object
* @returns Promise
*/
public listDataSources(request: google.cloud.bigquery.datatransfer.v1.IListDataSourcesRequest): Promise<google.cloud.bigquery.datatransfer.v1.ListDataSourcesResponse>;
/**
* Calls CreateTransferConfig.
* @param request CreateTransferConfigRequest message or plain object
* @param callback Node-style callback called with the error, if any, and TransferConfig
*/
public createTransferConfig(request: google.cloud.bigquery.datatransfer.v1.ICreateTransferConfigRequest, callback: google.cloud.bigquery.datatransfer.v1.DataTransferService.CreateTransferConfigCallback): void;
/**
* Calls CreateTransferConfig.
* @param request CreateTransferConfigRequest message or plain object
* @returns Promise
*/
public createTransferConfig(request: google.cloud.bigquery.datatransfer.v1.ICreateTransferConfigRequest): Promise<google.cloud.bigquery.datatransfer.v1.TransferConfig>;
/**
* Calls UpdateTransferConfig.
* @param request UpdateTransferConfigRequest message or plain object
* @param callback Node-style callback called with the error, if any, and TransferConfig
*/
public updateTransferConfig(request: google.cloud.bigquery.datatransfer.v1.IUpdateTransferConfigRequest, callback: google.cloud.bigquery.datatransfer.v1.DataTransferService.UpdateTransferConfigCallback): void;
/**
* Calls UpdateTransferConfig.
* @param request UpdateTransferConfigRequest message or plain object
* @returns Promise
*/
public updateTransferConfig(request: google.cloud.bigquery.datatransfer.v1.IUpdateTransferConfigRequest): Promise<google.cloud.bigquery.datatransfer.v1.TransferConfig>;
/**
* Calls DeleteTransferConfig.
* @param request DeleteTransferConfigRequest message or plain object
* @param callback Node-style callback called with the error, if any, and Empty
*/
public deleteTransferConfig(request: google.cloud.bigquery.datatransfer.v1.IDeleteTransferConfigRequest, callback: google.cloud.bigquery.datatransfer.v1.DataTransferService.DeleteTransferConfigCallback): void;
/**
* Calls DeleteTransferConfig.
* @param request DeleteTransferConfigRequest message or plain object
* @returns Promise
*/
public deleteTransferConfig(request: google.cloud.bigquery.datatransfer.v1.IDeleteTransferConfigRequest): Promise<google.protobuf.Empty>;
/**
* Calls GetTransferConfig.
* @param request GetTransferConfigRequest message or plain object
* @param callback Node-style callback called with the error, if any, and TransferConfig
*/
public getTransferConfig(request: google.cloud.bigquery.datatransfer.v1.IGetTransferConfigRequest, callback: google.cloud.bigquery.datatransfer.v1.DataTransferService.GetTransferConfigCallback): void;
/**
* Calls GetTransferConfig.
* @param request GetTransferConfigRequest message or plain object
* @returns Promise
*/
public getTransferConfig(request: google.cloud.bigquery.datatransfer.v1.IGetTransferConfigRequest): Promise<google.cloud.bigquery.datatransfer.v1.TransferConfig>;
/**
* Calls ListTransferConfigs.
* @param request ListTransferConfigsRequest message or plain object
* @param callback Node-style callback called with the error, if any, and ListTransferConfigsResponse
*/
public listTransferConfigs(request: google.cloud.bigquery.datatransfer.v1.IListTransferConfigsRequest, callback: google.cloud.bigquery.datatransfer.v1.DataTransferService.ListTransferConfigsCallback): void;
/**
* Calls ListTransferConfigs.
* @param request ListTransferConfigsRequest message or plain object
* @returns Promise
*/
public listTransferConfigs(request: google.cloud.bigquery.datatransfer.v1.IListTransferConfigsRequest): Promise<google.cloud.bigquery.datatransfer.v1.ListTransferConfigsResponse>;
/**
* Calls ScheduleTransferRuns.
* @param request ScheduleTransferRunsRequest message or plain object
* @param callback Node-style callback called with the error, if any, and ScheduleTransferRunsResponse
*/
public scheduleTransferRuns(request: google.cloud.bigquery.datatransfer.v1.IScheduleTransferRunsRequest, callback: google.cloud.bigquery.datatransfer.v1.DataTransferService.ScheduleTransferRunsCallback): void;
/**
* Calls ScheduleTransferRuns.
* @param request ScheduleTransferRunsRequest message or plain object
* @returns Promise
*/
public scheduleTransferRuns(request: google.cloud.bigquery.datatransfer.v1.IScheduleTransferRunsRequest): Promise<google.cloud.bigquery.datatransfer.v1.ScheduleTransferRunsResponse>;
/**
* Calls StartManualTransferRuns.
* @param request StartManualTransferRunsRequest message or plain object
* @param callback Node-style callback called with the error, if any, and StartManualTransferRunsResponse
*/
public startManualTransferRuns(request: google.cloud.bigquery.datatransfer.v1.IStartManualTransferRunsRequest, callback: google.cloud.bigquery.datatransfer.v1.DataTransferService.StartManualTransferRunsCallback): void;
/**
* Calls StartManualTransferRuns.
* @param request StartManualTransferRunsRequest message or plain object
* @returns Promise
*/
public startManualTransferRuns(request: google.cloud.bigquery.datatransfer.v1.IStartManualTransferRunsRequest): Promise<google.cloud.bigquery.datatransfer.v1.StartManualTransferRunsResponse>;
/**
* Calls GetTransferRun.
* @param request GetTransferRunRequest message or plain object
* @param callback Node-style callback called with the error, if any, and TransferRun
*/
public getTransferRun(request: google.cloud.bigquery.datatransfer.v1.IGetTransferRunRequest, callback: google.cloud.bigquery.datatransfer.v1.DataTransferService.GetTransferRunCallback): void;
/**
* Calls GetTransferRun.
* @param request GetTransferRunRequest message or plain object
* @returns Promise
*/
public getTransferRun(request: google.cloud.bigquery.datatransfer.v1.IGetTransferRunRequest): Promise<google.cloud.bigquery.datatransfer.v1.TransferRun>;
/**
* Calls DeleteTransferRun.
* @param request DeleteTransferRunRequest message or plain object
* @param callback Node-style callback called with the error, if any, and Empty
*/
public deleteTransferRun(request: google.cloud.bigquery.datatransfer.v1.IDeleteTransferRunRequest, callback: google.cloud.bigquery.datatransfer.v1.DataTransferService.DeleteTransferRunCallback): void;
/**
* Calls DeleteTransferRun.
* @param request DeleteTransferRunRequest message or plain object
* @returns Promise
*/
public deleteTransferRun(request: google.cloud.bigquery.datatransfer.v1.IDeleteTransferRunRequest): Promise<google.protobuf.Empty>;
/**
* Calls ListTransferRuns.
* @param request ListTransferRunsRequest message or plain object
* @param callback Node-style callback called with the error, if any, and ListTransferRunsResponse
*/
public listTransferRuns(request: google.cloud.bigquery.datatransfer.v1.IListTransferRunsRequest, callback: google.cloud.bigquery.datatransfer.v1.DataTransferService.ListTransferRunsCallback): void;
/**
* Calls ListTransferRuns.
* @param request ListTransferRunsRequest message or plain object
* @returns Promise
*/
public listTransferRuns(request: google.cloud.bigquery.datatransfer.v1.IListTransferRunsRequest): Promise<google.cloud.bigquery.datatransfer.v1.ListTransferRunsResponse>;
/**
* Calls ListTransferLogs.
* @param request ListTransferLogsRequest message or plain object
* @param callback Node-style callback called with the error, if any, and ListTransferLogsResponse
*/
public listTransferLogs(request: google.cloud.bigquery.datatransfer.v1.IListTransferLogsRequest, callback: google.cloud.bigquery.datatransfer.v1.DataTransferService.ListTransferLogsCallback): void;
/**
* Calls ListTransferLogs.
* @param request ListTransferLogsRequest message or plain object
* @returns Promise
*/
public listTransferLogs(request: google.cloud.bigquery.datatransfer.v1.IListTransferLogsRequest): Promise<google.cloud.bigquery.datatransfer.v1.ListTransferLogsResponse>;
/**
* Calls CheckValidCreds.
* @param request CheckValidCredsRequest message or plain object
* @param callback Node-style callback called with the error, if any, and CheckValidCredsResponse
*/
public checkValidCreds(request: google.cloud.bigquery.datatransfer.v1.ICheckValidCredsRequest, callback: google.cloud.bigquery.datatransfer.v1.DataTransferService.CheckValidCredsCallback): void;
/**
* Calls CheckValidCreds.
* @param request CheckValidCredsRequest message or plain object
* @returns Promise
*/
public checkValidCreds(request: google.cloud.bigquery.datatransfer.v1.ICheckValidCredsRequest): Promise<google.cloud.bigquery.datatransfer.v1.CheckValidCredsResponse>;
/**
* Calls EnrollDataSources.
* @param request EnrollDataSourcesRequest message or plain object
* @param callback Node-style callback called with the error, if any, and Empty
*/
public enrollDataSources(request: google.cloud.bigquery.datatransfer.v1.IEnrollDataSourcesRequest, callback: google.cloud.bigquery.datatransfer.v1.DataTransferService.EnrollDataSourcesCallback): void;
/**
* Calls EnrollDataSources.
* @param request EnrollDataSourcesRequest message or plain object
* @returns Promise
*/
public enrollDataSources(request: google.cloud.bigquery.datatransfer.v1.IEnrollDataSourcesRequest): Promise<google.protobuf.Empty>;
/**
* Calls UnenrollDataSources.
* @param request UnenrollDataSourcesRequest message or plain object
* @param callback Node-style callback called with the error, if any, and Empty
*/
public unenrollDataSources(request: google.cloud.bigquery.datatransfer.v1.IUnenrollDataSourcesRequest, callback: google.cloud.bigquery.datatransfer.v1.DataTransferService.UnenrollDataSourcesCallback): void;
/**
* Calls UnenrollDataSources.
* @param request UnenrollDataSourcesRequest message or plain object
* @returns Promise
*/
public unenrollDataSources(request: google.cloud.bigquery.datatransfer.v1.IUnenrollDataSourcesRequest): Promise<google.protobuf.Empty>;
}
namespace DataTransferService {
/**
* Callback as used by {@link google.cloud.bigquery.datatransfer.v1.DataTransferService|getDataSource}.
* @param error Error, if any
* @param [response] DataSource
*/
type GetDataSourceCallback = (error: (Error|null), response?: google.cloud.bigquery.datatransfer.v1.DataSource) => void;
/**
* Callback as used by {@link google.cloud.bigquery.datatransfer.v1.DataTransferService|listDataSources}.
* @param error Error, if any
* @param [response] ListDataSourcesResponse
*/
type ListDataSourcesCallback = (error: (Error|null), response?: google.cloud.bigquery.datatransfer.v1.ListDataSourcesResponse) => void;
/**
* Callback as used by {@link google.cloud.bigquery.datatransfer.v1.DataTransferService|createTransferConfig}.
* @param error Error, if any
* @param [response] TransferConfig
*/
type CreateTransferConfigCallback = (error: (Error|null), response?: google.cloud.bigquery.datatransfer.v1.TransferConfig) => void;
/**
* Callback as used by {@link google.cloud.bigquery.datatransfer.v1.DataTransferService|updateTransferConfig}.
* @param error Error, if any
* @param [response] TransferConfig
*/
type UpdateTransferConfigCallback = (error: (Error|null), response?: google.cloud.bigquery.datatransfer.v1.TransferConfig) => void;
/**
* Callback as used by {@link google.cloud.bigquery.datatransfer.v1.DataTransferService|deleteTransferConfig}.
* @param error Error, if any
* @param [response] Empty
*/
type DeleteTransferConfigCallback = (error: (Error|null), response?: google.protobuf.Empty) => void;
/**
* Callback as used by {@link google.cloud.bigquery.datatransfer.v1.DataTransferService|getTransferConfig}.
* @param error Error, if any
* @param [response] TransferConfig
*/
type GetTransferConfigCallback = (error: (Error|null), response?: google.cloud.bigquery.datatransfer.v1.TransferConfig) => void;
/**
* Callback as used by {@link google.cloud.bigquery.datatransfer.v1.DataTransferService|listTransferConfigs}.
* @param error Error, if any
* @param [response] ListTransferConfigsResponse
*/
type ListTransferConfigsCallback = (error: (Error|null), response?: google.cloud.bigquery.datatransfer.v1.ListTransferConfigsResponse) => void;
/**
* Callback as used by {@link google.cloud.bigquery.datatransfer.v1.DataTransferService|scheduleTransferRuns}.
* @param error Error, if any
* @param [response] ScheduleTransferRunsResponse
*/
type ScheduleTransferRunsCallback = (error: (Error|null), response?: google.cloud.bigquery.datatransfer.v1.ScheduleTransferRunsResponse) => void;
/**
* Callback as used by {@link google.cloud.bigquery.datatransfer.v1.DataTransferService|startManualTransferRuns}.
* @param error Error, if any
* @param [response] StartManualTransferRunsResponse
*/
type StartManualTransferRunsCallback = (error: (Error|null), response?: google.cloud.bigquery.datatransfer.v1.StartManualTransferRunsResponse) => void;
/**
* Callback as used by {@link google.cloud.bigquery.datatransfer.v1.DataTransferService|getTransferRun}.
* @param error Error, if any
* @param [response] TransferRun
*/
type GetTransferRunCallback = (error: (Error|null), response?: google.cloud.bigquery.datatransfer.v1.TransferRun) => void;
/**
* Callback as used by {@link google.cloud.bigquery.datatransfer.v1.DataTransferService|deleteTransferRun}.
* @param error Error, if any
* @param [response] Empty
*/
type DeleteTransferRunCallback = (error: (Error|null), response?: google.protobuf.Empty) => void;
/**
* Callback as used by {@link google.cloud.bigquery.datatransfer.v1.DataTransferService|listTransferRuns}.
* @param error Error, if any
* @param [response] ListTransferRunsResponse
*/
type ListTransferRunsCallback = (error: (Error|null), response?: google.cloud.bigquery.datatransfer.v1.ListTransferRunsResponse) => void;
/**
* Callback as used by {@link google.cloud.bigquery.datatransfer.v1.DataTransferService|listTransferLogs}.
* @param error Error, if any
* @param [response] ListTransferLogsResponse
*/
type ListTransferLogsCallback = (error: (Error|null), response?: google.cloud.bigquery.datatransfer.v1.ListTransferLogsResponse) => void;
/**
* Callback as used by {@link google.cloud.bigquery.datatransfer.v1.DataTransferService|checkValidCreds}.
* @param error Error, if any
* @param [response] CheckValidCredsResponse
*/
type CheckValidCredsCallback = (error: (Error|null), response?: google.cloud.bigquery.datatransfer.v1.CheckValidCredsResponse) => void;
/**
* Callback as used by {@link google.cloud.bigquery.datatransfer.v1.DataTransferService|enrollDataSources}.
* @param error Error, if any
* @param [response] Empty
*/
type EnrollDataSourcesCallback = (error: (Error|null), response?: google.protobuf.Empty) => void;
/**
* Callback as used by {@link google.cloud.bigquery.datatransfer.v1.DataTransferService|unenrollDataSources}.
* @param error Error, if any
* @param [response] Empty
*/
type UnenrollDataSourcesCallback = (error: (Error|null), response?: google.protobuf.Empty) => void;
}
/** Properties of a DataSourceParameter. */
interface IDataSourceParameter {
/** DataSourceParameter paramId */
paramId?: (string|null);
/** DataSourceParameter displayName */
displayName?: (string|null);
/** DataSourceParameter description */
description?: (string|null);
/** DataSourceParameter type */
type?: (google.cloud.bigquery.datatransfer.v1.DataSourceParameter.Type|keyof typeof google.cloud.bigquery.datatransfer.v1.DataSourceParameter.Type|null);
/** DataSourceParameter required */
required?: (boolean|null);
/** DataSourceParameter repeated */
repeated?: (boolean|null);
/** DataSourceParameter validationRegex */
validationRegex?: (string|null);
/** DataSourceParameter allowedValues */
allowedValues?: (string[]|null);
/** DataSourceParameter minValue */
minValue?: (google.protobuf.IDoubleValue|null);
/** DataSourceParameter maxValue */
maxValue?: (google.protobuf.IDoubleValue|null);
/** DataSourceParameter fields */
fields?: (google.cloud.bigquery.datatransfer.v1.IDataSourceParameter[]|null);
/** DataSourceParameter validationDescription */
validationDescription?: (string|null);
/** DataSourceParameter validationHelpUrl */
validationHelpUrl?: (string|null);
/** DataSourceParameter immutable */
immutable?: (boolean|null);
/** DataSourceParameter recurse */
recurse?: (boolean|null);
/** DataSourceParameter deprecated */
deprecated?: (boolean|null);
}
/** Represents a DataSourceParameter. */
class DataSourceParameter implements IDataSourceParameter {
/**
* Constructs a new DataSourceParameter.
* @param [properties] Properties to set
*/
constructor(properties?: google.cloud.bigquery.datatransfer.v1.IDataSourceParameter);
/** DataSourceParameter paramId. */
public paramId: string;
/** DataSourceParameter displayName. */
public displayName: string;
/** DataSourceParameter description. */
public description: string;
/** DataSourceParameter type. */
public type: (google.cloud.bigquery.datatransfer.v1.DataSourceParameter.Type|keyof typeof google.cloud.bigquery.datatransfer.v1.DataSourceParameter.Type);
/** DataSourceParameter required. */
public required: boolean;
/** DataSourceParameter repeated. */
public repeated: boolean;
/** DataSourceParameter validationRegex. */
public validationRegex: string;
/** DataSourceParameter allowedValues. */
public allowedValues: string[];
/** DataSourceParameter minValue. */
public minValue?: (google.protobuf.IDoubleValue|null);
/** DataSourceParameter maxValue. */
public maxValue?: (google.protobuf.IDoubleValue|null);
/** DataSourceParameter fields. */
public fields: google.cloud.bigquery.datatransfer.v1.IDataSourceParameter[];
/** DataSourceParameter validationDescription. */
public validationDescription: string;
/** DataSourceParameter validationHelpUrl. */
public validationHelpUrl: string;
/** DataSourceParameter immutable. */
public immutable: boolean;
/** DataSourceParameter recurse. */
public recurse: boolean;
/** DataSourceParameter deprecated. */
public deprecated: boolean;
/**
* Creates a new DataSourceParameter instance using the specified properties.
* @param [properties] Properties to set
* @returns DataSourceParameter instance
*/
public static create(properties?: google.cloud.bigquery.datatransfer.v1.IDataSourceParameter): google.cloud.bigquery.datatransfer.v1.DataSourceParameter;
/**
* Encodes the specified DataSourceParameter message. Does not implicitly {@link google.cloud.bigquery.datatransfer.v1.DataSourceParameter.verify|verify} messages.
* @param message DataSourceParameter message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encode(message: google.cloud.bigquery.datatransfer.v1.IDataSourceParameter, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Encodes the specified DataSourceParameter message, length delimited. Does not implicitly {@link google.cloud.bigquery.datatransfer.v1.DataSourceParameter.verify|verify} messages.
* @param message DataSourceParameter message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encodeDelimited(message: google.cloud.bigquery.datatransfer.v1.IDataSourceParameter, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Decodes a DataSourceParameter message from the specified reader or buffer.
* @param reader Reader or buffer to decode from
* @param [length] Message length if known beforehand
* @returns DataSourceParameter
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.bigquery.datatransfer.v1.DataSourceParameter;
/**
* Decodes a DataSourceParameter message from the specified reader or buffer, length delimited.
* @param reader Reader or buffer to decode from
* @returns DataSourceParameter
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.bigquery.datatransfer.v1.DataSourceParameter;
/**
* Verifies a DataSourceParameter message.
* @param message Plain object to verify
* @returns `null` if valid, otherwise the reason why it is not
*/
public static verify(message: { [k: string]: any }): (string|null);
/**
* Creates a DataSourceParameter message from a plain object. Also converts values to their respective internal types.
* @param object Plain object
* @returns DataSourceParameter
*/
public static fromObject(object: { [k: string]: any }): google.cloud.bigquery.datatransfer.v1.DataSourceParameter;
/**
* Creates a plain object from a DataSourceParameter message. Also converts values to other types if specified.
* @param message DataSourceParameter
* @param [options] Conversion options
* @returns Plain object
*/
public static toObject(message: google.cloud.bigquery.datatransfer.v1.DataSourceParameter, options?: $protobuf.IConversionOptions): { [k: string]: any };
/**
* Converts this DataSourceParameter to JSON.
* @returns JSON object
*/
public toJSON(): { [k: string]: any };
/**
* Gets the default type url for DataSourceParameter
* @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
* @returns The default type url
*/
public static getTypeUrl(typeUrlPrefix?: string): string;
}
namespace DataSourceParameter {
/** Type enum. */
enum Type {
TYPE_UNSPECIFIED = 0,
STRING = 1,
INTEGER = 2,
DOUBLE = 3,
BOOLEAN = 4,
RECORD = 5,
PLUS_PAGE = 6,
LIST = 7
}
}
/** Properties of a DataSource. */
interface IDataSource {
/** DataSource name */
name?: (string|null);
/** DataSource dataSourceId */
dataSourceId?: (string|null);
/** DataSource displayName */
displayName?: (string|null);
/** DataSource description */
description?: (string|null);
/** DataSource clientId */
clientId?: (string|null);
/** DataSource scopes */
scopes?: (string[]|null);
/** DataSource transferType */
transferType?: (google.cloud.bigquery.datatransfer.v1.TransferType|keyof typeof google.cloud.bigquery.datatransfer.v1.TransferType|null);
/** DataSource supportsMultipleTransfers */
supportsMultipleTransfers?: (boolean|null);
/** DataSource updateDeadlineSeconds */
updateDeadlineSeconds?: (number|null);
/** DataSource defaultSchedule */
defaultSchedule?: (string|null);
/** DataSource supportsCustomSchedule */
supportsCustomSchedule?: (boolean|null);
/** DataSource parameters */
parameters?: (google.cloud.bigquery.datatransfer.v1.IDataSourceParameter[]|null);
/** DataSource helpUrl */
helpUrl?: (string|null);
/** DataSource authorizationType */
authorizationType?: (google.cloud.bigquery.datatransfer.v1.DataSource.AuthorizationType|keyof typeof google.cloud.bigquery.datatransfer.v1.DataSource.AuthorizationType|null);
/** DataSource dataRefreshType */
dataRefreshType?: (google.cloud.bigquery.datatransfer.v1.DataSource.DataRefreshType|keyof typeof google.cloud.bigquery.datatransfer.v1.DataSource.DataRefreshType|null);
/** DataSource defaultDataRefreshWindowDays */
defaultDataRefreshWindowDays?: (number|null);
/** DataSource manualRunsDisabled */
manualRunsDisabled?: (boolean|null);
/** DataSource minimumScheduleInterval */
minimumScheduleInterval?: (google.protobuf.IDuration|null);
}
/** Represents a DataSource. */
class DataSource implements IDataSource {
/**
* Constructs a new DataSource.
* @param [properties] Properties to set
*/
constructor(properties?: google.cloud.bigquery.datatransfer.v1.IDataSource);
/** DataSource name. */
public name: string;
/** DataSource dataSourceId. */
public dataSourceId: string;
/** DataSource displayName. */
public displayName: string;
/** DataSource description. */
public description: string;
/** DataSource clientId. */
public clientId: string;
/** DataSource scopes. */
public scopes: string[];
/** DataSource transferType. */
public transferType: (google.cloud.bigquery.datatransfer.v1.TransferType|keyof typeof google.cloud.bigquery.datatransfer.v1.TransferType);
/** DataSource supportsMultipleTransfers. */
public supportsMultipleTransfers: boolean;
/** DataSource updateDeadlineSeconds. */
public updateDeadlineSeconds: number;
/** DataSource defaultSchedule. */
public defaultSchedule: string;
/** DataSource supportsCustomSchedule. */
public supportsCustomSchedule: boolean;
/** DataSource parameters. */
public parameters: google.cloud.bigquery.datatransfer.v1.IDataSourceParameter[];
/** DataSource helpUrl. */
public helpUrl: string;
/** DataSource authorizationType. */
public authorizationType: (google.cloud.bigquery.datatransfer.v1.DataSource.AuthorizationType|keyof typeof google.cloud.bigquery.datatransfer.v1.DataSource.AuthorizationType);
/** DataSource dataRefreshType. */
public dataRefreshType: (google.cloud.bigquery.datatransfer.v1.DataSource.DataRefreshType|keyof typeof google.cloud.bigquery.datatransfer.v1.DataSource.DataRefreshType);
/** DataSource defaultDataRefreshWindowDays. */
public defaultDataRefreshWindowDays: number;
/** DataSource manualRunsDisabled. */
public manualRunsDisabled: boolean;
/** DataSource minimumScheduleInterval. */
public minimumScheduleInterval?: (google.protobuf.IDuration|null);
/**
* Creates a new DataSource instance using the specified properties.
* @param [properties] Properties to set
* @returns DataSource instance
*/
public static create(properties?: google.cloud.bigquery.datatransfer.v1.IDataSource): google.cloud.bigquery.datatransfer.v1.DataSource;
/**
* Encodes the specified DataSource message. Does not implicitly {@link google.cloud.bigquery.datatransfer.v1.DataSource.verify|verify} messages.
* @param message DataSource message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encode(message: google.cloud.bigquery.datatransfer.v1.IDataSource, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Encodes the specified DataSource message, length delimited. Does not implicitly {@link google.cloud.bigquery.datatransfer.v1.DataSource.verify|verify} messages.
* @param message DataSource message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encodeDelimited(message: google.cloud.bigquery.datatransfer.v1.IDataSource, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Decodes a DataSource message from the specified reader or buffer.
* @param reader Reader or buffer to decode from
* @param [length] Message length if known beforehand
* @returns DataSource
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.bigquery.datatransfer.v1.DataSource;
/**
* Decodes a DataSource message from the specified reader or buffer, length delimited.
* @param reader Reader or buffer to decode from
* @returns DataSource
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.bigquery.datatransfer.v1.DataSource;
/**
* Verifies a DataSource message.
* @param message Plain object to verify
* @returns `null` if valid, otherwise the reason why it is not
*/
public static verify(message: { [k: string]: any }): (string|null);
/**
* Creates a DataSource message from a plain object. Also converts values to their respective internal types.
* @param object Plain object
* @returns DataSource
*/
public static fromObject(object: { [k: string]: any }): google.cloud.bigquery.datatransfer.v1.DataSource;
/**
* Creates a plain object from a DataSource message. Also converts values to other types if specified.
* @param message DataSource
* @param [options] Conversion options
* @returns Plain object
*/
public static toObject(message: google.cloud.bigquery.datatransfer.v1.DataSource, options?: $protobuf.IConversionOptions): { [k: string]: any };
/**
* Converts this DataSource to JSON.
* @returns JSON object
*/
public toJSON(): { [k: string]: any };
/**
* Gets the default type url for DataSource
* @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
* @returns The default type url
*/
public static getTypeUrl(typeUrlPrefix?: string): string;
}
namespace DataSource {
/** AuthorizationType enum. */
enum AuthorizationType {
AUTHORIZATION_TYPE_UNSPECIFIED = 0,
AUTHORIZATION_CODE = 1,
GOOGLE_PLUS_AUTHORIZATION_CODE = 2,
FIRST_PARTY_OAUTH = 3
}
/** DataRefreshType enum. */
enum DataRefreshType {
DATA_REFRESH_TYPE_UNSPECIFIED = 0,
SLIDING_WINDOW = 1,
CUSTOM_SLIDING_WINDOW = 2
}
}
/** Properties of a GetDataSourceRequest. */
interface IGetDataSourceRequest {
/** GetDataSourceRequest name */
name?: (string|null);
}
/** Represents a GetDataSourceRequest. */
class GetDataSourceRequest implements IGetDataSourceRequest {
/**
* Constructs a new GetDataSourceRequest.
* @param [properties] Properties to set
*/
constructor(properties?: google.cloud.bigquery.datatransfer.v1.IGetDataSourceRequest);
/** GetDataSourceRequest name. */
public name: string;
/**
* Creates a new GetDataSourceRequest instance using the specified properties.
* @param [properties] Properties to set
* @returns GetDataSourceRequest instance
*/
public static create(properties?: google.cloud.bigquery.datatransfer.v1.IGetDataSourceRequest): google.cloud.bigquery.datatransfer.v1.GetDataSourceRequest;
/**
* Encodes the specified GetDataSourceRequest message. Does not implicitly {@link google.cloud.bigquery.datatransfer.v1.GetDataSourceRequest.verify|verify} messages.
* @param message GetDataSourceRequest message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encode(message: google.cloud.bigquery.datatransfer.v1.IGetDataSourceRequest, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Encodes the specified GetDataSourceRequest message, length delimited. Does not implicitly {@link google.cloud.bigquery.datatransfer.v1.GetDataSourceRequest.verify|verify} messages.
* @param message GetDataSourceRequest message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encodeDelimited(message: google.cloud.bigquery.datatransfer.v1.IGetDataSourceRequest, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Decodes a GetDataSourceRequest message from the specified reader or buffer.
* @param reader Reader or buffer to decode from
* @param [length] Message length if known beforehand
* @returns GetDataSourceRequest
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.bigquery.datatransfer.v