Class StorageInsightsClient (2.16.0)

Version 2.16.0

• 2.30.0-rc (latest)
• 2.29.0
• 2.28.0
• 2.27.0
• 2.26.0
• 2.25.1
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.1
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0

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.