BigQuery Connection v1 API - Class ConnectionServiceClientImpl (2.3.0)

public sealed class ConnectionServiceClientImpl : ConnectionServiceClient

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

ConnectionService client wrapper implementation, for convenient use.

Inheritance

Object > ConnectionServiceClient > ConnectionServiceClientImpl

Inherited Members

ConnectionServiceClient.DefaultEndpoint

ConnectionServiceClient.DefaultScopes

ConnectionServiceClient.ServiceMetadata

ConnectionServiceClient.CreateAsync(CancellationToken)

ConnectionServiceClient.Create()

ConnectionServiceClient.ShutdownDefaultChannelsAsync()

ConnectionServiceClient.CreateConnectionAsync(CreateConnectionRequest, CancellationToken)

ConnectionServiceClient.CreateConnection(String, Connection, String, CallSettings)

ConnectionServiceClient.CreateConnectionAsync(String, Connection, String, CallSettings)

ConnectionServiceClient.CreateConnectionAsync(String, Connection, String, CancellationToken)

ConnectionServiceClient.CreateConnection(LocationName, Connection, String, CallSettings)

ConnectionServiceClient.CreateConnectionAsync(LocationName, Connection, String, CallSettings)

ConnectionServiceClient.CreateConnectionAsync(LocationName, Connection, String, CancellationToken)

ConnectionServiceClient.GetConnectionAsync(GetConnectionRequest, CancellationToken)

ConnectionServiceClient.GetConnection(String, CallSettings)

ConnectionServiceClient.GetConnectionAsync(String, CallSettings)

ConnectionServiceClient.GetConnectionAsync(String, CancellationToken)

ConnectionServiceClient.GetConnection(ConnectionName, CallSettings)

ConnectionServiceClient.GetConnectionAsync(ConnectionName, CallSettings)

ConnectionServiceClient.GetConnectionAsync(ConnectionName, CancellationToken)

ConnectionServiceClient.ListConnections(String, String, Nullable<Int32>, CallSettings)

ConnectionServiceClient.ListConnectionsAsync(String, String, Nullable<Int32>, CallSettings)

ConnectionServiceClient.ListConnections(LocationName, String, Nullable<Int32>, CallSettings)

ConnectionServiceClient.ListConnectionsAsync(LocationName, String, Nullable<Int32>, CallSettings)

ConnectionServiceClient.UpdateConnectionAsync(UpdateConnectionRequest, CancellationToken)

ConnectionServiceClient.UpdateConnection(String, Connection, FieldMask, CallSettings)

ConnectionServiceClient.UpdateConnectionAsync(String, Connection, FieldMask, CallSettings)

ConnectionServiceClient.UpdateConnectionAsync(String, Connection, FieldMask, CancellationToken)

ConnectionServiceClient.UpdateConnection(ConnectionName, Connection, FieldMask, CallSettings)

ConnectionServiceClient.UpdateConnectionAsync(ConnectionName, Connection, FieldMask, CallSettings)

ConnectionServiceClient.UpdateConnectionAsync(ConnectionName, Connection, FieldMask, CancellationToken)

ConnectionServiceClient.DeleteConnectionAsync(DeleteConnectionRequest, CancellationToken)

ConnectionServiceClient.DeleteConnection(String, CallSettings)

ConnectionServiceClient.DeleteConnectionAsync(String, CallSettings)

ConnectionServiceClient.DeleteConnectionAsync(String, CancellationToken)

ConnectionServiceClient.DeleteConnection(ConnectionName, CallSettings)

ConnectionServiceClient.DeleteConnectionAsync(ConnectionName, CallSettings)

ConnectionServiceClient.DeleteConnectionAsync(ConnectionName, CancellationToken)

ConnectionServiceClient.GetIamPolicyAsync(GetIamPolicyRequest, CancellationToken)

ConnectionServiceClient.GetIamPolicy(String, GetPolicyOptions, CallSettings)

ConnectionServiceClient.GetIamPolicyAsync(String, GetPolicyOptions, CallSettings)

ConnectionServiceClient.GetIamPolicyAsync(String, GetPolicyOptions, CancellationToken)

ConnectionServiceClient.GetIamPolicy(IResourceName, GetPolicyOptions, CallSettings)

ConnectionServiceClient.GetIamPolicyAsync(IResourceName, GetPolicyOptions, CallSettings)

