Class DeveloperConnectClient (2.34.0-rc)

Service describing handlers for resources.

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

DeveloperConnectClient(DeveloperConnectClient const &)

Copy and move support

Parameter
Name Description
DeveloperConnectClient const &

DeveloperConnectClient(DeveloperConnectClient &&)

Copy and move support

Parameter
Name Description
DeveloperConnectClient &&

DeveloperConnectClient(std::shared_ptr< DeveloperConnectConnection >, Options)

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

Operators

operator=(DeveloperConnectClient const &)

Copy and move support

Parameter
Name Description
DeveloperConnectClient const &
Returns
Type Description
DeveloperConnectClient &

operator=(DeveloperConnectClient &&)

Copy and move support

Parameter
Name Description
DeveloperConnectClient &&
Returns
Type Description
DeveloperConnectClient &

Functions

ListConnections(std::string const &, Options)

Lists Connections in a given project and location.

Parameters
Name Description
parent std::string const &

Required. Parent value for ListConnectionsRequest

opts Options

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

Returns
Type Description
StreamRange< google::cloud::developerconnect::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.developerconnect.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::developerconnect::v1::ListConnectionsRequest, Options)

Lists Connections in a given project and location.

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

GetConnection(std::string const &, Options)

Gets details of a single Connection.

Parameters
Name Description
name std::string const &

Required. Name of the resource

opts Options

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

Returns
Type Description
StatusOr< google::cloud::developerconnect::v1::Connection >

the result of the RPC. The response message type (google.cloud.developerconnect.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::developerconnect::v1::GetConnectionRequest const &, Options)

Gets details of a single Connection.

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

