Class SecureSourceManagerClient (2.42.0-rc)

Secure Source Manager API.

Access Secure Source Manager instances, resources, and repositories.

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

SecureSourceManagerClient(SecureSourceManagerClient const &)

Copy and move support

Parameter
Name Description
SecureSourceManagerClient const &

SecureSourceManagerClient(SecureSourceManagerClient &&)

Copy and move support

Parameter
Name Description
SecureSourceManagerClient &&

SecureSourceManagerClient(std::shared_ptr< SecureSourceManagerConnection >, Options)

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

Operators

operator=(SecureSourceManagerClient const &)

Copy and move support

Parameter
Name Description
SecureSourceManagerClient const &
Returns
Type Description
SecureSourceManagerClient &

operator=(SecureSourceManagerClient &&)

Copy and move support

Parameter
Name Description
SecureSourceManagerClient &&
Returns
Type Description
SecureSourceManagerClient &

Functions

ListInstances(std::string const &, Options)

Lists Instances in a given project and location.

Parameters
Name Description
parent std::string const &

Required. Parent value for ListInstancesRequest.

opts Options

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

Returns
Type Description
StreamRange< google::cloud::securesourcemanager::v1::Instance >

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

ListInstances(google::cloud::securesourcemanager::v1::ListInstancesRequest, Options)

Lists Instances in a given project and location.

Parameters
Name Description
request google::cloud::securesourcemanager::v1::ListInstancesRequest

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.securesourcemanager.v1.ListInstancesRequest. 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::securesourcemanager::v1::Instance >

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

GetInstance(std::string const &, Options)

Gets details of a single instance.

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::securesourcemanager::v1::Instance >

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

GetInstance(google::cloud::securesourcemanager::v1::GetInstanceRequest const &, Options)

Gets details of a single instance.

Parameters
Name Description
request google::cloud::securesourcemanager::v1::GetInstanceRequest 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.securesourcemanager.v1.GetInstanceRequest. 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::securesourcemanager::v1::Instance >

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

CreateInstance(std::string const &, google::cloud::securesourcemanager::v1::Instance const &, std::string const &, Options)

Creates a new instance in a given project and location.

Parameters
Name Description
parent std::string const &

Required. Value for parent.

instance google::cloud::securesourcemanager::v1::Instance const &

Required. The resource being created.

instance_id std::string const &

Required. ID of the instance to be created.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::securesourcemanager::v1::Instance > >

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

CreateInstance(NoAwaitTag, std::string const &, google::cloud::securesourcemanager::v1::Instance const &, std::string const &, Options)

Creates a new instance 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 &
instance google::cloud::securesourcemanager::v1::Instance const &
instance_id std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateInstance(google::cloud::securesourcemanager::v1::CreateInstanceRequest const &, Options)

Creates a new instance in a given project and location.

Parameters
Name Description
request google::cloud::securesourcemanager::v1::CreateInstanceRequest 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.securesourcemanager.v1.CreateInstanceRequest. 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::securesourcemanager::v1::Instance > >

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

CreateInstance(NoAwaitTag, google::cloud::securesourcemanager::v1::CreateInstanceRequest const &, Options)

Creates a new instance 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::securesourcemanager::v1::CreateInstanceRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

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

Creates a new instance 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::securesourcemanager::v1::Instance > >

DeleteInstance(std::string const &, Options)

Deletes a single instance.

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

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

Deletes a single instance.

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 >

DeleteInstance(google::cloud::securesourcemanager::v1::DeleteInstanceRequest const &, Options)

Deletes a single instance.

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

DeleteInstance(NoAwaitTag, google::cloud::securesourcemanager::v1::DeleteInstanceRequest const &, Options)

Deletes a single instance.

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

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

Deletes a single instance.

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

ListRepositories(std::string const &, Options)

Lists Repositories in a given project and location.

The instance field is required in the query parameter for requests using the securesourcemanager.googleapis.com endpoint.

Parameters
Name Description
parent std::string const &

Required. Parent value for ListRepositoriesRequest.

opts Options

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

Returns
Type Description
StreamRange< google::cloud::securesourcemanager::v1::Repository >

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

ListRepositories(google::cloud::securesourcemanager::v1::ListRepositoriesRequest, Options)

Lists Repositories in a given project and location.

The instance field is required in the query parameter for requests using the securesourcemanager.googleapis.com endpoint.

Parameters
Name Description
request google::cloud::securesourcemanager::v1::ListRepositoriesRequest

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.securesourcemanager.v1.ListRepositoriesRequest. 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::securesourcemanager::v1::Repository >

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

GetRepository(std::string const &, Options)

Gets metadata of a repository.

Parameters
Name Description
name std::string const &

Required. Name of the repository to retrieve. The format is projects/{project_number}/locations/{location_id}/repositories/{repository_id}.

opts Options

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

Returns
Type Description
StatusOr< google::cloud::securesourcemanager::v1::Repository >

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

GetRepository(google::cloud::securesourcemanager::v1::GetRepositoryRequest const &, Options)

Gets metadata of a repository.

Parameters
Name Description
request google::cloud::securesourcemanager::v1::GetRepositoryRequest 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.securesourcemanager.v1.GetRepositoryRequest. 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::securesourcemanager::v1::Repository >

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

CreateRepository(std::string const &, google::cloud::securesourcemanager::v1::Repository const &, std::string const &, Options)

Creates a new repository in a given project and location.

The Repository.Instance field is required in the request body for requests using the securesourcemanager.googleapis.com endpoint.

Parameters
Name Description
parent std::string const &

Required. The project in which to create the repository. Values are of the form projects/{project_number}/locations/{location_id}

repository google::cloud::securesourcemanager::v1::Repository const &

Required. The resource being created.

repository_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 value should be 4-63 characters, and valid characters are /[a-z][0-9]-/.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::securesourcemanager::v1::Repository > >

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

CreateRepository(NoAwaitTag, std::string const &, google::cloud::securesourcemanager::v1::Repository const &, std::string const &, Options)

Creates a new repository 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 &
repository google::cloud::securesourcemanager::v1::Repository const &
repository_id std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateRepository(google::cloud::securesourcemanager::v1::CreateRepositoryRequest const &, Options)

Creates a new repository in a given project and location.

The Repository.Instance field is required in the request body for requests using the securesourcemanager.googleapis.com endpoint.

Parameters
Name Description
request google::cloud::securesourcemanager::v1::CreateRepositoryRequest 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.securesourcemanager.v1.CreateRepositoryRequest. 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::securesourcemanager::v1::Repository > >

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

CreateRepository(NoAwaitTag, google::cloud::securesourcemanager::v1::CreateRepositoryRequest const &, Options)

