Class OracleDatabaseClient (3.3.0-rc)

Service describing handlers for resources.

Equality

Instances of this class created via copy-construction or copy-assignment always compare equal. Instances created with equal std::shared_ptr<*Connection> objects compare equal. Objects that compare equal share the same underlying resources.

Performance

Creating a new instance of this class is a relatively expensive operation, new objects establish new connections to the service. In contrast, copy-construction, move-construction, and the corresponding assignment operations are relatively efficient as the copies share all underlying resources.

Thread Safety

Concurrent access to different instances of this class, even if they compare equal, is guaranteed to work. Two or more threads operating on the same instance of this class is not guaranteed to work. Since copy-construction and move-construction is a relatively efficient operation, consider using such a copy when using this class from multiple threads.

Constructors

OracleDatabaseClient(OracleDatabaseClient const &)

Copy and move support

Parameter
Name Description
OracleDatabaseClient const &

OracleDatabaseClient(OracleDatabaseClient &&)

Copy and move support

Parameter
Name Description
OracleDatabaseClient &&

OracleDatabaseClient(std::shared_ptr< OracleDatabaseConnection >, Options)

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

Operators

operator=(OracleDatabaseClient const &)

Copy and move support

Parameter
Name Description
OracleDatabaseClient const &
Returns
Type Description
OracleDatabaseClient &

operator=(OracleDatabaseClient &&)

Copy and move support

Parameter
Name Description
OracleDatabaseClient &&
Returns
Type Description
OracleDatabaseClient &

Functions

ListCloudExadataInfrastructures(std::string const &, Options)

Lists Exadata Infrastructures in a given project and location.

Parameters
Name Description
parent std::string const &

Required. The parent value for CloudExadataInfrastructure in the following format: projects/{project}/locations/{location}.

opts Options

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

Returns
Type Description
StreamRange< google::cloud::oracledatabase::v1::CloudExadataInfrastructure >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.oracledatabase.v1.CloudExadataInfrastructure, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListCloudExadataInfrastructures(google::cloud::oracledatabase::v1::ListCloudExadataInfrastructuresRequest, Options)

Lists Exadata Infrastructures in a given project and location.

Parameters
Name Description
request google::cloud::oracledatabase::v1::ListCloudExadataInfrastructuresRequest

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

opts Options

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

Returns
Type Description
StreamRange< google::cloud::oracledatabase::v1::CloudExadataInfrastructure >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.oracledatabase.v1.CloudExadataInfrastructure, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

GetCloudExadataInfrastructure(std::string const &, Options)

Gets details of a single Exadata Infrastructure.

Parameters
Name Description
name std::string const &

Required. The name of the Cloud Exadata Infrastructure in the following format: projects/{project}/locations/{location}/cloudExadataInfrastructures/{cloud_exadata_infrastructure}.

opts Options

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

Returns
Type Description
StatusOr< google::cloud::oracledatabase::v1::CloudExadataInfrastructure >

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

GetCloudExadataInfrastructure(google::cloud::oracledatabase::v1::GetCloudExadataInfrastructureRequest const &, Options)

Gets details of a single Exadata Infrastructure.

Parameters
Name Description
request google::cloud::oracledatabase::v1::GetCloudExadataInfrastructureRequest const &

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

opts Options

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

Returns
Type Description
StatusOr< google::cloud::oracledatabase::v1::CloudExadataInfrastructure >

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

CreateCloudExadataInfrastructure(std::string const &, google::cloud::oracledatabase::v1::CloudExadataInfrastructure const &, std::string const &, Options)

Creates a new Exadata Infrastructure in a given project and location.

Parameters
Name Description
parent std::string const &

Required. The parent value for CloudExadataInfrastructure in the following format: projects/{project}/locations/{location}.

cloud_exadata_infrastructure google::cloud::oracledatabase::v1::CloudExadataInfrastructure const &

Required. Details of the Exadata Infrastructure instance to create.

cloud_exadata_infrastructure_id std::string const &

Required. The ID of the Exadata Infrastructure to create. This value is restricted to (^a-z?$) and must be a maximum of 63 characters in length. The value must start with a letter and end with a letter or a number.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::oracledatabase::v1::CloudExadataInfrastructure > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.oracledatabase.v1.CloudExadataInfrastructure proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateCloudExadataInfrastructure(NoAwaitTag, std::string const &, google::cloud::oracledatabase::v1::CloudExadataInfrastructure const &, std::string const &, Options)

Creates a new Exadata Infrastructure 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 &
cloud_exadata_infrastructure google::cloud::oracledatabase::v1::CloudExadataInfrastructure const &
cloud_exadata_infrastructure_id std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateCloudExadataInfrastructure(google::cloud::oracledatabase::v1::CreateCloudExadataInfrastructureRequest const &, Options)

Creates a new Exadata Infrastructure in a given project and location.

Parameters
Name Description
request google::cloud::oracledatabase::v1::CreateCloudExadataInfrastructureRequest const &

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

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::oracledatabase::v1::CloudExadataInfrastructure > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.oracledatabase.v1.CloudExadataInfrastructure proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateCloudExadataInfrastructure(NoAwaitTag, google::cloud::oracledatabase::v1::CreateCloudExadataInfrastructureRequest const &, Options)

Creates a new Exadata Infrastructure 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::oracledatabase::v1::CreateCloudExadataInfrastructureRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

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

Creates a new Exadata Infrastructure 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::oracledatabase::v1::CloudExadataInfrastructure > >

DeleteCloudExadataInfrastructure(std::string const &, Options)

Deletes a single Exadata Infrastructure.

Parameters
Name Description
name std::string const &

Required. The name of the Cloud Exadata Infrastructure in the following format: projects/{project}/locations/{location}/cloudExadataInfrastructures/{cloud_exadata_infrastructure}.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::oracledatabase::v1::OperationMetadata > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.oracledatabase.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

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

Deletes a single Exadata Infrastructure.

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 >

DeleteCloudExadataInfrastructure(google::cloud::oracledatabase::v1::DeleteCloudExadataInfrastructureRequest const &, Options)

Deletes a single Exadata Infrastructure.

Parameters
Name Description
request google::cloud::oracledatabase::v1::DeleteCloudExadataInfrastructureRequest const &

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

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::oracledatabase::v1::OperationMetadata > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.oracledatabase.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteCloudExadataInfrastructure(NoAwaitTag, google::cloud::oracledatabase::v1::DeleteCloudExadataInfrastructureRequest const &, Options)

Deletes a single Exadata Infrastructure.

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

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

Deletes a single Exadata Infrastructure.

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

ListCloudVmClusters(std::string const &, Options)

Lists the VM Clusters in a given project and location.

Parameters
Name Description
parent std::string const &

Required. The name of the parent in the following format: projects/{project}/locations/{location}.

opts Options

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

Returns
Type Description
StreamRange< google::cloud::oracledatabase::v1::CloudVmCluster >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.oracledatabase.v1.CloudVmCluster, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListCloudVmClusters(google::cloud::oracledatabase::v1::ListCloudVmClustersRequest, Options)

Lists the VM Clusters in a given project and location.

Parameters
Name Description
request google::cloud::oracledatabase::v1::ListCloudVmClustersRequest

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

opts Options

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

Returns
Type Description
StreamRange< google::cloud::oracledatabase::v1::CloudVmCluster >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.oracledatabase.v1.CloudVmCluster, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

GetCloudVmCluster(std::string const &, Options)

Gets details of a single VM Cluster.

Parameters
Name Description
name std::string const &

Required. The name of the Cloud VM Cluster in the following format: projects/{project}/locations/{location}/cloudVmClusters/{cloud_vm_cluster}.

opts Options

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

Returns
Type Description
StatusOr< google::cloud::oracledatabase::v1::CloudVmCluster >

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

GetCloudVmCluster(google::cloud::oracledatabase::v1::GetCloudVmClusterRequest const &, Options)

Gets details of a single VM Cluster.

Parameters
Name Description
request google::cloud::oracledatabase::v1::GetCloudVmClusterRequest const &

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

opts Options

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

Returns
Type Description
StatusOr< google::cloud::oracledatabase::v1::CloudVmCluster >

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

CreateCloudVmCluster(std::string const &, google::cloud::oracledatabase::v1::CloudVmCluster const &, std::string const &, Options)

