Class ConnectionServiceClient (2.31.0)

Version 2.31.0

• 2.34.0-rc (latest)
• 2.33.0
• 2.32.0
• 2.31.0
• 2.30.0
• 2.29.0
• 2.28.0
• 2.27.0
• 2.26.0
• 2.25.1
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.1
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0

Manages external data source connections and credentials.

Equality

Instances of this class created via copy-construction or copy-assignment always compare equal. Instances created with equal std::shared_ptr<*Connection> objects compare equal. Objects that compare equal share the same underlying resources.

Performance

Creating a new instance of this class is a relatively expensive operation, new objects establish new connections to the service. In contrast, copy-construction, move-construction, and the corresponding assignment operations are relatively efficient as the copies share all underlying resources.

Thread Safety

Concurrent access to different instances of this class, even if they compare equal, is guaranteed to work. Two or more threads operating on the same instance of this class is not guaranteed to work. Since copy-construction and move-construction is a relatively efficient operation, consider using such a copy when using this class from multiple threads.

Constructors

ConnectionServiceClient(ConnectionServiceClient const &)

Copy and move support

Parameter
Name	Description
	ConnectionServiceClient const &

ConnectionServiceClient(ConnectionServiceClient &&)

Copy and move support

Parameter
Name	Description
	ConnectionServiceClient &&

ConnectionServiceClient(std::shared_ptr< ConnectionServiceConnection >, Options)

Parameters
Name	Description
connection	std::shared_ptr< ConnectionServiceConnection >
opts	Options

Operators

operator=(ConnectionServiceClient const &)

Copy and move support

Parameter
Name	Description
	ConnectionServiceClient const &

Returns
Type	Description
ConnectionServiceClient &

operator=(ConnectionServiceClient &&)

Copy and move support

Parameter
Name	Description
	ConnectionServiceClient &&

Returns
Type	Description
ConnectionServiceClient &

Functions

CreateConnection(std::string const &, google::cloud::bigquery::connection::v1::Connection const &, std::string const &, Options)

Creates a new connection.

Parameters
Name	Description
parent	std::string const & Required. Parent resource name. Must be in the format projects/{project_id}/locations/{location_id}
connection	google::cloud::bigquery::connection::v1::Connection const & Required. Connection to create.
connection_id	std::string const & Optional. Connection id that should be assigned to the created connection.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::bigquery::connection::v1::Connection >	the result of the RPC. The response message type (google.cloud.bigquery.connection.v1.Connection) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

CreateConnection(google::cloud::bigquery::connection::v1::CreateConnectionRequest const &, Options)

Creates a new connection.

Parameters
Name	Description
request	google::cloud::bigquery::connection::v1::CreateConnectionRequest const & Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.bigquery.connection.v1.CreateConnectionRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::bigquery::connection::v1::Connection >	the result of the RPC. The response message type (google.cloud.bigquery.connection.v1.Connection) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetConnection(std::string const &, Options)

Returns specified connection.

Parameters
Name	Description
name	std::string const & Required. Name of the requested connection, for example: projects/{project_id}/locations/{location_id}/connections/{connection_id}
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::bigquery::connection::v1::Connection >	the result of the RPC. The response message type (google.cloud.bigquery.connection.v1.Connection) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetConnection(google::cloud::bigquery::connection::v1::GetConnectionRequest const &, Options)

Returns specified connection.

Parameters
Name	Description
request	google::cloud::bigquery::connection::v1::GetConnectionRequest const & Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.bigquery.connection.v1.GetConnectionRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::bigquery::connection::v1::Connection >	the result of the RPC. The response message type (google.cloud.bigquery.connection.v1.Connection) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

ListConnections(std::string const &, Options)

Returns a list of connections in the given project.

Parameters
Name	Description
parent	std::string const & Required. Parent resource name. Must be in the form: projects/{project_id}/locations/{location_id}
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StreamRange< google::cloud::bigquery::connection::v1::Connection >	a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.bigquery.connection.v1.Connection, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListConnections(google::cloud::bigquery::connection::v1::ListConnectionsRequest, Options)

