Class protos.google.cloud.bigquery.connection.v1.AwsProperties (1.4.2)

Version 1.4.2

• 2.2.1 (latest)
• 2.1.1
• 2.0.2
• 1.5.1
• 1.4.2
• 1.3.5

Represents an AwsProperties.

Package

@google-cloud/bigquery-connection!

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.bigquery.connection.v1.IAwsProperties);

Constructs a new AwsProperties.

Parameter

Name	Description
properties	IAwsProperties Properties to set

Properties

accessRole

public accessRole?: (google.cloud.bigquery.connection.v1.IAwsAccessRole|null);

AwsProperties accessRole.

Property Value

Type	Description
(google.cloud.bigquery.connection.v1.IAwsAccessRole|null)

authenticationMethod

public authenticationMethod?: ("crossAccountRole"|"accessRole");

AwsProperties authenticationMethod.

Property Value

Type	Description
("crossAccountRole"|"accessRole")

crossAccountRole

public crossAccountRole?: (google.cloud.bigquery.connection.v1.IAwsCrossAccountRole|null);

AwsProperties crossAccountRole.

Property Value

Type	Description
(google.cloud.bigquery.connection.v1.IAwsCrossAccountRole|null)

Methods

create(properties)

public static create(properties?: google.cloud.bigquery.connection.v1.IAwsProperties): google.cloud.bigquery.connection.v1.AwsProperties;

Creates a new AwsProperties instance using the specified properties.

Parameter

Name	Description
properties	IAwsProperties Properties to set

Returns

Type	Description
google.cloud.bigquery.connection.v1.AwsProperties	AwsProperties instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.bigquery.connection.v1.AwsProperties;

Decodes an AwsProperties 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.connection.v1.AwsProperties	AwsProperties

decodeDelimited(reader)

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

Decodes an AwsProperties 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.connection.v1.AwsProperties	AwsProperties

encode(message, writer)

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

Encodes the specified AwsProperties message. Does not implicitly messages.

Parameters

Name	Description
message	IAwsProperties AwsProperties 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.connection.v1.IAwsProperties, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters

Name	Description
message	IAwsProperties AwsProperties 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.connection.v1.AwsProperties;

Creates an AwsProperties 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.connection.v1.AwsProperties	AwsProperties

toJSON()

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

Converts this AwsProperties to JSON.

Returns

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

toObject(message, options)

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

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

Parameters

Name	Description
message	google.cloud.bigquery.connection.v1.AwsProperties AwsProperties
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 an AwsProperties 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