DataSourceParameter

google.cloud.bigquery.datatransfer.v1. DataSourceParameter

Represents a DataSourceParameter.

Constructor

new DataSourceParameter(propertiesopt)

Constructs a new DataSourceParameter.

Parameters:
Name Type Attributes Description
properties google.cloud.bigquery.datatransfer.v1.IDataSourceParameter <optional>

Properties to set

Implements:
  • IDataSourceParameter

Members

allowedValues

DataSourceParameter allowedValues.

deprecated

DataSourceParameter deprecated.

description

DataSourceParameter description.

displayName

DataSourceParameter displayName.

fields

DataSourceParameter fields.

immutable

DataSourceParameter immutable.

maxValue

DataSourceParameter maxValue.

minValue

DataSourceParameter minValue.

paramId

DataSourceParameter paramId.

recurse

DataSourceParameter recurse.

repeated

DataSourceParameter repeated.

required

DataSourceParameter required.

type

DataSourceParameter type.

validationDescription

DataSourceParameter validationDescription.

validationHelpUrl

DataSourceParameter validationHelpUrl.

validationRegex

DataSourceParameter validationRegex.

Type

Type enum.

Properties:
Name Type Description
TYPE_UNSPECIFIED number

TYPE_UNSPECIFIED value

STRING number

STRING value

INTEGER number

INTEGER value

DOUBLE number

DOUBLE value

BOOLEAN number

BOOLEAN value

RECORD number

RECORD value

PLUS_PAGE number

PLUS_PAGE value

LIST number

LIST value

Methods

toJSON() → {Object.<string, *>}

Converts this DataSourceParameter to JSON.

Returns:
Type Description
Object.<string, *>

JSON object

(static) create(propertiesopt) → {google.cloud.bigquery.datatransfer.v1.DataSourceParameter}

Creates a new DataSourceParameter instance using the specified properties.

Parameters:
Name Type Attributes Description
properties google.cloud.bigquery.datatransfer.v1.IDataSourceParameter <optional>

Properties to set

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

DataSourceParameter instance

(static) decode(reader, lengthopt) → {google.cloud.bigquery.datatransfer.v1.DataSourceParameter}

Decodes a DataSourceParameter message from the specified reader or buffer.

Parameters:
Name Type Attributes Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from

length number <optional>

Message length if known beforehand

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

DataSourceParameter

Throws:
  • If the payload is not a reader or valid buffer

    Type
    Error
  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) decodeDelimited(reader) → {google.cloud.bigquery.datatransfer.v1.DataSourceParameter}

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

Parameters:
Name Type Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from

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

DataSourceParameter

Throws:
  • If the payload is not a reader or valid buffer

    Type
    Error
  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) encode(message, writeropt) → {$protobuf.Writer}

Encodes the specified DataSourceParameter message. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.cloud.bigquery.datatransfer.v1.IDataSourceParameter

DataSourceParameter message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

Returns:
Type Description
$protobuf.Writer

Writer

(static) encodeDelimited(message, writeropt) → {$protobuf.Writer}

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

Parameters:
Name Type Attributes Description
message google.cloud.bigquery.datatransfer.v1.IDataSourceParameter

DataSourceParameter message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

Returns:
Type Description
$protobuf.Writer

Writer

(static) fromObject(object) → {google.cloud.bigquery.datatransfer.v1.DataSourceParameter}

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

Parameters:
Name Type Description
object Object.<string, *>

Plain object

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

DataSourceParameter

(static) getTypeUrl(typeUrlPrefixopt) → {string}

Gets the default type url for DataSourceParameter

Parameters:
Name Type Attributes Description
typeUrlPrefix string <optional>

your custom typeUrlPrefix(default "type.googleapis.com")

Returns:
Type Description
string

The default type url

(static) toObject(message, optionsopt) → {Object.<string, *>}

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

Parameters:
Name Type Attributes Description
message google.cloud.bigquery.datatransfer.v1.DataSourceParameter

DataSourceParameter

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object

(static) verify(message) → {string|null}

Verifies a DataSourceParameter message.

Parameters:
Name Type Description
message Object.<string, *>

Plain object to verify

Returns:
Type Description
string | null

null if valid, otherwise the reason why it is not