Class ConnectorsClient (2.29.0-rc)

Connectors is the interface for managing Connectors.

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

ConnectorsClient(ConnectorsClient const &)

Copy and move support

Parameter
Name	Description
	`ConnectorsClient const &`

ConnectorsClient(ConnectorsClient &&)

Copy and move support

Parameter
Name	Description
	`ConnectorsClient &&`

ConnectorsClient(std::shared_ptr< ConnectorsConnection >, Options)

Parameters
Name	Description
`connection`	`std::shared_ptr< ConnectorsConnection >`
`opts`	`Options`

Operators

operator=(ConnectorsClient const &)

Copy and move support

Parameter
Name	Description
	`ConnectorsClient const &`

Returns
Type	Description
`ConnectorsClient &`

operator=(ConnectorsClient &&)

Copy and move support

Parameter
Name	Description
	`ConnectorsClient &&`

Returns
Type	Description
`ConnectorsClient &`

Functions

ListConnections(std::string const &, Options)

Lists Connections in a given project and location.

Parameters
Name	Description
`parent`	`std::string const &` Required. Parent resource of the Connection, of the form: `projects//locations/`
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::connectors::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.connectors.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::connectors::v1::ListConnectionsRequest, Options)

Lists Connections in a given project and location.

Parameters
Name	Description
`request`	`google::cloud::connectors::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.connectors.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::connectors::v1::Connection >

GetConnection(std::string const &, Options)

Gets details of a single Connection.

Parameters
Name	Description
`name`	`std::string const &` Required. Resource name of the form: `projects//locations//connections/*`
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::connectors::v1::Connection >`	the result of the RPC. The response message type (google.cloud.connectors.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::connectors::v1::GetConnectionRequest const &, Options)

Gets details of a single Connection.

Parameters
Name	Description
`request`	`google::cloud::connectors::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.connectors.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::connectors::v1::Connection >`	the result of the RPC. The response message type (google.cloud.connectors.v1.Connection) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

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

Creates a new Connection in a given project and location.

Parameters
Name	Description
`parent`	`std::string const &` Required. Parent resource of the Connection, of the form: `projects//locations/`
`connection`	`google::cloud::connectors::v1::Connection const &` Required. Connection resource.
`connection_id`	`std::string const &` Required. Identifier to assign to the Connection. Must be unique within scope of the parent resource.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::connectors::v1::Connection > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.connectors.v1.Connection proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateConnection(NoAwaitTag, std::string const &, google::cloud::connectors::v1::Connection const &, std::string const &, Options)

Creates a new Connection in a given project and location.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	`NoAwaitTag`
`parent`	`std::string const &`
`connection`	`google::cloud::connectors::v1::Connection const &`
`connection_id`	`std::string const &`
`opts`	`Options`

Returns
Type	Description
`StatusOr< google::longrunning::Operation >`

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

Creates a new Connection in a given project and location.

Parameters
Name	Description
`request`	`google::cloud::connectors::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.connectors.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

future< StatusOr< google::cloud::connectors::v1::Connection > >

CreateConnection(NoAwaitTag, google::cloud::connectors::v1::CreateConnectionRequest const &, Options)

Creates a new Connection in a given project and location.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	`NoAwaitTag`
`request`	`google::cloud::connectors::v1::CreateConnectionRequest const &`
`opts`	`Options`

Returns
Type	Description
`StatusOr< google::longrunning::Operation >`

CreateConnection(google::longrunning::Operation const &, Options)

Creates a new Connection in a given project and location.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name	Description
`operation`	`google::longrunning::Operation const &`
`opts`	`Options`

Returns
Type	Description
`future< StatusOr< google::cloud::connectors::v1::Connection > >`

UpdateConnection(google::cloud::connectors::v1::Connection const &, google::protobuf::FieldMask const &, Options)

Updates the parameters of a single Connection.

Parameters
Name	Description
`connection`	`google::cloud::connectors::v1::Connection const &` Required. Connection resource.
`update_mask`	`google::protobuf::FieldMask const &` Required. You can modify only the fields listed below. To lock/unlock a connection: `lock_config` To suspend/resume a connection: `suspended` To update the connection details: `description` `labels` `connector_version` `config_variables` `auth_config` `destination_configs` `node_config`
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::connectors::v1::Connection > >

UpdateConnection(NoAwaitTag, google::cloud::connectors::v1::Connection const &, google::protobuf::FieldMask const &, Options)

Updates the parameters of a single Connection.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	`NoAwaitTag`
`connection`	`google::cloud::connectors::v1::Connection const &`
`update_mask`	`google::protobuf::FieldMask const &`
`opts`	`Options`

Returns
Type	Description
`StatusOr< google::longrunning::Operation >`

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

Updates the parameters of a single Connection.

Parameters
Name	Description
`request`	`google::cloud::connectors::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.connectors.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

