Class StorageInsightsClient (3.4.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

StorageInsightsClient(StorageInsightsClient const &)

Copy and move support

Parameter
Name Description
StorageInsightsClient const &

StorageInsightsClient(StorageInsightsClient &&)

Copy and move support

Parameter
Name Description
StorageInsightsClient &&

StorageInsightsClient(std::shared_ptr< StorageInsightsConnection >, Options)

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

Operators

operator=(StorageInsightsClient const &)

Copy and move support

Parameter
Name Description
StorageInsightsClient const &
Returns
Type Description
StorageInsightsClient &

operator=(StorageInsightsClient &&)

Copy and move support

Parameter
Name Description
StorageInsightsClient &&
Returns
Type Description
StorageInsightsClient &

Functions

ListReportConfigs(std::string const &, Options)

Lists ReportConfigs in a given project and location.

Parameters
Name Description
parent std::string const &

Required. Parent value for ListReportConfigsRequest

opts Options

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

Returns
Type Description
StreamRange< google::cloud::storageinsights::v1::ReportConfig >

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.storageinsights.v1.ReportConfig, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListReportConfigs(google::cloud::storageinsights::v1::ListReportConfigsRequest, Options)

Lists ReportConfigs in a given project and location.

Parameters
Name Description
request google::cloud::storageinsights::v1::ListReportConfigsRequest

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.storageinsights.v1.ListReportConfigsRequest. 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::storageinsights::v1::ReportConfig >

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.storageinsights.v1.ReportConfig, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

GetReportConfig(std::string const &, Options)

Gets details of a single ReportConfig.

Parameters
Name Description
name std::string const &

Required. Name of the resource

opts Options

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

Returns
Type Description
StatusOr< google::cloud::storageinsights::v1::ReportConfig >

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

GetReportConfig(google::cloud::storageinsights::v1::GetReportConfigRequest const &, Options)

Gets details of a single ReportConfig.

Parameters
Name Description
request google::cloud::storageinsights::v1::GetReportConfigRequest 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.storageinsights.v1.GetReportConfigRequest. 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::storageinsights::v1::ReportConfig >

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

CreateReportConfig(std::string const &, google::cloud::storageinsights::v1::ReportConfig const &, Options)

Creates a new ReportConfig in a given project and location.

Parameters
Name Description
parent std::string const &

Required. Value for parent.

report_config google::cloud::storageinsights::v1::ReportConfig const &

Required. The resource being created

opts Options

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

Returns
Type Description
StatusOr< google::cloud::storageinsights::v1::ReportConfig >

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

CreateReportConfig(google::cloud::storageinsights::v1::CreateReportConfigRequest const &, Options)

Creates a new ReportConfig in a given project and location.

Parameters
Name Description
request google::cloud::storageinsights::v1::CreateReportConfigRequest 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.storageinsights.v1.CreateReportConfigRequest. 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::storageinsights::v1::ReportConfig >

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

UpdateReportConfig(google::cloud::storageinsights::v1::ReportConfig const &, google::protobuf::FieldMask const &, Options)

Updates the parameters of a single ReportConfig.

Parameters
Name Description
report_config google::cloud::storageinsights::v1::ReportConfig const &

Required. The resource being updated

update_mask google::protobuf::FieldMask const &

Required. Field mask is used to specify the fields to be overwritten in the ReportConfig 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
StatusOr< google::cloud::storageinsights::v1::ReportConfig >

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

UpdateReportConfig(google::cloud::storageinsights::v1::UpdateReportConfigRequest const &, Options)

Updates the parameters of a single ReportConfig.

Parameters
Name Description
request google::cloud::storageinsights::v1::UpdateReportConfigRequest 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.storageinsights.v1.UpdateReportConfigRequest. 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::storageinsights::v1::ReportConfig >

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

DeleteReportConfig(std::string const &, Options)

Deletes a single ReportConfig.

Parameters
Name Description
name std::string const &

Required. Name of the resource

opts Options

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

Returns
Type Description
Status

a Status object. If the request failed, the status contains the details of the failure.

DeleteReportConfig(google::cloud::storageinsights::v1::DeleteReportConfigRequest const &, Options)

Deletes a single ReportConfig.

Parameters
Name Description
request google::cloud::storageinsights::v1::DeleteReportConfigRequest 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.storageinsights.v1.DeleteReportConfigRequest. 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.

ListReportDetails(std::string const &, Options)

Lists ReportDetails in a given project and location.

Parameters
Name Description
parent std::string const &

Required. Parent value for ListReportDetailsRequest

opts Options

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

Returns
Type Description
StreamRange< google::cloud::storageinsights::v1::ReportDetail >

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.storageinsights.v1.ReportDetail, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListReportDetails(google::cloud::storageinsights::v1::ListReportDetailsRequest, Options)

Lists ReportDetails in a given project and location.

Parameters
Name Description
request google::cloud::storageinsights::v1::ListReportDetailsRequest

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.storageinsights.v1.ListReportDetailsRequest. 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::storageinsights::v1::ReportDetail >

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.storageinsights.v1.ReportDetail, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

GetReportDetail(std::string const &, Options)

Gets details of a single ReportDetail.

Parameters
Name Description
name std::string const &

Required. Name of the resource

opts Options

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

Returns
Type Description
StatusOr< google::cloud::storageinsights::v1::ReportDetail >

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

GetReportDetail(google::cloud::storageinsights::v1::GetReportDetailRequest const &, Options)

Gets details of a single ReportDetail.

Parameters
Name Description
request google::cloud::storageinsights::v1::GetReportDetailRequest 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.storageinsights.v1.GetReportDetailRequest. 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::storageinsights::v1::ReportDetail >

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

ListDatasetConfigs(std::string const &, Options)

Lists the dataset configurations in a given project for a given location.

Parameters
Name Description
parent std::string const &

Required. Parent value for ListDatasetConfigsRequest

opts Options

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

Returns
Type Description
StreamRange< google::cloud::storageinsights::v1::DatasetConfig >

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.storageinsights.v1.DatasetConfig, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListDatasetConfigs(google::cloud::storageinsights::v1::ListDatasetConfigsRequest, Options)

Lists the dataset configurations in a given project for a given location.

Parameters
Name Description
request google::cloud::storageinsights::v1::ListDatasetConfigsRequest

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.storageinsights.v1.ListDatasetConfigsRequest. 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::storageinsights::v1::DatasetConfig >

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.storageinsights.v1.DatasetConfig, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

GetDatasetConfig(std::string const &, Options)

Gets the dataset configuration in a given project for a given location.

Parameters
Name Description
name std::string const &

Required. Name of the resource

opts Options

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

Returns
Type Description
StatusOr< google::cloud::storageinsights::v1::DatasetConfig >

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

GetDatasetConfig(google::cloud::storageinsights::v1::GetDatasetConfigRequest const &, Options)

Gets the dataset configuration in a given project for a given location.

Parameters
Name Description
request google::cloud::storageinsights::v1::GetDatasetConfigRequest 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.storageinsights.v1.GetDatasetConfigRequest. 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::storageinsights::v1::DatasetConfig >

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

CreateDatasetConfig(std::string const &, google::cloud::storageinsights::v1::DatasetConfig const &, std::string const &, Options)

Creates a dataset configuration in a given project for a given location.

Parameters
Name Description
parent std::string const &

Required. Value for parent.

dataset_config google::cloud::storageinsights::v1::DatasetConfig const &

Required. The resource being created

dataset_config_id std::string const &

Required. ID of the requesting object. If auto-generating ID is enabled on the server-side, remove this field and dataset_config_id from the method_signature of Create RPC Note: The value should not contain any hyphens.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::storageinsights::v1::DatasetConfig > >

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.storageinsights.v1.DatasetConfig proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateDatasetConfig(NoAwaitTag, std::string const &, google::cloud::storageinsights::v1::DatasetConfig const &, std::string const &, Options)

Creates a dataset configuration in a given project for a given 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 &
dataset_config google::cloud::storageinsights::v1::DatasetConfig const &
dataset_config_id std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateDatasetConfig(google::cloud::storageinsights::v1::CreateDatasetConfigRequest const &, Options)

Creates a dataset configuration in a given project for a given location.

Parameters
Name Description
request google::cloud::storageinsights::v1::CreateDatasetConfigRequest 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.storageinsights.v1.CreateDatasetConfigRequest. 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::storageinsights::v1::DatasetConfig > >

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.storageinsights.v1.DatasetConfig proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateDatasetConfig(NoAwaitTag, google::cloud::storageinsights::v1::CreateDatasetConfigRequest const &, Options)

Creates a dataset configuration in a given project for a given 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::storageinsights::v1::CreateDatasetConfigRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

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

Creates a dataset configuration in a given project for a given 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::storageinsights::v1::DatasetConfig > >

UpdateDatasetConfig(google::cloud::storageinsights::v1::DatasetConfig const &, google::protobuf::FieldMask const &, Options)

Updates a dataset configuration in a given project for a given location.

Parameters
Name Description
dataset_config google::cloud::storageinsights::v1::DatasetConfig const &

Required. The resource being updated

update_mask google::protobuf::FieldMask const &

Required. Field mask is used to specify the fields to be overwritten in the DatasetConfig resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it is in the mask. If the user does not provide a mask then it returns an "Invalid Argument" error.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::storageinsights::v1::DatasetConfig > >

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.storageinsights.v1.DatasetConfig proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateDatasetConfig(NoAwaitTag, google::cloud::storageinsights::v1::DatasetConfig const &, google::protobuf::FieldMask const &, Options)

Updates a dataset configuration in a given project for a given 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
dataset_config google::cloud::storageinsights::v1::DatasetConfig const &
update_mask google::protobuf::FieldMask const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

UpdateDatasetConfig(google::cloud::storageinsights::v1::UpdateDatasetConfigRequest const &, Options)

Updates a dataset configuration in a given project for a given location.

Parameters
Name Description
request google::cloud::storageinsights::v1::UpdateDatasetConfigRequest 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.storageinsights.v1.UpdateDatasetConfigRequest. 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::storageinsights::v1::DatasetConfig > >

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.storageinsights.v1.DatasetConfig proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateDatasetConfig(NoAwaitTag, google::cloud::storageinsights::v1::UpdateDatasetConfigRequest const &, Options)

Updates a dataset configuration in a given project for a given 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::storageinsights::v1::UpdateDatasetConfigRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

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

Updates a dataset configuration in a given project for a given 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::storageinsights::v1::DatasetConfig > >

DeleteDatasetConfig(std::string const &, Options)

Deletes a dataset configuration in a given project for a given location.

Parameters
Name Description
name std::string const &

Required. Name of the resource

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::storageinsights::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.storageinsights.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

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

Deletes a dataset configuration in a given project for a given 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
name std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

DeleteDatasetConfig(google::cloud::storageinsights::v1::DeleteDatasetConfigRequest const &, Options)

Deletes a dataset configuration in a given project for a given location.

Parameters
Name Description
request google::cloud::storageinsights::v1::DeleteDatasetConfigRequest 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.storageinsights.v1.DeleteDatasetConfigRequest. 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::storageinsights::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.storageinsights.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteDatasetConfig(NoAwaitTag, google::cloud::storageinsights::v1::DeleteDatasetConfigRequest const &, Options)

Deletes a dataset configuration in a given project for a given 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::storageinsights::v1::DeleteDatasetConfigRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

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

Deletes a dataset configuration in a given project for a given 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::storageinsights::v1::OperationMetadata > >

LinkDataset(std::string const &, Options)

Links a dataset to BigQuery in a given project for a given location.

Parameters
Name Description
name std::string const &

Required. Name of the resource

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::storageinsights::v1::LinkDatasetResponse > >

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.storageinsights.v1.LinkDatasetResponse proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

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

Links a dataset to BigQuery in a given project for a given 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
name std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

LinkDataset(google::cloud::storageinsights::v1::LinkDatasetRequest const &, Options)

Links a dataset to BigQuery in a given project for a given location.

Parameters
Name Description
request google::cloud::storageinsights::v1::LinkDatasetRequest 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.storageinsights.v1.LinkDatasetRequest. 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::storageinsights::v1::LinkDatasetResponse > >

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.storageinsights.v1.LinkDatasetResponse proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

LinkDataset(NoAwaitTag, google::cloud::storageinsights::v1::LinkDatasetRequest const &, Options)

Links a dataset to BigQuery in a given project for a given 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::storageinsights::v1::LinkDatasetRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

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

Links a dataset to BigQuery in a given project for a given 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::storageinsights::v1::LinkDatasetResponse > >

UnlinkDataset(std::string const &, Options)

Unlinks a dataset from BigQuery in a given project for a given location.

Parameters
Name Description
name std::string const &

Required. Name of the resource

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::storageinsights::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.storageinsights.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

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

Unlinks a dataset from BigQuery in a given project for a given 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
name std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

UnlinkDataset(google::cloud::storageinsights::v1::UnlinkDatasetRequest const &, Options)

Unlinks a dataset from BigQuery in a given project for a given location.

Parameters
Name Description
request google::cloud::storageinsights::v1::UnlinkDatasetRequest 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.storageinsights.v1.UnlinkDatasetRequest. 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::storageinsights::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.storageinsights.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UnlinkDataset(NoAwaitTag, google::cloud::storageinsights::v1::UnlinkDatasetRequest const &, Options)

Unlinks a dataset from BigQuery in a given project for a given 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::storageinsights::v1::UnlinkDatasetRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

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

Unlinks a dataset from BigQuery in a given project for a given 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::storageinsights::v1::OperationMetadata > >

ListLocations(google::cloud::location::ListLocationsRequest, Options)

Lists information about the supported locations for this service.

Parameters
Name Description
request google::cloud::location::ListLocationsRequest

Unary RPCs, such as the one wrapped by this function, receive a single 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.