ConnectionService

google.cloud.bigquery.connection.v1beta1. ConnectionService

Represents a ConnectionService

Constructor

new ConnectionService(rpcImpl, requestDelimitedopt, responseDelimitedopt)

Constructs a new ConnectionService service.

Parameters:
Name Type Attributes Default Description
rpcImpl $protobuf.RPCImpl

RPC implementation

requestDelimited boolean <optional>
false

Whether requests are length-delimited

responseDelimited boolean <optional>
false

Whether responses are length-delimited

Extends

  • $protobuf.rpc.Service

Methods

createConnection(request, callback) → {undefined}

Calls CreateConnection.

Parameters:
Name Type Description
request google.cloud.bigquery.connection.v1beta1.ICreateConnectionRequest

CreateConnectionRequest message or plain object

callback google.cloud.bigquery.connection.v1beta1.ConnectionService.CreateConnectionCallback

Node-style callback called with the error, if any, and Connection

Returns:
Type Description
undefined

createConnection(request) → {Promise.<google.cloud.bigquery.connection.v1beta1.Connection>}

Calls CreateConnection.

Parameters:
Name Type Description
request google.cloud.bigquery.connection.v1beta1.ICreateConnectionRequest

CreateConnectionRequest message or plain object

Returns:
Type Description
Promise.<google.cloud.bigquery.connection.v1beta1.Connection>

Promise

deleteConnection(request, callback) → {undefined}

Calls DeleteConnection.

Parameters:
Name Type Description
request google.cloud.bigquery.connection.v1beta1.IDeleteConnectionRequest

DeleteConnectionRequest message or plain object

callback google.cloud.bigquery.connection.v1beta1.ConnectionService.DeleteConnectionCallback

Node-style callback called with the error, if any, and Empty

Returns:
Type Description
undefined

deleteConnection(request) → {Promise.<google.protobuf.Empty>}

Calls DeleteConnection.

Parameters:
Name Type Description
request google.cloud.bigquery.connection.v1beta1.IDeleteConnectionRequest

DeleteConnectionRequest message or plain object

Returns:
Type Description
Promise.<google.protobuf.Empty>

Promise

getConnection(request, callback) → {undefined}

Calls GetConnection.

Parameters:
Name Type Description
request google.cloud.bigquery.connection.v1beta1.IGetConnectionRequest

GetConnectionRequest message or plain object

callback google.cloud.bigquery.connection.v1beta1.ConnectionService.GetConnectionCallback

Node-style callback called with the error, if any, and Connection

Returns:
Type Description
undefined

getConnection(request) → {Promise.<google.cloud.bigquery.connection.v1beta1.Connection>}

Calls GetConnection.

Parameters:
Name Type Description
request google.cloud.bigquery.connection.v1beta1.IGetConnectionRequest

GetConnectionRequest message or plain object

Returns:
Type Description
Promise.<google.cloud.bigquery.connection.v1beta1.Connection>

Promise

getIamPolicy(request, callback) → {undefined}

Calls GetIamPolicy.

Parameters:
Name Type Description
request google.iam.v1.IGetIamPolicyRequest

GetIamPolicyRequest message or plain object

callback google.cloud.bigquery.connection.v1beta1.ConnectionService.GetIamPolicyCallback

Node-style callback called with the error, if any, and Policy

Returns:
Type Description
undefined

getIamPolicy(request) → {Promise.<google.iam.v1.Policy>}

Calls GetIamPolicy.

Parameters:
Name Type Description
request google.iam.v1.IGetIamPolicyRequest

GetIamPolicyRequest message or plain object

Returns:
Type Description
Promise.<google.iam.v1.Policy>

Promise

listConnections(request, callback) → {undefined}

Calls ListConnections.

Parameters:
Name Type Description
request google.cloud.bigquery.connection.v1beta1.IListConnectionsRequest

ListConnectionsRequest message or plain object

callback google.cloud.bigquery.connection.v1beta1.ConnectionService.ListConnectionsCallback

Node-style callback called with the error, if any, and ListConnectionsResponse

Returns:
Type Description
undefined

listConnections(request) → {Promise.<google.cloud.bigquery.connection.v1beta1.ListConnectionsResponse>}

Calls ListConnections.

Parameters:
Name Type Description
request google.cloud.bigquery.connection.v1beta1.IListConnectionsRequest

ListConnectionsRequest message or plain object

Returns:
Type Description
Promise.<google.cloud.bigquery.connection.v1beta1.ListConnectionsResponse>

Promise

setIamPolicy(request, callback) → {undefined}

Calls SetIamPolicy.

Parameters:
Name Type Description
request google.iam.v1.ISetIamPolicyRequest

SetIamPolicyRequest message or plain object

callback google.cloud.bigquery.connection.v1beta1.ConnectionService.SetIamPolicyCallback