future< StatusOr< google::cloud::connectors::v1::Connection > >

UpdateConnection(NoAwaitTag, google::cloud::connectors::v1::UpdateConnectionRequest const &, Options)

Updates the parameters of a single Connection.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	`NoAwaitTag`
`request`	`google::cloud::connectors::v1::UpdateConnectionRequest const &`
`opts`	`Options`

Returns
Type	Description
`StatusOr< google::longrunning::Operation >`

UpdateConnection(google::longrunning::Operation const &, Options)

Updates the parameters of a single Connection.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name	Description
`operation`	`google::longrunning::Operation const &`
`opts`	`Options`

Returns
Type	Description
`future< StatusOr< google::cloud::connectors::v1::Connection > >`

DeleteConnection(std::string const &, Options)

Deletes a single Connection.

Parameters
Name	Description
`name`	`std::string const &` Required. Resource name of the form: `projects//locations//connections/*`
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::connectors::v1::OperationMetadata > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.connectors.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteConnection(NoAwaitTag, std::string const &, Options)

Deletes a single Connection.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	`NoAwaitTag`
`name`	`std::string const &`
`opts`	`Options`

Returns
Type	Description
`StatusOr< google::longrunning::Operation >`

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

Deletes a single Connection.

Parameters
Name	Description
`request`	`google::cloud::connectors::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.connectors.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

future< StatusOr< google::cloud::connectors::v1::OperationMetadata > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.connectors.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteConnection(NoAwaitTag, google::cloud::connectors::v1::DeleteConnectionRequest const &, Options)

Deletes a single Connection.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	`NoAwaitTag`
`request`	`google::cloud::connectors::v1::DeleteConnectionRequest const &`
`opts`	`Options`

Returns
Type	Description
`StatusOr< google::longrunning::Operation >`

DeleteConnection(google::longrunning::Operation const &, Options)

Deletes a single Connection.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name	Description
`operation`	`google::longrunning::Operation const &`
`opts`	`Options`

Returns
Type	Description
`future< StatusOr< google::cloud::connectors::v1::OperationMetadata > >`

ListProviders(std::string const &, Options)

Lists Providers in a given project and location.

Parameters
Name	Description
`parent`	`std::string const &` Required. Parent resource of the API, of the form: `projects//locations/` Only global location is supported for Provider resource.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::connectors::v1::Provider >

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.connectors.v1.Provider, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListProviders(google::cloud::connectors::v1::ListProvidersRequest, Options)

Lists Providers in a given project and location.

Parameters
Name	Description
`request`	`google::cloud::connectors::v1::ListProvidersRequest` 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.connectors.v1.ListProvidersRequest. 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::connectors::v1::Provider >

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.connectors.v1.Provider, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

GetProvider(std::string const &, Options)

Gets details of a provider.

Parameters
Name	Description
`name`	`std::string const &` Required. Resource name of the form: `projects//locations//providers/*` Only global location is supported for Provider resource.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

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

GetProvider(google::cloud::connectors::v1::GetProviderRequest const &, Options)

Gets details of a provider.

Parameters
Name	Description
`request`	`google::cloud::connectors::v1::GetProviderRequest 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.connectors.v1.GetProviderRequest. 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::connectors::v1::Provider >`	the result of the RPC. The response message type (google.cloud.connectors.v1.Provider) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

ListConnectors(std::string const &, Options)

Lists Connectors in a given project and location.

Parameters
Name	Description
`parent`	`std::string const &` Required. Parent resource of the connectors, of the form: `projects//locations//providers/*` Only global location is supported for Connector resource.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::connectors::v1::Connector >

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.connectors.v1.Connector, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListConnectors(google::cloud::connectors::v1::ListConnectorsRequest, Options)

