BigQuery Connection v1 API - Class ConnectionServiceClientImpl (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 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, int?, CallSettings)

ConnectionServiceClient.ListConnectionsAsync(string, string, int?, CallSettings)

ConnectionServiceClient.ListConnections(LocationName, string, int?, CallSettings)

ConnectionServiceClient.ListConnectionsAsync(LocationName, string, int?, 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.ToString()

Namespace

Google.Cloud.BigQuery.Connection.V1

Assembly

Google.Cloud.BigQuery.Connection.V1.dll

Remarks

Manages external data source connections and credentials.

Constructors

ConnectionServiceClientImpl(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	ConnectionServiceConnectionServiceClient 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
ConnectionServiceConnectionServiceClient

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
TaskConnection	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
TaskConnection	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
TaskPolicy	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
PagedEnumerableListConnectionsResponseConnection	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
PagedAsyncEnumerableListConnectionsResponseConnection	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
TaskPolicy	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
TaskTestIamPermissionsResponse	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
TaskConnection	A Task containing the RPC response.

Overrides

ConnectionServiceClient.UpdateConnectionAsync(UpdateConnectionRequest, CallSettings)