Class ConnectionService.ConnectionServiceClient (1.4.0) 

public class ConnectionServiceClient : ClientBase<ConnectionService.ConnectionServiceClient>

Client for ConnectionService

Inheritance

Object > ClientBase > ClientBase<ConnectionService.ConnectionServiceClient> > ConnectionService.ConnectionServiceClient

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(Channel)

[Obsolete("This constructor overload is present for compatibility only, and will be removed in the next major version")]
public ConnectionServiceClient(Channel channel)

Creates a new client using a channel.

Parameter
Name Description
channel Grpc.Core.Channel

The channel 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(ClientBase.ClientBaseConfiguration)

protected ConnectionServiceClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name Description
configuration ClientBase.ClientBaseConfiguration

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, Nullable<DateTime>, CancellationToken)

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

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 Nullable<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
AsyncUnaryCall<Connection>

The call object.

CreateConnectionAsync(CreateConnectionRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

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 Nullable<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
AsyncUnaryCall<Connection>

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, Nullable<DateTime>, CancellationToken)

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

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 Nullable<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
AsyncUnaryCall<Empty>

The call object.

DeleteConnectionAsync(DeleteConnectionRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

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 Nullable<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
AsyncUnaryCall<Empty>

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, Nullable<DateTime>, CancellationToken)

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

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 Nullable<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
AsyncUnaryCall<Connection>

The call object.

GetConnectionAsync(GetConnectionRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

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 Nullable<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
AsyncUnaryCall<Connection>

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, Nullable<DateTime>, CancellationToken)

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

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 Nullable<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
AsyncUnaryCall<Policy>

The call object.

GetIamPolicyAsync(GetIamPolicyRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

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 Nullable<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
AsyncUnaryCall<Policy>

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, Nullable<DateTime>, CancellationToken)

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

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 Nullable<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
AsyncUnaryCall<ListConnectionsResponse>

The call object.

ListConnectionsAsync(ListConnectionsRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

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 Nullable<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
AsyncUnaryCall<ListConnectionsResponse>

The call object.

NewInstance(ClientBase.ClientBaseConfiguration)

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

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name Description
configuration ClientBase.ClientBaseConfiguration
Returns
Type Description
ConnectionService.ConnectionServiceClient
Overrides
Grpc.Core.ClientBase<Google.Cloud.BigQuery.Connection.V1.ConnectionService.ConnectionServiceClient>.NewInstance(Grpc.Core.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, Nullable<DateTime>, CancellationToken)

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

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 Nullable<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
AsyncUnaryCall<Policy>

The call object.

SetIamPolicyAsync(SetIamPolicyRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

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 Nullable<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
AsyncUnaryCall<Policy>

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, Nullable<DateTime>, CancellationToken)

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

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 Nullable<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
AsyncUnaryCall<TestIamPermissionsResponse>

The call object.

TestIamPermissionsAsync(TestIamPermissionsRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

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 Nullable<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
AsyncUnaryCall<TestIamPermissionsResponse>

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, Nullable<DateTime>, CancellationToken)

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

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 Nullable<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
AsyncUnaryCall<Connection>

The call object.

UpdateConnectionAsync(UpdateConnectionRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

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 Nullable<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
AsyncUnaryCall<Connection>

The call object.