Class AppConnectorsServiceClient (2.20.0)

API Overview:

The beyondcorp.googleapis.com service implements the Google Cloud BeyondCorp API.

Data Model:

The AppConnectorsService exposes the following resource:

  • AppConnectors, named as follows: projects/{project_id}/locations/{location_id}/appConnectors/{app_connector_id}.

The AppConnectorsService provides methods to manage (create/read/update/delete) BeyondCorp AppConnectors.

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

AppConnectorsServiceClient(AppConnectorsServiceClient const &)

Copy and move support

Parameter
Name Description
AppConnectorsServiceClient const &

AppConnectorsServiceClient(AppConnectorsServiceClient &&)

Copy and move support

Parameter
Name Description
AppConnectorsServiceClient &&

AppConnectorsServiceClient(std::shared_ptr< AppConnectorsServiceConnection >, Options)

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

Operators

operator=(AppConnectorsServiceClient const &)

Copy and move support

Parameter
Name Description
AppConnectorsServiceClient const &
Returns
Type Description
AppConnectorsServiceClient &

operator=(AppConnectorsServiceClient &&)

Copy and move support

Parameter
Name Description
AppConnectorsServiceClient &&
Returns
Type Description
AppConnectorsServiceClient &

Functions

ListAppConnectors(std::string const &, Options)

Lists AppConnectors in a given project and location.

Parameters
Name Description
parent std::string const &

Required. The resource name of the AppConnector location using 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::beyondcorp::appconnectors::v1::AppConnector >

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

ListAppConnectors(google::cloud::beyondcorp::appconnectors::v1::ListAppConnectorsRequest, Options)

Lists AppConnectors in a given project and location.

Parameters
Name Description
request google::cloud::beyondcorp::appconnectors::v1::ListAppConnectorsRequest

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.beyondcorp.appconnectors.v1.ListAppConnectorsRequest. 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::beyondcorp::appconnectors::v1::AppConnector >

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

GetAppConnector(std::string const &, Options)

Gets details of a single AppConnector.

Parameters
Name Description
name std::string const &

Required. BeyondCorp AppConnector name using the form: projects/{project_id}/locations/{location_id}/appConnectors/{app_connector_id}
opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::beyondcorp::appconnectors::v1::AppConnector >

the result of the RPC. The response message type (google.cloud.beyondcorp.appconnectors.v1.AppConnector) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetAppConnector(google::cloud::beyondcorp::appconnectors::v1::GetAppConnectorRequest const &, Options)

Gets details of a single AppConnector.

Parameters
Name Description
request google::cloud::beyondcorp::appconnectors::v1::GetAppConnectorRequest 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.beyondcorp.appconnectors.v1.GetAppConnectorRequest. 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::beyondcorp::appconnectors::v1::AppConnector >

the result of the RPC. The response message type (google.cloud.beyondcorp.appconnectors.v1.AppConnector) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

CreateAppConnector(std::string const &, google::cloud::beyondcorp::appconnectors::v1::AppConnector const &, std::string const &, Options)

Creates a new AppConnector in a given project and location.

Parameters
Name Description
parent std::string const &

Required. The resource project name of the AppConnector location using the form: projects/{project_id}/locations/{location_id}
app_connector google::cloud::beyondcorp::appconnectors::v1::AppConnector const &

Required. A BeyondCorp AppConnector resource.

app_connector_id std::string const &

Optional. User-settable AppConnector resource ID.

  • Must start with a letter.
  • Must contain between 4-63 characters from /[a-z][0-9]-/.
  • Must end with a number or a letter.
opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::beyondcorp::appconnectors::v1::AppConnector > >

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.beyondcorp.appconnectors.v1.AppConnector proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateAppConnector(google::cloud::beyondcorp::appconnectors::v1::CreateAppConnectorRequest const &, Options)

Creates a new AppConnector in a given project and location.

Parameters
Name Description
request google::cloud::beyondcorp::appconnectors::v1::CreateAppConnectorRequest 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.beyondcorp.appconnectors.v1.CreateAppConnectorRequest. 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::beyondcorp::appconnectors::v1::AppConnector > >

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.beyondcorp.appconnectors.v1.AppConnector proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateAppConnector(google::cloud::beyondcorp::appconnectors::v1::AppConnector const &, google::protobuf::FieldMask const &, Options)

Updates the parameters of a single AppConnector.

Parameters
Name Description
app_connector google::cloud::beyondcorp::appconnectors::v1::AppConnector const &

Required. AppConnector message with updated fields. Only supported fields specified in update_mask are updated.

update_mask google::protobuf::FieldMask const &

Required. Mask of fields to update. At least one path must be supplied in this field. The elements of the repeated paths field may only include these fields from [BeyondCorp.AppConnector]:

  • labels
  • display_name
opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::beyondcorp::appconnectors::v1::AppConnector > >

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.beyondcorp.appconnectors.v1.AppConnector proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateAppConnector(google::cloud::beyondcorp::appconnectors::v1::UpdateAppConnectorRequest const &, Options)

Updates the parameters of a single AppConnector.

Parameters
Name Description
request google::cloud::beyondcorp::appconnectors::v1::UpdateAppConnectorRequest 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.beyondcorp.appconnectors.v1.UpdateAppConnectorRequest. 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::beyondcorp::appconnectors::v1::AppConnector > >

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.beyondcorp.appconnectors.v1.AppConnector proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteAppConnector(std::string const &, Options)

Deletes a single AppConnector.

Parameters
Name Description
name std::string const &

Required. BeyondCorp AppConnector name using the form: projects/{project_id}/locations/{location_id}/appConnectors/{app_connector_id}
opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::beyondcorp::appconnectors::v1::AppConnectorOperationMetadata > >

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.beyondcorp.appconnectors.v1.AppConnectorOperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteAppConnector(google::cloud::beyondcorp::appconnectors::v1::DeleteAppConnectorRequest const &, Options)

Deletes a single AppConnector.

Parameters
Name Description
request google::cloud::beyondcorp::appconnectors::v1::DeleteAppConnectorRequest 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.beyondcorp.appconnectors.v1.DeleteAppConnectorRequest. 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::beyondcorp::appconnectors::v1::AppConnectorOperationMetadata > >

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.beyondcorp.appconnectors.v1.AppConnectorOperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

ReportStatus(std::string const &, google::cloud::beyondcorp::appconnectors::v1::ResourceInfo const &, Options)

Report status for a given connector.

Parameters
Name Description
app_connector std::string const &

Required. BeyondCorp Connector name using the form: projects/{project_id}/locations/{location_id}/connectors/{connector}
resource_info google::cloud::beyondcorp::appconnectors::v1::ResourceInfo const &

Required. Resource info of the connector.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::beyondcorp::appconnectors::v1::AppConnector > >

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.beyondcorp.appconnectors.v1.AppConnector proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

ReportStatus(google::cloud::beyondcorp::appconnectors::v1::ReportStatusRequest const &, Options)

Report status for a given connector.

Parameters
Name Description
request google::cloud::beyondcorp::appconnectors::v1::ReportStatusRequest 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.beyondcorp.appconnectors.v1.ReportStatusRequest. 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::beyondcorp::appconnectors::v1::AppConnector > >

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.beyondcorp.appconnectors.v1.AppConnector proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.