Connection

google.cloud.bigquery.connection.v1. Connection

Represents a Connection.

Constructor

new Connection(propertiesopt)

Constructs a new Connection.

Parameters:
Name Type Attributes Description
properties google.cloud.bigquery.connection.v1.IConnection <optional>

Properties to set

Implements:
  • IConnection

Members

aws

Connection aws.

azure

Connection azure.

cloudResource

Connection cloudResource.

cloudSpanner

Connection cloudSpanner.

cloudSql

Connection cloudSql.

creationTime

Connection creationTime.

description

Connection description.

friendlyName

Connection friendlyName.

hasCredential

Connection hasCredential.

lastModifiedTime

Connection lastModifiedTime.

name

Connection name.

properties

Connection properties.

spark

Connection spark.

Methods

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

Converts this Connection to JSON.

Returns:
Type Description
Object.<string, *>

JSON object

(static) create(propertiesopt) → {google.cloud.bigquery.connection.v1.Connection}

Creates a new Connection instance using the specified properties.

Parameters:
Name Type Attributes Description
properties google.cloud.bigquery.connection.v1.IConnection <optional>

Properties to set

Returns:
Type Description
google.cloud.bigquery.connection.v1.Connection

Connection instance

(static) decode(reader, lengthopt) → {google.cloud.bigquery.connection.v1.Connection}

Decodes a Connection 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.connection.v1.Connection

Connection

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.connection.v1.Connection}

Decodes a Connection 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.connection.v1.Connection

Connection

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 Connection message. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.cloud.bigquery.connection.v1.IConnection

Connection 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 Connection message, length delimited. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.cloud.bigquery.connection.v1.IConnection

Connection 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.connection.v1.Connection}

Creates a Connection 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.connection.v1.Connection

Connection

(static) getTypeUrl(typeUrlPrefixopt) → {string}

Gets the default type url for Connection

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 Connection message. Also converts values to other types if specified.

Parameters:
Name Type Attributes Description
message google.cloud.bigquery.connection.v1.Connection

Connection

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object

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

Verifies a Connection 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