Represents a Connection.
Package
@google-cloud/bigquery-connection!Constructors
(constructor)(properties)
constructor(properties?: google.cloud.bigquery.connection.v1.IConnection);
Constructs a new Connection.
Name | Description |
properties |
IConnection
Properties to set |
Properties
aws
public aws?: (google.cloud.bigquery.connection.v1.IAwsProperties|null);
Connection aws.
Type | Description |
(google.cloud.bigquery.connection.v1.IAwsProperties|null) |
cloudSql
public cloudSql?: (google.cloud.bigquery.connection.v1.ICloudSqlProperties|null);
Connection cloudSql.
Type | Description |
(google.cloud.bigquery.connection.v1.ICloudSqlProperties|null) |
creationTime
public creationTime: (number|Long|string);
Connection creationTime.
Type | Description |
(number|Long|string) |
description
public description: string;
Connection description.
Type | Description |
string |
friendlyName
public friendlyName: string;
Connection friendlyName.
Type | Description |
string |
hasCredential
public hasCredential: boolean;
Connection hasCredential.
Type | Description |
boolean |
lastModifiedTime
public lastModifiedTime: (number|Long|string);
Connection lastModifiedTime.
Type | Description |
(number|Long|string) |
name
public name: string;
Connection name.
Type | Description |
string |
properties
public properties?: ("cloudSql"|"aws");
Connection properties.
Type | Description |
("cloudSql"|"aws") |
Methods
create(properties)
public static create(properties?: google.cloud.bigquery.connection.v1.IConnection): google.cloud.bigquery.connection.v1.Connection;
Creates a new Connection instance using the specified properties.
Name | Description |
properties |
IConnection
Properties to set |
Type | Description |
google.cloud.bigquery.connection.v1.Connection | Connection instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.bigquery.connection.v1.Connection;
Decodes a Connection message from the specified reader or buffer.
Name | Description |
reader |
($protobuf.Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
Type | Description |
google.cloud.bigquery.connection.v1.Connection | Connection |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.bigquery.connection.v1.Connection;
Decodes a Connection message from the specified reader or buffer, length delimited.
Name | Description |
reader |
($protobuf.Reader|Uint8Array)
Reader or buffer to decode from |
Type | Description |
google.cloud.bigquery.connection.v1.Connection | Connection |
encode(message, writer)
public static encode(message: google.cloud.bigquery.connection.v1.IConnection, writer?: $protobuf.Writer): $protobuf.Writer;
Encodes the specified Connection message. Does not implicitly messages.
Name | Description |
message |
IConnection
Connection message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
Type | Description |
$protobuf.Writer | Writer |
encodeDelimited(message, writer)
public static encodeDelimited(message: google.cloud.bigquery.connection.v1.IConnection, writer?: $protobuf.Writer): $protobuf.Writer;
Encodes the specified Connection message, length delimited. Does not implicitly messages.
Name | Description |
message |
IConnection
Connection message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
Type | Description |
$protobuf.Writer | Writer |
fromObject(object)
public static fromObject(object: { [k: string]: any }): google.cloud.bigquery.connection.v1.Connection;
Creates a Connection message from a plain object. Also converts values to their respective internal types.
Name | Description |
object |
{ [k: string]: any }
Plain object |
Type | Description |
google.cloud.bigquery.connection.v1.Connection | Connection |
toJSON()
public toJSON(): { [k: string]: any };
Converts this Connection to JSON.
Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
public static toObject(message: google.cloud.bigquery.connection.v1.Connection, options?: $protobuf.IConversionOptions): { [k: string]: any };
Creates a plain object from a Connection message. Also converts values to other types if specified.
Name | Description |
message |
google.cloud.bigquery.connection.v1.Connection
Connection |
options |
$protobuf.IConversionOptions
Conversion options |
Type | Description |
{ [k: string]: any } | Plain object |
verify(message)
public static verify(message: { [k: string]: any }): (string|null);
Verifies a Connection message.
Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
Type | Description |
(string|null) |
|