Class AppPlatformClient (3.3.0-rc)

Service describing handlers for resources.

Equality

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

Performance

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

Thread Safety

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

Constructors

AppPlatformClient(AppPlatformClient const &)

Copy and move support

Parameter
Name Description
AppPlatformClient const &

AppPlatformClient(AppPlatformClient &&)

Copy and move support

Parameter
Name Description
AppPlatformClient &&

AppPlatformClient(std::shared_ptr< AppPlatformConnection >, Options)

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

Operators

operator=(AppPlatformClient const &)

Copy and move support

Parameter
Name Description
AppPlatformClient const &
Returns
Type Description
AppPlatformClient &

operator=(AppPlatformClient &&)

Copy and move support

Parameter
Name Description
AppPlatformClient &&
Returns
Type Description
AppPlatformClient &

Functions

ListApplications(std::string const &, Options)

Lists Applications in a given project and location.

Parameters
Name Description
parent std::string const &

Required. Parent value for ListApplicationsRequest.

opts Options

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

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

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

ListApplications(google::cloud::visionai::v1::ListApplicationsRequest, Options)

Lists Applications in a given project and location.

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

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.ListApplicationsRequest. 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::Application >

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

GetApplication(std::string const &, Options)

Gets details of a single Application.

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::Application >

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

GetApplication(google::cloud::visionai::v1::GetApplicationRequest const &, Options)

Gets details of a single Application.

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

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

CreateApplication(std::string const &, google::cloud::visionai::v1::Application const &, Options)

Creates a new Application in a given project and location.

Parameters
Name Description
parent std::string const &

Required. Value for parent.

application google::cloud::visionai::v1::Application const &

Required. The resource being created.

opts Options

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

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

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

CreateApplication(NoAwaitTag, std::string const &, google::cloud::visionai::v1::Application const &, Options)

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

CreateApplication(google::cloud::visionai::v1::CreateApplicationRequest const &, Options)

Creates a new Application in a given project and location.

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

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

CreateApplication(NoAwaitTag, google::cloud::visionai::v1::CreateApplicationRequest const &, Options)

Creates a new Application 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::CreateApplicationRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

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

Creates a new Application 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::Application > >

UpdateApplication(google::cloud::visionai::v1::Application const &, google::protobuf::FieldMask const &, Options)

Updates the parameters of a single Application.

Parameters
Name Description
application google::cloud::visionai::v1::Application const &

Required. The resource being updated.

update_mask google::protobuf::FieldMask const &

Optional. Field mask is used to specify the fields to be overwritten in the Application 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::Application > >

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

UpdateApplication(NoAwaitTag, google::cloud::visionai::v1::Application const &, google::protobuf::FieldMask const &, Options)

Updates the parameters of a single Application.

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

UpdateApplication(google::cloud::visionai::v1::UpdateApplicationRequest const &, Options)

Updates the parameters of a single Application.

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

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

UpdateApplication(NoAwaitTag, google::cloud::visionai::v1::UpdateApplicationRequest const &, Options)

Updates the parameters of a single Application.

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

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

Updates the parameters of a single Application.

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::Application > >

DeleteApplication(std::string const &, Options)

Deletes a single Application.

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.

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

Deletes a single Application.

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 >

DeleteApplication(google::cloud::visionai::v1::DeleteApplicationRequest const &, Options)

Deletes a single Application.

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

DeleteApplication(NoAwaitTag, google::cloud::visionai::v1::DeleteApplicationRequest const &, Options)

Deletes a single Application.

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

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

Deletes a single Application.

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 > >

DeployApplication(std::string const &, Options)

Deploys a single Application.

Parameters
Name Description
name std::string const &

Required. the name of the application to retrieve. Format: "projects/{project}/locations/{location}/applications/{application}"

opts Options

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

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

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

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

Deploys a single Application.

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 >

DeployApplication(google::cloud::visionai::v1::DeployApplicationRequest const &, Options)

Deploys a single Application.

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

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

DeployApplication(NoAwaitTag, google::cloud::visionai::v1::DeployApplicationRequest const &, Options)

Deploys a single Application.

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

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

Deploys a single Application.

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::DeployApplicationResponse > >

UndeployApplication(std::string const &, Options)

Undeploys a single Application.

Parameters
Name Description
name std::string const &

Required. the name of the application to retrieve. Format: "projects/{project}/locations/{location}/applications/{application}"

opts Options

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

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

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

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

Undeploys a single Application.

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 >

UndeployApplication(google::cloud::visionai::v1::UndeployApplicationRequest const &, Options)