Lists Connectors in a given project and location.

Parameters
Name	Description
`request`	`google::cloud::connectors::v1::ListConnectorsRequest` 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.connectors.v1.ListConnectorsRequest. 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::connectors::v1::Connector >

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.connectors.v1.Connector, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

GetConnector(std::string const &, Options)

Gets details of a single Connector.

Parameters
Name	Description
`name`	`std::string const &` Required. Resource name of the form: `projects//locations//providers//connectors/` Only global location is supported for Connector resource.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

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

GetConnector(google::cloud::connectors::v1::GetConnectorRequest const &, Options)

Gets details of a single Connector.

Parameters
Name	Description
`request`	`google::cloud::connectors::v1::GetConnectorRequest 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.connectors.v1.GetConnectorRequest. 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::connectors::v1::Connector >`	the result of the RPC. The response message type (google.cloud.connectors.v1.Connector) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

ListConnectorVersions(std::string const &, Options)

Lists Connector Versions in a given project and location.

Parameters
Name	Description
`parent`	`std::string const &` Required. Parent resource of the connectors, of the form: `projects//locations//providers//connectors/` Only global location is supported for ConnectorVersion resource.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::connectors::v1::ConnectorVersion >

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.connectors.v1.ConnectorVersion, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListConnectorVersions(google::cloud::connectors::v1::ListConnectorVersionsRequest, Options)

Lists Connector Versions in a given project and location.

Parameters
Name	Description
`request`	`google::cloud::connectors::v1::ListConnectorVersionsRequest` 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.connectors.v1.ListConnectorVersionsRequest. 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::connectors::v1::ConnectorVersion >

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.connectors.v1.ConnectorVersion, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

GetConnectorVersion(std::string const &, Options)

Gets details of a single connector version.

Parameters
Name	Description
`name`	`std::string const &` Required. Resource name of the form: `projects//locations//providers//connectors//versions/*` Only global location is supported for ConnectorVersion resource.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

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

GetConnectorVersion(google::cloud::connectors::v1::GetConnectorVersionRequest const &, Options)

Gets details of a single connector version.

Parameters
Name	Description
`request`	`google::cloud::connectors::v1::GetConnectorVersionRequest 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.connectors.v1.GetConnectorVersionRequest. 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::connectors::v1::ConnectorVersion >`	the result of the RPC. The response message type (google.cloud.connectors.v1.ConnectorVersion) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

GetConnectionSchemaMetadata(std::string const &, Options)

Gets schema metadata of a connection.

SchemaMetadata is a singleton resource for each connection.

Parameters
Name	Description
`name`	`std::string const &` Required. Connection name Format: projects/{project}/locations/{location}/connections/{connection}/connectionSchemaMetadata
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

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

GetConnectionSchemaMetadata(google::cloud::connectors::v1::GetConnectionSchemaMetadataRequest const &, Options)

Gets schema metadata of a connection.

SchemaMetadata is a singleton resource for each connection.

Parameters
Name	Description
`request`	`google::cloud::connectors::v1::GetConnectionSchemaMetadataRequest 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.connectors.v1.GetConnectionSchemaMetadataRequest. 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::connectors::v1::ConnectionSchemaMetadata >`	the result of the RPC. The response message type (google.cloud.connectors.v1.ConnectionSchemaMetadata) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

RefreshConnectionSchemaMetadata(std::string const &, Options)

Refresh runtime schema of a connection.

Parameters
Name	Description
`name`	`std::string const &` Required. Resource name. Format: projects/{project}/locations/{location}/connections/{connection}/connectionSchemaMetadata
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::connectors::v1::ConnectionSchemaMetadata > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.connectors.v1.ConnectionSchemaMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

RefreshConnectionSchemaMetadata(NoAwaitTag, std::string const &, Options)

Refresh runtime schema of a connection.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	`NoAwaitTag`
`name`	`std::string const &`
`opts`	`Options`

Returns
Type	Description
`StatusOr< google::longrunning::Operation >`

RefreshConnectionSchemaMetadata(google::cloud::connectors::v1::RefreshConnectionSchemaMetadataRequest const &, Options)

Refresh runtime schema of a connection.