Creates a new repository 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::securesourcemanager::v1::CreateRepositoryRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

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

Creates a new repository 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::securesourcemanager::v1::Repository > >

UpdateRepository(google::cloud::securesourcemanager::v1::Repository const &, google::protobuf::FieldMask const &, Options)

Updates the metadata of a repository.

Parameters
Name Description
repository google::cloud::securesourcemanager::v1::Repository const &

Required. The repository being updated.

update_mask google::protobuf::FieldMask const &

Optional. Field mask is used to specify the fields to be overwritten in the repository 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::securesourcemanager::v1::Repository > >

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

UpdateRepository(NoAwaitTag, google::cloud::securesourcemanager::v1::Repository const &, google::protobuf::FieldMask const &, Options)

Updates the metadata of a repository.

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
repository google::cloud::securesourcemanager::v1::Repository const &
update_mask google::protobuf::FieldMask const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

UpdateRepository(google::cloud::securesourcemanager::v1::UpdateRepositoryRequest const &, Options)

Updates the metadata of a repository.

Parameters
Name Description
request google::cloud::securesourcemanager::v1::UpdateRepositoryRequest 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.securesourcemanager.v1.UpdateRepositoryRequest. 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::securesourcemanager::v1::Repository > >

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

UpdateRepository(NoAwaitTag, google::cloud::securesourcemanager::v1::UpdateRepositoryRequest const &, Options)

Updates the metadata of a repository.

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

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

Updates the metadata of a repository.

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::securesourcemanager::v1::Repository > >

DeleteRepository(std::string const &, Options)

Deletes a Repository.

Parameters
Name Description
name std::string const &

Required. Name of the repository to delete. The format is projects/{project_number}/locations/{location_id}/repositories/{repository_id}.

opts Options

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

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

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

Deletes a Repository.

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 >

DeleteRepository(google::cloud::securesourcemanager::v1::DeleteRepositoryRequest const &, Options)

Deletes a Repository.

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

DeleteRepository(NoAwaitTag, google::cloud::securesourcemanager::v1::DeleteRepositoryRequest const &, Options)

Deletes a Repository.

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

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

Deletes a Repository.

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

ListHooks(std::string const &, Options)

Lists hooks in a given repository.

Parameters
Name Description
parent std::string const &

Required. Parent value for ListHooksRequest.

opts Options

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

Returns
Type Description
StreamRange< google::cloud::securesourcemanager::v1::Hook >

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

ListHooks(google::cloud::securesourcemanager::v1::ListHooksRequest, Options)

Lists hooks in a given repository.

Parameters
Name Description
request google::cloud::securesourcemanager::v1::ListHooksRequest

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.securesourcemanager.v1.ListHooksRequest. 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::securesourcemanager::v1::Hook >

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

GetHook(std::string const &, Options)

Gets metadata of a hook.

Parameters
Name Description
name std::string const &

Required. Name of the hook to retrieve. The format is projects/{project_number}/locations/{location_id}/repositories/{repository_id}/hooks/{hook_id}.

opts Options

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

Returns
Type Description
StatusOr< google::cloud::securesourcemanager::v1::Hook >

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

GetHook(google::cloud::securesourcemanager::v1::GetHookRequest const &, Options)

Gets metadata of a hook.

Parameters
Name Description
request google::cloud::securesourcemanager::v1::GetHookRequest 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.securesourcemanager.v1.GetHookRequest. 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::securesourcemanager::v1::Hook >

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

CreateHook(std::string const &, google::cloud::securesourcemanager::v1::Hook const &, std::string const &, Options)

Creates a new hook in a given repository.

Parameters
Name Description
parent std::string const &

Required. The repository in which to create the hook. Values are of the form projects/{project_number}/locations/{location_id}/repositories/{repository_id}

hook google::cloud::securesourcemanager::v1::Hook const &

Required. The resource being created.

hook_id std::string const &

Required. The ID to use for the hook, which will become the final component of the hook's resource name. This value restricts to lower-case letters, numbers, and hyphen, with the first character a letter, the last a letter or a number, and a 63 character maximum.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::securesourcemanager::v1::Hook > >

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

CreateHook(NoAwaitTag, std::string const &, google::cloud::securesourcemanager::v1::Hook const &, std::string const &, Options)

Creates a new hook in a given repository.

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 &
hook google::cloud::securesourcemanager::v1::Hook const &
hook_id std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateHook(google::cloud::securesourcemanager::v1::CreateHookRequest const &, Options)

Creates a new hook in a given repository.

Parameters
Name Description
request google::cloud::securesourcemanager::v1::CreateHookRequest 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.securesourcemanager.v1.CreateHookRequest. 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::securesourcemanager::v1::Hook > >

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

CreateHook(NoAwaitTag, google::cloud::securesourcemanager::v1::CreateHookRequest const &, Options)

Creates a new hook in a given repository.

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

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

Creates a new hook in a given repository.

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::securesourcemanager::v1::Hook > >

UpdateHook(google::cloud::securesourcemanager::v1::Hook const &, google::protobuf::FieldMask const &, Options)

Updates the metadata of a hook.

Parameters
Name Description
hook google::cloud::securesourcemanager::v1::Hook const &

Required. The hook being updated.

update_mask google::protobuf::FieldMask const &

Required. Field mask is used to specify the fields to be overwritten in the hook 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. The special value "*" means full replacement.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::securesourcemanager::v1::Hook > >

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

UpdateHook(NoAwaitTag, google::cloud::securesourcemanager::v1::Hook const &, google::protobuf::FieldMask const &, Options)

Updates the metadata of a hook.

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
hook google::cloud::securesourcemanager::v1::Hook const &
update_mask google::protobuf::FieldMask const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

UpdateHook(google::cloud::securesourcemanager::v1::UpdateHookRequest const &, Options)

Updates the metadata of a hook.

Parameters
Name Description
request google::cloud::securesourcemanager::v1::UpdateHookRequest 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.securesourcemanager.v1.UpdateHookRequest. 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::securesourcemanager::v1::Hook > >

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

UpdateHook(NoAwaitTag, google::cloud::securesourcemanager::v1::UpdateHookRequest const &, Options)

Updates the metadata of a hook.

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

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

Updates the metadata of a hook.

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::securesourcemanager::v1::Hook > >

DeleteHook(std::string const &, Options)

Deletes a Hook.

Parameters
Name Description
name std::string const &

Required. Name of the hook to delete. The format is projects/{project_number}/locations/{location_id}/repositories/{repository_id}/hooks/{hook_id}.

opts Options

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

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

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

Deletes a Hook.

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 >

