DataSourceParameter

import type { DataSourceParameter } from "https://googleapis.deno.dev/v1/bigquerydatatransfer:v1.ts";

A parameter used to define custom fields in a data source definition.

interface DataSourceParameter {

allowedValues?: string[];

deprecated?: boolean;

description?: string;

displayName?: string;

fields?: DataSourceParameter[];

immutable?: boolean;

maxValue?: number;

minValue?: number;

paramId?: string;

recurse?: boolean;

repeated?: boolean;

required?: boolean;

type?:

| "TYPE_UNSPECIFIED"

| "STRING"

| "INTEGER"

| "DOUBLE"

| "BOOLEAN"

| "RECORD"

| "PLUS_PAGE"

| "LIST";

validationDescription?: string;

validationHelpUrl?: string;

validationRegex?: string;

}

§Properties

allowedValues?: string[]

[src]

All possible values for the parameter.

deprecated?: boolean

[src]

If true, it should not be used in new transfers, and it should not be visible to users.

description?: string

[src]

Parameter description.

displayName?: string

[src]

Parameter display name in the user interface.

fields?: DataSourceParameter[]

[src]

Deprecated. This field has no effect.

immutable?: boolean

[src]

Cannot be changed after initial creation.

maxValue?: number

[src]

For integer and double values specifies maximum allowed value.

minValue?: number

[src]

For integer and double values specifies minimum allowed value.

paramId?: string

[src]

Parameter identifier.

recurse?: boolean

[src]

Deprecated. This field has no effect.

repeated?: boolean

[src]

Deprecated. This field has no effect.

required?: boolean

[src]

Is parameter required.

[src]

Parameter type.

validationDescription?: string

[src]

Description of the requirements for this field, in case the user input does not fulfill the regex pattern or min/max values.

validationHelpUrl?: string

[src]

URL to a help document to further explain the naming requirements.

validationRegex?: string

[src]

Regular expression which can be used for parameter validation.