Class ConnectionServiceClient (1.13.2)
 
 
 
 
 
 
 Stay organized with collections
 
 
 
 Save and categorize content based on your preferences.
 
  
 
 ConnectionServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.bigquery_connection_v1.services.connection_service.transports.base.ConnectionServiceTransport]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)Manages external data source connections and credentials.
Properties
transport
Returns the transport used by the client instance.
| Returns | |
|---|---|
| Type | Description | 
| ConnectionServiceTransport | The transport used by the client instance. | 
Methods
ConnectionServiceClient
ConnectionServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.bigquery_connection_v1.services.connection_service.transports.base.ConnectionServiceTransport]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)Instantiates the connection service client.
| Parameters | |
|---|---|
| Name | Description | 
| credentials | Optional[google.auth.credentials.Credentials]The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment. | 
| transport | Union[str, ConnectionServiceTransport]The transport to use. If set to None, a transport is chosen automatically. | 
| client_options | Optional[Union[google.api_core.client_options.ClientOptions, dict]]Custom options for the client. It won't take effect if a  | 
| client_info | google.api_core.gapic_v1.client_info.ClientInfoThe client info used to send a user-agent string along with API requests. If  | 
| Exceptions | |
|---|---|
| Type | Description | 
| google.auth.exceptions.MutualTLSChannelError | If mutual TLS transport creation failed for any reason. | 
__exit__
__exit__(type, value, traceback)Releases underlying transport's resources.
cluster_path
cluster_path(project: str, region: str, cluster: str) -> strReturns a fully-qualified cluster string.
common_billing_account_path
common_billing_account_path(billing_account: str) -> strReturns a fully-qualified billing_account string.
common_folder_path
common_folder_path(folder: str) -> strReturns a fully-qualified folder string.
common_location_path
common_location_path(project: str, location: str) -> strReturns a fully-qualified location string.
common_organization_path
common_organization_path(organization: str) -> strReturns a fully-qualified organization string.
common_project_path
common_project_path(project: str) -> strReturns a fully-qualified project string.
connection_path
connection_path(project: str, location: str, connection: str) -> strReturns a fully-qualified connection string.
create_connection
create_connection(
 request: typing.Optional[
 typing.Union[
 google.cloud.bigquery_connection_v1.types.connection.CreateConnectionRequest,
 dict,
 ]
 ] = None,
 *,
 parent: typing.Optional[str] = None,
 connection: typing.Optional[
 google.cloud.bigquery_connection_v1.types.connection.Connection
 ] = None,
 connection_id: typing.Optional[str] = None,
 retry: typing.Union[
 google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault
 ] = _MethodDefault._DEFAULT_VALUE,
 timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
 metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.bigquery_connection_v1.types.connection.ConnectionCreates a new connection.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import bigquery_connection_v1
def sample_create_connection():
 # Create a client
 client = bigquery_connection_v1.ConnectionServiceClient()
 # Initialize request argument(s)
 request = bigquery_connection_v1.CreateConnectionRequest(
 parent="parent_value",
 )
 # Make the request
 response = client.create_connection(request=request)
 # Handle the response
 print(response)
| Parameters | |
|---|---|
| Name | Description | 
| request | Union[google.cloud.bigquery_connection_v1.types.CreateConnectionRequest, dict]The request object. The request for ConnectionService.CreateConnection. | 
| parent | strRequired. Parent resource name. Must be in the format  | 
| connection | google.cloud.bigquery_connection_v1.types.Connection Required. Connection to create. This corresponds to the  | 
| connection_id | strOptional. Connection id that should be assigned to the created connection. This corresponds to the  | 
| retry | google.api_core.retry.RetryDesignation of what errors, if any, should be retried. | 
| timeout | floatThe timeout for this request. | 
| metadata | Sequence[Tuple[str, str]]Strings which should be sent along with the request as metadata. | 
| Returns | |
|---|---|
| Type | Description | 
| google.cloud.bigquery_connection_v1.types.Connection  | Configuration parameters to establish connection with an external data source, except the credential attributes. | 
delete_connection
delete_connection(
 request: typing.Optional[
 typing.Union[
 google.cloud.bigquery_connection_v1.types.connection.DeleteConnectionRequest,
 dict,
 ]
 ] = None,
 *,
 name: typing.Optional[str] = None,
 retry: typing.Union[
 google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault
 ] = _MethodDefault._DEFAULT_VALUE,
 timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
 metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> NoneDeletes connection and associated credential.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import bigquery_connection_v1
def sample_delete_connection():
 # Create a client
 client = bigquery_connection_v1.ConnectionServiceClient()
 # Initialize request argument(s)
 request = bigquery_connection_v1.DeleteConnectionRequest(
 name="name_value",
 )
 # Make the request
 client.delete_connection(request=request)
| Parameters | |
|---|---|
| Name | Description | 
| request | Union[google.cloud.bigquery_connection_v1.types.DeleteConnectionRequest, dict]The request object. The request for [ConnectionService.DeleteConnectionRequest][]. | 
| name | strRequired. Name of the deleted connection, for example:  | 
| retry | google.api_core.retry.RetryDesignation of what errors, if any, should be retried. | 
| timeout | floatThe timeout for this request. | 
| metadata | Sequence[Tuple[str, str]]Strings which should be sent along with the request as metadata. | 
from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)Creates an instance of this client using the provided credentials file.
| Parameter | |
|---|---|
| Name | Description | 
| filename | strThe path to the service account private key json file. | 
| Returns | |
|---|---|
| Type | Description | 
| ConnectionServiceClient | The constructed client. | 
from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)Creates an instance of this client using the provided credentials info.
| Parameter | |
|---|---|
| Name | Description | 
| info | dictThe service account private key info. | 
| Returns | |
|---|---|
| Type | Description | 
| ConnectionServiceClient | The constructed client. | 
from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)Creates an instance of this client using the provided credentials file.
| Parameter | |
|---|---|
| Name | Description | 
| filename | strThe path to the service account private key json file. | 
| Returns | |
|---|---|
| Type | Description | 
| ConnectionServiceClient | The constructed client. | 
get_connection
get_connection(
 request: typing.Optional[
 typing.Union[
 google.cloud.bigquery_connection_v1.types.connection.GetConnectionRequest,
 dict,
 ]
 ] = None,
 *,
 name: typing.Optional[str] = None,
 retry: typing.Union[
 google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault
 ] = _MethodDefault._DEFAULT_VALUE,
 timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
 metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.bigquery_connection_v1.types.connection.ConnectionReturns specified connection.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import bigquery_connection_v1
def sample_get_connection():
 # Create a client
 client = bigquery_connection_v1.ConnectionServiceClient()
 # Initialize request argument(s)
 request = bigquery_connection_v1.GetConnectionRequest(
 name="name_value",
 )
 # Make the request
 response = client.get_connection(request=request)
 # Handle the response
 print(response)
| Parameters | |
|---|---|
| Name | Description | 
| request | Union[google.cloud.bigquery_connection_v1.types.GetConnectionRequest, dict]The request object. The request for ConnectionService.GetConnection. | 
| name | strRequired. Name of the requested connection, for example:  | 
| retry | google.api_core.retry.RetryDesignation of what errors, if any, should be retried. | 
| timeout | floatThe timeout for this request. | 
| metadata | Sequence[Tuple[str, str]]Strings which should be sent along with the request as metadata. | 
| Returns | |
|---|---|
| Type | Description | 
| google.cloud.bigquery_connection_v1.types.Connection  | Configuration parameters to establish connection with an external data source, except the credential attributes. | 
get_iam_policy
get_iam_policy(
 request: typing.Optional[
 typing.Union[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest, dict]
 ] = None,
 *,
 resource: typing.Optional[str] = None,
 retry: typing.Union[
 google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault
 ] = _MethodDefault._DEFAULT_VALUE,
 timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
 metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.PolicyGets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import bigquery_connection_v1
from google.iam.v1 import iam_policy_pb2 # type: ignore
def sample_get_iam_policy():
 # Create a client
 client = bigquery_connection_v1.ConnectionServiceClient()
 # Initialize request argument(s)
 request = iam_policy_pb2.GetIamPolicyRequest(
 resource="resource_value",
 )
 # Make the request
 response = client.get_iam_policy(request=request)
 # Handle the response
 print(response)
| Parameters | |
|---|---|
| Name | Description | 
| request | Union[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest, dict]The request object. Request message for  | 
| resource | strREQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. This corresponds to the  | 
| retry | google.api_core.retry.RetryDesignation of what errors, if any, should be retried. | 
| timeout | floatThe timeout for this request. | 
| metadata | Sequence[Tuple[str, str]]Strings which should be sent along with the request as metadata. | 
| Returns | |
|---|---|
| Type | Description | 
| google.iam.v1.policy_pb2.Policy | An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A Policy is a collection of bindings. A binding binds one or more members, or principals, to a single role. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions; each role can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a binding can also specify a condition, which is a logical expression that allows access to a resource only if the expression evaluates to true. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](\ https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** :literal: \{ "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020年10月01日t00:00:00.000z')",="" }="" }="" ],="" "etag":="" "bwwwja0yfja=", " version":="" 3="">\ \**YAML example:** :literal:\bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020年10月01日t00:00:00.000z')="" etag:="" bwwwja0yfja="version:">\ \For a description of IAM and its features, see the [IAM documentation](\ https://cloud.google.com/iam/docs/). | 
get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
 client_options: typing.Optional[
 google.api_core.client_options.ClientOptions
 ] = None,
)Return the API endpoint and client cert source for mutual TLS.
The client cert source is determined in the following order:
(1) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is not "true", the
client cert source is None.
(2) if client_options.client_cert_source is provided, use the provided one; if the
default client cert source exists, use the default one; otherwise the client cert
source is None.
The API endpoint is determined in the following order:
(1) if client_options.api_endpoint if provided, use the provided one.
(2) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "always", use the
default mTLS endpoint; if the environment variable is "never", use the default API
endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise
use the default API endpoint.
More details can be found at https://google.aip.dev/auth/4114.
| Parameter | |
|---|---|
| Name | Description | 
| client_options | google.api_core.client_options.ClientOptionsCustom options for the client. Only the  | 
| Exceptions | |
|---|---|
| Type | Description | 
| google.auth.exceptions.MutualTLSChannelError | If any errors happen. | 
| Returns | |
|---|---|
| Type | Description | 
| Tuple[str, Callable[[], Tuple[bytes, bytes]]] | returns the API endpoint and the client cert source to use. | 
list_connections
list_connections(
 request: typing.Optional[
 typing.Union[
 google.cloud.bigquery_connection_v1.types.connection.ListConnectionsRequest,
 dict,
 ]
 ] = None,
 *,
 parent: typing.Optional[str] = None,
 retry: typing.Union[
 google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault
 ] = _MethodDefault._DEFAULT_VALUE,
 timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
 metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
 google.cloud.bigquery_connection_v1.services.connection_service.pagers.ListConnectionsPager
)Returns a list of connections in the given project.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import bigquery_connection_v1
def sample_list_connections():
 # Create a client
 client = bigquery_connection_v1.ConnectionServiceClient()
 # Initialize request argument(s)
 request = bigquery_connection_v1.ListConnectionsRequest(
 parent="parent_value",
 page_size=951,
 )
 # Make the request
 page_result = client.list_connections(request=request)
 # Handle the response
 for response in page_result:
 print(response)