Creates a new VM Cluster in a given project and location.

Parameters
Name Description
parent std::string const &

Required. The name of the parent in the following format: projects/{project}/locations/{location}.

cloud_vm_cluster google::cloud::oracledatabase::v1::CloudVmCluster const &

Required. The resource being created

cloud_vm_cluster_id std::string const &

Required. The ID of the VM Cluster to create. This value is restricted to (^a-z?$) and must be a maximum of 63 characters in length. The value must start with a letter and end with a letter or a number.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::oracledatabase::v1::CloudVmCluster > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.oracledatabase.v1.CloudVmCluster proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateCloudVmCluster(NoAwaitTag, std::string const &, google::cloud::oracledatabase::v1::CloudVmCluster const &, std::string const &, Options)

Creates a new VM Cluster 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 &
cloud_vm_cluster google::cloud::oracledatabase::v1::CloudVmCluster const &
cloud_vm_cluster_id std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateCloudVmCluster(google::cloud::oracledatabase::v1::CreateCloudVmClusterRequest const &, Options)

Creates a new VM Cluster in a given project and location.

Parameters
Name Description
request google::cloud::oracledatabase::v1::CreateCloudVmClusterRequest const &

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

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::oracledatabase::v1::CloudVmCluster > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.oracledatabase.v1.CloudVmCluster proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateCloudVmCluster(NoAwaitTag, google::cloud::oracledatabase::v1::CreateCloudVmClusterRequest const &, Options)

Creates a new VM Cluster 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::oracledatabase::v1::CreateCloudVmClusterRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

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

Creates a new VM Cluster 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::oracledatabase::v1::CloudVmCluster > >

DeleteCloudVmCluster(std::string const &, Options)

Deletes a single VM Cluster.

Parameters
Name Description
name std::string const &

Required. The name of the Cloud VM Cluster in the following format: projects/{project}/locations/{location}/cloudVmClusters/{cloud_vm_cluster}.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::oracledatabase::v1::OperationMetadata > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.oracledatabase.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

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

Deletes a single VM Cluster.

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 >

DeleteCloudVmCluster(google::cloud::oracledatabase::v1::DeleteCloudVmClusterRequest const &, Options)

Deletes a single VM Cluster.

Parameters
Name Description
request google::cloud::oracledatabase::v1::DeleteCloudVmClusterRequest const &

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

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::oracledatabase::v1::OperationMetadata > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.oracledatabase.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteCloudVmCluster(NoAwaitTag, google::cloud::oracledatabase::v1::DeleteCloudVmClusterRequest const &, Options)

Deletes a single VM Cluster.

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

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

Deletes a single VM Cluster.

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

ListEntitlements(std::string const &, Options)

Lists the entitlements in a given project.

Parameters
Name Description
parent std::string const &

Required. The parent value for the entitlement in the following format: projects/{project}/locations/{location}.

opts Options

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

Returns
Type Description
StreamRange< google::cloud::oracledatabase::v1::Entitlement >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.oracledatabase.v1.Entitlement, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListEntitlements(google::cloud::oracledatabase::v1::ListEntitlementsRequest, Options)

Lists the entitlements in a given project.

Parameters
Name Description
request google::cloud::oracledatabase::v1::ListEntitlementsRequest

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

opts Options

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

Returns
Type Description
StreamRange< google::cloud::oracledatabase::v1::Entitlement >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.oracledatabase.v1.Entitlement, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListDbServers(std::string const &, Options)

Lists the database servers of an Exadata Infrastructure instance.

Parameters
Name Description
parent std::string const &

Required. The parent value for database server in the following format: projects/{project}/locations/{location}/cloudExadataInfrastructures/{cloudExadataInfrastructure}.

opts Options

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

Returns
Type Description
StreamRange< google::cloud::oracledatabase::v1::DbServer >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.oracledatabase.v1.DbServer, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListDbServers(google::cloud::oracledatabase::v1::ListDbServersRequest, Options)

Lists the database servers of an Exadata Infrastructure instance.

Parameters
Name Description
request google::cloud::oracledatabase::v1::ListDbServersRequest

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

opts Options

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

Returns
Type Description
StreamRange< google::cloud::oracledatabase::v1::DbServer >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.oracledatabase.v1.DbServer, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListDbNodes(std::string const &, Options)

Lists the database nodes of a VM Cluster.

Parameters
Name Description
parent std::string const &

Required. The parent value for database node in the following format: projects/{project}/locations/{location}/cloudVmClusters/{cloudVmCluster}.

opts Options

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

Returns
Type Description
StreamRange< google::cloud::oracledatabase::v1::DbNode >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.oracledatabase.v1.DbNode, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListDbNodes(google::cloud::oracledatabase::v1::ListDbNodesRequest, Options)

Lists the database nodes of a VM Cluster.

Parameters
Name Description
request google::cloud::oracledatabase::v1::ListDbNodesRequest

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

opts Options

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

Returns
Type Description
StreamRange< google::cloud::oracledatabase::v1::DbNode >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.oracledatabase.v1.DbNode, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListGiVersions(std::string const &, Options)

Lists all the valid Oracle Grid Infrastructure (GI) versions for the given project and location.

Parameters
Name Description
parent std::string const &

Required. The parent value for Grid Infrastructure Version in the following format: Format: projects/{project}/locations/{location}.

opts Options

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

Returns
Type Description
StreamRange< google::cloud::oracledatabase::v1::GiVersion >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.oracledatabase.v1.GiVersion, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListGiVersions(google::cloud::oracledatabase::v1::ListGiVersionsRequest, Options)

Lists all the valid Oracle Grid Infrastructure (GI) versions for the given project and location.

Parameters
Name Description
request google::cloud::oracledatabase::v1::ListGiVersionsRequest

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

opts Options

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

Returns
Type Description
StreamRange< google::cloud::oracledatabase::v1::GiVersion >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.oracledatabase.v1.GiVersion, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListMinorVersions(std::string const &, Options)

Lists all the valid minor versions for the given project, location, gi version and shape family.

Parameters
Name Description
parent std::string const &

Required. The parent value for the MinorVersion resource with the format: projects/{project}/locations/{location}/giVersions/{gi_version}

opts Options

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

Returns
Type Description
StreamRange< google::cloud::oracledatabase::v1::MinorVersion >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.oracledatabase.v1.MinorVersion, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListMinorVersions(google::cloud::oracledatabase::v1::ListMinorVersionsRequest, Options)

Lists all the valid minor versions for the given project, location, gi version and shape family.

Parameters
Name Description
request google::cloud::oracledatabase::v1::ListMinorVersionsRequest

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

opts Options

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

Returns
Type Description
StreamRange< google::cloud::oracledatabase::v1::MinorVersion >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.oracledatabase.v1.MinorVersion, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListDbSystemShapes(std::string const &, Options)

Lists the database system shapes available for the project and location.

Parameters
Name Description
parent std::string const &

Required. The parent value for Database System Shapes in the following format: projects/{project}/locations/{location}.

opts Options

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

Returns
Type Description
StreamRange< google::cloud::oracledatabase::v1::DbSystemShape >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.oracledatabase.v1.DbSystemShape, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListDbSystemShapes(google::cloud::oracledatabase::v1::ListDbSystemShapesRequest, Options)

Lists the database system shapes available for the project and location.

Parameters
Name Description
request google::cloud::oracledatabase::v1::ListDbSystemShapesRequest

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

opts Options

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

Returns
Type Description
StreamRange< google::cloud::oracledatabase::v1::DbSystemShape >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.oracledatabase.v1.DbSystemShape, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListAutonomousDatabases(std::string const &, Options)

Lists the Autonomous Databases in a given project and location.

Parameters
Name Description
parent std::string const &

Required. The parent value for the Autonomous Database in the following format: projects/{project}/locations/{location}.

opts Options

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

Returns
Type Description
StreamRange< google::cloud::oracledatabase::v1::AutonomousDatabase >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.oracledatabase.v1.AutonomousDatabase, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListAutonomousDatabases(google::cloud::oracledatabase::v1::ListAutonomousDatabasesRequest, Options)

Lists the Autonomous Databases in a given project and location.

Parameters
Name Description
request google::cloud::oracledatabase::v1::ListAutonomousDatabasesRequest

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

opts Options

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