Undeploys a single Application.

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

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

UndeployApplication(NoAwaitTag, google::cloud::visionai::v1::UndeployApplicationRequest const &, Options)

Undeploys a single Application.

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

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

Undeploys a single Application.

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::UndeployApplicationResponse > >

AddApplicationStreamInput(std::string const &, Options)

Adds target stream input to the Application.

If the Application is deployed, the corresponding new Application instance will be created. If the stream has already been in the Application, the RPC will fail.

Parameters
Name Description
name std::string const &

Required. the name of the application to retrieve. Format: "projects/{project}/locations/{location}/applications/{application}"

opts Options

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

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

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

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

Adds target stream input to the Application.

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 >

AddApplicationStreamInput(google::cloud::visionai::v1::AddApplicationStreamInputRequest const &, Options)

Adds target stream input to the Application.

If the Application is deployed, the corresponding new Application instance will be created. If the stream has already been in the Application, the RPC will fail.

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

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

AddApplicationStreamInput(NoAwaitTag, google::cloud::visionai::v1::AddApplicationStreamInputRequest const &, Options)

Adds target stream input to the Application.

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

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

Adds target stream input to the Application.

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::AddApplicationStreamInputResponse > >

RemoveApplicationStreamInput(std::string const &, Options)

Remove target stream input to the Application, if the Application is deployed, the corresponding instance based will be deleted.

If the stream is not in the Application, the RPC will fail.

Parameters
Name Description
name std::string const &

Required. the name of the application to retrieve. Format: "projects/{project}/locations/{location}/applications/{application}"

opts Options

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

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

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

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

Remove target stream input to the Application, if the Application is deployed, the corresponding instance based will be deleted.

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 >

RemoveApplicationStreamInput(google::cloud::visionai::v1::RemoveApplicationStreamInputRequest const &, Options)

Remove target stream input to the Application, if the Application is deployed, the corresponding instance based will be deleted.

If the stream is not in the Application, the RPC will fail.

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

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

RemoveApplicationStreamInput(NoAwaitTag, google::cloud::visionai::v1::RemoveApplicationStreamInputRequest const &, Options)

Remove target stream input to the Application, if the Application is deployed, the corresponding instance based will be deleted.

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

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

Remove target stream input to the Application, if the Application is deployed, the corresponding instance based will be deleted.

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::RemoveApplicationStreamInputResponse > >

UpdateApplicationStreamInput(std::string const &, Options)

Update target stream input to the Application, if the Application is deployed, the corresponding instance based will be deployed.

For CreateOrUpdate behavior, set allow_missing to true.

Parameters
Name Description
name std::string const &

Required. the name of the application to retrieve. Format: "projects/{project}/locations/{location}/applications/{application}"

opts Options

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

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

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

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

Update target stream input to the Application, if the Application is deployed, the corresponding instance based will be deployed.

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 >

UpdateApplicationStreamInput(google::cloud::visionai::v1::UpdateApplicationStreamInputRequest const &, Options)

Update target stream input to the Application, if the Application is deployed, the corresponding instance based will be deployed.

For CreateOrUpdate behavior, set allow_missing to true.

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

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

UpdateApplicationStreamInput(NoAwaitTag, google::cloud::visionai::v1::UpdateApplicationStreamInputRequest const &, Options)

Update target stream input to the Application, if the Application is deployed, the corresponding instance based will be deployed.

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

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

Update target stream input to the Application, if the Application is deployed, the corresponding instance based will be deployed.

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::UpdateApplicationStreamInputResponse > >

ListInstances(std::string const &, Options)

Lists Instances in a given project and location.

Parameters
Name Description
parent std::string const &

Required. Parent value for ListInstancesRequest.

opts Options

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

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

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

ListInstances(google::cloud::visionai::v1::ListInstancesRequest, Options)

Lists Instances in a given project and location.

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

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.ListInstancesRequest. 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::Instance >

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

GetInstance(std::string const &, Options)

Gets details of a single Instance.

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::Instance >

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

GetInstance(google::cloud::visionai::v1::GetInstanceRequest const &, Options)

Gets details of a single Instance.

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

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

CreateApplicationInstances(std::string const &, Options)

Adds target stream input to the Application.

If the Application is deployed, the corresponding new Application instance will be created. If the stream has already been in the Application, the RPC will fail.

Parameters
Name Description
name std::string const &

Required. the name of the application to retrieve. Format: "projects/{project}/locations/{location}/applications/{application}"

opts Options

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

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

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

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

Adds target stream input to the Application.

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 >

