BigQuery Connection v1 API - Class ConnectionService.ConnectionServiceClient (2.6.0)

Version 2.6.0

• 2.9.0 (latest)
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0

public class ConnectionService.ConnectionServiceClient : ClientBase<ConnectionService.ConnectionServiceClient>

Reference documentation and code samples for the BigQuery Connection v1 API class ConnectionService.ConnectionServiceClient.

Client for ConnectionService

Inheritance

object > ClientBase > ClientBaseConnectionServiceConnectionServiceClient > ConnectionService.ConnectionServiceClient

Inherited Members

ClientBase<ConnectionService.ConnectionServiceClient>.WithHost(string)

ClientBase.CallInvoker

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.BigQuery.Connection.V1

Assembly

Google.Cloud.BigQuery.Connection.V1.dll

Constructors

ConnectionServiceClient()

protected ConnectionServiceClient()

Protected parameterless constructor to allow creation of test doubles.

ConnectionServiceClient(CallInvoker)

public ConnectionServiceClient(CallInvoker callInvoker)

Creates a new client for ConnectionService that uses a custom CallInvoker.

Parameter
Name	Description
callInvoker	CallInvoker The callInvoker to use to make remote calls.

ConnectionServiceClient(ChannelBase)

public ConnectionServiceClient(ChannelBase channel)

Creates a new client for ConnectionService

Parameter
Name	Description
channel	ChannelBase The channel to use to make remote calls.

ConnectionServiceClient(ClientBaseConfiguration)

protected ConnectionServiceClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration The client configuration.

Methods

CreateConnection(CreateConnectionRequest, CallOptions)

public virtual Connection CreateConnection(CreateConnectionRequest request, CallOptions options)

Creates a new connection.

Parameters
Name	Description
request	CreateConnectionRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Connection	The response received from the server.

CreateConnection(CreateConnectionRequest, Metadata, DateTime?, CancellationToken)

