The BatchController provides methods to manage batch workloads.
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
BatchControllerClient(BatchControllerClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
BatchControllerClient const &
|
BatchControllerClient(BatchControllerClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
BatchControllerClient &&
|
BatchControllerClient(std::shared_ptr< BatchControllerConnection >, Options)
Parameters | |
---|---|
Name | Description |
connection |
std::shared_ptr< BatchControllerConnection >
|
opts |
Options
|
Operators
operator=(BatchControllerClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
BatchControllerClient const &
|
Returns | |
---|---|
Type | Description |
BatchControllerClient & |
operator=(BatchControllerClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
BatchControllerClient &&
|
Returns | |
---|---|
Type | Description |
BatchControllerClient & |
Functions
CreateBatch(std::string const &, google::cloud::dataproc::v1::Batch const &, std::string const &, Options)
Creates a batch workload that executes asynchronously.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The parent resource where this batch will be created. |
batch |
google::cloud::dataproc::v1::Batch const &
Required. The batch to create. |
batch_id |
std::string const &
Optional. The ID to use for the batch, which will become the final component of the batch's resource name. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::dataproc::v1::Batch > > |
A |
CreateBatch(google::cloud::dataproc::v1::CreateBatchRequest const &, Options)
Creates a batch workload that executes asynchronously.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::dataproc::v1::CreateBatchRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::dataproc::v1::Batch > > |
A |
GetBatch(std::string const &, Options)
Gets the batch workload resource representation.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The fully qualified name of the batch to retrieve in the format "projects/PROJECT_ID/locations/DATAPROC_REGION/batches/BATCH_ID" |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::dataproc::v1::Batch > |
the result of the RPC. The response message type (google.cloud.dataproc.v1.Batch) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetBatch(google::cloud::dataproc::v1::GetBatchRequest const &, Options)
Gets the batch workload resource representation.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::dataproc::v1::GetBatchRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::dataproc::v1::Batch > |
the result of the RPC. The response message type (google.cloud.dataproc.v1.Batch) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
ListBatches(std::string const &, Options)
Lists batch workloads.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The parent, which owns this collection of batches. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::dataproc::v1::Batch > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListBatches(google::cloud::dataproc::v1::ListBatchesRequest, Options)
Lists batch workloads.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::dataproc::v1::ListBatchesRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::dataproc::v1::Batch > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
DeleteBatch(std::string const &, Options)
Deletes the batch workload resource.
If the batch is not in terminal state, the delete fails and the response returns FAILED_PRECONDITION
.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The fully qualified name of the batch to retrieve in the format "projects/PROJECT_ID/locations/DATAPROC_REGION/batches/BATCH_ID" |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
Status |
a |
DeleteBatch(google::cloud::dataproc::v1::DeleteBatchRequest const &, Options)
Deletes the batch workload resource.
If the batch is not in terminal state, the delete fails and the response returns FAILED_PRECONDITION
.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::dataproc::v1::DeleteBatchRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
Status |
a |