Returns
Type Description
StreamRange< google::cloud::oracledatabase::v1::AutonomousDatabase >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.oracledatabase.v1.AutonomousDatabase, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

GetAutonomousDatabase(std::string const &, Options)

Gets the details of a single Autonomous Database.

Parameters
Name Description
name std::string const &

Required. The name of the Autonomous Database in the following format: projects/{project}/locations/{location}/autonomousDatabases/{autonomous_database}.

opts Options

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

Returns
Type Description
StatusOr< google::cloud::oracledatabase::v1::AutonomousDatabase >

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

GetAutonomousDatabase(google::cloud::oracledatabase::v1::GetAutonomousDatabaseRequest const &, Options)

Gets the details of a single Autonomous Database.

Parameters
Name Description
request google::cloud::oracledatabase::v1::GetAutonomousDatabaseRequest const &

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

opts Options

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

Returns
Type Description
StatusOr< google::cloud::oracledatabase::v1::AutonomousDatabase >

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

CreateAutonomousDatabase(std::string const &, google::cloud::oracledatabase::v1::AutonomousDatabase const &, std::string const &, Options)

Creates a new Autonomous Database in a given project and location.

Parameters
Name Description
parent std::string const &

Required. The name of the parent in the following format: projects/{project}/locations/{location}.

autonomous_database google::cloud::oracledatabase::v1::AutonomousDatabase const &

Required. The Autonomous Database being created.

autonomous_database_id std::string const &

Required. The ID of the Autonomous Database to create. This value is restricted to (^a-z?$) and must be a maximum of 63 characters in length. The value must start with a letter and end with a letter or a number.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::oracledatabase::v1::AutonomousDatabase > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.oracledatabase.v1.AutonomousDatabase proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateAutonomousDatabase(NoAwaitTag, std::string const &, google::cloud::oracledatabase::v1::AutonomousDatabase const &, std::string const &, Options)

Creates a new Autonomous Database 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 &
autonomous_database google::cloud::oracledatabase::v1::AutonomousDatabase const &
autonomous_database_id std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateAutonomousDatabase(google::cloud::oracledatabase::v1::CreateAutonomousDatabaseRequest const &, Options)

Creates a new Autonomous Database in a given project and location.

Parameters
Name Description
request google::cloud::oracledatabase::v1::CreateAutonomousDatabaseRequest const &

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

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::oracledatabase::v1::AutonomousDatabase > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.oracledatabase.v1.AutonomousDatabase proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateAutonomousDatabase(NoAwaitTag, google::cloud::oracledatabase::v1::CreateAutonomousDatabaseRequest const &, Options)

Creates a new Autonomous Database 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::oracledatabase::v1::CreateAutonomousDatabaseRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

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

Creates a new Autonomous Database 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::oracledatabase::v1::AutonomousDatabase > >

UpdateAutonomousDatabase(google::cloud::oracledatabase::v1::AutonomousDatabase const &, google::protobuf::FieldMask const &, Options)

Updates the parameters of a single Autonomous Database.

Parameters
Name Description
autonomous_database google::cloud::oracledatabase::v1::AutonomousDatabase const &

Required. The resource being updated

update_mask google::protobuf::FieldMask const &

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

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::oracledatabase::v1::AutonomousDatabase > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.oracledatabase.v1.AutonomousDatabase proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateAutonomousDatabase(NoAwaitTag, google::cloud::oracledatabase::v1::AutonomousDatabase const &, google::protobuf::FieldMask const &, Options)

Updates the parameters of a single Autonomous Database.

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

UpdateAutonomousDatabase(google::cloud::oracledatabase::v1::UpdateAutonomousDatabaseRequest const &, Options)

Updates the parameters of a single Autonomous Database.

Parameters
Name Description
request google::cloud::oracledatabase::v1::UpdateAutonomousDatabaseRequest const &

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

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::oracledatabase::v1::AutonomousDatabase > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.oracledatabase.v1.AutonomousDatabase proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateAutonomousDatabase(NoAwaitTag, google::cloud::oracledatabase::v1::UpdateAutonomousDatabaseRequest const &, Options)

Updates the parameters of a single Autonomous Database.

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

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

Updates the parameters of a single Autonomous Database.

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::oracledatabase::v1::AutonomousDatabase > >

DeleteAutonomousDatabase(std::string const &, Options)

Deletes a single Autonomous Database.

Parameters
Name Description
name std::string const &

Required. The name of the resource in the following format: projects/{project}/locations/{location}/autonomousDatabases/{autonomous_database}.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::oracledatabase::v1::OperationMetadata > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.oracledatabase.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

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

Deletes a single Autonomous Database.

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 >

DeleteAutonomousDatabase(google::cloud::oracledatabase::v1::DeleteAutonomousDatabaseRequest const &, Options)

Deletes a single Autonomous Database.

Parameters
Name Description
request google::cloud::oracledatabase::v1::DeleteAutonomousDatabaseRequest const &

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

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::oracledatabase::v1::OperationMetadata > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.oracledatabase.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteAutonomousDatabase(NoAwaitTag, google::cloud::oracledatabase::v1::DeleteAutonomousDatabaseRequest const &, Options)

Deletes a single Autonomous Database.

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

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

Deletes a single Autonomous Database.

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

RestoreAutonomousDatabase(std::string const &, google::protobuf::Timestamp const &, Options)

Restores a single Autonomous Database.

Parameters
Name Description
name std::string const &

Required. The name of the Autonomous Database in the following format: projects/{project}/locations/{location}/autonomousDatabases/{autonomous_database}.

restore_time google::protobuf::Timestamp const &

Required. The time and date to restore the database to.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::oracledatabase::v1::AutonomousDatabase > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.oracledatabase.v1.AutonomousDatabase proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

RestoreAutonomousDatabase(NoAwaitTag, std::string const &, google::protobuf::Timestamp const &, Options)

Restores a single Autonomous Database.

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 &
restore_time google::protobuf::Timestamp const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

RestoreAutonomousDatabase(google::cloud::oracledatabase::v1::RestoreAutonomousDatabaseRequest const &, Options)

Restores a single Autonomous Database.

Parameters
Name Description
request google::cloud::oracledatabase::v1::RestoreAutonomousDatabaseRequest const &

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

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::oracledatabase::v1::AutonomousDatabase > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.oracledatabase.v1.AutonomousDatabase proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

RestoreAutonomousDatabase(NoAwaitTag, google::cloud::oracledatabase::v1::RestoreAutonomousDatabaseRequest const &, Options)

Restores a single Autonomous Database.

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

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

Restores a single Autonomous Database.

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::oracledatabase::v1::AutonomousDatabase > >

GenerateAutonomousDatabaseWallet(std::string const &, google::cloud::oracledatabase::v1::GenerateType, bool, std::string const &, Options)

Generates a wallet for an Autonomous Database.

Parameters
Name Description
name std::string const &

Required. The name of the Autonomous Database in the following format: projects/{project}/locations/{location}/autonomousDatabases/{autonomous_database}.

type google::cloud::oracledatabase::v1::GenerateType

Optional. The type of wallet generation for the Autonomous Database. The default value is SINGLE.

is_regional bool

Optional. True when requesting regional connection strings in PDB connect info, applicable to cross-region Data Guard only.

password std::string const &

Required. The password used to encrypt the keys inside the wallet. The password must be a minimum of 8 characters.

opts Options

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

Returns
Type Description
StatusOr< google::cloud::oracledatabase::v1::GenerateAutonomousDatabaseWalletResponse >

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

GenerateAutonomousDatabaseWallet(google::cloud::oracledatabase::v1::GenerateAutonomousDatabaseWalletRequest const &, Options)

Generates a wallet for an Autonomous Database.

Parameters
Name Description
request google::cloud::oracledatabase::v1::GenerateAutonomousDatabaseWalletRequest const &

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

opts Options

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

Returns
Type Description
StatusOr< google::cloud::oracledatabase::v1::GenerateAutonomousDatabaseWalletResponse >

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

ListAutonomousDbVersions(std::string const &, Options)

Lists all the available Autonomous Database versions for a project and location.

Parameters
Name Description
parent std::string const &

Required. The parent value for the Autonomous Database in the following format: projects/{project}/locations/{location}.

opts Options

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

