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(ExperimentalTag, 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 |
|
ExperimentalTag
|
|
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(ExperimentalTag, 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 |
|
ExperimentalTag
|
|
NoAwaitTag
|
request |
google::cloud::securesourcemanager::v1::CreateInstanceRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
CreateInstance(ExperimentalTag, 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 |
|
ExperimentalTag
|
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(ExperimentalTag, 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 |
|
ExperimentalTag
|
|
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(ExperimentalTag, 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 |
|
ExperimentalTag
|
|
NoAwaitTag
|
request |
google::cloud::securesourcemanager::v1::DeleteInstanceRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
DeleteInstance(ExperimentalTag, 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 |
|
ExperimentalTag
|
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(ExperimentalTag, 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 |
|
ExperimentalTag
|
|
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(ExperimentalTag, 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 |
|
ExperimentalTag
|
|
NoAwaitTag
|
request |
google::cloud::securesourcemanager::v1::CreateRepositoryRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
CreateRepository(ExperimentalTag, 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 |
|
ExperimentalTag
|
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(ExperimentalTag, 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 |
|
ExperimentalTag
|
|
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(ExperimentalTag, 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 |
|
ExperimentalTag
|
|
NoAwaitTag
|
request |
google::cloud::securesourcemanager::v1::DeleteRepositoryRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
DeleteRepository(ExperimentalTag, 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 |
|
ExperimentalTag
|
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 |