Parameters
Name	Description
`request`	`google::cloud::connectors::v1::RefreshConnectionSchemaMetadataRequest 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.connectors.v1.RefreshConnectionSchemaMetadataRequest. 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

future< StatusOr< google::cloud::connectors::v1::ConnectionSchemaMetadata > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.connectors.v1.ConnectionSchemaMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

RefreshConnectionSchemaMetadata(NoAwaitTag, google::cloud::connectors::v1::RefreshConnectionSchemaMetadataRequest const &, Options)

Refresh runtime schema of a connection.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	`NoAwaitTag`
`request`	`google::cloud::connectors::v1::RefreshConnectionSchemaMetadataRequest const &`
`opts`	`Options`

Returns
Type	Description
`StatusOr< google::longrunning::Operation >`

RefreshConnectionSchemaMetadata(google::longrunning::Operation const &, Options)

Refresh runtime schema of a connection.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name	Description
`operation`	`google::longrunning::Operation const &`
`opts`	`Options`

Returns
Type	Description
`future< StatusOr< google::cloud::connectors::v1::ConnectionSchemaMetadata > >`

ListRuntimeEntitySchemas(std::string const &, Options)

List schema of a runtime entities filtered by entity name.

Parameters
Name	Description
`parent`	`std::string const &` Required. Parent resource of RuntimeEntitySchema Format: projects/{project}/locations/{location}/connections/{connection}
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::connectors::v1::RuntimeEntitySchema >

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.connectors.v1.RuntimeEntitySchema, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListRuntimeEntitySchemas(google::cloud::connectors::v1::ListRuntimeEntitySchemasRequest, Options)

List schema of a runtime entities filtered by entity name.

Parameters
Name	Description
`request`	`google::cloud::connectors::v1::ListRuntimeEntitySchemasRequest` 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.connectors.v1.ListRuntimeEntitySchemasRequest. 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::connectors::v1::RuntimeEntitySchema >

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.connectors.v1.RuntimeEntitySchema, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListRuntimeActionSchemas(std::string const &, Options)

List schema of a runtime actions filtered by action name.

Parameters
Name	Description
`parent`	`std::string const &` Required. Parent resource of RuntimeActionSchema Format: projects/{project}/locations/{location}/connections/{connection}
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::connectors::v1::RuntimeActionSchema >

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.connectors.v1.RuntimeActionSchema, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListRuntimeActionSchemas(google::cloud::connectors::v1::ListRuntimeActionSchemasRequest, Options)

List schema of a runtime actions filtered by action name.

Parameters
Name	Description
`request`	`google::cloud::connectors::v1::ListRuntimeActionSchemasRequest` 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.connectors.v1.ListRuntimeActionSchemasRequest. 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::connectors::v1::RuntimeActionSchema >

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.connectors.v1.RuntimeActionSchema, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

GetRuntimeConfig(std::string const &, Options)

Gets the runtimeConfig of a location.

RuntimeConfig is a singleton resource for each location.

Parameters
Name	Description
`name`	`std::string const &` Required. Resource name of the form: `projects//locations//runtimeConfig`
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

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

GetRuntimeConfig(google::cloud::connectors::v1::GetRuntimeConfigRequest const &, Options)

Gets the runtimeConfig of a location.

RuntimeConfig is a singleton resource for each location.

Parameters
Name	Description
`request`	`google::cloud::connectors::v1::GetRuntimeConfigRequest 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.connectors.v1.GetRuntimeConfigRequest. 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::connectors::v1::RuntimeConfig >`	the result of the RPC. The response message type (google.cloud.connectors.v1.RuntimeConfig) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

GetGlobalSettings(std::string const &, Options)

GetGlobalSettings gets settings of a project.

GlobalSettings is a singleton resource.

Parameters
Name	Description
`name`	`std::string const &` Required. The resource name of the Settings.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

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

GetGlobalSettings(google::cloud::connectors::v1::GetGlobalSettingsRequest const &, Options)

GetGlobalSettings gets settings of a project.

GlobalSettings is a singleton resource.

Parameters
Name	Description
`request`	`google::cloud::connectors::v1::GetGlobalSettingsRequest 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.connectors.v1.GetGlobalSettingsRequest. 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::connectors::v1::Settings >`	the result of the RPC. The response message type (google.cloud.connectors.v1.Settings) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.