DeleteHook(google::cloud::securesourcemanager::v1::DeleteHookRequest const &, Options)

Deletes a Hook.

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

DeleteHook(NoAwaitTag, google::cloud::securesourcemanager::v1::DeleteHookRequest const &, Options)

Deletes a Hook.

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

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

Deletes a Hook.

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

GetIamPolicyRepo(std::string const &, Options)

Get IAM policy for a repository.

Parameters
Name Description
resource std::string const &

REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.

opts Options

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

Returns
Type Description
StatusOr< google::iam::v1::Policy >

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

GetIamPolicyRepo(google::iam::v1::GetIamPolicyRequest const &, Options)

Get IAM policy for a repository.

Parameters
Name Description
request google::iam::v1::GetIamPolicyRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.iam.v1.GetIamPolicyRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

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

Returns
Type Description
StatusOr< google::iam::v1::Policy >

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

SetIamPolicyRepo(std::string const &, Options)

Set IAM policy on a repository.

Parameters
Name Description
resource std::string const &

REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.

opts Options

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

Returns
Type Description
StatusOr< google::iam::v1::Policy >

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

SetIamPolicyRepo(google::iam::v1::SetIamPolicyRequest const &, Options)

Set IAM policy on a repository.

Parameters
Name Description
request google::iam::v1::SetIamPolicyRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.iam.v1.SetIamPolicyRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

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

Returns
Type Description
StatusOr< google::iam::v1::Policy >

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

TestIamPermissionsRepo(std::string const &, Options)

Test IAM permissions on a repository.

IAM permission checks are not required on this method.

Parameters
Name Description
resource std::string const &

REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.

opts Options

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

Returns
Type Description
StatusOr< google::iam::v1::TestIamPermissionsResponse >

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

TestIamPermissionsRepo(google::iam::v1::TestIamPermissionsRequest const &, Options)

Test IAM permissions on a repository.

IAM permission checks are not required on this method.

Parameters
Name Description
request google::iam::v1::TestIamPermissionsRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.iam.v1.TestIamPermissionsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

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

Returns
Type Description
StatusOr< google::iam::v1::TestIamPermissionsResponse >

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

CreateBranchRule(std::string const &, google::cloud::securesourcemanager::v1::BranchRule const &, std::string const &, Options)

CreateBranchRule creates a branch rule in a given repository.

Parameters
Name Description
parent std::string const &
branch_rule google::cloud::securesourcemanager::v1::BranchRule const &
branch_rule_id std::string const &
opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::securesourcemanager::v1::BranchRule > >

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

CreateBranchRule(NoAwaitTag, std::string const &, google::cloud::securesourcemanager::v1::BranchRule const &, std::string const &, Options)

CreateBranchRule creates a branch rule in a given repository.

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 &
branch_rule google::cloud::securesourcemanager::v1::BranchRule const &
branch_rule_id std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateBranchRule(google::cloud::securesourcemanager::v1::CreateBranchRuleRequest const &, Options)

CreateBranchRule creates a branch rule in a given repository.

Parameters
Name Description
request google::cloud::securesourcemanager::v1::CreateBranchRuleRequest 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.securesourcemanager.v1.CreateBranchRuleRequest. 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::securesourcemanager::v1::BranchRule > >

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

CreateBranchRule(NoAwaitTag, google::cloud::securesourcemanager::v1::CreateBranchRuleRequest const &, Options)

CreateBranchRule creates a branch rule in a given repository.

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

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

CreateBranchRule creates a branch rule in a given repository.

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::securesourcemanager::v1::BranchRule > >

ListBranchRules(std::string const &, Options)

ListBranchRules lists branch rules in a given repository.

Parameters
Name Description
parent std::string const &
opts Options

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

Returns
Type Description
StreamRange< google::cloud::securesourcemanager::v1::BranchRule >

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

ListBranchRules(google::cloud::securesourcemanager::v1::ListBranchRulesRequest, Options)

ListBranchRules lists branch rules in a given repository.

Parameters
Name Description
request google::cloud::securesourcemanager::v1::ListBranchRulesRequest

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.securesourcemanager.v1.ListBranchRulesRequest. 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::securesourcemanager::v1::BranchRule >

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

GetBranchRule(std::string const &, Options)

GetBranchRule gets a branch rule.

Parameters
Name Description
name std::string const &

Required. Name of the repository to retrieve. The format is projects/{project}/locations/{location}/repositories/{repository}/branchRules/{branch_rule}.

opts Options

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

Returns
Type Description
StatusOr< google::cloud::securesourcemanager::v1::BranchRule >

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

GetBranchRule(google::cloud::securesourcemanager::v1::GetBranchRuleRequest const &, Options)

GetBranchRule gets a branch rule.

Parameters
Name Description
request google::cloud::securesourcemanager::v1::GetBranchRuleRequest 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.securesourcemanager.v1.GetBranchRuleRequest. 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::securesourcemanager::v1::BranchRule >

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

UpdateBranchRule(google::cloud::securesourcemanager::v1::BranchRule const &, google::protobuf::FieldMask const &, Options)

UpdateBranchRule updates a branch rule.

Parameters
Name Description
branch_rule google::cloud::securesourcemanager::v1::BranchRule const &
update_mask google::protobuf::FieldMask const &

Required. Field mask is used to specify the fields to be overwritten in the branchRule 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. The special value "*" means full replacement.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::securesourcemanager::v1::BranchRule > >

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

UpdateBranchRule(NoAwaitTag, google::cloud::securesourcemanager::v1::BranchRule const &, google::protobuf::FieldMask const &, Options)

UpdateBranchRule updates a branch rule.

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
branch_rule google::cloud::securesourcemanager::v1::BranchRule const &
update_mask google::protobuf::FieldMask const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

UpdateBranchRule(google::cloud::securesourcemanager::v1::UpdateBranchRuleRequest const &, Options)

UpdateBranchRule updates a branch rule.

Parameters
Name Description
request google::cloud::securesourcemanager::v1::UpdateBranchRuleRequest 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.securesourcemanager.v1.UpdateBranchRuleRequest. 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::securesourcemanager::v1::BranchRule > >

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

UpdateBranchRule(NoAwaitTag, google::cloud::securesourcemanager::v1::UpdateBranchRuleRequest const &, Options)

UpdateBranchRule updates a branch rule.

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

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

UpdateBranchRule updates a branch rule.

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::securesourcemanager::v1::BranchRule > >

DeleteBranchRule(std::string const &, Options)

DeleteBranchRule deletes a branch rule.

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

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

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

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

DeleteBranchRule deletes a branch rule.

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 >

