Class LiveVideoAnalyticsClient (3.3.0-rc)

Service describing handlers for resources.

The service enables clients to run Live Video Analytics (LVA) on the streaming inputs.

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

LiveVideoAnalyticsClient(LiveVideoAnalyticsClient const &)

Copy and move support

Parameter
Name Description
LiveVideoAnalyticsClient const &

LiveVideoAnalyticsClient(LiveVideoAnalyticsClient &&)

Copy and move support

Parameter
Name Description
LiveVideoAnalyticsClient &&

LiveVideoAnalyticsClient(std::shared_ptr< LiveVideoAnalyticsConnection >, Options)

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

Operators

operator=(LiveVideoAnalyticsClient const &)

Copy and move support

Parameter
Name Description
LiveVideoAnalyticsClient const &
Returns
Type Description
LiveVideoAnalyticsClient &

operator=(LiveVideoAnalyticsClient &&)

Copy and move support

Parameter
Name Description
LiveVideoAnalyticsClient &&
Returns
Type Description
LiveVideoAnalyticsClient &

Functions

ListPublicOperators(std::string const &, Options)

ListPublicOperators returns all the operators in public registry.

Parameters
Name Description
parent std::string const &

Required. Parent value for ListPublicOperatorsRequest.

opts Options

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

Returns
Type Description
StreamRange< google::cloud::visionai::v1::Operator >

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

ListPublicOperators(google::cloud::visionai::v1::ListPublicOperatorsRequest, Options)

ListPublicOperators returns all the operators in public registry.

Parameters
Name Description
request google::cloud::visionai::v1::ListPublicOperatorsRequest

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.visionai.v1.ListPublicOperatorsRequest. 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::visionai::v1::Operator >

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

ResolveOperatorInfo(std::string const &, std::vector< google::cloud::visionai::v1::OperatorQuery > const &, Options)

ResolveOperatorInfo returns the operator information based on the request.

Parameters
Name Description
parent std::string const &

Required. Parent value for ResolveOperatorInfoRequest.

queries std::vector< google::cloud::visionai::v1::OperatorQuery > const &

Required. The operator queries.

opts Options

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

Returns
Type Description
StatusOr< google::cloud::visionai::v1::ResolveOperatorInfoResponse >

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

ResolveOperatorInfo(google::cloud::visionai::v1::ResolveOperatorInfoRequest const &, Options)

ResolveOperatorInfo returns the operator information based on the request.

Parameters
Name Description
request google::cloud::visionai::v1::ResolveOperatorInfoRequest 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.visionai.v1.ResolveOperatorInfoRequest. 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::visionai::v1::ResolveOperatorInfoResponse >

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

ListOperators(std::string const &, Options)

Lists Operators in a given project and location.

Parameters
Name Description
parent std::string const &

Required. Parent value for ListOperatorsRequest.

opts Options

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

Returns
Type Description
StreamRange< google::cloud::visionai::v1::Operator >

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

ListOperators(google::cloud::visionai::v1::ListOperatorsRequest, Options)

Lists Operators in a given project and location.

Parameters
Name Description
request google::cloud::visionai::v1::ListOperatorsRequest

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.visionai.v1.ListOperatorsRequest. 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::visionai::v1::Operator >

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

GetOperator(std::string const &, Options)

Gets details of a single Operator.

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::visionai::v1::Operator >

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

GetOperator(google::cloud::visionai::v1::GetOperatorRequest const &, Options)

Gets details of a single Operator.

Parameters
Name Description
request google::cloud::visionai::v1::GetOperatorRequest 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.visionai.v1.GetOperatorRequest. 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::visionai::v1::Operator >

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

CreateOperator(std::string const &, google::cloud::visionai::v1::Operator const &, std::string const &, Options)

Creates a new Operator in a given project and location.

Parameters
Name Description
parent std::string const &

Required. Value for parent.

operator_ google::cloud::visionai::v1::Operator const &

Required. The resource being created.

operator_id std::string const &

Required. Id of the requesting object.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::visionai::v1::Operator > >

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

CreateOperator(NoAwaitTag, std::string const &, google::cloud::visionai::v1::Operator const &, std::string const &, Options)

Creates a new Operator 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 &
operator_ google::cloud::visionai::v1::Operator const &
operator_id std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateOperator(google::cloud::visionai::v1::CreateOperatorRequest const &, Options)

Creates a new Operator in a given project and location.

Parameters
Name Description
request google::cloud::visionai::v1::CreateOperatorRequest 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.visionai.v1.CreateOperatorRequest. 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::visionai::v1::Operator > >

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

CreateOperator(NoAwaitTag, google::cloud::visionai::v1::CreateOperatorRequest const &, Options)

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

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

Creates a new Operator 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::visionai::v1::Operator > >

UpdateOperator(google::cloud::visionai::v1::Operator const &, google::protobuf::FieldMask const &, Options)

Updates the parameters of a single Operator.