Returns
Type Description
StreamRange< google::cloud::oracledatabase::v1::AutonomousDbVersion >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.oracledatabase.v1.AutonomousDbVersion, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListAutonomousDbVersions(google::cloud::oracledatabase::v1::ListAutonomousDbVersionsRequest, Options)

Lists all the available Autonomous Database versions for a project and location.

Parameters
Name Description
request google::cloud::oracledatabase::v1::ListAutonomousDbVersionsRequest

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

opts Options

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

Returns
Type Description
StreamRange< google::cloud::oracledatabase::v1::AutonomousDbVersion >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.oracledatabase.v1.AutonomousDbVersion, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListAutonomousDatabaseCharacterSets(std::string const &, Options)

Lists Autonomous Database Character Sets in a given project and location.

Parameters
Name Description
parent std::string const &

Required. The parent value for the Autonomous Database in the following format: projects/{project}/locations/{location}.

opts Options

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

Returns
Type Description
StreamRange< google::cloud::oracledatabase::v1::AutonomousDatabaseCharacterSet >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.oracledatabase.v1.AutonomousDatabaseCharacterSet, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListAutonomousDatabaseCharacterSets(google::cloud::oracledatabase::v1::ListAutonomousDatabaseCharacterSetsRequest, Options)

Lists Autonomous Database Character Sets in a given project and location.

Parameters
Name Description
request google::cloud::oracledatabase::v1::ListAutonomousDatabaseCharacterSetsRequest

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

opts Options

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

Returns
Type Description
StreamRange< google::cloud::oracledatabase::v1::AutonomousDatabaseCharacterSet >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.oracledatabase.v1.AutonomousDatabaseCharacterSet, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListAutonomousDatabaseBackups(std::string const &, Options)

Lists the long-term and automatic backups of an Autonomous Database.

Parameters
Name Description
parent std::string const &

Required. The parent value for ListAutonomousDatabaseBackups in the following format: projects/{project}/locations/{location}.

opts Options

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

Returns
Type Description
StreamRange< google::cloud::oracledatabase::v1::AutonomousDatabaseBackup >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.oracledatabase.v1.AutonomousDatabaseBackup, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListAutonomousDatabaseBackups(google::cloud::oracledatabase::v1::ListAutonomousDatabaseBackupsRequest, Options)

Lists the long-term and automatic backups of an Autonomous Database.

Parameters
Name Description
request google::cloud::oracledatabase::v1::ListAutonomousDatabaseBackupsRequest

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

opts Options

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

Returns
Type Description
StreamRange< google::cloud::oracledatabase::v1::AutonomousDatabaseBackup >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.oracledatabase.v1.AutonomousDatabaseBackup, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

StopAutonomousDatabase(std::string const &, Options)

Stops an Autonomous Database.

Parameters
Name Description
name std::string const &

Required. The name of the Autonomous Database in the following format: projects/{project}/locations/{location}/autonomousDatabases/{autonomous_database}.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::oracledatabase::v1::AutonomousDatabase > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.oracledatabase.v1.AutonomousDatabase proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

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

Stops an Autonomous Database.

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 >

StopAutonomousDatabase(google::cloud::oracledatabase::v1::StopAutonomousDatabaseRequest const &, Options)

Stops an Autonomous Database.

Parameters
Name Description
request google::cloud::oracledatabase::v1::StopAutonomousDatabaseRequest const &

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

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::oracledatabase::v1::AutonomousDatabase > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.oracledatabase.v1.AutonomousDatabase proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

StopAutonomousDatabase(NoAwaitTag, google::cloud::oracledatabase::v1::StopAutonomousDatabaseRequest const &, Options)

Stops an Autonomous Database.

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

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

Stops an Autonomous Database.

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::oracledatabase::v1::AutonomousDatabase > >

StartAutonomousDatabase(std::string const &, Options)

Starts an Autonomous Database.

Parameters
Name Description
name std::string const &

Required. The name of the Autonomous Database in the following format: projects/{project}/locations/{location}/autonomousDatabases/{autonomous_database}.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::oracledatabase::v1::AutonomousDatabase > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.oracledatabase.v1.AutonomousDatabase proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

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

Starts an Autonomous Database.

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 >

StartAutonomousDatabase(google::cloud::oracledatabase::v1::StartAutonomousDatabaseRequest const &, Options)

Starts an Autonomous Database.

Parameters
Name Description
request google::cloud::oracledatabase::v1::StartAutonomousDatabaseRequest const &

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

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::oracledatabase::v1::AutonomousDatabase > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.oracledatabase.v1.AutonomousDatabase proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

StartAutonomousDatabase(NoAwaitTag, google::cloud::oracledatabase::v1::StartAutonomousDatabaseRequest const &, Options)

Starts an Autonomous Database.

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

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

Starts an Autonomous Database.

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::oracledatabase::v1::AutonomousDatabase > >

RestartAutonomousDatabase(std::string const &, Options)

Restarts an Autonomous Database.

Parameters
Name Description
name std::string const &

Required. The name of the Autonomous Database in the following format: projects/{project}/locations/{location}/autonomousDatabases/{autonomous_database}.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::oracledatabase::v1::AutonomousDatabase > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.oracledatabase.v1.AutonomousDatabase proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

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

Restarts an Autonomous Database.

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 >

RestartAutonomousDatabase(google::cloud::oracledatabase::v1::RestartAutonomousDatabaseRequest const &, Options)

Restarts an Autonomous Database.

Parameters
Name Description
request google::cloud::oracledatabase::v1::RestartAutonomousDatabaseRequest const &

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

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::oracledatabase::v1::AutonomousDatabase > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.oracledatabase.v1.AutonomousDatabase proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

RestartAutonomousDatabase(NoAwaitTag, google::cloud::oracledatabase::v1::RestartAutonomousDatabaseRequest const &, Options)

Restarts an Autonomous Database.

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

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

Restarts an Autonomous Database.

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::oracledatabase::v1::AutonomousDatabase > >

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

Initiates a switchover of specified autonomous database to the associated peer database.

Parameters
Name Description
name std::string const &

Required. The name of the Autonomous Database in the following format: projects/{project}/locations/{location}/autonomousDatabases/{autonomous_database}.

peer_autonomous_database std::string const &

Required. The peer database name to switch over to.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::oracledatabase::v1::AutonomousDatabase > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.oracledatabase.v1.AutonomousDatabase proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

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

Initiates a switchover of specified autonomous database to the associated peer database.

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

SwitchoverAutonomousDatabase(google::cloud::oracledatabase::v1::SwitchoverAutonomousDatabaseRequest const &, Options)

Initiates a switchover of specified autonomous database to the associated peer database.

Parameters
Name Description
request google::cloud::oracledatabase::v1::SwitchoverAutonomousDatabaseRequest const &

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

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::oracledatabase::v1::AutonomousDatabase > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.oracledatabase.v1.AutonomousDatabase proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

SwitchoverAutonomousDatabase(NoAwaitTag, google::cloud::oracledatabase::v1::SwitchoverAutonomousDatabaseRequest const &, Options)

Initiates a switchover of specified autonomous database to the associated peer database.

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

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

Initiates a switchover of specified autonomous database to the associated peer database.

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::oracledatabase::v1::AutonomousDatabase > >

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

Initiates a failover to target autonomous database from the associated primary database.

Parameters
Name Description
name std::string const &

Required. The name of the Autonomous Database in the following format: projects/{project}/locations/{location}/autonomousDatabases/{autonomous_database}.

peer_autonomous_database std::string const &

Required. The peer database name to fail over to.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::oracledatabase::v1::AutonomousDatabase > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.oracledatabase.v1.AutonomousDatabase proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

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

Initiates a failover to target autonomous database from the associated primary database.

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

FailoverAutonomousDatabase(google::cloud::oracledatabase::v1::FailoverAutonomousDatabaseRequest const &, Options)

Initiates a failover to target autonomous database from the associated primary database.

Parameters
Name Description
request google::cloud::oracledatabase::v1::FailoverAutonomousDatabaseRequest const &

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

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::oracledatabase::v1::AutonomousDatabase > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.oracledatabase.v1.AutonomousDatabase proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

FailoverAutonomousDatabase(NoAwaitTag, google::cloud::oracledatabase::v1::FailoverAutonomousDatabaseRequest const &, Options)

Initiates a failover to target autonomous database from the associated primary database.

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

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