Returns a list of connections in the given project.

Parameters
Name	Description
request	google::cloud::bigquery::connection::v1::ListConnectionsRequest Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.bigquery.connection.v1.ListConnectionsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StreamRange< google::cloud::bigquery::connection::v1::Connection >	a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.bigquery.connection.v1.Connection, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

UpdateConnection(std::string const &, google::cloud::bigquery::connection::v1::Connection const &, google::protobuf::FieldMask const &, Options)

Updates the specified connection.

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

Parameters
Name	Description
name	std::string const & Required. Name of the connection to update, for example: projects/{project_id}/locations/{location_id}/connections/{connection_id}
connection	google::cloud::bigquery::connection::v1::Connection const & Required. Connection containing the updated fields.
update_mask	google::protobuf::FieldMask const & Required. Update mask for the connection fields to be updated.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::bigquery::connection::v1::Connection >	the result of the RPC. The response message type (google.cloud.bigquery.connection.v1.Connection) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

UpdateConnection(google::cloud::bigquery::connection::v1::UpdateConnectionRequest const &, Options)

Updates the specified connection.

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

Parameters
Name	Description
request	google::cloud::bigquery::connection::v1::UpdateConnectionRequest const & Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.bigquery.connection.v1.UpdateConnectionRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::bigquery::connection::v1::Connection >	the result of the RPC. The response message type (google.cloud.bigquery.connection.v1.Connection) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

DeleteConnection(std::string const &, Options)

Deletes connection and associated credential.

Parameters
Name	Description
name	std::string const & Required. Name of the deleted connection, for example: projects/{project_id}/locations/{location_id}/connections/{connection_id}
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
Status	a Status object. If the request failed, the status contains the details of the failure.

DeleteConnection(google::cloud::bigquery::connection::v1::DeleteConnectionRequest const &, Options)

Deletes connection and associated credential.

Parameters
Name	Description
request	google::cloud::bigquery::connection::v1::DeleteConnectionRequest const & Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.bigquery.connection.v1.DeleteConnectionRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
Status	a Status object. If the request failed, the status contains the details of the failure.

GetIamPolicy(std::string const &, google::iam::v1::GetPolicyOptions const &, 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
resource	std::string const & REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.
options	google::iam::v1::GetPolicyOptions const & OPTIONAL: A GetPolicyOptions object for specifying options to GetIamPolicy.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::iam::v1::Policy >	the result of the RPC. The response message type (google.iam.v1.Policy) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetIamPolicy(google::iam::v1::GetIamPolicyRequest const &, 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	google::iam::v1::GetIamPolicyRequest const & Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.iam.v1.GetIamPolicyRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::iam::v1::Policy >	the result of the RPC. The response message type (google.iam.v1.Policy) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

SetIamPolicy(std::string const &, google::iam::v1::Policy const &, 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
resource	std::string const & REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
policy	google::iam::v1::Policy const & REQUIRED: The complete policy to be applied to the resource. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::iam::v1::Policy >	the result of the RPC. The response message type (google.iam.v1.Policy) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

SetIamPolicy(google::iam::v1::SetIamPolicyRequest const &, 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	google::iam::v1::SetIamPolicyRequest const & Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.iam.v1.SetIamPolicyRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::iam::v1::Policy >	the result of the RPC. The response message type (google.iam.v1.Policy) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

TestIamPermissions(std::string const &, std::vector< std::string > const &, 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
resource	std::string const & REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
permissions	std::vector< std::string > const & The set of permissions to check for the resource. Permissions with wildcards (such as '' or 'storage.') are not allowed. For more information see IAM Overview.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::iam::v1::TestIamPermissionsResponse >	the result of the RPC. The response message type (google.iam.v1.TestIamPermissionsResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

TestIamPermissions(google::iam::v1::TestIamPermissionsRequest const &, 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	google::iam::v1::TestIamPermissionsRequest const & Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.iam.v1.TestIamPermissionsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::iam::v1::TestIamPermissionsResponse >	the result of the RPC. The response message type (google.iam.v1.TestIamPermissionsResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.