Node-style callback called with the error, if any, and Policy

Returns:
Type Description
undefined

setIamPolicy(request) → {Promise.<google.iam.v1.Policy>}

Calls SetIamPolicy.

Parameters:
Name Type Description
request google.iam.v1.ISetIamPolicyRequest

SetIamPolicyRequest message or plain object

Returns:
Type Description
Promise.<google.iam.v1.Policy>

Promise

testIamPermissions(request, callback) → {undefined}

Calls TestIamPermissions.

Parameters:
Name Type Description
request google.iam.v1.ITestIamPermissionsRequest

TestIamPermissionsRequest message or plain object

callback google.cloud.bigquery.connection.v1beta1.ConnectionService.TestIamPermissionsCallback

Node-style callback called with the error, if any, and TestIamPermissionsResponse

Returns:
Type Description
undefined

testIamPermissions(request) → {Promise.<google.iam.v1.TestIamPermissionsResponse>}

Calls TestIamPermissions.

Parameters:
Name Type Description
request google.iam.v1.ITestIamPermissionsRequest

TestIamPermissionsRequest message or plain object

Returns:
Type Description
Promise.<google.iam.v1.TestIamPermissionsResponse>

Promise

updateConnection(request, callback) → {undefined}

Calls UpdateConnection.

Parameters:
Name Type Description
request google.cloud.bigquery.connection.v1beta1.IUpdateConnectionRequest

UpdateConnectionRequest message or plain object

callback google.cloud.bigquery.connection.v1beta1.ConnectionService.UpdateConnectionCallback

Node-style callback called with the error, if any, and Connection

Returns:
Type Description
undefined

updateConnection(request) → {Promise.<google.cloud.bigquery.connection.v1beta1.Connection>}

Calls UpdateConnection.

Parameters:
Name Type Description
request google.cloud.bigquery.connection.v1beta1.IUpdateConnectionRequest

UpdateConnectionRequest message or plain object

Returns:
Type Description
Promise.<google.cloud.bigquery.connection.v1beta1.Connection>

Promise

updateConnectionCredential(request, callback) → {undefined}

Calls UpdateConnectionCredential.

Parameters:
Name Type Description
request google.cloud.bigquery.connection.v1beta1.IUpdateConnectionCredentialRequest

UpdateConnectionCredentialRequest message or plain object

callback google.cloud.bigquery.connection.v1beta1.ConnectionService.UpdateConnectionCredentialCallback

Node-style callback called with the error, if any, and Empty

Returns:
Type Description
undefined

updateConnectionCredential(request) → {Promise.<google.protobuf.Empty>}

Calls UpdateConnectionCredential.

Parameters:
Name Type Description
request google.cloud.bigquery.connection.v1beta1.IUpdateConnectionCredentialRequest

UpdateConnectionCredentialRequest message or plain object

Returns:
Type Description
Promise.<google.protobuf.Empty>

Promise

(static) create(rpcImpl, requestDelimitedopt, responseDelimitedopt) → {ConnectionService}

Creates new ConnectionService service using the specified rpc implementation.

Parameters:
Name Type Attributes Default Description
rpcImpl $protobuf.RPCImpl

RPC implementation

requestDelimited boolean <optional>
false

Whether requests are length-delimited

responseDelimited boolean <optional>
false

Whether responses are length-delimited

Returns:
Type Description
ConnectionService

RPC service. Useful where requests and/or responses are streamed.

Type Definitions

CreateConnectionCallback(error, responseopt)

Callback as used by createConnection.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.bigquery.connection.v1beta1.Connection <optional>

Connection

DeleteConnectionCallback(error, responseopt)

Callback as used by deleteConnection.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.protobuf.Empty <optional>

Empty

GetConnectionCallback(error, responseopt)

Callback as used by getConnection.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.bigquery.connection.v1beta1.Connection <optional>

Connection

GetIamPolicyCallback(error, responseopt)

Callback as used by getIamPolicy.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.iam.v1.Policy <optional>

Policy

ListConnectionsCallback(error, responseopt)

Callback as used by listConnections.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.bigquery.connection.v1beta1.ListConnectionsResponse <optional>

ListConnectionsResponse

SetIamPolicyCallback(error, responseopt)

Callback as used by setIamPolicy.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.iam.v1.Policy <optional>

Policy

TestIamPermissionsCallback(error, responseopt)

Callback as used by testIamPermissions.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.iam.v1.TestIamPermissionsResponse <optional>

TestIamPermissionsResponse

UpdateConnectionCallback(error, responseopt)

Callback as used by updateConnection.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.bigquery.connection.v1beta1.Connection <optional>

Connection

UpdateConnectionCredentialCallback(error, responseopt)

Callback as used by updateConnectionCredential.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.protobuf.Empty <optional>

Empty