DeleteBranchRule(google::cloud::securesourcemanager::v1::DeleteBranchRuleRequest const &, Options)

DeleteBranchRule deletes a branch rule.

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

DeleteBranchRule(NoAwaitTag, google::cloud::securesourcemanager::v1::DeleteBranchRuleRequest const &, Options)

DeleteBranchRule deletes a branch rule.

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

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

DeleteBranchRule deletes a branch rule.

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

CreatePullRequest(std::string const &, google::cloud::securesourcemanager::v1::PullRequest const &, Options)

Creates a pull request.

Parameters
Name Description
parent std::string const &

Required. The repository that the pull request is created from. Format: projects/{project_number}/locations/{location_id}/repositories/{repository_id}

pull_request google::cloud::securesourcemanager::v1::PullRequest const &

Required. The pull request to create.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::securesourcemanager::v1::PullRequest > >

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

CreatePullRequest(NoAwaitTag, std::string const &, google::cloud::securesourcemanager::v1::PullRequest const &, Options)

Creates a pull request.

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 &
pull_request google::cloud::securesourcemanager::v1::PullRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreatePullRequest(google::cloud::securesourcemanager::v1::CreatePullRequestRequest const &, Options)

Creates a pull request.

Parameters
Name Description
request google::cloud::securesourcemanager::v1::CreatePullRequestRequest 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.securesourcemanager.v1.CreatePullRequestRequest. 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::securesourcemanager::v1::PullRequest > >

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

CreatePullRequest(NoAwaitTag, google::cloud::securesourcemanager::v1::CreatePullRequestRequest const &, Options)

Creates a pull request.

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

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

Creates a pull request.

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::securesourcemanager::v1::PullRequest > >

GetPullRequest(std::string const &, Options)

Gets a pull request.

Parameters
Name Description
name std::string const &

Required. Name of the pull request to retrieve. The format is projects/{project}/locations/{location}/repositories/{repository}/pullRequests/{pull_request}.

opts Options

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

Returns
Type Description
StatusOr< google::cloud::securesourcemanager::v1::PullRequest >

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

GetPullRequest(google::cloud::securesourcemanager::v1::GetPullRequestRequest const &, Options)

Gets a pull request.

Parameters
Name Description
request google::cloud::securesourcemanager::v1::GetPullRequestRequest 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.securesourcemanager.v1.GetPullRequestRequest. 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::securesourcemanager::v1::PullRequest >

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

ListPullRequests(std::string const &, Options)

Lists pull requests in a repository.

Parameters
Name Description
parent std::string const &

Required. The repository in which to list pull requests. Format: projects/{project_number}/locations/{location_id}/repositories/{repository_id}

opts Options

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

Returns
Type Description
StreamRange< google::cloud::securesourcemanager::v1::PullRequest >

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

ListPullRequests(google::cloud::securesourcemanager::v1::ListPullRequestsRequest, Options)

Lists pull requests in a repository.

Parameters
Name Description
request google::cloud::securesourcemanager::v1::ListPullRequestsRequest

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.securesourcemanager.v1.ListPullRequestsRequest. 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::securesourcemanager::v1::PullRequest >

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

UpdatePullRequest(google::cloud::securesourcemanager::v1::PullRequest const &, google::protobuf::FieldMask const &, Options)

Updates a pull request.

Parameters
Name Description
pull_request google::cloud::securesourcemanager::v1::PullRequest const &

Required. The pull request to update.

update_mask google::protobuf::FieldMask const &

Optional. Field mask is used to specify the fields to be overwritten in the pull request 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. The special value "*" means full replacement.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::securesourcemanager::v1::PullRequest > >

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

UpdatePullRequest(NoAwaitTag, google::cloud::securesourcemanager::v1::PullRequest const &, google::protobuf::FieldMask const &, Options)

Updates a pull request.

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
pull_request google::cloud::securesourcemanager::v1::PullRequest const &
update_mask google::protobuf::FieldMask const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

UpdatePullRequest(google::cloud::securesourcemanager::v1::UpdatePullRequestRequest const &, Options)

Updates a pull request.

Parameters
Name Description
request google::cloud::securesourcemanager::v1::UpdatePullRequestRequest 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.securesourcemanager.v1.UpdatePullRequestRequest. 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::securesourcemanager::v1::PullRequest > >

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

UpdatePullRequest(NoAwaitTag, google::cloud::securesourcemanager::v1::UpdatePullRequestRequest const &, Options)

Updates a pull request.

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

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

Updates a pull request.

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::securesourcemanager::v1::PullRequest > >

MergePullRequest(std::string const &, Options)

Merges a pull request.

Parameters
Name Description
name std::string const &

Required. The pull request to merge. Format: projects/{project_number}/locations/{location_id}/repositories/{repository_id}/pullRequests/{pull_request_id}

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::securesourcemanager::v1::PullRequest > >

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

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

Merges a pull request.

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 >

MergePullRequest(google::cloud::securesourcemanager::v1::MergePullRequestRequest const &, Options)

Merges a pull request.

Parameters
Name Description
request google::cloud::securesourcemanager::v1::MergePullRequestRequest 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.securesourcemanager.v1.MergePullRequestRequest. 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::securesourcemanager::v1::PullRequest > >

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

MergePullRequest(NoAwaitTag, google::cloud::securesourcemanager::v1::MergePullRequestRequest const &, Options)

Merges a pull request.

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

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

Merges a pull request.

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::securesourcemanager::v1::PullRequest > >

OpenPullRequest(std::string const &, Options)

Opens a pull request.

Parameters
Name Description
name std::string const &

Required. The pull request to open. Format: projects/{project_number}/locations/{location_id}/repositories/{repository_id}/pullRequests/{pull_request_id}

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::securesourcemanager::v1::PullRequest > >

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

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

Opens a pull request.

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 >

OpenPullRequest(google::cloud::securesourcemanager::v1::OpenPullRequestRequest const &, Options)

Opens a pull request.

Parameters
Name Description
request google::cloud::securesourcemanager::v1::OpenPullRequestRequest 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.securesourcemanager.v1.OpenPullRequestRequest. 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::securesourcemanager::v1::PullRequest > >

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

OpenPullRequest(NoAwaitTag, google::cloud::securesourcemanager::v1::OpenPullRequestRequest const &, Options)

Opens a pull request.

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

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

Opens a pull request.

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::securesourcemanager::v1::PullRequest > >

ClosePullRequest(std::string const &, Options)

Closes a pull request without merging.

Parameters
Name Description
name std::string const &

Required. The pull request to close. Format: projects/{project_number}/locations/{location_id}/repositories/{repository_id}/pullRequests/{pull_request_id}

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::securesourcemanager::v1::PullRequest > >

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

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