CreateApplicationInstances(google::cloud::visionai::v1::CreateApplicationInstancesRequest const &, Options)

Adds target stream input to the Application.

If the Application is deployed, the corresponding new Application instance will be created. If the stream has already been in the Application, the RPC will fail.

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

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

CreateApplicationInstances(NoAwaitTag, google::cloud::visionai::v1::CreateApplicationInstancesRequest const &, Options)

Adds target stream input to the Application.

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

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

Adds target stream input to the Application.

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::CreateApplicationInstancesResponse > >

DeleteApplicationInstances(std::string const &, Options)

Remove target stream input to the Application, if the Application is deployed, the corresponding instance based will be deleted.

If the stream is not in the Application, the RPC will fail.

Parameters
Name Description
name std::string const &

Required. the name of the application to retrieve. Format: "projects/{project}/locations/{location}/applications/{application}"

opts Options

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

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

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

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

Remove target stream input to the Application, if the Application is deployed, the corresponding instance based will be deleted.

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 >

DeleteApplicationInstances(google::cloud::visionai::v1::DeleteApplicationInstancesRequest const &, Options)

Remove target stream input to the Application, if the Application is deployed, the corresponding instance based will be deleted.

If the stream is not in the Application, the RPC will fail.

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

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

DeleteApplicationInstances(NoAwaitTag, google::cloud::visionai::v1::DeleteApplicationInstancesRequest const &, Options)

Remove target stream input to the Application, if the Application is deployed, the corresponding instance based will be deleted.

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

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

Remove target stream input to the Application, if the Application is deployed, the corresponding instance based will be deleted.

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::Instance > >

UpdateApplicationInstances(std::string const &, std::vector< google::cloud::visionai::v1::UpdateApplicationInstancesRequest::UpdateApplicationInstance > const &, Options)

Adds target stream input to the Application.

If the Application is deployed, the corresponding new Application instance will be created. If the stream has already been in the Application, the RPC will fail.

Parameters
Name Description
name std::string const &

Required. the name of the application to retrieve. Format: "projects/{project}/locations/{location}/applications/{application}"

application_instances std::vector< google::cloud::visionai::v1::UpdateApplicationInstancesRequest::UpdateApplicationInstance > const &
opts Options

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

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

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

UpdateApplicationInstances(NoAwaitTag, std::string const &, std::vector< google::cloud::visionai::v1::UpdateApplicationInstancesRequest::UpdateApplicationInstance > const &, Options)

Adds target stream input to the Application.

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

UpdateApplicationInstances(google::cloud::visionai::v1::UpdateApplicationInstancesRequest const &, Options)

Adds target stream input to the Application.

If the Application is deployed, the corresponding new Application instance will be created. If the stream has already been in the Application, the RPC will fail.

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

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

UpdateApplicationInstances(NoAwaitTag, google::cloud::visionai::v1::UpdateApplicationInstancesRequest const &, Options)

Adds target stream input to the Application.

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

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

Adds target stream input to the Application.

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::UpdateApplicationInstancesResponse > >

ListDrafts(std::string const &, Options)

Lists Drafts in a given project and location.

Parameters
Name Description
parent std::string const &

Required. Parent value for ListDraftsRequest.

opts Options

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

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

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

ListDrafts(google::cloud::visionai::v1::ListDraftsRequest, Options)

Lists Drafts in a given project and location.

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

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.ListDraftsRequest. 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::Draft >

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

GetDraft(std::string const &, Options)

Gets details of a single Draft.

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::Draft >

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

GetDraft(google::cloud::visionai::v1::GetDraftRequest const &, Options)

Gets details of a single Draft.

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

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

CreateDraft(std::string const &, google::cloud::visionai::v1::Draft const &, std::string const &, Options)

Creates a new Draft in a given project and location.

Parameters
Name Description
parent std::string const &

Required. Value for parent.

draft google::cloud::visionai::v1::Draft const &

Required. The resource being created.

draft_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::Draft > >

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

CreateDraft(NoAwaitTag, std::string const &, google::cloud::visionai::v1::Draft const &, std::string const &, Options)

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

CreateDraft(google::cloud::visionai::v1::CreateDraftRequest const &, Options)

Creates a new Draft in a given project and location.

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

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

CreateDraft(NoAwaitTag, google::cloud::visionai::v1::CreateDraftRequest const &, Options)

Creates a new Draft 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::CreateDraftRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

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

Creates a new Draft 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::Draft > >

UpdateDraft(google::cloud::visionai::v1::Draft const &, google::protobuf::FieldMask const &, Options)

Updates the parameters of a single Draft.