Initiates a failover to target autonomous database from the associated primary database.

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::oracledatabase::v1::AutonomousDatabase > >

ListOdbNetworks(std::string const &, Options)

Lists the ODB Networks in a given project and location.

Parameters
Name Description
parent std::string const &

Required. The parent value for the ODB Network in the following format: projects/{project}/locations/{location}.

opts Options

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

Returns
Type Description
StreamRange< google::cloud::oracledatabase::v1::OdbNetwork >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.oracledatabase.v1.OdbNetwork, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListOdbNetworks(google::cloud::oracledatabase::v1::ListOdbNetworksRequest, Options)

Lists the ODB Networks in a given project and location.

Parameters
Name Description
request google::cloud::oracledatabase::v1::ListOdbNetworksRequest

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

opts Options

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

Returns
Type Description
StreamRange< google::cloud::oracledatabase::v1::OdbNetwork >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.oracledatabase.v1.OdbNetwork, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

GetOdbNetwork(std::string const &, Options)

Gets details of a single ODB Network.

Parameters
Name Description
name std::string const &

Required. The name of the OdbNetwork in the following format: projects/{project}/locations/{location}/odbNetworks/{odb_network}.

opts Options

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

Returns
Type Description
StatusOr< google::cloud::oracledatabase::v1::OdbNetwork >

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

GetOdbNetwork(google::cloud::oracledatabase::v1::GetOdbNetworkRequest const &, Options)

Gets details of a single ODB Network.

Parameters
Name Description
request google::cloud::oracledatabase::v1::GetOdbNetworkRequest const &

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

opts Options

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

Returns
Type Description
StatusOr< google::cloud::oracledatabase::v1::OdbNetwork >

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

CreateOdbNetwork(std::string const &, google::cloud::oracledatabase::v1::OdbNetwork const &, std::string const &, Options)

Creates a new ODB Network in a given project and location.

Parameters
Name Description
parent std::string const &

Required. The parent value for the OdbNetwork in the following format: projects/{project}/locations/{location}.

odb_network google::cloud::oracledatabase::v1::OdbNetwork const &

Required. Details of the OdbNetwork instance to create.

odb_network_id std::string const &

Required. The ID of the OdbNetwork to create. This value is restricted to (^a-z?$) and must be a maximum of 63 characters in length. The value must start with a letter and end with a letter or a number.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::oracledatabase::v1::OdbNetwork > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.oracledatabase.v1.OdbNetwork proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateOdbNetwork(NoAwaitTag, std::string const &, google::cloud::oracledatabase::v1::OdbNetwork const &, std::string const &, Options)

Creates a new ODB Network 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 &
odb_network google::cloud::oracledatabase::v1::OdbNetwork const &
odb_network_id std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateOdbNetwork(google::cloud::oracledatabase::v1::CreateOdbNetworkRequest const &, Options)

Creates a new ODB Network in a given project and location.

Parameters
Name Description
request google::cloud::oracledatabase::v1::CreateOdbNetworkRequest const &

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

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::oracledatabase::v1::OdbNetwork > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.oracledatabase.v1.OdbNetwork proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateOdbNetwork(NoAwaitTag, google::cloud::oracledatabase::v1::CreateOdbNetworkRequest const &, Options)

Creates a new ODB Network 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::oracledatabase::v1::CreateOdbNetworkRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

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

Creates a new ODB Network 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::oracledatabase::v1::OdbNetwork > >

DeleteOdbNetwork(std::string const &, Options)

Deletes a single ODB Network.

Parameters
Name Description
name std::string const &

Required. The name of the resource in the following format: projects/{project}/locations/{location}/odbNetworks/{odb_network}.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::oracledatabase::v1::OperationMetadata > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.oracledatabase.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

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

Deletes a single ODB Network.

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 >

DeleteOdbNetwork(google::cloud::oracledatabase::v1::DeleteOdbNetworkRequest const &, Options)

Deletes a single ODB Network.

Parameters
Name Description
request google::cloud::oracledatabase::v1::DeleteOdbNetworkRequest const &

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

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::oracledatabase::v1::OperationMetadata > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.oracledatabase.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteOdbNetwork(NoAwaitTag, google::cloud::oracledatabase::v1::DeleteOdbNetworkRequest const &, Options)

Deletes a single ODB Network.

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

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

Deletes a single ODB Network.

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

ListOdbSubnets(std::string const &, Options)

Lists all the ODB Subnets in a given ODB Network.

Parameters
Name Description
parent std::string const &

Required. The parent value for the OdbSubnet in the following format: projects/{project}/locations/{location}/odbNetworks/{odb_network}.

opts Options

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

Returns
Type Description
StreamRange< google::cloud::oracledatabase::v1::OdbSubnet >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.oracledatabase.v1.OdbSubnet, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListOdbSubnets(google::cloud::oracledatabase::v1::ListOdbSubnetsRequest, Options)

Lists all the ODB Subnets in a given ODB Network.

Parameters
Name Description
request google::cloud::oracledatabase::v1::ListOdbSubnetsRequest

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

opts Options

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

Returns
Type Description
StreamRange< google::cloud::oracledatabase::v1::OdbSubnet >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.oracledatabase.v1.OdbSubnet, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

GetOdbSubnet(std::string const &, Options)

Gets details of a single ODB Subnet.

Parameters
Name Description
name std::string const &

Required. The name of the OdbSubnet in the following format: projects/{project}/locations/{location}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet}.

opts Options

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

Returns
Type Description
StatusOr< google::cloud::oracledatabase::v1::OdbSubnet >

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

GetOdbSubnet(google::cloud::oracledatabase::v1::GetOdbSubnetRequest const &, Options)

Gets details of a single ODB Subnet.

Parameters
Name Description
request google::cloud::oracledatabase::v1::GetOdbSubnetRequest const &

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

opts Options

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

Returns
Type Description
StatusOr< google::cloud::oracledatabase::v1::OdbSubnet >

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

CreateOdbSubnet(std::string const &, google::cloud::oracledatabase::v1::OdbSubnet const &, std::string const &, Options)

Creates a new ODB Subnet in a given ODB Network.

Parameters
Name Description
parent std::string const &

Required. The parent value for the OdbSubnet in the following format: projects/{project}/locations/{location}/odbNetworks/{odb_network}.

odb_subnet google::cloud::oracledatabase::v1::OdbSubnet const &

Required. Details of the OdbSubnet instance to create.

odb_subnet_id std::string const &

Required. The ID of the OdbSubnet to create. This value is restricted to (^a-z?$) and must be a maximum of 63 characters in length. The value must start with a letter and end with a letter or a number.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::oracledatabase::v1::OdbSubnet > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.oracledatabase.v1.OdbSubnet proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateOdbSubnet(NoAwaitTag, std::string const &, google::cloud::oracledatabase::v1::OdbSubnet const &, std::string const &, Options)

Creates a new ODB Subnet in a given ODB Network.

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 &
odb_subnet google::cloud::oracledatabase::v1::OdbSubnet const &
odb_subnet_id std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateOdbSubnet(google::cloud::oracledatabase::v1::CreateOdbSubnetRequest const &, Options)

Creates a new ODB Subnet in a given ODB Network.

Parameters
Name Description
request google::cloud::oracledatabase::v1::CreateOdbSubnetRequest const &

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

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::oracledatabase::v1::OdbSubnet > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.oracledatabase.v1.OdbSubnet proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateOdbSubnet(NoAwaitTag, google::cloud::oracledatabase::v1::CreateOdbSubnetRequest const &, Options)

Creates a new ODB Subnet in a given ODB Network.

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

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

Creates a new ODB Subnet in a given ODB Network.

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::oracledatabase::v1::OdbSubnet > >

DeleteOdbSubnet(std::string const &, Options)

Deletes a single ODB Subnet.

Parameters
Name Description
name std::string const &

Required. The name of the resource in the following format: projects/{project}/locations/{region}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet}.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::oracledatabase::v1::OperationMetadata > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.oracledatabase.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

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

Deletes a single ODB Subnet.

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 >

DeleteOdbSubnet(google::cloud::oracledatabase::v1::DeleteOdbSubnetRequest const &, Options)

Deletes a single ODB Subnet.