Closes a pull request without merging.

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 >

ClosePullRequest(google::cloud::securesourcemanager::v1::ClosePullRequestRequest const &, Options)

Closes a pull request without merging.

Parameters
Name Description
request google::cloud::securesourcemanager::v1::ClosePullRequestRequest 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.securesourcemanager.v1.ClosePullRequestRequest. 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::securesourcemanager::v1::PullRequest > >

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

ClosePullRequest(NoAwaitTag, google::cloud::securesourcemanager::v1::ClosePullRequestRequest const &, Options)

Closes a pull request without merging.

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

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

Closes a pull request without merging.

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::securesourcemanager::v1::PullRequest > >

ListPullRequestFileDiffs(std::string const &, Options)

Lists a pull request's file diffs.

Parameters
Name Description
name std::string const &

Required. The pull request to list file diffs for. Format: projects/{project_number}/locations/{location_id}/repositories/{repository_id}/pullRequests/{pull_request_id}

opts Options

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

Returns
Type Description
StreamRange< google::cloud::securesourcemanager::v1::FileDiff >

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

ListPullRequestFileDiffs(google::cloud::securesourcemanager::v1::ListPullRequestFileDiffsRequest, Options)

Lists a pull request's file diffs.

Parameters
Name Description
request google::cloud::securesourcemanager::v1::ListPullRequestFileDiffsRequest

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.securesourcemanager.v1.ListPullRequestFileDiffsRequest. 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::securesourcemanager::v1::FileDiff >

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

FetchTree(google::cloud::securesourcemanager::v1::FetchTreeRequest, Options)

Fetches a tree from a repository.

Parameters
Name Description
request google::cloud::securesourcemanager::v1::FetchTreeRequest

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.securesourcemanager.v1.FetchTreeRequest. 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::securesourcemanager::v1::TreeEntry >

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

FetchBlob(google::cloud::securesourcemanager::v1::FetchBlobRequest const &, Options)

Fetches a blob from a repository.

Parameters
Name Description
request google::cloud::securesourcemanager::v1::FetchBlobRequest 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.securesourcemanager.v1.FetchBlobRequest. 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::securesourcemanager::v1::FetchBlobResponse >

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

CreateIssue(std::string const &, google::cloud::securesourcemanager::v1::Issue const &, Options)

Creates an issue.

Parameters
Name Description
parent std::string const &

Required. The repository in which to create the issue. Format: projects/{project_number}/locations/{location_id}/repositories/{repository_id}

issue google::cloud::securesourcemanager::v1::Issue const &

Required. The issue to create.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::securesourcemanager::v1::Issue > >

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

CreateIssue(NoAwaitTag, std::string const &, google::cloud::securesourcemanager::v1::Issue const &, Options)

Creates an issue.

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 &
issue google::cloud::securesourcemanager::v1::Issue const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateIssue(google::cloud::securesourcemanager::v1::CreateIssueRequest const &, Options)

Creates an issue.

Parameters
Name Description
request google::cloud::securesourcemanager::v1::CreateIssueRequest 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.securesourcemanager.v1.CreateIssueRequest. 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::securesourcemanager::v1::Issue > >

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

CreateIssue(NoAwaitTag, google::cloud::securesourcemanager::v1::CreateIssueRequest const &, Options)

Creates an issue.

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

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

Creates an issue.

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::securesourcemanager::v1::Issue > >

GetIssue(std::string const &, Options)

Gets an issue.

Parameters
Name Description
name std::string const &

Required. Name of the issue to retrieve. The format is projects/{project}/locations/{location}/repositories/{repository}/issues/{issue_id}.

opts Options

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

Returns
Type Description
StatusOr< google::cloud::securesourcemanager::v1::Issue >

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

GetIssue(google::cloud::securesourcemanager::v1::GetIssueRequest const &, Options)

Gets an issue.

Parameters
Name Description
request google::cloud::securesourcemanager::v1::GetIssueRequest 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.securesourcemanager.v1.GetIssueRequest. 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::securesourcemanager::v1::Issue >

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

ListIssues(std::string const &, Options)

Lists issues in a repository.

Parameters
Name Description
parent std::string const &

Required. The repository in which to list issues. Format: projects/{project_number}/locations/{location_id}/repositories/{repository_id}

opts Options

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

Returns
Type Description
StreamRange< google::cloud::securesourcemanager::v1::Issue >

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

ListIssues(google::cloud::securesourcemanager::v1::ListIssuesRequest, Options)

Lists issues in a repository.

Parameters
Name Description
request google::cloud::securesourcemanager::v1::ListIssuesRequest

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.securesourcemanager.v1.ListIssuesRequest. 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::securesourcemanager::v1::Issue >

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

UpdateIssue(google::cloud::securesourcemanager::v1::Issue const &, google::protobuf::FieldMask const &, Options)

Updates a issue.

Parameters
Name Description
issue google::cloud::securesourcemanager::v1::Issue const &

Required. The issue to update.

update_mask google::protobuf::FieldMask const &

Optional. Field mask is used to specify the fields to be overwritten in the issue 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. The special value "*" means full replacement.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::securesourcemanager::v1::Issue > >

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

UpdateIssue(NoAwaitTag, google::cloud::securesourcemanager::v1::Issue const &, google::protobuf::FieldMask const &, Options)

Updates a issue.

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
issue google::cloud::securesourcemanager::v1::Issue const &
update_mask google::protobuf::FieldMask const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

UpdateIssue(google::cloud::securesourcemanager::v1::UpdateIssueRequest const &, Options)

Updates a issue.

Parameters
Name Description
request google::cloud::securesourcemanager::v1::UpdateIssueRequest 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.securesourcemanager.v1.UpdateIssueRequest. 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::securesourcemanager::v1::Issue > >

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

UpdateIssue(NoAwaitTag, google::cloud::securesourcemanager::v1::UpdateIssueRequest const &, Options)

Updates a issue.

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

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

Updates a issue.

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::securesourcemanager::v1::Issue > >

DeleteIssue(std::string const &, Options)

Deletes an issue.

Parameters
Name Description
name std::string const &

Required. Name of the issue to delete. The format is projects/{project_number}/locations/{location_id}/repositories/{repository_id}/issues/{issue_id}.

opts Options

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

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

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

Deletes an issue.

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 >

DeleteIssue(google::cloud::securesourcemanager::v1::DeleteIssueRequest const &, Options)

Deletes an issue.

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

DeleteIssue(NoAwaitTag, google::cloud::securesourcemanager::v1::DeleteIssueRequest const &, Options)