ConnectionServiceClient.GetIamPolicyAsync(IResourceName, GetPolicyOptions, CancellationToken)

ConnectionServiceClient.SetIamPolicyAsync(SetIamPolicyRequest, CancellationToken)

ConnectionServiceClient.SetIamPolicy(String, Policy, CallSettings)

ConnectionServiceClient.SetIamPolicyAsync(String, Policy, CallSettings)

ConnectionServiceClient.SetIamPolicyAsync(String, Policy, CancellationToken)

ConnectionServiceClient.SetIamPolicy(IResourceName, Policy, CallSettings)

ConnectionServiceClient.SetIamPolicyAsync(IResourceName, Policy, CallSettings)

ConnectionServiceClient.SetIamPolicyAsync(IResourceName, Policy, CancellationToken)

ConnectionServiceClient.TestIamPermissionsAsync(TestIamPermissionsRequest, CancellationToken)

ConnectionServiceClient.TestIamPermissions(String, IEnumerable<String>, CallSettings)

ConnectionServiceClient.TestIamPermissionsAsync(String, IEnumerable<String>, CallSettings)

ConnectionServiceClient.TestIamPermissionsAsync(String, IEnumerable<String>, CancellationToken)

ConnectionServiceClient.TestIamPermissions(IResourceName, IEnumerable<String>, CallSettings)

ConnectionServiceClient.TestIamPermissionsAsync(IResourceName, IEnumerable<String>, CallSettings)

ConnectionServiceClient.TestIamPermissionsAsync(IResourceName, IEnumerable<String>, CancellationToken)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ToString()

Namespace

Google.Cloud.BigQuery.Connection.V1

Assembly

Google.Cloud.BigQuery.Connection.V1.dll

Remarks

Manages external data source connections and credentials.

Constructors

ConnectionServiceClientImpl(ConnectionService.ConnectionServiceClient, ConnectionServiceSettings, ILogger)

public ConnectionServiceClientImpl(ConnectionService.ConnectionServiceClient grpcClient, ConnectionServiceSettings settings, ILogger logger)

Constructs a client wrapper for the ConnectionService service, with the specified gRPC client and settings.

Parameters
Name	Description
`grpcClient`	`ConnectionService.ConnectionServiceClient` The underlying gRPC client.
`settings`	`ConnectionServiceSettings` The base ConnectionServiceSettings used within this client.
`logger`	`ILogger` Optional ILogger to use within this client.

Properties

GrpcClient

public override ConnectionService.ConnectionServiceClient GrpcClient { get; }

The underlying gRPC ConnectionService client

Property Value
Type	Description
`ConnectionService.ConnectionServiceClient`

Overrides

ConnectionServiceClient.GrpcClient

Methods

CreateConnection(CreateConnectionRequest, CallSettings)

public override Connection CreateConnection(CreateConnectionRequest request, CallSettings callSettings = null)

Creates a new connection.

Parameters
Name	Description
`request`	`CreateConnectionRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Connection`	The RPC response.

Overrides

ConnectionServiceClient.CreateConnection(CreateConnectionRequest, CallSettings)

CreateConnectionAsync(CreateConnectionRequest, CallSettings)

public override Task<Connection> CreateConnectionAsync(CreateConnectionRequest request, CallSettings callSettings = null)

Creates a new connection.

Parameters
Name	Description
`request`	`CreateConnectionRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task<Connection>`	A Task containing the RPC response.

Overrides

ConnectionServiceClient.CreateConnectionAsync(CreateConnectionRequest, CallSettings)

DeleteConnection(DeleteConnectionRequest, CallSettings)

public override void DeleteConnection(DeleteConnectionRequest request, CallSettings callSettings = null)

Deletes connection and associated credential.

