API v2 service for Workbench Notebooks Instances.
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
NotebookServiceClient(NotebookServiceClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
NotebookServiceClient const &
|
NotebookServiceClient(NotebookServiceClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
NotebookServiceClient &&
|
NotebookServiceClient(std::shared_ptr< NotebookServiceConnection >, Options)
Parameters | |
---|---|
Name | Description |
connection |
std::shared_ptr< NotebookServiceConnection >
|
opts |
Options
|
Operators
operator=(NotebookServiceClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
NotebookServiceClient const &
|
Returns | |
---|---|
Type | Description |
NotebookServiceClient & |
operator=(NotebookServiceClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
NotebookServiceClient &&
|
Returns | |
---|---|
Type | Description |
NotebookServiceClient & |
Functions
ListInstances(std::string const &, Options)
Lists instances in a given project and location.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::notebooks::v2::Instance > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListInstances(google::cloud::notebooks::v2::ListInstancesRequest, Options)
Lists instances in a given project and location.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::notebooks::v2::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::notebooks::v2::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. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::notebooks::v2::Instance > |
the result of the RPC. The response message type (google.cloud.notebooks.v2.Instance) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetInstance(google::cloud::notebooks::v2::GetInstanceRequest const &, Options)
Gets details of a single Instance.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::notebooks::v2::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::notebooks::v2::Instance > |
the result of the RPC. The response message type (google.cloud.notebooks.v2.Instance) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
CreateInstance(std::string const &, google::cloud::notebooks::v2::Instance const &, std::string const &, Options)
Creates a new Instance in a given project and location.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. Format: |
instance |
google::cloud::notebooks::v2::Instance const &
Required. The instance to be created. |
instance_id |
std::string const &
Required. User-defined unique ID of this instance. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::notebooks::v2::Instance > > |
A |
CreateInstance(NoAwaitTag, std::string const &, google::cloud::notebooks::v2::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::notebooks::v2::Instance const &
|
instance_id |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
CreateInstance(google::cloud::notebooks::v2::CreateInstanceRequest const &, Options)
Creates a new Instance in a given project and location.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::notebooks::v2::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::notebooks::v2::Instance > > |
A |
CreateInstance(NoAwaitTag, google::cloud::notebooks::v2::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::notebooks::v2::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::notebooks::v2::Instance > > |
UpdateInstance(google::cloud::notebooks::v2::Instance const &, google::protobuf::FieldMask const &, Options)
UpdateInstance updates an Instance.
Parameters | |
---|---|
Name | Description |
instance |
google::cloud::notebooks::v2::Instance const &
Required. A representation of an instance. |
update_mask |
google::protobuf::FieldMask const &
Required. Mask used to update an instance |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::notebooks::v2::Instance > > |
A |
UpdateInstance(NoAwaitTag, google::cloud::notebooks::v2::Instance const &, google::protobuf::FieldMask const &, Options)
UpdateInstance updates an 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
|
instance |
google::cloud::notebooks::v2::Instance const &
|
update_mask |
google::protobuf::FieldMask const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
UpdateInstance(google::cloud::notebooks::v2::UpdateInstanceRequest const &, Options)
UpdateInstance updates an Instance.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::notebooks::v2::UpdateInstanceRequest 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::notebooks::v2::Instance > > |
A |
UpdateInstance(NoAwaitTag, google::cloud::notebooks::v2::UpdateInstanceRequest const &, Options)
UpdateInstance updates an 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::notebooks::v2::UpdateInstanceRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
UpdateInstance(google::longrunning::Operation const &, Options)
UpdateInstance updates an 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::notebooks::v2::Instance > > |
DeleteInstance(std::string const &, Options)
Deletes a single Instance.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::notebooks::v2::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::notebooks::v2::DeleteInstanceRequest const &, Options)
Deletes a single Instance.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::notebooks::v2::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::notebooks::v2::OperationMetadata > > |
A |
DeleteInstance(NoAwaitTag, google::cloud::notebooks::v2::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::notebooks::v2::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::notebooks::v2::OperationMetadata > > |
StartInstance(google::cloud::notebooks::v2::StartInstanceRequest const &, Options)
Starts a notebook instance.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::notebooks::v2::StartInstanceRequest 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::notebooks::v2::Instance > > |
A |
StartInstance(NoAwaitTag, google::cloud::notebooks::v2::StartInstanceRequest const &, Options)
Starts a notebook 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::notebooks::v2::StartInstanceRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
StartInstance(google::longrunning::Operation const &, Options)
Starts a notebook 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::notebooks::v2::Instance > > |
StopInstance(google::cloud::notebooks::v2::StopInstanceRequest const &, Options)
Stops a notebook instance.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::notebooks::v2::StopInstanceRequest 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::notebooks::v2::Instance > > |
A |
StopInstance(NoAwaitTag, google::cloud::notebooks::v2::StopInstanceRequest const &, Options)
Stops a notebook 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::notebooks::v2::StopInstanceRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
StopInstance(google::longrunning::Operation const &, Options)
Stops a notebook 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::notebooks::v2::Instance > > |
ResetInstance(google::cloud::notebooks::v2::ResetInstanceRequest const &, Options)
Resets a notebook instance.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::notebooks::v2::ResetInstanceRequest 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::notebooks::v2::Instance > > |
A |
ResetInstance(NoAwaitTag, google::cloud::notebooks::v2::ResetInstanceRequest const &, Options)
Resets a notebook 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::notebooks::v2::ResetInstanceRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
ResetInstance(google::longrunning::Operation const &, Options)
Resets a notebook 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::notebooks::v2::Instance > > |
CheckInstanceUpgradability(google::cloud::notebooks::v2::CheckInstanceUpgradabilityRequest const &, Options)
Checks whether a notebook instance is upgradable.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::notebooks::v2::CheckInstanceUpgradabilityRequest 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::notebooks::v2::CheckInstanceUpgradabilityResponse > |
the result of the RPC. The response message type (google.cloud.notebooks.v2.CheckInstanceUpgradabilityResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
UpgradeInstance(google::cloud::notebooks::v2::UpgradeInstanceRequest const &, Options)
Upgrades a notebook instance to the latest version.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::notebooks::v2::UpgradeInstanceRequest 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::notebooks::v2::Instance > > |
A |
UpgradeInstance(NoAwaitTag, google::cloud::notebooks::v2::UpgradeInstanceRequest const &, Options)
Upgrades a notebook instance to the latest version.
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::notebooks::v2::UpgradeInstanceRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
UpgradeInstance(google::longrunning::Operation const &, Options)
Upgrades a notebook instance to the latest version.
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::notebooks::v2::Instance > > |
RollbackInstance(google::cloud::notebooks::v2::RollbackInstanceRequest const &, Options)
Rollbacks a notebook instance to the previous version.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::notebooks::v2::RollbackInstanceRequest 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::notebooks::v2::Instance > > |
A |
RollbackInstance(NoAwaitTag, google::cloud::notebooks::v2::RollbackInstanceRequest const &, Options)
Rollbacks a notebook instance to the previous version.
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::notebooks::v2::RollbackInstanceRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
RollbackInstance(google::longrunning::Operation const &, Options)
Rollbacks a notebook instance to the previous version.
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::notebooks::v2::Instance > > |
DiagnoseInstance(std::string const &, google::cloud::notebooks::v2::DiagnosticConfig const &, Options)
Creates a Diagnostic File and runs Diagnostic Tool given an Instance.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. Format: |
diagnostic_config |
google::cloud::notebooks::v2::DiagnosticConfig const &
Required. Defines flags that are used to run the diagnostic tool |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::notebooks::v2::Instance > > |
A |
DiagnoseInstance(NoAwaitTag, std::string const &, google::cloud::notebooks::v2::DiagnosticConfig const &, Options)
Creates a Diagnostic File and runs Diagnostic Tool given an 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 &
|
diagnostic_config |
google::cloud::notebooks::v2::DiagnosticConfig const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
DiagnoseInstance(google::cloud::notebooks::v2::DiagnoseInstanceRequest const &, Options)
Creates a Diagnostic File and runs Diagnostic Tool given an Instance.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::notebooks::v2::DiagnoseInstanceRequest 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::notebooks::v2::Instance > > |
A |
DiagnoseInstance(NoAwaitTag, google::cloud::notebooks::v2::DiagnoseInstanceRequest const &, Options)
Creates a Diagnostic File and runs Diagnostic Tool given an 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::notebooks::v2::DiagnoseInstanceRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
DiagnoseInstance(google::longrunning::Operation const &, Options)
Creates a Diagnostic File and runs Diagnostic Tool given an 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::notebooks::v2::Instance > > |
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 |