Deletes an issue.

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

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

Deletes an issue.

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

OpenIssue(std::string const &, Options)

Opens an issue.

Parameters
Name Description
name std::string const &

Required. Name of the issue to open. The format is projects/{project_number}/locations/{location_id}/repositories/{repository_id}/issues/{issue_id}.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::securesourcemanager::v1::Issue > >

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

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

Opens an issue.

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 >

OpenIssue(google::cloud::securesourcemanager::v1::OpenIssueRequest const &, Options)

Opens an issue.

Parameters
Name Description
request google::cloud::securesourcemanager::v1::OpenIssueRequest 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.securesourcemanager.v1.OpenIssueRequest. 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::securesourcemanager::v1::Issue > >

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

OpenIssue(NoAwaitTag, google::cloud::securesourcemanager::v1::OpenIssueRequest const &, Options)

Opens an issue.

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

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

Opens an issue.

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::securesourcemanager::v1::Issue > >

CloseIssue(std::string const &, Options)

Closes an issue.

Parameters
Name Description
name std::string const &

Required. Name of the issue to close. The format is projects/{project_number}/locations/{location_id}/repositories/{repository_id}/issues/{issue_id}.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::securesourcemanager::v1::Issue > >

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

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

Closes an issue.

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 >

CloseIssue(google::cloud::securesourcemanager::v1::CloseIssueRequest const &, Options)

Closes an issue.

Parameters
Name Description
request google::cloud::securesourcemanager::v1::CloseIssueRequest 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.securesourcemanager.v1.CloseIssueRequest. 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::securesourcemanager::v1::Issue > >

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

CloseIssue(NoAwaitTag, google::cloud::securesourcemanager::v1::CloseIssueRequest const &, Options)

Closes an issue.

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

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

Closes an issue.

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::securesourcemanager::v1::Issue > >

GetPullRequestComment(std::string const &, Options)

Gets a pull request comment.

Parameters
Name Description
name std::string const &

Required. Name of the pull request comment to retrieve. The format is projects/{project_number}/locations/{location_id}/repositories/{repository_id}/pullRequests/{pull_request_id}/pullRequestComments/{comment_id}.

opts Options

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

Returns
Type Description
StatusOr< google::cloud::securesourcemanager::v1::PullRequestComment >

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

GetPullRequestComment(google::cloud::securesourcemanager::v1::GetPullRequestCommentRequest const &, Options)

Gets a pull request comment.

Parameters
Name Description
request google::cloud::securesourcemanager::v1::GetPullRequestCommentRequest 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.securesourcemanager.v1.GetPullRequestCommentRequest. 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::securesourcemanager::v1::PullRequestComment >

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

ListPullRequestComments(std::string const &, Options)

Lists pull request comments.

Parameters
Name Description
parent std::string const &

Required. The pull request in which to list pull request comments. Format: projects/{project_number}/locations/{location_id}/repositories/{repository_id}/pullRequests/{pull_request_id}

opts Options

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

Returns
Type Description
StreamRange< google::cloud::securesourcemanager::v1::PullRequestComment >

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

ListPullRequestComments(google::cloud::securesourcemanager::v1::ListPullRequestCommentsRequest, Options)

Lists pull request comments.

Parameters
Name Description
request google::cloud::securesourcemanager::v1::ListPullRequestCommentsRequest

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.securesourcemanager.v1.ListPullRequestCommentsRequest. 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::securesourcemanager::v1::PullRequestComment >

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

CreatePullRequestComment(std::string const &, google::cloud::securesourcemanager::v1::PullRequestComment const &, Options)

Creates a pull request comment.

This function is used to create a single PullRequestComment of type Comment, or a single PullRequestComment of type Code that's replying to another PullRequestComment of type Code. Use BatchCreatePullRequestComments to create multiple PullRequestComments for code reviews.

Parameters
Name Description
parent std::string const &

Required. The pull request in which to create the pull request comment. Format: projects/{project_number}/locations/{location_id}/repositories/{repository_id}/pullRequests/{pull_request_id}

pull_request_comment google::cloud::securesourcemanager::v1::PullRequestComment const &

Required. The pull request comment to create.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::securesourcemanager::v1::PullRequestComment > >

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

CreatePullRequestComment(NoAwaitTag, std::string const &, google::cloud::securesourcemanager::v1::PullRequestComment const &, Options)

Creates a pull request comment.

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 &
pull_request_comment google::cloud::securesourcemanager::v1::PullRequestComment const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreatePullRequestComment(google::cloud::securesourcemanager::v1::CreatePullRequestCommentRequest const &, Options)

Creates a pull request comment.

This function is used to create a single PullRequestComment of type Comment, or a single PullRequestComment of type Code that's replying to another PullRequestComment of type Code. Use BatchCreatePullRequestComments to create multiple PullRequestComments for code reviews.

Parameters
Name Description
request google::cloud::securesourcemanager::v1::CreatePullRequestCommentRequest 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.securesourcemanager.v1.CreatePullRequestCommentRequest. 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::securesourcemanager::v1::PullRequestComment > >

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

CreatePullRequestComment(NoAwaitTag, google::cloud::securesourcemanager::v1::CreatePullRequestCommentRequest const &, Options)

Creates a pull request comment.

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

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

Creates a pull request comment.

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::securesourcemanager::v1::PullRequestComment > >

UpdatePullRequestComment(google::cloud::securesourcemanager::v1::PullRequestComment const &, google::protobuf::FieldMask const &, Options)

Updates a pull request comment.

Parameters
Name Description
pull_request_comment google::cloud::securesourcemanager::v1::PullRequestComment const &

Required. The pull request comment to update.

update_mask google::protobuf::FieldMask const &

Optional. Field mask is used to specify the fields to be overwritten in the pull request comment resource by the update. Updatable fields are body.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::securesourcemanager::v1::PullRequestComment > >

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

UpdatePullRequestComment(NoAwaitTag, google::cloud::securesourcemanager::v1::PullRequestComment const &, google::protobuf::FieldMask const &, Options)

Updates a pull request comment.

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
pull_request_comment google::cloud::securesourcemanager::v1::PullRequestComment const &
update_mask google::protobuf::FieldMask const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

UpdatePullRequestComment(google::cloud::securesourcemanager::v1::UpdatePullRequestCommentRequest const &, Options)

Updates a pull request comment.

Parameters
Name Description
request google::cloud::securesourcemanager::v1::UpdatePullRequestCommentRequest 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.securesourcemanager.v1.UpdatePullRequestCommentRequest. 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::securesourcemanager::v1::PullRequestComment > >

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