the result of the RPC. The response message type (google.cloud.developerconnect.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::developerconnect::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. Value for parent.

connection google::cloud::developerconnect::v1::Connection const &

Required. The resource being created

connection_id std::string const &

Required. Id of the requesting object If auto-generating Id server-side, remove this field and connection_id from the method_signature of Create RPC

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::developerconnect::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.developerconnect.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::developerconnect::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::developerconnect::v1::Connection const &
connection_id std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

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

Creates a new Connection in a given project and location.

Parameters
Name Description
request google::cloud::developerconnect::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.developerconnect.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::developerconnect::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.developerconnect.v1.Connection proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateConnection(NoAwaitTag, google::cloud::developerconnect::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::developerconnect::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::developerconnect::v1::Connection > >

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

Updates the parameters of a single Connection.

Parameters
Name Description
connection google::cloud::developerconnect::v1::Connection const &

Required. The resource being updated

update_mask google::protobuf::FieldMask const &

Required. Field mask is used to specify the fields to be overwritten in the Connection resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::developerconnect::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.developerconnect.v1.Connection proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateConnection(NoAwaitTag, google::cloud::developerconnect::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::developerconnect::v1::Connection const &
update_mask google::protobuf::FieldMask const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

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

Updates the parameters of a single Connection.

Parameters
Name Description
request google::cloud::developerconnect::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.developerconnect.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::developerconnect::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.developerconnect.v1.Connection proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateConnection(NoAwaitTag, google::cloud::developerconnect::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::developerconnect::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::developerconnect::v1::Connection > >

DeleteConnection(std::string const &, Options)

Deletes a single Connection.

Parameters
Name Description
name std::string const &

Required. Name of the resource

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::developerconnect::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.developerconnect.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::developerconnect::v1::DeleteConnectionRequest const &, Options)

Deletes a single Connection.

Parameters
Name Description
request google::cloud::developerconnect::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.developerconnect.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::developerconnect::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.developerconnect.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteConnection(NoAwaitTag, google::cloud::developerconnect::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::developerconnect::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::developerconnect::v1::OperationMetadata > >

CreateGitRepositoryLink(std::string const &, google::cloud::developerconnect::v1::GitRepositoryLink const &, std::string const &, Options)

Creates a GitRepositoryLink.

Upon linking a Git Repository, Developer Connect will configure the Git Repository to send webhook events to Developer Connect. Connections that use Firebase GitHub Application will have events forwarded to the Firebase service. All other Connections will have events forwarded to Cloud Build.

Parameters
Name Description
parent std::string const &

Required. Value for parent.

git_repository_link google::cloud::developerconnect::v1::GitRepositoryLink const &

Required. The resource being created

git_repository_link_id std::string const &

Required. The ID to use for the repository, which will become the final component of the repository's resource name. This ID should be unique in the connection. Allows alphanumeric characters and any of -._~%!$&'()*+,;=.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::developerconnect::v1::GitRepositoryLink > >

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

CreateGitRepositoryLink(NoAwaitTag, std::string const &, google::cloud::developerconnect::v1::GitRepositoryLink const &, std::string const &, Options)

Creates a GitRepositoryLink.

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 &
git_repository_link google::cloud::developerconnect::v1::GitRepositoryLink const &
git_repository_link_id std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateGitRepositoryLink(google::cloud::developerconnect::v1::CreateGitRepositoryLinkRequest const &, Options)

Creates a GitRepositoryLink.

Upon linking a Git Repository, Developer Connect will configure the Git Repository to send webhook events to Developer Connect. Connections that use Firebase GitHub Application will have events forwarded to the Firebase service. All other Connections will have events forwarded to Cloud Build.

Parameters
Name Description
request google::cloud::developerconnect::v1::CreateGitRepositoryLinkRequest 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.developerconnect.v1.CreateGitRepositoryLinkRequest. 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::developerconnect::v1::GitRepositoryLink > >

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

CreateGitRepositoryLink(NoAwaitTag, google::cloud::developerconnect::v1::CreateGitRepositoryLinkRequest const &, Options)

Creates a GitRepositoryLink.

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::developerconnect::v1::CreateGitRepositoryLinkRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

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

Creates a GitRepositoryLink.

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::developerconnect::v1::GitRepositoryLink > >

DeleteGitRepositoryLink(std::string const &, Options)

Deletes a single GitRepositoryLink.

Parameters
Name Description
name std::string const &

Required. Name of the resource

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::developerconnect::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.developerconnect.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

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

Deletes a single GitRepositoryLink.

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 >

DeleteGitRepositoryLink(google::cloud::developerconnect::v1::DeleteGitRepositoryLinkRequest const &, Options)

Deletes a single GitRepositoryLink.

Parameters
Name Description
request google::cloud::developerconnect::v1::DeleteGitRepositoryLinkRequest 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.developerconnect.v1.DeleteGitRepositoryLinkRequest. 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::developerconnect::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.developerconnect.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteGitRepositoryLink(NoAwaitTag, google::cloud::developerconnect::v1::DeleteGitRepositoryLinkRequest const &, Options)

Deletes a single GitRepositoryLink.

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::developerconnect::v1::DeleteGitRepositoryLinkRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

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

Deletes a single GitRepositoryLink.

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::developerconnect::v1::OperationMetadata > >

ListGitRepositoryLinks(std::string const &, Options)

Lists GitRepositoryLinks in a given project, location, and connection.

Parameters
Name Description
parent std::string const &

Required. Parent value for ListGitRepositoryLinksRequest

opts Options

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

Returns
Type Description
StreamRange< google::cloud::developerconnect::v1::GitRepositoryLink >

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

ListGitRepositoryLinks(google::cloud::developerconnect::v1::ListGitRepositoryLinksRequest, Options)

Lists GitRepositoryLinks in a given project, location, and connection.

Parameters
Name Description
request google::cloud::developerconnect::v1::ListGitRepositoryLinksRequest

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.developerconnect.v1.ListGitRepositoryLinksRequest. 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::developerconnect::v1::GitRepositoryLink >

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

GetGitRepositoryLink(std::string const &, Options)

Gets details of a single GitRepositoryLink.

Parameters
Name Description
name std::string const &

Required. Name of the resource

opts Options

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

Returns
Type Description
StatusOr< google::cloud::developerconnect::v1::GitRepositoryLink >

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

GetGitRepositoryLink(google::cloud::developerconnect::v1::GetGitRepositoryLinkRequest const &, Options)

Gets details of a single GitRepositoryLink.

Parameters
Name Description
request google::cloud::developerconnect::v1::GetGitRepositoryLinkRequest 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.developerconnect.v1.GetGitRepositoryLinkRequest. 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::developerconnect::v1::GitRepositoryLink >

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

FetchReadWriteToken(std::string const &, Options)

Fetches read/write token of a given gitRepositoryLink.

Parameters
Name Description
git_repository_link std::string const &

Required. The resource name of the gitRepositoryLink in the format projects/*/locations/*/connections/*/gitRepositoryLinks/*.

opts Options

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

Returns
Type Description
StatusOr< google::cloud::developerconnect::v1::FetchReadWriteTokenResponse >

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

FetchReadWriteToken(google::cloud::developerconnect::v1::FetchReadWriteTokenRequest const &, Options)

Fetches read/write token of a given gitRepositoryLink.

Parameters
Name Description
request google::cloud::developerconnect::v1::FetchReadWriteTokenRequest 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.developerconnect.v1.FetchReadWriteTokenRequest. 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::developerconnect::v1::FetchReadWriteTokenResponse >

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

FetchReadToken(std::string const &, Options)

Fetches read token of a given gitRepositoryLink.

Parameters
Name Description
git_repository_link std::string const &

Required. The resource name of the gitRepositoryLink in the format projects/*/locations/*/connections/*/gitRepositoryLinks/*.

opts Options

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

Returns
Type Description
StatusOr< google::cloud::developerconnect::v1::FetchReadTokenResponse >

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

FetchReadToken(google::cloud::developerconnect::v1::FetchReadTokenRequest const &, Options)

Fetches read token of a given gitRepositoryLink.

Parameters
Name Description
request google::cloud::developerconnect::v1::FetchReadTokenRequest 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.developerconnect.v1.FetchReadTokenRequest. 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::developerconnect::v1::FetchReadTokenResponse >

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

FetchLinkableGitRepositories(std::string const &, Options)

FetchLinkableGitRepositories returns a list of git repositories from an SCM that are available to be added to a Connection.

Parameters
Name Description
connection std::string const &

Required. The name of the Connection. Format: projects/*/locations/*/connections/*.

opts Options

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

Returns
Type Description
StreamRange< google::cloud::developerconnect::v1::LinkableGitRepository >

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

FetchLinkableGitRepositories(google::cloud::developerconnect::v1::FetchLinkableGitRepositoriesRequest, Options)

FetchLinkableGitRepositories returns a list of git repositories from an SCM that are available to be added to a Connection.

Parameters
Name Description
request google::cloud::developerconnect::v1::FetchLinkableGitRepositoriesRequest

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.developerconnect.v1.FetchLinkableGitRepositoriesRequest. 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::developerconnect::v1::LinkableGitRepository >

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

FetchGitHubInstallations(std::string const &, Options)

FetchGitHubInstallations returns the list of GitHub Installations that are available to be added to a Connection.

For github.com, only installations accessible to the authorizer token are returned. For GitHub Enterprise, all installations are returned.

Parameters
Name Description
connection std::string const &

Required. The resource name of the connection in the format projects/*/locations/*/connections/*.

opts Options

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

Returns
Type Description
StatusOr< google::cloud::developerconnect::v1::FetchGitHubInstallationsResponse >

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

FetchGitHubInstallations(google::cloud::developerconnect::v1::FetchGitHubInstallationsRequest const &, Options)

FetchGitHubInstallations returns the list of GitHub Installations that are available to be added to a Connection.

For github.com, only installations accessible to the authorizer token are returned. For GitHub Enterprise, all installations are returned.

Parameters
Name Description
request google::cloud::developerconnect::v1::FetchGitHubInstallationsRequest 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.developerconnect.v1.FetchGitHubInstallationsRequest. 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::developerconnect::v1::FetchGitHubInstallationsResponse >

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

FetchGitRefs(std::string const &, google::cloud::developerconnect::v1::FetchGitRefsRequest::RefType, Options)

Fetch the list of branches or tags for a given repository.

Parameters
Name Description
git_repository_link std::string const &

Required. The resource name of GitRepositoryLink in the format projects/*/locations/*/connections/*/gitRepositoryLinks/*.

ref_type google::cloud::developerconnect::v1::FetchGitRefsRequest::RefType

Required. Type of refs to fetch.

opts Options

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

Returns
Type Description
StreamRange< std::string >

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 a std::string.

FetchGitRefs(google::cloud::developerconnect::v1::FetchGitRefsRequest, Options)

Fetch the list of branches or tags for a given repository.

Parameters
Name Description
request google::cloud::developerconnect::v1::FetchGitRefsRequest

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.developerconnect.v1.FetchGitRefsRequest. 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< std::string >

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 a std::string.

ListLocations(google::cloud::location::ListLocationsRequest, Options)

Lists information about the supported locations for this service.

Parameters
Name Description
request google::cloud::location::ListLocationsRequest

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.location.ListLocationsRequest. 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::location::Location >

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

GetLocation(google::cloud::location::GetLocationRequest const &, Options)

Gets information about a location.

Parameters
Name Description
request google::cloud::location::GetLocationRequest 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.location.GetLocationRequest. 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::location::Location >

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

ListOperations(std::string const &, std::string const &, Options)

Lists operations that match the specified filter in the request.

If the server doesn't support this method, it returns UNIMPLEMENTED.

Parameters
Name Description
name std::string const &

The name of the operation's parent resource.

filter std::string const &

The standard list filter.

opts Options

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

Returns
Type Description
StreamRange< google::longrunning::Operation >

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

ListOperations(google::longrunning::ListOperationsRequest, Options)

Lists operations that match the specified filter in the request.

If the server doesn't support this method, it returns UNIMPLEMENTED.

Parameters
Name Description
request google::longrunning::ListOperationsRequest

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.longrunning.ListOperationsRequest. 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::longrunning::Operation >

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

GetOperation(std::string const &, Options)

Gets the latest state of a long-running operation.

Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters
Name Description
name std::string const &

The name of the operation resource.

opts Options

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

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

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

GetOperation(google::longrunning::GetOperationRequest const &, Options)

Gets the latest state of a long-running operation.

Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters
Name Description
request google::longrunning::GetOperationRequest 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.longrunning.GetOperationRequest. 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::longrunning::Operation >

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

DeleteOperation(std::string const &, Options)

Deletes a long-running operation.

This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

Parameters
Name Description
name std::string const &

The name of the operation resource to be deleted.

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.

DeleteOperation(google::longrunning::DeleteOperationRequest const &, Options)

Deletes a long-running operation.

This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

Parameters
Name Description
request google::longrunning::DeleteOperationRequest 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.longrunning.DeleteOperationRequest. 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.

CancelOperation(std::string const &, Options)

Starts asynchronous cancellation on a long-running operation.

The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

Parameters
Name Description
name std::string const &

The name of the operation resource to be cancelled.

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.

CancelOperation(google::longrunning::CancelOperationRequest const &, Options)

Starts asynchronous cancellation on a long-running operation.

The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

Parameters
Name Description
request google::longrunning::CancelOperationRequest 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.longrunning.CancelOperationRequest. 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.