| Parameters | |
|---|---|
| Name | Description | 
| request | Union[google.cloud.bigquery_connection_v1.types.ListConnectionsRequest, dict]The request object. The request for ConnectionService.ListConnections. | 
| parent | strRequired. Parent resource name. Must be in the form:  | 
| retry | google.api_core.retry.RetryDesignation of what errors, if any, should be retried. | 
| timeout | floatThe timeout for this request. | 
| metadata | Sequence[Tuple[str, str]]Strings which should be sent along with the request as metadata. | 
| Returns | |
|---|---|
| Type | Description | 
| google.cloud.bigquery_connection_v1.services.connection_service.pagers.ListConnectionsPager  | The response for ConnectionService.ListConnections. Iterating over this object will yield results and resolve additional pages automatically. | 
parse_cluster_path
parse_cluster_path(path: str) -> typing.Dict[str, str]Parses a cluster path into its component segments.
parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]Parse a billing_account path into its component segments.
parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]Parse a folder path into its component segments.
parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]Parse a location path into its component segments.
parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]Parse a organization path into its component segments.
parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]Parse a project path into its component segments.
parse_connection_path
parse_connection_path(path: str) -> typing.Dict[str, str]Parses a connection path into its component segments.
parse_service_path
parse_service_path(path: str) -> typing.Dict[str, str]Parses a service path into its component segments.
service_path
service_path(project: str, location: str, service: str) -> strReturns a fully-qualified service string.
set_iam_policy
set_iam_policy(
 request: typing.Optional[
 typing.Union[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest, dict]
 ] = None,
 *,
 resource: typing.Optional[str] = None,
 retry: typing.Union[
 google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault
 ] = _MethodDefault._DEFAULT_VALUE,
 timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
 metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.PolicySets the access control policy on the specified resource. Replaces any existing policy.
Can return NOT_FOUND, INVALID_ARGUMENT, and
PERMISSION_DENIED errors.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import bigquery_connection_v1
from google.iam.v1 import iam_policy_pb2 # type: ignore
def sample_set_iam_policy():
 # Create a client
 client = bigquery_connection_v1.ConnectionServiceClient()
 # Initialize request argument(s)
 request = iam_policy_pb2.SetIamPolicyRequest(
 resource="resource_value",
 )
 # Make the request
 response = client.set_iam_policy(request=request)
 # Handle the response
 print(response)
| Parameters | |
|---|---|
| Name | Description | 
| request | Union[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest, dict]The request object. Request message for  | 
| resource | strREQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. This corresponds to the  | 
| retry | google.api_core.retry.RetryDesignation of what errors, if any, should be retried. | 
| timeout | floatThe timeout for this request. | 
| metadata | Sequence[Tuple[str, str]]Strings which should be sent along with the request as metadata. | 
| Returns | |
|---|---|
| Type | Description | 
| google.iam.v1.policy_pb2.Policy | An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A Policy is a collection of bindings. A binding binds one or more members, or principals, to a single role. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions; each role can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a binding can also specify a condition, which is a logical expression that allows access to a resource only if the expression evaluates to true. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](\ https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** :literal: \{ "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020年10月01日t00:00:00.000z')",="" }="" }="" ],="" "etag":="" "bwwwja0yfja=", " version":="" 3="">\ \**YAML example:** :literal:\bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020年10月01日t00:00:00.000z')="" etag:="" bwwwja0yfja="version:">\ \For a description of IAM and its features, see the [IAM documentation](\ https://cloud.google.com/iam/docs/). | 
test_iam_permissions
test_iam_permissions(
 request: typing.Optional[
 typing.Union[google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest, dict]
 ] = None,
 *,
 resource: typing.Optional[str] = None,
 permissions: typing.Optional[typing.MutableSequence[str]] = None,
 retry: typing.Union[
 google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault
 ] = _MethodDefault._DEFAULT_VALUE,
 timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
 metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponseReturns 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.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import bigquery_connection_v1
from google.iam.v1 import iam_policy_pb2 # type: ignore
def sample_test_iam_permissions():
 # Create a client
 client = bigquery_connection_v1.ConnectionServiceClient()
 # Initialize request argument(s)
 request = iam_policy_pb2.TestIamPermissionsRequest(
 resource="resource_value",
 permissions=['permissions_value1', 'permissions_value2'],
 )
 # Make the request
 response = client.test_iam_permissions(request=request)
 # Handle the response
 print(response)
| Parameters | |
|---|---|
| Name | Description | 
| request | Union[google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest, dict]The request object. Request message for  | 
| resource | strREQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. This corresponds to the  | 
| permissions | MutableSequence[str]The set of permissions to check for the  | 
| retry | google.api_core.retry.RetryDesignation of what errors, if any, should be retried. | 
| timeout | floatThe timeout for this request. | 
| metadata | Sequence[Tuple[str, str]]Strings which should be sent along with the request as metadata. | 
| Returns | |
|---|---|
| Type | Description | 
| google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse  | Response message for TestIamPermissions method. | 
update_connection
update_connection(
 request: typing.Optional[
 typing.Union[
 google.cloud.bigquery_connection_v1.types.connection.UpdateConnectionRequest,
 dict,
 ]
 ] = None,
 *,
 name: typing.Optional[str] = None,
 connection: typing.Optional[
 google.cloud.bigquery_connection_v1.types.connection.Connection
 ] = None,
 update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
 retry: typing.Union[
 google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault
 ] = _MethodDefault._DEFAULT_VALUE,
 timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
 metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.bigquery_connection_v1.types.connection.ConnectionUpdates the specified connection. For security reasons, also resets credential if connection properties are in the update field mask.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import bigquery_connection_v1
def sample_update_connection():
 # Create a client
 client = bigquery_connection_v1.ConnectionServiceClient()
 # Initialize request argument(s)
 request = bigquery_connection_v1.UpdateConnectionRequest(
 name="name_value",
 )
 # Make the request
 response = client.update_connection(request=request)
 # Handle the response
 print(response)
| Parameters | |
|---|---|
| Name | Description | 
| request | Union[google.cloud.bigquery_connection_v1.types.UpdateConnectionRequest, dict]The request object. The request for ConnectionService.UpdateConnection. | 
| name | strRequired. Name of the connection to update, for example:  | 
| connection | google.cloud.bigquery_connection_v1.types.Connection Required. Connection containing the updated fields. This corresponds to the  | 
| update_mask | google.protobuf.field_mask_pb2.FieldMaskRequired. Update mask for the connection fields to be updated. This corresponds to the  | 
| retry | google.api_core.retry.RetryDesignation of what errors, if any, should be retried. | 
| timeout | floatThe timeout for this request. | 
| metadata | Sequence[Tuple[str, str]]Strings which should be sent along with the request as metadata. | 
| Returns | |
|---|---|
| Type | Description | 
| google.cloud.bigquery_connection_v1.types.Connection  | Configuration parameters to establish connection with an external data source, except the credential attributes. |