UpdatePullRequestComment(NoAwaitTag, google::cloud::securesourcemanager::v1::UpdatePullRequestCommentRequest const &, Options)

Updates a pull request comment.

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

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

Updates a pull request comment.

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::securesourcemanager::v1::PullRequestComment > >

DeletePullRequestComment(std::string const &, Options)

Deletes a pull request comment.

Parameters
Name Description
name std::string const &

Required. Name of the pull request comment to delete. The format is projects/{project_number}/locations/{location_id}/repositories/{repository_id}/pullRequests/{pull_request_id}/pullRequestComments/{comment_id}.

opts Options

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

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

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

Deletes a pull request comment.

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 >

DeletePullRequestComment(google::cloud::securesourcemanager::v1::DeletePullRequestCommentRequest const &, Options)

Deletes a pull request comment.

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

DeletePullRequestComment(NoAwaitTag, google::cloud::securesourcemanager::v1::DeletePullRequestCommentRequest const &, Options)

Deletes a pull request comment.

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

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

Deletes a pull request comment.

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

BatchCreatePullRequestComments(std::string const &, std::vector< google::cloud::securesourcemanager::v1::CreatePullRequestCommentRequest > const &, Options)

Batch creates pull request comments.

This function is used to create multiple PullRequestComments for code review. There needs to be exactly one PullRequestComment of type Review, and at most 100 PullRequestComments of type Code per request. The Postition of the code comments must be unique within the request.

Parameters
Name Description
parent std::string const &

Required. The pull request in which to create the pull request comments. Format: projects/{project_number}/locations/{location_id}/repositories/{repository_id}/pullRequests/{pull_request_id}

requests std::vector< google::cloud::securesourcemanager::v1::CreatePullRequestCommentRequest > const &

Required. The request message specifying the resources to create. There should be exactly one CreatePullRequestCommentRequest with CommentDetail being REVIEW in the list, and no more than 100 CreatePullRequestCommentRequests with CommentDetail being CODE in the list

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::securesourcemanager::v1::BatchCreatePullRequestCommentsResponse > >

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

BatchCreatePullRequestComments(NoAwaitTag, std::string const &, std::vector< google::cloud::securesourcemanager::v1::CreatePullRequestCommentRequest > const &, Options)

Batch creates pull request comments.

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 &
requests std::vector< google::cloud::securesourcemanager::v1::CreatePullRequestCommentRequest > const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

BatchCreatePullRequestComments(google::cloud::securesourcemanager::v1::BatchCreatePullRequestCommentsRequest const &, Options)

Batch creates pull request comments.

This function is used to create multiple PullRequestComments for code review. There needs to be exactly one PullRequestComment of type Review, and at most 100 PullRequestComments of type Code per request. The Postition of the code comments must be unique within the request.

Parameters
Name Description
request google::cloud::securesourcemanager::v1::BatchCreatePullRequestCommentsRequest 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.securesourcemanager.v1.BatchCreatePullRequestCommentsRequest. 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::securesourcemanager::v1::BatchCreatePullRequestCommentsResponse > >

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

BatchCreatePullRequestComments(NoAwaitTag, google::cloud::securesourcemanager::v1::BatchCreatePullRequestCommentsRequest const &, Options)

Batch creates pull request comments.

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

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

Batch creates pull request comments.

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::securesourcemanager::v1::BatchCreatePullRequestCommentsResponse > >

ResolvePullRequestComments(std::string const &, std::vector< std::string > const &, Options)

Resolves pull request comments.

A list of PullRequestComment names must be provided. The PullRequestComment names must be in the same conversation thread. If auto_fill is set, all comments in the conversation thread will be resolved.

Parameters
Name Description
parent std::string const &

Required. The pull request in which to resolve the pull request comments. Format: projects/{project_number}/locations/{location_id}/repositories/{repository_id}/pullRequests/{pull_request_id}

names std::vector< std::string > const &

Required. The names of the pull request comments to resolve. Format: projects/{project_number}/locations/{location_id}/repositories/{repository_id}/pullRequests/{pull_request_id}/pullRequestComments/{comment_id} Only comments from the same threads are allowed in the same request.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::securesourcemanager::v1::ResolvePullRequestCommentsResponse > >

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

ResolvePullRequestComments(NoAwaitTag, std::string const &, std::vector< std::string > const &, Options)

Resolves pull request comments.

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 &
names std::vector< std::string > const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

ResolvePullRequestComments(google::cloud::securesourcemanager::v1::ResolvePullRequestCommentsRequest const &, Options)

Resolves pull request comments.

A list of PullRequestComment names must be provided. The PullRequestComment names must be in the same conversation thread. If auto_fill is set, all comments in the conversation thread will be resolved.

Parameters
Name Description
request google::cloud::securesourcemanager::v1::ResolvePullRequestCommentsRequest 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.securesourcemanager.v1.ResolvePullRequestCommentsRequest. 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::securesourcemanager::v1::ResolvePullRequestCommentsResponse > >

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

ResolvePullRequestComments(NoAwaitTag, google::cloud::securesourcemanager::v1::ResolvePullRequestCommentsRequest const &, Options)

Resolves pull request comments.

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

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

Resolves pull request comments.

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::securesourcemanager::v1::ResolvePullRequestCommentsResponse > >

UnresolvePullRequestComments(std::string const &, std::vector< std::string > const &, Options)

Unresolves pull request comments.

A list of PullRequestComment names must be provided. The PullRequestComment names must be in the same conversation thread. If auto_fill is set, all comments in the conversation thread will be unresolved.

Parameters
Name Description
parent std::string const &

Required. The pull request in which to resolve the pull request comments. Format: projects/{project_number}/locations/{location_id}/repositories/{repository_id}/pullRequests/{pull_request_id}

names std::vector< std::string > const &

Required. The names of the pull request comments to unresolve. Format: projects/{project_number}/locations/{location_id}/repositories/{repository_id}/pullRequests/{pull_request_id}/pullRequestComments/{comment_id} Only comments from the same threads are allowed in the same request.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::securesourcemanager::v1::UnresolvePullRequestCommentsResponse > >

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

UnresolvePullRequestComments(NoAwaitTag, std::string const &, std::vector< std::string > const &, Options)

Unresolves pull request comments.

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 &
names std::vector< std::string > const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

UnresolvePullRequestComments(google::cloud::securesourcemanager::v1::UnresolvePullRequestCommentsRequest const &, Options)

Unresolves pull request comments.

A list of PullRequestComment names must be provided. The PullRequestComment names must be in the same conversation thread. If auto_fill is set, all comments in the conversation thread will be unresolved.