Parameters
Name	Description
`request`	`DeleteConnectionRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Overrides

ConnectionServiceClient.DeleteConnection(DeleteConnectionRequest, CallSettings)

DeleteConnectionAsync(DeleteConnectionRequest, CallSettings)

public override Task DeleteConnectionAsync(DeleteConnectionRequest request, CallSettings callSettings = null)

Deletes connection and associated credential.

Parameters
Name	Description
`request`	`DeleteConnectionRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task`	A Task containing the RPC response.

Overrides

ConnectionServiceClient.DeleteConnectionAsync(DeleteConnectionRequest, CallSettings)

GetConnection(GetConnectionRequest, CallSettings)

public override Connection GetConnection(GetConnectionRequest request, CallSettings callSettings = null)

Returns specified connection.

Parameters
Name	Description
`request`	`GetConnectionRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Connection`	The RPC response.

Overrides

ConnectionServiceClient.GetConnection(GetConnectionRequest, CallSettings)

GetConnectionAsync(GetConnectionRequest, CallSettings)

public override Task<Connection> GetConnectionAsync(GetConnectionRequest request, CallSettings callSettings = null)

Returns specified connection.

Parameters
Name	Description
`request`	`GetConnectionRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task<Connection>`	A Task containing the RPC response.

Overrides

ConnectionServiceClient.GetConnectionAsync(GetConnectionRequest, CallSettings)

GetIamPolicy(GetIamPolicyRequest, CallSettings)

public override Policy GetIamPolicy(GetIamPolicyRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Policy`	The RPC response.

Overrides

ConnectionServiceClient.GetIamPolicy(GetIamPolicyRequest, CallSettings)

GetIamPolicyAsync(GetIamPolicyRequest, CallSettings)

public override Task<Policy> GetIamPolicyAsync(GetIamPolicyRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task<Policy>`	A Task containing the RPC response.

Overrides

ConnectionServiceClient.GetIamPolicyAsync(GetIamPolicyRequest, CallSettings)

ListConnections(ListConnectionsRequest, CallSettings)

public override PagedEnumerable<ListConnectionsResponse, Connection> ListConnections(ListConnectionsRequest request, CallSettings callSettings = null)

Returns a list of connections in the given project.

Parameters
Name	Description
`request`	`ListConnectionsRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`PagedEnumerable<ListConnectionsResponse, Connection>`	A pageable sequence of Connection resources.

Overrides

ConnectionServiceClient.ListConnections(ListConnectionsRequest, CallSettings)

ListConnectionsAsync(ListConnectionsRequest, CallSettings)

public override PagedAsyncEnumerable<ListConnectionsResponse, Connection> ListConnectionsAsync(ListConnectionsRequest request, CallSettings callSettings = null)

Returns a list of connections in the given project.

Parameters
Name	Description
`request`	`ListConnectionsRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`PagedAsyncEnumerable<ListConnectionsResponse, Connection>`	A pageable asynchronous sequence of Connection resources.

Overrides

ConnectionServiceClient.ListConnectionsAsync(ListConnectionsRequest, CallSettings)

SetIamPolicy(SetIamPolicyRequest, CallSettings)

public override Policy SetIamPolicy(SetIamPolicyRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Policy`	The RPC response.

Overrides

ConnectionServiceClient.SetIamPolicy(SetIamPolicyRequest, CallSettings)

SetIamPolicyAsync(SetIamPolicyRequest, CallSettings)

public override Task<Policy> SetIamPolicyAsync(SetIamPolicyRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task<Policy>`	A Task containing the RPC response.

Overrides

ConnectionServiceClient.SetIamPolicyAsync(SetIamPolicyRequest, CallSettings)

TestIamPermissions(TestIamPermissionsRequest, CallSettings)

public override TestIamPermissionsResponse TestIamPermissions(TestIamPermissionsRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`TestIamPermissionsResponse`	The RPC response.

Overrides

ConnectionServiceClient.TestIamPermissions(TestIamPermissionsRequest, CallSettings)

TestIamPermissionsAsync(TestIamPermissionsRequest, CallSettings)

public override Task<TestIamPermissionsResponse> TestIamPermissionsAsync(TestIamPermissionsRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task<TestIamPermissionsResponse>`	A Task containing the RPC response.

Overrides

ConnectionServiceClient.TestIamPermissionsAsync(TestIamPermissionsRequest, CallSettings)

UpdateConnection(UpdateConnectionRequest, CallSettings)

public override Connection UpdateConnection(UpdateConnectionRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Connection`	The RPC response.

Overrides

ConnectionServiceClient.UpdateConnection(UpdateConnectionRequest, CallSettings)

UpdateConnectionAsync(UpdateConnectionRequest, CallSettings)

public override Task<Connection> UpdateConnectionAsync(UpdateConnectionRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task<Connection>`	A Task containing the RPC response.

Overrides

ConnectionServiceClient.UpdateConnectionAsync(UpdateConnectionRequest, CallSettings)