Parameters
Name Description
request google::cloud::oracledatabase::v1::DeleteOdbSubnetRequest const &

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

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::oracledatabase::v1::OperationMetadata > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.oracledatabase.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteOdbSubnet(NoAwaitTag, google::cloud::oracledatabase::v1::DeleteOdbSubnetRequest const &, Options)

Deletes a single ODB Subnet.

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

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

Deletes a single ODB Subnet.

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

ListExadbVmClusters(std::string const &, Options)

Lists all the Exadb (Exascale) VM Clusters for the given project and location.

Parameters
Name Description
parent std::string const &

Required. The parent value for ExadbVmClusters in the following format: projects/{project}/locations/{location}.

opts Options

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

Returns
Type Description
StreamRange< google::cloud::oracledatabase::v1::ExadbVmCluster >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.oracledatabase.v1.ExadbVmCluster, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListExadbVmClusters(google::cloud::oracledatabase::v1::ListExadbVmClustersRequest, Options)

Lists all the Exadb (Exascale) VM Clusters for the given project and location.

Parameters
Name Description
request google::cloud::oracledatabase::v1::ListExadbVmClustersRequest

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

opts Options

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

Returns
Type Description
StreamRange< google::cloud::oracledatabase::v1::ExadbVmCluster >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.oracledatabase.v1.ExadbVmCluster, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

GetExadbVmCluster(std::string const &, Options)

Gets details of a single Exadb (Exascale) VM Cluster.

Parameters
Name Description
name std::string const &

Required. The name of the ExadbVmCluster in the following format: projects/{project}/locations/{location}/exadbVmClusters/{exadb_vm_cluster}.

opts Options

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

Returns
Type Description
StatusOr< google::cloud::oracledatabase::v1::ExadbVmCluster >

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

GetExadbVmCluster(google::cloud::oracledatabase::v1::GetExadbVmClusterRequest const &, Options)

Gets details of a single Exadb (Exascale) VM Cluster.

Parameters
Name Description
request google::cloud::oracledatabase::v1::GetExadbVmClusterRequest const &

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

opts Options

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

Returns
Type Description
StatusOr< google::cloud::oracledatabase::v1::ExadbVmCluster >

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

CreateExadbVmCluster(std::string const &, google::cloud::oracledatabase::v1::ExadbVmCluster const &, std::string const &, Options)

Creates a new Exadb (Exascale) VM Cluster resource.

Parameters
Name Description
parent std::string const &

Required. The value for parent of the ExadbVmCluster in the following format: projects/{project}/locations/{location}.

exadb_vm_cluster google::cloud::oracledatabase::v1::ExadbVmCluster const &

Required. The resource being created.

exadb_vm_cluster_id std::string const &

Required. The ID of the ExadbVmCluster to create. This value is restricted to (^a-z?$) and must be a maximum of 63 characters in length. The value must start with a letter and end with a letter or a number.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::oracledatabase::v1::ExadbVmCluster > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.oracledatabase.v1.ExadbVmCluster proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateExadbVmCluster(NoAwaitTag, std::string const &, google::cloud::oracledatabase::v1::ExadbVmCluster const &, std::string const &, Options)

Creates a new Exadb (Exascale) VM Cluster resource.

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 &
exadb_vm_cluster google::cloud::oracledatabase::v1::ExadbVmCluster const &
exadb_vm_cluster_id std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateExadbVmCluster(google::cloud::oracledatabase::v1::CreateExadbVmClusterRequest const &, Options)

Creates a new Exadb (Exascale) VM Cluster resource.

Parameters
Name Description
request google::cloud::oracledatabase::v1::CreateExadbVmClusterRequest const &

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

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::oracledatabase::v1::ExadbVmCluster > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.oracledatabase.v1.ExadbVmCluster proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateExadbVmCluster(NoAwaitTag, google::cloud::oracledatabase::v1::CreateExadbVmClusterRequest const &, Options)

Creates a new Exadb (Exascale) VM Cluster resource.

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

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

Creates a new Exadb (Exascale) VM Cluster resource.

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::oracledatabase::v1::ExadbVmCluster > >

DeleteExadbVmCluster(std::string const &, Options)

Deletes a single Exadb (Exascale) VM Cluster.

Parameters
Name Description
name std::string const &

Required. The name of the ExadbVmCluster in the following format: projects/{project}/locations/{location}/exadbVmClusters/{exadb_vm_cluster}.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::oracledatabase::v1::OperationMetadata > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.oracledatabase.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

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

Deletes a single Exadb (Exascale) VM Cluster.

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 >

DeleteExadbVmCluster(google::cloud::oracledatabase::v1::DeleteExadbVmClusterRequest const &, Options)

Deletes a single Exadb (Exascale) VM Cluster.

Parameters
Name Description
request google::cloud::oracledatabase::v1::DeleteExadbVmClusterRequest const &

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

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::oracledatabase::v1::OperationMetadata > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.oracledatabase.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteExadbVmCluster(NoAwaitTag, google::cloud::oracledatabase::v1::DeleteExadbVmClusterRequest const &, Options)

Deletes a single Exadb (Exascale) VM Cluster.

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

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

Deletes a single Exadb (Exascale) VM Cluster.

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

UpdateExadbVmCluster(google::cloud::oracledatabase::v1::ExadbVmCluster const &, google::protobuf::FieldMask const &, Options)

Updates a single Exadb (Exascale) VM Cluster.

To add virtual machines to existing exadb vm cluster, only pass the node count.

Parameters
Name Description
exadb_vm_cluster google::cloud::oracledatabase::v1::ExadbVmCluster const &

Required. The resource being updated.

update_mask google::protobuf::FieldMask const &

Optional. A mask specifying which fields in th VM Cluster should be updated. A field specified in the mask is overwritten. If a mask isn't provided then all the fields in the VM Cluster are overwritten.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::oracledatabase::v1::ExadbVmCluster > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.oracledatabase.v1.ExadbVmCluster proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateExadbVmCluster(NoAwaitTag, google::cloud::oracledatabase::v1::ExadbVmCluster const &, google::protobuf::FieldMask const &, Options)

Updates a single Exadb (Exascale) VM Cluster.

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

UpdateExadbVmCluster(google::cloud::oracledatabase::v1::UpdateExadbVmClusterRequest const &, Options)

Updates a single Exadb (Exascale) VM Cluster.

To add virtual machines to existing exadb vm cluster, only pass the node count.

Parameters
Name Description
request google::cloud::oracledatabase::v1::UpdateExadbVmClusterRequest const &

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

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::oracledatabase::v1::ExadbVmCluster > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.oracledatabase.v1.ExadbVmCluster proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateExadbVmCluster(NoAwaitTag, google::cloud::oracledatabase::v1::UpdateExadbVmClusterRequest const &, Options)

Updates a single Exadb (Exascale) VM Cluster.

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

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

Updates a single Exadb (Exascale) VM Cluster.

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::oracledatabase::v1::ExadbVmCluster > >

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

Removes virtual machines from an existing exadb vm cluster.

Parameters
Name Description
name std::string const &

Required. The name of the ExadbVmCluster in the following format: projects/{project}/locations/{location}/exadbVmClusters/{exadb_vm_cluster}.

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

Required. The list of host names of db nodes to be removed from the ExadbVmCluster.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::oracledatabase::v1::ExadbVmCluster > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.oracledatabase.v1.ExadbVmCluster proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

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

Removes virtual machines from an existing exadb vm cluster.

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

RemoveVirtualMachineExadbVmCluster(google::cloud::oracledatabase::v1::RemoveVirtualMachineExadbVmClusterRequest const &, Options)

Removes virtual machines from an existing exadb vm cluster.

Parameters
Name Description
request google::cloud::oracledatabase::v1::RemoveVirtualMachineExadbVmClusterRequest const &

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

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::oracledatabase::v1::ExadbVmCluster > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.oracledatabase.v1.ExadbVmCluster proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

RemoveVirtualMachineExadbVmCluster(NoAwaitTag, google::cloud::oracledatabase::v1::RemoveVirtualMachineExadbVmClusterRequest const &, Options)

Removes virtual machines from an existing exadb vm cluster.

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

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

Removes virtual machines from an existing exadb vm cluster.

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::oracledatabase::v1::ExadbVmCluster > >

ListExascaleDbStorageVaults(std::string const &, Options)

Lists all the ExascaleDB Storage Vaults for the given project and location.