Parameters
Name Description
request google::cloud::securesourcemanager::v1::UnresolvePullRequestCommentsRequest 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.securesourcemanager.v1.UnresolvePullRequestCommentsRequest. 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::securesourcemanager::v1::UnresolvePullRequestCommentsResponse > >

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

UnresolvePullRequestComments(NoAwaitTag, google::cloud::securesourcemanager::v1::UnresolvePullRequestCommentsRequest const &, Options)

Unresolves pull request comments.

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

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

Unresolves pull request comments.

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::securesourcemanager::v1::UnresolvePullRequestCommentsResponse > >

CreateIssueComment(std::string const &, google::cloud::securesourcemanager::v1::IssueComment const &, Options)

Creates an issue comment.

Parameters
Name Description
parent std::string const &

Required. The issue in which to create the issue comment. Format: projects/{project_number}/locations/{location_id}/repositories/{repository_id}/issues/{issue_id}

issue_comment google::cloud::securesourcemanager::v1::IssueComment const &

Required. The issue comment to create.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::securesourcemanager::v1::IssueComment > >

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

CreateIssueComment(NoAwaitTag, std::string const &, google::cloud::securesourcemanager::v1::IssueComment const &, Options)

Creates an issue comment.

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 &
issue_comment google::cloud::securesourcemanager::v1::IssueComment const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateIssueComment(google::cloud::securesourcemanager::v1::CreateIssueCommentRequest const &, Options)

Creates an issue comment.

Parameters
Name Description
request google::cloud::securesourcemanager::v1::CreateIssueCommentRequest 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.securesourcemanager.v1.CreateIssueCommentRequest. 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::securesourcemanager::v1::IssueComment > >

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

CreateIssueComment(NoAwaitTag, google::cloud::securesourcemanager::v1::CreateIssueCommentRequest const &, Options)

Creates an issue comment.

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

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

Creates an issue comment.

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::securesourcemanager::v1::IssueComment > >

GetIssueComment(std::string const &, Options)

Gets an issue comment.

Parameters
Name Description
name std::string const &

Required. Name of the issue comment to retrieve. The format is projects/{project}/locations/{location}/repositories/{repository}/issues/{issue_id}/issueComments/{comment_id}.

opts Options

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

Returns
Type Description
StatusOr< google::cloud::securesourcemanager::v1::IssueComment >

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

GetIssueComment(google::cloud::securesourcemanager::v1::GetIssueCommentRequest const &, Options)

Gets an issue comment.

Parameters
Name Description
request google::cloud::securesourcemanager::v1::GetIssueCommentRequest 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.securesourcemanager.v1.GetIssueCommentRequest. 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::securesourcemanager::v1::IssueComment >

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

ListIssueComments(std::string const &, Options)

Lists comments in an issue.

Parameters
Name Description
parent std::string const &

Required. The issue in which to list the comments. Format: projects/{project_number}/locations/{location_id}/repositories/{repository_id}/issues/{issue_id}

opts Options

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

Returns
Type Description
StreamRange< google::cloud::securesourcemanager::v1::IssueComment >

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

ListIssueComments(google::cloud::securesourcemanager::v1::ListIssueCommentsRequest, Options)

Lists comments in an issue.

Parameters
Name Description
request google::cloud::securesourcemanager::v1::ListIssueCommentsRequest

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.securesourcemanager.v1.ListIssueCommentsRequest. 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::securesourcemanager::v1::IssueComment >

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

UpdateIssueComment(google::cloud::securesourcemanager::v1::IssueComment const &, google::protobuf::FieldMask const &, Options)

Updates an issue comment.

Parameters
Name Description
issue_comment google::cloud::securesourcemanager::v1::IssueComment const &

Required. The issue comment to update.

update_mask google::protobuf::FieldMask const &

Optional. Field mask is used to specify the fields to be overwritten in the issue comment 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. The special value "*" means full replacement.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::securesourcemanager::v1::IssueComment > >

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

UpdateIssueComment(NoAwaitTag, google::cloud::securesourcemanager::v1::IssueComment const &, google::protobuf::FieldMask const &, Options)

Updates an issue comment.

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
issue_comment google::cloud::securesourcemanager::v1::IssueComment const &
update_mask google::protobuf::FieldMask const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

UpdateIssueComment(google::cloud::securesourcemanager::v1::UpdateIssueCommentRequest const &, Options)

Updates an issue comment.

Parameters
Name Description
request google::cloud::securesourcemanager::v1::UpdateIssueCommentRequest 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.securesourcemanager.v1.UpdateIssueCommentRequest. 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::securesourcemanager::v1::IssueComment > >

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

UpdateIssueComment(NoAwaitTag, google::cloud::securesourcemanager::v1::UpdateIssueCommentRequest const &, Options)

Updates an issue comment.

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

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

Updates an issue comment.

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::securesourcemanager::v1::IssueComment > >

DeleteIssueComment(std::string const &, Options)

Deletes an issue comment.

Parameters
Name Description
name std::string const &

Required. Name of the issue comment to delete. The format is projects/{project_number}/locations/{location_id}/repositories/{repository_id}/issues/{issue_id}/issueComments/{comment_id}.

opts Options

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

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

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

Deletes an issue comment.

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 >

DeleteIssueComment(google::cloud::securesourcemanager::v1::DeleteIssueCommentRequest const &, Options)

Deletes an issue comment.

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

DeleteIssueComment(NoAwaitTag, google::cloud::securesourcemanager::v1::DeleteIssueCommentRequest const &, Options)

Deletes an issue comment.

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

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

Deletes an issue comment.

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

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.

SetIamPolicy(google::iam::v1::SetIamPolicyRequest const &, Options)

Sets the access control policy on the specified resource.

Replaces any existing policy.

Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

Parameters
Name Description
request google::iam::v1::SetIamPolicyRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.iam.v1.SetIamPolicyRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

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

Returns
Type Description
StatusOr< google::iam::v1::Policy >

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

GetIamPolicy(google::iam::v1::GetIamPolicyRequest const &, Options)

Gets the access control policy for a resource.

Returns an empty policy if the resource exists and does not have a policy set.

Parameters
Name Description
request google::iam::v1::GetIamPolicyRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.iam.v1.GetIamPolicyRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

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

Returns
Type Description
StatusOr< google::iam::v1::Policy >

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

TestIamPermissions(google::iam::v1::TestIamPermissionsRequest const &, Options)

Returns permissions that a caller has on the specified resource.

If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.

Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

Parameters
Name Description
request google::iam::v1::TestIamPermissionsRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.iam.v1.TestIamPermissionsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

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

Returns
Type Description
StatusOr< google::iam::v1::TestIamPermissionsResponse >

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

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.