Parameters
Name Description
operator_ google::cloud::visionai::v1::Operator 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 Operator 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::visionai::v1::Operator > >

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

UpdateOperator(NoAwaitTag, google::cloud::visionai::v1::Operator const &, google::protobuf::FieldMask const &, Options)

Updates the parameters of a single Operator.

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

UpdateOperator(google::cloud::visionai::v1::UpdateOperatorRequest const &, Options)

Updates the parameters of a single Operator.

Parameters
Name Description
request google::cloud::visionai::v1::UpdateOperatorRequest 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.visionai.v1.UpdateOperatorRequest. 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::visionai::v1::Operator > >

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

UpdateOperator(NoAwaitTag, google::cloud::visionai::v1::UpdateOperatorRequest const &, Options)

Updates the parameters of a single Operator.

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

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

Updates the parameters of a single Operator.

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::visionai::v1::Operator > >

DeleteOperator(std::string const &, Options)

Deletes a single Operator.

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

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

Deletes a single Operator.

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 >

DeleteOperator(google::cloud::visionai::v1::DeleteOperatorRequest const &, Options)

Deletes a single Operator.

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

DeleteOperator(NoAwaitTag, google::cloud::visionai::v1::DeleteOperatorRequest const &, Options)

Deletes a single Operator.

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

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

Deletes a single Operator.

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

ListAnalyses(std::string const &, Options)

Lists Analyses in a given project and location.

Parameters
Name Description
parent std::string const &

Required. Parent value for ListAnalysesRequest

opts Options

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

Returns
Type Description
StreamRange< google::cloud::visionai::v1::Analysis >

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

ListAnalyses(google::cloud::visionai::v1::ListAnalysesRequest, Options)

Lists Analyses in a given project and location.

Parameters
Name Description
request google::cloud::visionai::v1::ListAnalysesRequest

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.visionai.v1.ListAnalysesRequest. 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::visionai::v1::Analysis >

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

GetAnalysis(std::string const &, Options)

Gets details of a single Analysis.

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::visionai::v1::Analysis >

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

GetAnalysis(google::cloud::visionai::v1::GetAnalysisRequest const &, Options)

Gets details of a single Analysis.

Parameters
Name Description
request google::cloud::visionai::v1::GetAnalysisRequest 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.visionai.v1.GetAnalysisRequest. 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::visionai::v1::Analysis >

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

CreateAnalysis(std::string const &, google::cloud::visionai::v1::Analysis const &, std::string const &, Options)

Creates a new Analysis in a given project and location.

Parameters
Name Description
parent std::string const &

Required. Value for parent.

analysis google::cloud::visionai::v1::Analysis const &

Required. The resource being created.

analysis_id std::string const &

Required. Id of the requesting object.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::visionai::v1::Analysis > >

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

CreateAnalysis(NoAwaitTag, std::string const &, google::cloud::visionai::v1::Analysis const &, std::string const &, Options)

Creates a new Analysis 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 &
analysis google::cloud::visionai::v1::Analysis const &
analysis_id std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateAnalysis(google::cloud::visionai::v1::CreateAnalysisRequest const &, Options)

Creates a new Analysis in a given project and location.

Parameters
Name Description
request google::cloud::visionai::v1::CreateAnalysisRequest 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.visionai.v1.CreateAnalysisRequest. 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::visionai::v1::Analysis > >

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

CreateAnalysis(NoAwaitTag, google::cloud::visionai::v1::CreateAnalysisRequest const &, Options)

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

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

Creates a new Analysis 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::visionai::v1::Analysis > >

UpdateAnalysis(google::cloud::visionai::v1::Analysis const &, google::protobuf::FieldMask const &, Options)

Updates the parameters of a single Analysis.

Parameters
Name Description
analysis google::cloud::visionai::v1::Analysis 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 Analysis 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::visionai::v1::Analysis > >

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

UpdateAnalysis(NoAwaitTag, google::cloud::visionai::v1::Analysis const &, google::protobuf::FieldMask const &, Options)

Updates the parameters of a single Analysis.

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

UpdateAnalysis(google::cloud::visionai::v1::UpdateAnalysisRequest const &, Options)

Updates the parameters of a single Analysis.

Parameters
Name Description
request google::cloud::visionai::v1::UpdateAnalysisRequest 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.visionai.v1.UpdateAnalysisRequest. 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::visionai::v1::Analysis > >

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

UpdateAnalysis(NoAwaitTag, google::cloud::visionai::v1::UpdateAnalysisRequest const &, Options)

Updates the parameters of a single Analysis.

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

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

Updates the parameters of a single Analysis.

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::visionai::v1::Analysis > >

DeleteAnalysis(std::string const &, Options)

Deletes a single Analysis.

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

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

Deletes a single Analysis.

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 >

DeleteAnalysis(google::cloud::visionai::v1::DeleteAnalysisRequest const &, Options)

Deletes a single Analysis.

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

DeleteAnalysis(NoAwaitTag, google::cloud::visionai::v1::DeleteAnalysisRequest const &, Options)

