Secure Source Manager API.
Access Secure Source Manager instances, resources, and repositories.
This API is split across two servers: the Control Plane and the Data Plane.
Data Plane endpoints are hosted directly by your Secure Source Manager instance, so you must connect to your instance's API hostname to access them. The API hostname looks like the following:
https://[instance-id]-[project-number]-api.[location].sourcemanager.dev
For example,
https://my-instance-702770452863-api.us-central1.sourcemanager.dev
Data Plane endpoints are denoted with Host: Data Plane.
All other endpoints are found in the normal Cloud API location, namely, securcesourcemanager.googleapis.com
.
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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.
Host: Data Plane
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 |
ListRepositories(google::cloud::securesourcemanager::v1::ListRepositoriesRequest, Options)
Lists Repositories in a given project and location.
Host: Data Plane
Parameters | |
---|---|
Name | Description |
request |
google::cloud::securesourcemanager::v1::ListRepositoriesRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
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 |
GetRepository(std::string const &, Options)
Gets metadata of a repository.
Host: Data Plane
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. Name of the repository to retrieve. The format is |
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 |
GetRepository(google::cloud::securesourcemanager::v1::GetRepositoryRequest const &, Options)
Gets metadata of a repository.
Host: Data Plane
Parameters | |
---|---|
Name | Description |
request |
google::cloud::securesourcemanager::v1::GetRepositoryRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
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 |
CreateRepository(std::string const &, google::cloud::securesourcemanager::v1::Repository const &, std::string const &, Options)
Creates a new repository in a given project and location.
Host: Data Plane
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The project in which to create the repository. Values are of the form |
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 |
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.
Host: Data Plane
Parameters | |
---|---|
Name | Description |
request |
google::cloud::securesourcemanager::v1::CreateRepositoryRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
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 |
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 > > |
DeleteRepository(std::string const &, Options)
Deletes a Repository.
Host: Data Plane
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 |
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.
Host: Data Plane
Parameters | |
---|---|
Name | Description |
request |
google::cloud::securesourcemanager::v1::DeleteRepositoryRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
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 |
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 > > |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 > > |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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
.
NOTE: the name
binding allows API services to override the binding to use different resource name schemes, such as users/*/operations
. To override the binding, API services can add a binding such as "/v1/{name=users/*}/operations"
to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.
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 |
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
.
NOTE: the name
binding allows API services to override the binding to use different resource name schemes, such as users/*/operations
. To override the binding, API services can add a binding such as "/v1/{name=users/*}/operations"
to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.
Parameters | |
---|---|
Name | Description |
request |
google::longrunning::ListOperationsRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
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 |
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 |
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 |
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 |
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 |
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 |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
Status |
a |
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 |
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 |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
Status |
a |