Class protos.google.cloud.bigquery.connection.v1.AwsAccessRole (2.0.2)

Represents an AwsAccessRole.

Package

@google-cloud/bigquery-connection

Constructors

(constructor)(properties)

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

Constructs a new AwsAccessRole.

Parameter
Name Description
properties IAwsAccessRole

Properties to set

Properties

iamRoleId

public iamRoleId: string;

AwsAccessRole iamRoleId.

identity

public identity: string;

AwsAccessRole identity.

Methods

create(properties)

public static create(properties?: google.cloud.bigquery.connection.v1.IAwsAccessRole): google.cloud.bigquery.connection.v1.AwsAccessRole;

Creates a new AwsAccessRole instance using the specified properties.

Parameter
Name Description
properties IAwsAccessRole

Properties to set
Returns
Type Description
google.cloud.bigquery.connection.v1.AwsAccessRole

AwsAccessRole instance

decode(reader, length)

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

Decodes an AwsAccessRole 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.AwsAccessRole

AwsAccessRole

decodeDelimited(reader)

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

Decodes an AwsAccessRole 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.AwsAccessRole

AwsAccessRole

encode(message, writer)

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

Encodes the specified AwsAccessRole message. Does not implicitly messages.

Parameters
Name Description
message IAwsAccessRole

AwsAccessRole 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.IAwsAccessRole, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message IAwsAccessRole

AwsAccessRole 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.AwsAccessRole;

Creates an AwsAccessRole 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.AwsAccessRole

AwsAccessRole

getTypeUrl(typeUrlPrefix)

public static getTypeUrl(typeUrlPrefix?: string): string;

Gets the default type url for AwsAccessRole

Parameter
Name Description
typeUrlPrefix string

your custom typeUrlPrefix(default "type.googleapis.com")
Returns
Type Description
string

The default type url

toJSON()

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

Converts this AwsAccessRole to JSON.

Returns
Type Description
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message google.cloud.bigquery.connection.v1.AwsAccessRole

AwsAccessRole
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 AwsAccessRole 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