Parameters
Name Description
parent std::string const &

Required. The parent value for ExascaleDbStorageVault in the following format: projects/{project}/locations/{location}.

opts Options

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

Returns
Type Description
StreamRange< google::cloud::oracledatabase::v1::ExascaleDbStorageVault >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.oracledatabase.v1.ExascaleDbStorageVault, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListExascaleDbStorageVaults(google::cloud::oracledatabase::v1::ListExascaleDbStorageVaultsRequest, Options)

Lists all the ExascaleDB Storage Vaults for the given project and location.

Parameters
Name Description
request google::cloud::oracledatabase::v1::ListExascaleDbStorageVaultsRequest

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

opts Options

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

Returns
Type Description
StreamRange< google::cloud::oracledatabase::v1::ExascaleDbStorageVault >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.oracledatabase.v1.ExascaleDbStorageVault, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

GetExascaleDbStorageVault(std::string const &, Options)

Gets details of a single ExascaleDB Storage Vault.

Parameters
Name Description
name std::string const &

Required. The name of the ExascaleDbStorageVault in the following format: projects/{project}/locations/{location}/exascaleDbStorageVaults/{exascale_db_storage_vault}.

opts Options

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

Returns
Type Description
StatusOr< google::cloud::oracledatabase::v1::ExascaleDbStorageVault >

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

GetExascaleDbStorageVault(google::cloud::oracledatabase::v1::GetExascaleDbStorageVaultRequest const &, Options)

Gets details of a single ExascaleDB Storage Vault.

Parameters
Name Description
request google::cloud::oracledatabase::v1::GetExascaleDbStorageVaultRequest const &

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

opts Options

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

Returns
Type Description
StatusOr< google::cloud::oracledatabase::v1::ExascaleDbStorageVault >

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

CreateExascaleDbStorageVault(std::string const &, google::cloud::oracledatabase::v1::ExascaleDbStorageVault const &, std::string const &, Options)

Creates a new ExascaleDB Storage Vault resource.

Parameters
Name Description
parent std::string const &

Required. The value for parent of the ExascaleDbStorageVault in the following format: projects/{project}/locations/{location}.

exascale_db_storage_vault google::cloud::oracledatabase::v1::ExascaleDbStorageVault const &

Required. The resource being created.

exascale_db_storage_vault_id std::string const &

Required. The ID of the ExascaleDbStorageVault to create. This value is restricted to (^a-z?$) and must be a maximum of 63 characters in length. The value must start with a letter and end with a letter or a number.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::oracledatabase::v1::ExascaleDbStorageVault > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.oracledatabase.v1.ExascaleDbStorageVault proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateExascaleDbStorageVault(NoAwaitTag, std::string const &, google::cloud::oracledatabase::v1::ExascaleDbStorageVault const &, std::string const &, Options)

Creates a new ExascaleDB Storage Vault resource.

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 &
exascale_db_storage_vault google::cloud::oracledatabase::v1::ExascaleDbStorageVault const &
exascale_db_storage_vault_id std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateExascaleDbStorageVault(google::cloud::oracledatabase::v1::CreateExascaleDbStorageVaultRequest const &, Options)

Creates a new ExascaleDB Storage Vault resource.

Parameters
Name Description
request google::cloud::oracledatabase::v1::CreateExascaleDbStorageVaultRequest const &

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

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::oracledatabase::v1::ExascaleDbStorageVault > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.oracledatabase.v1.ExascaleDbStorageVault proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateExascaleDbStorageVault(NoAwaitTag, google::cloud::oracledatabase::v1::CreateExascaleDbStorageVaultRequest const &, Options)

Creates a new ExascaleDB Storage Vault resource.

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

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

Creates a new ExascaleDB Storage Vault resource.

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::oracledatabase::v1::ExascaleDbStorageVault > >

DeleteExascaleDbStorageVault(std::string const &, Options)

Deletes a single ExascaleDB Storage Vault.

Parameters
Name Description
name std::string const &

Required. The name of the ExascaleDbStorageVault in the following format: projects/{project}/locations/{location}/exascaleDbStorageVaults/{exascale_db_storage_vault}.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::oracledatabase::v1::OperationMetadata > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.oracledatabase.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

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

Deletes a single ExascaleDB Storage Vault.

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 >

DeleteExascaleDbStorageVault(google::cloud::oracledatabase::v1::DeleteExascaleDbStorageVaultRequest const &, Options)

Deletes a single ExascaleDB Storage Vault.

Parameters
Name Description
request google::cloud::oracledatabase::v1::DeleteExascaleDbStorageVaultRequest const &

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

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::oracledatabase::v1::OperationMetadata > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.oracledatabase.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteExascaleDbStorageVault(NoAwaitTag, google::cloud::oracledatabase::v1::DeleteExascaleDbStorageVaultRequest const &, Options)

Deletes a single ExascaleDB Storage Vault.

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

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

Deletes a single ExascaleDB Storage Vault.

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

ListDbSystemInitialStorageSizes(std::string const &, Options)

Lists all the DbSystemInitialStorageSizes for the given project and location.

Parameters
Name Description
parent std::string const &

Required. The parent value for the DbSystemInitialStorageSize resource with the format: projects/{project}/locations/{location}

opts Options

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

Returns
Type Description
StreamRange< google::cloud::oracledatabase::v1::DbSystemInitialStorageSize >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.oracledatabase.v1.DbSystemInitialStorageSize, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListDbSystemInitialStorageSizes(google::cloud::oracledatabase::v1::ListDbSystemInitialStorageSizesRequest, Options)

Lists all the DbSystemInitialStorageSizes for the given project and location.

Parameters
Name Description
request google::cloud::oracledatabase::v1::ListDbSystemInitialStorageSizesRequest

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

opts Options

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

Returns
Type Description
StreamRange< google::cloud::oracledatabase::v1::DbSystemInitialStorageSize >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.oracledatabase.v1.DbSystemInitialStorageSize, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListDatabases(std::string const &, Options)

Lists all the Databases for the given project, location and DbSystem.

Parameters
Name Description
parent std::string const &

Required. The parent resource name in the following format: projects/{project}/locations/{region}

opts Options

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

Returns
Type Description
StreamRange< google::cloud::oracledatabase::v1::Database >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.oracledatabase.v1.Database, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListDatabases(google::cloud::oracledatabase::v1::ListDatabasesRequest, Options)

Lists all the Databases for the given project, location and DbSystem.

Parameters
Name Description
request google::cloud::oracledatabase::v1::ListDatabasesRequest

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

opts Options

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

Returns
Type Description
StreamRange< google::cloud::oracledatabase::v1::Database >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.oracledatabase.v1.Database, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

GetDatabase(std::string const &, Options)

Gets details of a single Database.

Parameters
Name Description
name std::string const &

Required. The name of the Database resource in the following format: projects/{project}/locations/{region}/databases/{database}

opts Options

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

Returns
Type Description
StatusOr< google::cloud::oracledatabase::v1::Database >

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

GetDatabase(google::cloud::oracledatabase::v1::GetDatabaseRequest const &, Options)

Gets details of a single Database.

Parameters
Name Description
request google::cloud::oracledatabase::v1::GetDatabaseRequest const &

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

opts Options

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

Returns
Type Description
StatusOr< google::cloud::oracledatabase::v1::Database >

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

ListPluggableDatabases(std::string const &, Options)

Lists all the PluggableDatabases for the given project, location and Container Database.

Parameters
Name Description
parent std::string const &

Required. The parent, which owns this collection of PluggableDatabases. Format: projects/{project}/locations/{location}

opts Options

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

Returns
Type Description
StreamRange< google::cloud::oracledatabase::v1::PluggableDatabase >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.oracledatabase.v1.PluggableDatabase, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListPluggableDatabases(google::cloud::oracledatabase::v1::ListPluggableDatabasesRequest, Options)

Lists all the PluggableDatabases for the given project, location and Container Database.

Parameters
Name Description
request google::cloud::oracledatabase::v1::ListPluggableDatabasesRequest

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

opts Options

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

Returns
Type Description
StreamRange< google::cloud::oracledatabase::v1::PluggableDatabase >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.oracledatabase.v1.PluggableDatabase, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

GetPluggableDatabase(std::string const &, Options)

Gets details of a single PluggableDatabase.

Parameters
Name Description
name std::string const &