public virtual Connection CreateConnection(CreateConnectionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates a new connection.

Parameters
Name	Description
request	CreateConnectionRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Connection	The response received from the server.

CreateConnectionAsync(CreateConnectionRequest, CallOptions)

public virtual AsyncUnaryCall<Connection> CreateConnectionAsync(CreateConnectionRequest request, CallOptions options)

Creates a new connection.

Parameters
Name	Description
request	CreateConnectionRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallConnection	The call object.

CreateConnectionAsync(CreateConnectionRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Connection> CreateConnectionAsync(CreateConnectionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates a new connection.

Parameters
Name	Description
request	CreateConnectionRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallConnection	The call object.

DeleteConnection(DeleteConnectionRequest, CallOptions)

public virtual Empty DeleteConnection(DeleteConnectionRequest request, CallOptions options)

Deletes connection and associated credential.

Parameters
Name	Description
request	DeleteConnectionRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Empty	The response received from the server.

DeleteConnection(DeleteConnectionRequest, Metadata, DateTime?, CancellationToken)

public virtual Empty DeleteConnection(DeleteConnectionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes connection and associated credential.

Parameters
Name	Description
request	DeleteConnectionRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Empty	The response received from the server.

DeleteConnectionAsync(DeleteConnectionRequest, CallOptions)

public virtual AsyncUnaryCall<Empty> DeleteConnectionAsync(DeleteConnectionRequest request, CallOptions options)

Deletes connection and associated credential.

Parameters
Name	Description
request	DeleteConnectionRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallEmpty	The call object.

DeleteConnectionAsync(DeleteConnectionRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Empty> DeleteConnectionAsync(DeleteConnectionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes connection and associated credential.

Parameters
Name	Description
request	DeleteConnectionRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallEmpty	The call object.

GetConnection(GetConnectionRequest, CallOptions)

public virtual Connection GetConnection(GetConnectionRequest request, CallOptions options)

Returns specified connection.

Parameters
Name	Description
request	GetConnectionRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Connection	The response received from the server.

GetConnection(GetConnectionRequest, Metadata, DateTime?, CancellationToken)

public virtual Connection GetConnection(GetConnectionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Returns specified connection.

Parameters
Name	Description
request	GetConnectionRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Connection	The response received from the server.

GetConnectionAsync(GetConnectionRequest, CallOptions)

public virtual AsyncUnaryCall<Connection> GetConnectionAsync(GetConnectionRequest request, CallOptions options)

Returns specified connection.

Parameters
Name	Description
request	GetConnectionRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallConnection	The call object.

GetConnectionAsync(GetConnectionRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Connection> GetConnectionAsync(GetConnectionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Returns specified connection.

Parameters
Name	Description
request	GetConnectionRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallConnection	The call object.

GetIamPolicy(GetIamPolicyRequest, CallOptions)

public virtual Policy GetIamPolicy(GetIamPolicyRequest request, CallOptions options)

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

Parameters
Name	Description
request	GetIamPolicyRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Policy	The response received from the server.

GetIamPolicy(GetIamPolicyRequest, Metadata, DateTime?, CancellationToken)

public virtual Policy GetIamPolicy(GetIamPolicyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

Parameters
Name	Description
request	GetIamPolicyRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Policy	The response received from the server.

GetIamPolicyAsync(GetIamPolicyRequest, CallOptions)

public virtual AsyncUnaryCall<Policy> GetIamPolicyAsync(GetIamPolicyRequest request, CallOptions options)

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

Parameters
Name	Description
request	GetIamPolicyRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallPolicy	The call object.

GetIamPolicyAsync(GetIamPolicyRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Policy> GetIamPolicyAsync(GetIamPolicyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

Parameters
Name	Description
request	GetIamPolicyRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallPolicy	The call object.

ListConnections(ListConnectionsRequest, CallOptions)

public virtual ListConnectionsResponse ListConnections(ListConnectionsRequest request, CallOptions options)

Returns a list of connections in the given project.

Parameters
Name	Description
request	ListConnectionsRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
ListConnectionsResponse	The response received from the server.

ListConnections(ListConnectionsRequest, Metadata, DateTime?, CancellationToken)

public virtual ListConnectionsResponse ListConnections(ListConnectionsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Returns a list of connections in the given project.

Parameters
Name	Description
request	ListConnectionsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
ListConnectionsResponse	The response received from the server.

ListConnectionsAsync(ListConnectionsRequest, CallOptions)

public virtual AsyncUnaryCall<ListConnectionsResponse> ListConnectionsAsync(ListConnectionsRequest request, CallOptions options)

Returns a list of connections in the given project.

Parameters
Name	Description
request	ListConnectionsRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallListConnectionsResponse	The call object.

ListConnectionsAsync(ListConnectionsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListConnectionsResponse> ListConnectionsAsync(ListConnectionsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Returns a list of connections in the given project.

Parameters
Name	Description
request	ListConnectionsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallListConnectionsResponse	The call object.

NewInstance(ClientBaseConfiguration)

protected override ConnectionService.ConnectionServiceClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration

Returns
Type	Description
ConnectionServiceConnectionServiceClient

Overrides

ClientBase<ConnectionService.ConnectionServiceClient>.NewInstance(ClientBase.ClientBaseConfiguration)

SetIamPolicy(SetIamPolicyRequest, CallOptions)

public virtual Policy SetIamPolicy(SetIamPolicyRequest request, CallOptions options)

Sets the access control policy on the specified resource. Replaces any existing policy.

Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

Parameters
Name	Description
request	SetIamPolicyRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Policy	The response received from the server.

SetIamPolicy(SetIamPolicyRequest, Metadata, DateTime?, CancellationToken)

public virtual Policy SetIamPolicy(SetIamPolicyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Sets the access control policy on the specified resource. Replaces any existing policy.

Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

Parameters
Name	Description
request	SetIamPolicyRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Policy	The response received from the server.

SetIamPolicyAsync(SetIamPolicyRequest, CallOptions)

public virtual AsyncUnaryCall<Policy> SetIamPolicyAsync(SetIamPolicyRequest request, CallOptions options)

Sets the access control policy on the specified resource. Replaces any existing policy.

Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

Parameters
Name	Description
request	SetIamPolicyRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallPolicy	The call object.

SetIamPolicyAsync(SetIamPolicyRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Policy> SetIamPolicyAsync(SetIamPolicyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Sets the access control policy on the specified resource. Replaces any existing policy.

Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

Parameters
Name	Description
request	SetIamPolicyRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallPolicy	The call object.

TestIamPermissions(TestIamPermissionsRequest, CallOptions)

public virtual TestIamPermissionsResponse TestIamPermissions(TestIamPermissionsRequest request, CallOptions options)

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.

Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

Parameters
Name	Description
request	TestIamPermissionsRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
TestIamPermissionsResponse	The response received from the server.

TestIamPermissions(TestIamPermissionsRequest, Metadata, DateTime?, CancellationToken)

public virtual TestIamPermissionsResponse TestIamPermissions(TestIamPermissionsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.

Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

Parameters
Name	Description
request	TestIamPermissionsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
TestIamPermissionsResponse	The response received from the server.

TestIamPermissionsAsync(TestIamPermissionsRequest, CallOptions)

public virtual AsyncUnaryCall<TestIamPermissionsResponse> TestIamPermissionsAsync(TestIamPermissionsRequest request, CallOptions options)

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.

Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

Parameters
Name	Description
request	TestIamPermissionsRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallTestIamPermissionsResponse	The call object.

TestIamPermissionsAsync(TestIamPermissionsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<TestIamPermissionsResponse> TestIamPermissionsAsync(TestIamPermissionsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.

Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

Parameters
Name	Description
request	TestIamPermissionsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallTestIamPermissionsResponse	The call object.

UpdateConnection(UpdateConnectionRequest, CallOptions)

public virtual Connection UpdateConnection(UpdateConnectionRequest request, CallOptions options)

Updates the specified connection. For security reasons, also resets credential if connection properties are in the update field mask.

Parameters
Name	Description
request	UpdateConnectionRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Connection	The response received from the server.

UpdateConnection(UpdateConnectionRequest, Metadata, DateTime?, CancellationToken)

public virtual Connection UpdateConnection(UpdateConnectionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates the specified connection. For security reasons, also resets credential if connection properties are in the update field mask.

Parameters
Name	Description
request	UpdateConnectionRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Connection	The response received from the server.

UpdateConnectionAsync(UpdateConnectionRequest, CallOptions)

public virtual AsyncUnaryCall<Connection> UpdateConnectionAsync(UpdateConnectionRequest request, CallOptions options)

Updates the specified connection. For security reasons, also resets credential if connection properties are in the update field mask.

Parameters
Name	Description
request	UpdateConnectionRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallConnection	The call object.

UpdateConnectionAsync(UpdateConnectionRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Connection> UpdateConnectionAsync(UpdateConnectionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates the specified connection. For security reasons, also resets credential if connection properties are in the update field mask.

Parameters
Name	Description
request	UpdateConnectionRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallConnection	The call object.