Parameters
Name Description
draft google::cloud::visionai::v1::Draft const &

Required. The resource being updated.

update_mask google::protobuf::FieldMask const &

Optional. Field mask is used to specify the fields to be overwritten in the Draft 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::Draft > >

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

UpdateDraft(NoAwaitTag, google::cloud::visionai::v1::Draft const &, google::protobuf::FieldMask const &, Options)

Updates the parameters of a single Draft.

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

UpdateDraft(google::cloud::visionai::v1::UpdateDraftRequest const &, Options)

Updates the parameters of a single Draft.

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

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

UpdateDraft(NoAwaitTag, google::cloud::visionai::v1::UpdateDraftRequest const &, Options)

Updates the parameters of a single Draft.

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

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

Updates the parameters of a single Draft.

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::Draft > >

DeleteDraft(std::string const &, Options)

Deletes a single Draft.

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.

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

Deletes a single Draft.

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 >

DeleteDraft(google::cloud::visionai::v1::DeleteDraftRequest const &, Options)

Deletes a single Draft.

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

DeleteDraft(NoAwaitTag, google::cloud::visionai::v1::DeleteDraftRequest const &, Options)

Deletes a single Draft.

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

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

Deletes a single Draft.

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 > >

ListProcessors(std::string const &, Options)

Lists Processors in a given project and location.

Parameters
Name Description
parent std::string const &

Required. Parent value for ListProcessorsRequest.

opts Options

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

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

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

ListProcessors(google::cloud::visionai::v1::ListProcessorsRequest, Options)

Lists Processors in a given project and location.

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

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.ListProcessorsRequest. 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::Processor >

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

ListPrebuiltProcessors(std::string const &, Options)

ListPrebuiltProcessors is a custom pass-through verb that Lists Prebuilt Processors.

Parameters
Name Description
parent std::string const &

Required. Parent path.

opts Options

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

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

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

ListPrebuiltProcessors(google::cloud::visionai::v1::ListPrebuiltProcessorsRequest const &, Options)

ListPrebuiltProcessors is a custom pass-through verb that Lists Prebuilt Processors.

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

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

GetProcessor(std::string const &, Options)

Gets details of a single Processor.

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::Processor >

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

GetProcessor(google::cloud::visionai::v1::GetProcessorRequest const &, Options)

Gets details of a single Processor.

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

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

CreateProcessor(std::string const &, google::cloud::visionai::v1::Processor const &, std::string const &, Options)

Creates a new Processor in a given project and location.

Parameters
Name Description
parent std::string const &

Required. Value for parent.

processor google::cloud::visionai::v1::Processor const &

Required. The resource being created.

processor_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::Processor > >

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

CreateProcessor(NoAwaitTag, std::string const &, google::cloud::visionai::v1::Processor const &, std::string const &, Options)

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

CreateProcessor(google::cloud::visionai::v1::CreateProcessorRequest const &, Options)

Creates a new Processor in a given project and location.

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

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

CreateProcessor(NoAwaitTag, google::cloud::visionai::v1::CreateProcessorRequest const &, Options)

Creates a new Processor 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::CreateProcessorRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

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

Creates a new Processor 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::Processor > >

UpdateProcessor(google::cloud::visionai::v1::Processor const &, google::protobuf::FieldMask const &, Options)

Updates the parameters of a single Processor.

Parameters
Name Description
processor google::cloud::visionai::v1::Processor const &

Required. The resource being updated.

update_mask google::protobuf::FieldMask const &

Optional. Field mask is used to specify the fields to be overwritten in the Processor 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::Processor > >

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

UpdateProcessor(NoAwaitTag, google::cloud::visionai::v1::Processor const &, google::protobuf::FieldMask const &, Options)

Updates the parameters of a single Processor.

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

UpdateProcessor(google::cloud::visionai::v1::UpdateProcessorRequest const &, Options)

Updates the parameters of a single Processor.

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

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

UpdateProcessor(NoAwaitTag, google::cloud::visionai::v1::UpdateProcessorRequest const &, Options)

Updates the parameters of a single Processor.

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

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

Updates the parameters of a single Processor.

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::Processor > >

DeleteProcessor(std::string const &, Options)

Deletes a single Processor.

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.

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

Deletes a single Processor.

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 >

DeleteProcessor(google::cloud::visionai::v1::DeleteProcessorRequest const &, Options)

Deletes a single Processor.

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

DeleteProcessor(NoAwaitTag, google::cloud::visionai::v1::DeleteProcessorRequest const &, Options)

Deletes a single Processor.

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

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

Deletes a single Processor.

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 > >

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.