Required. The name of the PluggableDatabase resource in the following format: projects/{project}/locations/{region}/pluggableDatabases/{pluggable_database}

opts Options

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

Returns
Type Description
StatusOr< google::cloud::oracledatabase::v1::PluggableDatabase >

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

GetPluggableDatabase(google::cloud::oracledatabase::v1::GetPluggableDatabaseRequest const &, Options)

Gets details of a single PluggableDatabase.

Parameters
Name Description
request google::cloud::oracledatabase::v1::GetPluggableDatabaseRequest const &

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

opts Options

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

Returns
Type Description
StatusOr< google::cloud::oracledatabase::v1::PluggableDatabase >

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

ListDbSystems(std::string const &, Options)

Lists all the DbSystems for the given project and location.

Parameters
Name Description
parent std::string const &

Required. The parent value for DbSystems in the following format: projects/{project}/locations/{location}.

opts Options

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

Returns
Type Description
StreamRange< google::cloud::oracledatabase::v1::DbSystem >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.oracledatabase.v1.DbSystem, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListDbSystems(google::cloud::oracledatabase::v1::ListDbSystemsRequest, Options)

Lists all the DbSystems for the given project and location.

Parameters
Name Description
request google::cloud::oracledatabase::v1::ListDbSystemsRequest

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

opts Options

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

Returns
Type Description
StreamRange< google::cloud::oracledatabase::v1::DbSystem >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.oracledatabase.v1.DbSystem, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

GetDbSystem(std::string const &, Options)

Gets details of a single DbSystem.

Parameters
Name Description
name std::string const &

Required. The name of the DbSystem in the following format: projects/{project}/locations/{location}/dbSystems/{db_system}.

opts Options

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

Returns
Type Description
StatusOr< google::cloud::oracledatabase::v1::DbSystem >

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

GetDbSystem(google::cloud::oracledatabase::v1::GetDbSystemRequest const &, Options)

Gets details of a single DbSystem.

Parameters
Name Description
request google::cloud::oracledatabase::v1::GetDbSystemRequest const &

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

opts Options

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

Returns
Type Description
StatusOr< google::cloud::oracledatabase::v1::DbSystem >

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

CreateDbSystem(std::string const &, google::cloud::oracledatabase::v1::DbSystem const &, std::string const &, Options)

Creates a new DbSystem in a given project and location.

Parameters
Name Description
parent std::string const &

Required. The value for parent of the DbSystem in the following format: projects/{project}/locations/{location}.

db_system google::cloud::oracledatabase::v1::DbSystem const &

Required. The resource being created.

db_system_id std::string const &

Required. The ID of the DbSystem to create. This value is restricted to (^a-z?$) and must be a maximum of 63 characters in length. The value must start with a letter and end with a letter or a number.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::oracledatabase::v1::DbSystem > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.oracledatabase.v1.DbSystem proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateDbSystem(NoAwaitTag, std::string const &, google::cloud::oracledatabase::v1::DbSystem const &, std::string const &, Options)

Creates a new DbSystem 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 &
db_system google::cloud::oracledatabase::v1::DbSystem const &
db_system_id std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateDbSystem(google::cloud::oracledatabase::v1::CreateDbSystemRequest const &, Options)

Creates a new DbSystem in a given project and location.

Parameters
Name Description
request google::cloud::oracledatabase::v1::CreateDbSystemRequest const &

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

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::oracledatabase::v1::DbSystem > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.oracledatabase.v1.DbSystem proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateDbSystem(NoAwaitTag, google::cloud::oracledatabase::v1::CreateDbSystemRequest const &, Options)

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

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

Creates a new DbSystem 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::oracledatabase::v1::DbSystem > >

DeleteDbSystem(std::string const &, Options)

Deletes a single DbSystem.

Parameters
Name Description
name std::string const &

Required. The name of the DbSystem in the following format: projects/{project}/locations/{location}/dbSystems/{db_system}.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::oracledatabase::v1::OperationMetadata > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.oracledatabase.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

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

Deletes a single DbSystem.

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 >

DeleteDbSystem(google::cloud::oracledatabase::v1::DeleteDbSystemRequest const &, Options)

Deletes a single DbSystem.

Parameters
Name Description
request google::cloud::oracledatabase::v1::DeleteDbSystemRequest const &

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

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::oracledatabase::v1::OperationMetadata > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.oracledatabase.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteDbSystem(NoAwaitTag, google::cloud::oracledatabase::v1::DeleteDbSystemRequest const &, Options)

Deletes a single DbSystem.

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

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

Deletes a single DbSystem.

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

ListDbVersions(std::string const &, Options)

List DbVersions for the given project and location.

Parameters
Name Description
parent std::string const &

Required. The parent value for the DbVersion resource with the format: projects/{project}/locations/{location}

opts Options

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

Returns
Type Description
StreamRange< google::cloud::oracledatabase::v1::DbVersion >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.oracledatabase.v1.DbVersion, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListDbVersions(google::cloud::oracledatabase::v1::ListDbVersionsRequest, Options)

List DbVersions for the given project and location.

Parameters
Name Description
request google::cloud::oracledatabase::v1::ListDbVersionsRequest

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

opts Options

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

Returns
Type Description
StreamRange< google::cloud::oracledatabase::v1::DbVersion >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.oracledatabase.v1.DbVersion, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListDatabaseCharacterSets(std::string const &, Options)

List DatabaseCharacterSets for the given project and location.

Parameters
Name Description
parent std::string const &

Required. The parent value for DatabaseCharacterSets in the following format: projects/{project}/locations/{location}.

opts Options

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

Returns
Type Description
StreamRange< google::cloud::oracledatabase::v1::DatabaseCharacterSet >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.oracledatabase.v1.DatabaseCharacterSet, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListDatabaseCharacterSets(google::cloud::oracledatabase::v1::ListDatabaseCharacterSetsRequest, Options)

List DatabaseCharacterSets for the given project and location.

Parameters
Name Description
request google::cloud::oracledatabase::v1::ListDatabaseCharacterSetsRequest

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

opts Options

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

Returns
Type Description
StreamRange< google::cloud::oracledatabase::v1::DatabaseCharacterSet >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.oracledatabase.v1.DatabaseCharacterSet, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

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

Lists information about the supported locations for this service.

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

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

opts Options

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

Returns
Type Description
StreamRange< google::cloud::location::Location >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.location.Location, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

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

Gets information about a location.

Parameters
Name Description
request google::cloud::location::GetLocationRequest const &

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

opts Options

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

Returns
Type Description
StatusOr< google::cloud::location::Location >

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

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

Lists operations that match the specified filter in the request.

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

Parameters
Name Description
name std::string const &

The name of the operation's parent resource.

filter std::string const &

The standard list filter.

opts Options

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

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

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.longrunning.Operation, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

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

Lists operations that match the specified filter in the request.

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

Parameters
Name Description
request google::longrunning::ListOperationsRequest

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

opts Options

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

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

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.longrunning.Operation, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

GetOperation(std::string const &, Options)

Gets the latest state of a long-running operation.

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

Parameters
Name Description
name std::string const &

The name of the operation resource.

opts Options

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

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

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

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

Gets the latest state of a long-running operation.

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

Parameters
Name Description
request google::longrunning::GetOperationRequest const &

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

opts Options

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

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

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

DeleteOperation(std::string const &, Options)

Deletes a long-running operation.

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

Parameters
Name Description
name std::string const &

The name of the operation resource to be deleted.

opts Options

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

Returns
Type Description
Status

a Status object. If the request failed, the status contains the details of the failure.

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

Deletes a long-running operation.

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

Parameters
Name Description
request google::longrunning::DeleteOperationRequest const &

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

opts Options

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

Returns
Type Description
Status

a Status object. If the request failed, the status contains the details of the failure.

CancelOperation(std::string const &, Options)

Starts asynchronous cancellation on a long-running operation.

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

Parameters
Name Description
name std::string const &

The name of the operation resource to be cancelled.

opts Options

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

Returns
Type Description
Status

a Status object. If the request failed, the status contains the details of the failure.

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

Starts asynchronous cancellation on a long-running operation.

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

Parameters
Name Description
request google::longrunning::CancelOperationRequest const &

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

opts Options

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

Returns
Type Description
Status

a Status object. If the request failed, the status contains the details of the failure.