Class protos.google.cloud.bigquery.datatransfer.v1.DataSourceParameter (2.2.7)

Represents a DataSourceParameter.

Package

@google-cloud/bigquery-data-transfer!

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.bigquery.datatransfer.v1.IDataSourceParameter);

Constructs a new DataSourceParameter.

Parameter

Name	Description
properties	`IDataSourceParameter` Properties to set

Properties

allowedValues

public allowedValues: string[];

DataSourceParameter allowedValues.

Property Value

Type	Description
string[]

deprecated

public deprecated: boolean;

DataSourceParameter deprecated.

Property Value

Type	Description
boolean

description

public description: string;

DataSourceParameter description.

Property Value

Type	Description
string

displayName

public displayName: string;

DataSourceParameter displayName.

Property Value

Type	Description
string

fields

public fields: google.cloud.bigquery.datatransfer.v1.IDataSourceParameter[];

DataSourceParameter fields.

Property Value

Type	Description
google.cloud.bigquery.datatransfer.v1.IDataSourceParameter[]

immutable

public immutable: boolean;

DataSourceParameter immutable.

Property Value

Type	Description
boolean

maxValue

public maxValue?: (google.protobuf.IDoubleValue|null);

DataSourceParameter maxValue.

Property Value

Type	Description
(google.protobuf.IDoubleValue\|null)

minValue

public minValue?: (google.protobuf.IDoubleValue|null);

DataSourceParameter minValue.

Property Value

Type	Description
(google.protobuf.IDoubleValue\|null)

paramId

public paramId: string;

DataSourceParameter paramId.

Property Value

Type	Description
string

recurse

public recurse: boolean;

DataSourceParameter recurse.

Property Value

Type	Description
boolean

repeated

public repeated: boolean;

DataSourceParameter repeated.

Property Value

Type	Description
boolean

required

public required: boolean;

DataSourceParameter required.

Property Value

Type	Description
boolean

type

public type: (google.cloud.bigquery.datatransfer.v1.DataSourceParameter.Type|keyof typeof google.cloud.bigquery.datatransfer.v1.DataSourceParameter.Type);

DataSourceParameter type.

Property Value

Type	Description
(google.cloud.bigquery.datatransfer.v1.DataSourceParameter.Type\|keyof typeof google.cloud.bigquery.datatransfer.v1.DataSourceParameter.Type)

validationDescription

public validationDescription: string;

DataSourceParameter validationDescription.

Property Value

Type	Description
string

validationHelpUrl

public validationHelpUrl: string;

DataSourceParameter validationHelpUrl.

Property Value

Type	Description
string

validationRegex

public validationRegex: string;

DataSourceParameter validationRegex.

Property Value

Type	Description
string

Methods

create(properties)

public static create(properties?: google.cloud.bigquery.datatransfer.v1.IDataSourceParameter): google.cloud.bigquery.datatransfer.v1.DataSourceParameter;

Creates a new DataSourceParameter instance using the specified properties.

Parameter

Name	Description
properties	`IDataSourceParameter` Properties to set

Returns

Type	Description
google.cloud.bigquery.datatransfer.v1.DataSourceParameter	DataSourceParameter instance

decode(reader, length)

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.

Parameters

Name	Description
reader	`($protobuf.Reader\|Uint8Array)` Reader or buffer to decode from
length	`number` Message length if known beforehand

Returns

Type	Description
google.cloud.bigquery.datatransfer.v1.DataSourceParameter	DataSourceParameter

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.bigquery.datatransfer.v1.DataSourceParameter;

Decodes a DataSourceParameter message from the specified reader or buffer, length delimited.

Parameter

Name	Description
reader	`($protobuf.Reader\|Uint8Array)` Reader or buffer to decode from

Returns

Type	Description
google.cloud.bigquery.datatransfer.v1.DataSourceParameter	DataSourceParameter

encode(message, writer)

public static encode(message: google.cloud.bigquery.datatransfer.v1.IDataSourceParameter, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified DataSourceParameter message. Does not implicitly messages.

Parameters

Name	Description
message	`IDataSourceParameter` DataSourceParameter message or plain object to encode
writer	`$protobuf.Writer` Writer to encode to

Returns

Type	Description
$protobuf.Writer	Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.cloud.bigquery.datatransfer.v1.IDataSourceParameter, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified DataSourceParameter message, length delimited. Does not implicitly messages.

Parameters

Name	Description
message	`IDataSourceParameter` DataSourceParameter message or plain object to encode
writer	`$protobuf.Writer` Writer to encode to

Returns

Type	Description
$protobuf.Writer	Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.cloud.bigquery.datatransfer.v1.DataSourceParameter;

Creates a DataSourceParameter message from a plain object. Also converts values to their respective internal types.

Parameter

Name	Description
object	`{ [k: string]: any }` Plain object

Returns

Type	Description
google.cloud.bigquery.datatransfer.v1.DataSourceParameter	DataSourceParameter

toJSON()

public toJSON(): { [k: string]: any };

Converts this DataSourceParameter to JSON.

Returns

Type	Description
{ [k: string]: any }	JSON object

toObject(message, options)

public static toObject(message: google.cloud.bigquery.datatransfer.v1.DataSourceParameter, options?: $protobuf.IConversionOptions): { [k: string]: any };

Creates a plain object from a DataSourceParameter message. Also converts values to other types if specified.

Parameters

Name	Description
message	`google.cloud.bigquery.datatransfer.v1.DataSourceParameter` DataSourceParameter
options	`$protobuf.IConversionOptions` Conversion options

Returns

Type	Description
{ [k: string]: any }	Plain object

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies a DataSourceParameter message.

Parameter

Name	Description
message	`{ [k: string]: any }` Plain object to verify

Returns

Type	Description
(string\|null)	`null` if valid, otherwise the reason why it is not