Deletes a single Analysis.

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

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

Deletes a single Analysis.

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

ListProcesses(std::string const &, Options)

Lists Processes in a given project and location.

Parameters
Name Description
parent std::string const &

Required. Parent value for ListProcessesRequest.

opts Options

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

Returns
Type Description
StreamRange< google::cloud::visionai::v1::Process >

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

ListProcesses(google::cloud::visionai::v1::ListProcessesRequest, Options)

Lists Processes in a given project and location.

Parameters
Name Description
request google::cloud::visionai::v1::ListProcessesRequest

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.visionai.v1.ListProcessesRequest. 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::visionai::v1::Process >

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

GetProcess(std::string const &, Options)

Gets details of a single Process.

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::visionai::v1::Process >

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

GetProcess(google::cloud::visionai::v1::GetProcessRequest const &, Options)

Gets details of a single Process.

Parameters
Name Description
request google::cloud::visionai::v1::GetProcessRequest 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.visionai.v1.GetProcessRequest. 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::visionai::v1::Process >

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

CreateProcess(std::string const &, google::cloud::visionai::v1::Process const &, std::string const &, Options)

Creates a new Process in a given project and location.

Parameters
Name Description
parent std::string const &

Required. Value for parent.

process google::cloud::visionai::v1::Process const &

Required. The resource being created.

process_id std::string const &

Required. Id of the requesting object.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::visionai::v1::Process > >

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

CreateProcess(NoAwaitTag, std::string const &, google::cloud::visionai::v1::Process const &, std::string const &, Options)

Creates a new Process 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 &
process google::cloud::visionai::v1::Process const &
process_id std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

CreateProcess(google::cloud::visionai::v1::CreateProcessRequest const &, Options)

Creates a new Process in a given project and location.

Parameters
Name Description
request google::cloud::visionai::v1::CreateProcessRequest 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.visionai.v1.CreateProcessRequest. 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::visionai::v1::Process > >

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

CreateProcess(NoAwaitTag, google::cloud::visionai::v1::CreateProcessRequest const &, Options)

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

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

Creates a new Process 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::visionai::v1::Process > >

UpdateProcess(google::cloud::visionai::v1::Process const &, google::protobuf::FieldMask const &, Options)

Updates the parameters of a single Process.

Parameters
Name Description
process google::cloud::visionai::v1::Process 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 Process 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::visionai::v1::Process > >

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

UpdateProcess(NoAwaitTag, google::cloud::visionai::v1::Process const &, google::protobuf::FieldMask const &, Options)

Updates the parameters of a single Process.

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

UpdateProcess(google::cloud::visionai::v1::UpdateProcessRequest const &, Options)

Updates the parameters of a single Process.

Parameters
Name Description
request google::cloud::visionai::v1::UpdateProcessRequest 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.visionai.v1.UpdateProcessRequest. 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::visionai::v1::Process > >

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

UpdateProcess(NoAwaitTag, google::cloud::visionai::v1::UpdateProcessRequest const &, Options)

Updates the parameters of a single Process.

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

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

Updates the parameters of a single Process.

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::visionai::v1::Process > >

DeleteProcess(std::string const &, Options)

Deletes a single Process.

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

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

Deletes a single Process.

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 >

DeleteProcess(google::cloud::visionai::v1::DeleteProcessRequest const &, Options)

Deletes a single Process.

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

DeleteProcess(NoAwaitTag, google::cloud::visionai::v1::DeleteProcessRequest const &, Options)

Deletes a single Process.

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

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

Deletes a single Process.

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

BatchRunProcess(std::string const &, std::vector< google::cloud::visionai::v1::CreateProcessRequest > const &, Options)

Run all of the processes to "completion".

Max time for each process is the LRO time limit.

Parameters
Name Description
parent std::string const &

Required. The parent resource shared by all processes being created.

requests std::vector< google::cloud::visionai::v1::CreateProcessRequest > const &

Required. The create process requests.

opts Options

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

Returns
Type Description
future< StatusOr< google::cloud::visionai::v1::BatchRunProcessResponse > >

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

BatchRunProcess(NoAwaitTag, std::string const &, std::vector< google::cloud::visionai::v1::CreateProcessRequest > const &, Options)

Run all of the processes to "completion".

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 &
requests std::vector< google::cloud::visionai::v1::CreateProcessRequest > const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

BatchRunProcess(google::cloud::visionai::v1::BatchRunProcessRequest const &, Options)

Run all of the processes to "completion".

Max time for each process is the LRO time limit.

Parameters
Name Description
request google::cloud::visionai::v1::BatchRunProcessRequest 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.visionai.v1.BatchRunProcessRequest. 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::visionai::v1::BatchRunProcessResponse > >

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

BatchRunProcess(NoAwaitTag, google::cloud::visionai::v1::BatchRunProcessRequest const &, Options)

Run all of the processes to "completion".

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

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

Run all of the processes to "completion".

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::visionai::v1::BatchRunProcessResponse > >

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.