Service describing handlers for resources.
Vision API and Vision AI API are two independent APIs developed by the same team. Vision API is for people to annotate their image while Vision AI is an e2e solution for customer to build their own computer vision application.
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
StreamsServiceClient(StreamsServiceClient const &)
Copy and move support
| Parameter | |
|---|---|
| Name | Description |
|
StreamsServiceClient const &
|
StreamsServiceClient(StreamsServiceClient &&)
Copy and move support
| Parameter | |
|---|---|
| Name | Description |
|
StreamsServiceClient &&
|
StreamsServiceClient(std::shared_ptr< StreamsServiceConnection >, Options)
| Parameters | |
|---|---|
| Name | Description |
connection |
std::shared_ptr< StreamsServiceConnection >
|
opts |
Options
|
Operators
operator=(StreamsServiceClient const &)
Copy and move support
| Parameter | |
|---|---|
| Name | Description |
|
StreamsServiceClient const &
|
| Returns | |
|---|---|
| Type | Description |
StreamsServiceClient & |
|
operator=(StreamsServiceClient &&)
Copy and move support
| Parameter | |
|---|---|
| Name | Description |
|
StreamsServiceClient &&
|
| Returns | |
|---|---|
| Type | Description |
StreamsServiceClient & |
|
Functions
ListClusters(std::string const &, Options)
Lists Clusters in a given project and location.
| Parameters | |
|---|---|
| Name | Description |
parent |
std::string const &
Required. Parent value for ListClustersRequest. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StreamRange< google::cloud::visionai::v1::Cluster > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListClusters(google::cloud::visionai::v1::ListClustersRequest, Options)
Lists Clusters in a given project and location.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::visionai::v1::ListClustersRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StreamRange< google::cloud::visionai::v1::Cluster > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
GetCluster(std::string const &, Options)
Gets details of a single Cluster.
| 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::Cluster > |
the result of the RPC. The response message type (google.cloud.visionai.v1.Cluster) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetCluster(google::cloud::visionai::v1::GetClusterRequest const &, Options)
Gets details of a single Cluster.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::visionai::v1::GetClusterRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::cloud::visionai::v1::Cluster > |
the result of the RPC. The response message type (google.cloud.visionai.v1.Cluster) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
CreateCluster(std::string const &, google::cloud::visionai::v1::Cluster const &, std::string const &, Options)
Creates a new Cluster in a given project and location.
| Parameters | |
|---|---|
| Name | Description |
parent |
std::string const &
Required. Value for parent. |
cluster |
google::cloud::visionai::v1::Cluster const &
Required. The resource being created. |
cluster_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::Cluster > > |
A |
CreateCluster(NoAwaitTag, std::string const &, google::cloud::visionai::v1::Cluster const &, std::string const &, Options)
Creates a new Cluster 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 &
|
cluster |
google::cloud::visionai::v1::Cluster const &
|
cluster_id |
std::string const &
|
opts |
Options
|
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::longrunning::Operation > |
|
CreateCluster(google::cloud::visionai::v1::CreateClusterRequest const &, Options)
Creates a new Cluster in a given project and location.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::visionai::v1::CreateClusterRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
future< StatusOr< google::cloud::visionai::v1::Cluster > > |
A |
CreateCluster(NoAwaitTag, google::cloud::visionai::v1::CreateClusterRequest const &, Options)
Creates a new Cluster 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::CreateClusterRequest const &
|
opts |
Options
|
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::longrunning::Operation > |
|
CreateCluster(google::longrunning::Operation const &, Options)
Creates a new Cluster 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::Cluster > > |
|
UpdateCluster(google::cloud::visionai::v1::Cluster const &, google::protobuf::FieldMask const &, Options)
Updates the parameters of a single Cluster.
| Parameters | |
|---|---|
| Name | Description |
cluster |
google::cloud::visionai::v1::Cluster const &
Required. The resource being updated |
update_mask |
google::protobuf::FieldMask const &
Required. Field mask is used to specify the fields to be overwritten in the Cluster 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::Cluster > > |
A |
UpdateCluster(NoAwaitTag, google::cloud::visionai::v1::Cluster const &, google::protobuf::FieldMask const &, Options)
Updates the parameters of a single Cluster.
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
|
cluster |
google::cloud::visionai::v1::Cluster const &
|
update_mask |
google::protobuf::FieldMask const &
|
opts |
Options
|
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::longrunning::Operation > |
|
UpdateCluster(google::cloud::visionai::v1::UpdateClusterRequest const &, Options)
Updates the parameters of a single Cluster.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::visionai::v1::UpdateClusterRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
future< StatusOr< google::cloud::visionai::v1::Cluster > > |
A |
UpdateCluster(NoAwaitTag, google::cloud::visionai::v1::UpdateClusterRequest const &, Options)
Updates the parameters of a single Cluster.
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::UpdateClusterRequest const &
|
opts |
Options
|
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::longrunning::Operation > |
|
UpdateCluster(google::longrunning::Operation const &, Options)
Updates the parameters of a single Cluster.
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::Cluster > > |
|
DeleteCluster(std::string const &, Options)
Deletes a single Cluster.
| 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 |
DeleteCluster(NoAwaitTag, std::string const &, Options)
Deletes a single Cluster.
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 > |
|
DeleteCluster(google::cloud::visionai::v1::DeleteClusterRequest const &, Options)
Deletes a single Cluster.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::visionai::v1::DeleteClusterRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
future< StatusOr< google::cloud::visionai::v1::OperationMetadata > > |
A |
DeleteCluster(NoAwaitTag, google::cloud::visionai::v1::DeleteClusterRequest const &, Options)
Deletes a single Cluster.
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::DeleteClusterRequest const &
|
opts |
Options
|
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::longrunning::Operation > |
|
DeleteCluster(google::longrunning::Operation const &, Options)
Deletes a single Cluster.
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 > > |
|
ListStreams(std::string const &, Options)
Lists Streams in a given project and location.
| Parameters | |
|---|---|
| Name | Description |
parent |
std::string const &
Required. Parent value for ListStreamsRequest. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StreamRange< google::cloud::visionai::v1::Stream > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListStreams(google::cloud::visionai::v1::ListStreamsRequest, Options)
Lists Streams in a given project and location.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::visionai::v1::ListStreamsRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StreamRange< google::cloud::visionai::v1::Stream > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
GetStream(std::string const &, Options)
Gets details of a single Stream.
| 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::Stream > |
the result of the RPC. The response message type (google.cloud.visionai.v1.Stream) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetStream(google::cloud::visionai::v1::GetStreamRequest const &, Options)
Gets details of a single Stream.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::visionai::v1::GetStreamRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::cloud::visionai::v1::Stream > |
the result of the RPC. The response message type (google.cloud.visionai.v1.Stream) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
CreateStream(std::string const &, google::cloud::visionai::v1::Stream const &, std::string const &, Options)
Creates a new Stream in a given project and location.
| Parameters | |
|---|---|
| Name | Description |
parent |
std::string const &
Required. Value for parent. |
stream |
google::cloud::visionai::v1::Stream const &
Required. The resource being created. |
stream_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::Stream > > |
A |
CreateStream(NoAwaitTag, std::string const &, google::cloud::visionai::v1::Stream const &, std::string const &, Options)
Creates a new Stream 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 &
|
stream |
google::cloud::visionai::v1::Stream const &
|
stream_id |
std::string const &
|
opts |
Options
|
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::longrunning::Operation > |
|
CreateStream(google::cloud::visionai::v1::CreateStreamRequest const &, Options)
Creates a new Stream in a given project and location.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::visionai::v1::CreateStreamRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
future< StatusOr< google::cloud::visionai::v1::Stream > > |
A |
CreateStream(NoAwaitTag, google::cloud::visionai::v1::CreateStreamRequest const &, Options)
Creates a new Stream 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::CreateStreamRequest const &
|
opts |
Options
|
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::longrunning::Operation > |
|
CreateStream(google::longrunning::Operation const &, Options)
Creates a new Stream 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::Stream > > |
|
UpdateStream(google::cloud::visionai::v1::Stream const &, google::protobuf::FieldMask const &, Options)
Updates the parameters of a single Stream.
| Parameters | |
|---|---|
| Name | Description |
stream |
google::cloud::visionai::v1::Stream const &
Required. The resource being updated. |
update_mask |
google::protobuf::FieldMask const &
Required. Field mask is used to specify the fields to be overwritten in the Stream 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::Stream > > |
A |
UpdateStream(NoAwaitTag, google::cloud::visionai::v1::Stream const &, google::protobuf::FieldMask const &, Options)
Updates the parameters of a single Stream.
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
|
stream |
google::cloud::visionai::v1::Stream const &
|
update_mask |
google::protobuf::FieldMask const &
|
opts |
Options
|
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::longrunning::Operation > |
|
UpdateStream(google::cloud::visionai::v1::UpdateStreamRequest const &, Options)
Updates the parameters of a single Stream.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::visionai::v1::UpdateStreamRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
future< StatusOr< google::cloud::visionai::v1::Stream > > |
A |
UpdateStream(NoAwaitTag, google::cloud::visionai::v1::UpdateStreamRequest const &, Options)
Updates the parameters of a single Stream.
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::UpdateStreamRequest const &
|
opts |
Options
|
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::longrunning::Operation > |
|
UpdateStream(google::longrunning::Operation const &, Options)
Updates the parameters of a single Stream.
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::Stream > > |
|
DeleteStream(std::string const &, Options)
Deletes a single Stream.
| 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 |
DeleteStream(NoAwaitTag, std::string const &, Options)
Deletes a single Stream.
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 > |
|
DeleteStream(google::cloud::visionai::v1::DeleteStreamRequest const &, Options)
Deletes a single Stream.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::visionai::v1::DeleteStreamRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
future< StatusOr< google::cloud::visionai::v1::OperationMetadata > > |
A |
DeleteStream(NoAwaitTag, google::cloud::visionai::v1::DeleteStreamRequest const &, Options)
Deletes a single Stream.
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::DeleteStreamRequest const &
|
opts |
Options
|
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::longrunning::Operation > |
|
DeleteStream(google::longrunning::Operation const &, Options)
Deletes a single Stream.
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 > > |
|
GetStreamThumbnail(std::string const &, std::string const &, Options)
Gets the thumbnail (image snapshot) of a single Stream.
| Parameters | |
|---|---|
| Name | Description |
stream |
std::string const &
Required. The name of the stream for to get the thumbnail from. |
gcs_object_name |
std::string const &
Required. The name of the GCS object to store the thumbnail image. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
future< StatusOr< google::cloud::visionai::v1::GetStreamThumbnailResponse > > |
A |
GetStreamThumbnail(NoAwaitTag, std::string const &, std::string const &, Options)
Gets the thumbnail (image snapshot) of a single Stream.
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
|
stream |
std::string const &
|
gcs_object_name |
std::string const &
|
opts |
Options
|
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::longrunning::Operation > |
|
GetStreamThumbnail(google::cloud::visionai::v1::GetStreamThumbnailRequest const &, Options)
Gets the thumbnail (image snapshot) of a single Stream.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::visionai::v1::GetStreamThumbnailRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
future< StatusOr< google::cloud::visionai::v1::GetStreamThumbnailResponse > > |
A |
GetStreamThumbnail(NoAwaitTag, google::cloud::visionai::v1::GetStreamThumbnailRequest const &, Options)
Gets the thumbnail (image snapshot) of a single Stream.
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::GetStreamThumbnailRequest const &
|
opts |
Options
|
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::longrunning::Operation > |
|
GetStreamThumbnail(google::longrunning::Operation const &, Options)
Gets the thumbnail (image snapshot) of a single Stream.
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::GetStreamThumbnailResponse > > |
|
GenerateStreamHlsToken(std::string const &, Options)
Generate the JWT auth token required to get the stream HLS contents.
| Parameters | |
|---|---|
| Name | Description |
stream |
std::string const &
Required. The name of the stream. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::cloud::visionai::v1::GenerateStreamHlsTokenResponse > |
the result of the RPC. The response message type (google.cloud.visionai.v1.GenerateStreamHlsTokenResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GenerateStreamHlsToken(google::cloud::visionai::v1::GenerateStreamHlsTokenRequest const &, Options)
Generate the JWT auth token required to get the stream HLS contents.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::visionai::v1::GenerateStreamHlsTokenRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::cloud::visionai::v1::GenerateStreamHlsTokenResponse > |
the result of the RPC. The response message type (google.cloud.visionai.v1.GenerateStreamHlsTokenResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
ListEvents(std::string const &, Options)
Lists Events in a given project and location.
| Parameters | |
|---|---|
| Name | Description |
parent |
std::string const &
Required. Parent value for ListEventsRequest. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StreamRange< google::cloud::visionai::v1::Event > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListEvents(google::cloud::visionai::v1::ListEventsRequest, Options)
Lists Events in a given project and location.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::visionai::v1::ListEventsRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StreamRange< google::cloud::visionai::v1::Event > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
GetEvent(std::string const &, Options)
Gets details of a single Event.
| 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::Event > |
the result of the RPC. The response message type (google.cloud.visionai.v1.Event) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetEvent(google::cloud::visionai::v1::GetEventRequest const &, Options)
Gets details of a single Event.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::visionai::v1::GetEventRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::cloud::visionai::v1::Event > |
the result of the RPC. The response message type (google.cloud.visionai.v1.Event) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
CreateEvent(std::string const &, google::cloud::visionai::v1::Event const &, std::string const &, Options)
Creates a new Event in a given project and location.
| Parameters | |
|---|---|
| Name | Description |
parent |
std::string const &
Required. Value for parent. |
event |
google::cloud::visionai::v1::Event const &
Required. The resource being created. |
event_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::Event > > |
A |
CreateEvent(NoAwaitTag, std::string const &, google::cloud::visionai::v1::Event const &, std::string const &, Options)
Creates a new Event 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 &
|
event |
google::cloud::visionai::v1::Event const &
|
event_id |
std::string const &
|
opts |
Options
|
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::longrunning::Operation > |
|
CreateEvent(google::cloud::visionai::v1::CreateEventRequest const &, Options)
Creates a new Event in a given project and location.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::visionai::v1::CreateEventRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
future< StatusOr< google::cloud::visionai::v1::Event > > |
A |
CreateEvent(NoAwaitTag, google::cloud::visionai::v1::CreateEventRequest const &, Options)
Creates a new Event 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::CreateEventRequest const &
|
opts |
Options
|
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::longrunning::Operation > |
|
CreateEvent(google::longrunning::Operation const &, Options)
Creates a new Event 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::Event > > |
|
UpdateEvent(google::cloud::visionai::v1::Event const &, google::protobuf::FieldMask const &, Options)
Updates the parameters of a single Event.
| Parameters | |
|---|---|
| Name | Description |
event |
google::cloud::visionai::v1::Event const &
Required. The resource being updated. |
update_mask |
google::protobuf::FieldMask const &
Required. Field mask is used to specify the fields to be overwritten in the Event 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::Event > > |
A |
UpdateEvent(NoAwaitTag, google::cloud::visionai::v1::Event const &, google::protobuf::FieldMask const &, Options)
Updates the parameters of a single Event.
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
|
event |
google::cloud::visionai::v1::Event const &
|
update_mask |
google::protobuf::FieldMask const &
|
opts |
Options
|
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::longrunning::Operation > |
|
UpdateEvent(google::cloud::visionai::v1::UpdateEventRequest const &, Options)
Updates the parameters of a single Event.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::visionai::v1::UpdateEventRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
future< StatusOr< google::cloud::visionai::v1::Event > > |
A |
UpdateEvent(NoAwaitTag, google::cloud::visionai::v1::UpdateEventRequest const &, Options)
Updates the parameters of a single Event.
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::UpdateEventRequest const &
|
opts |
Options
|
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::longrunning::Operation > |
|
UpdateEvent(google::longrunning::Operation const &, Options)
Updates the parameters of a single Event.
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::Event > > |
|
DeleteEvent(std::string const &, Options)
Deletes a single Event.
| 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 |
DeleteEvent(NoAwaitTag, std::string const &, Options)
Deletes a single Event.
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 > |
|
DeleteEvent(google::cloud::visionai::v1::DeleteEventRequest const &, Options)
Deletes a single Event.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::visionai::v1::DeleteEventRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
future< StatusOr< google::cloud::visionai::v1::OperationMetadata > > |
A |
DeleteEvent(NoAwaitTag, google::cloud::visionai::v1::DeleteEventRequest const &, Options)
Deletes a single Event.
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::DeleteEventRequest const &
|
opts |
Options
|
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::longrunning::Operation > |
|
DeleteEvent(google::longrunning::Operation const &, Options)
Deletes a single Event.
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 > > |
|
ListSeries(std::string const &, Options)
Lists Series in a given project and location.
| Parameters | |
|---|---|
| Name | Description |
parent |
std::string const &
Required. Parent value for ListSeriesRequest. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StreamRange< google::cloud::visionai::v1::Series > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListSeries(google::cloud::visionai::v1::ListSeriesRequest, Options)
Lists Series in a given project and location.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::visionai::v1::ListSeriesRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StreamRange< google::cloud::visionai::v1::Series > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
GetSeries(std::string const &, Options)
Gets details of a single Series.
| 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::Series > |
the result of the RPC. The response message type (google.cloud.visionai.v1.Series) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetSeries(google::cloud::visionai::v1::GetSeriesRequest const &, Options)
Gets details of a single Series.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::visionai::v1::GetSeriesRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::cloud::visionai::v1::Series > |
the result of the RPC. The response message type (google.cloud.visionai.v1.Series) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
CreateSeries(std::string const &, google::cloud::visionai::v1::Series const &, std::string const &, Options)
Creates a new Series in a given project and location.
| Parameters | |
|---|---|
| Name | Description |
parent |
std::string const &
Required. Value for parent. |
series |
google::cloud::visionai::v1::Series const &
Required. The resource being created. |
series_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::Series > > |
A |
CreateSeries(NoAwaitTag, std::string const &, google::cloud::visionai::v1::Series const &, std::string const &, Options)
Creates a new Series 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 &
|
series |
google::cloud::visionai::v1::Series const &
|
series_id |
std::string const &
|
opts |
Options
|
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::longrunning::Operation > |
|
CreateSeries(google::cloud::visionai::v1::CreateSeriesRequest const &, Options)
Creates a new Series in a given project and location.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::visionai::v1::CreateSeriesRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
future< StatusOr< google::cloud::visionai::v1::Series > > |
A |
CreateSeries(NoAwaitTag, google::cloud::visionai::v1::CreateSeriesRequest const &, Options)
Creates a new Series 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::CreateSeriesRequest const &
|
opts |
Options
|
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::longrunning::Operation > |
|
CreateSeries(google::longrunning::Operation const &, Options)
Creates a new Series 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::Series > > |
|
UpdateSeries(google::cloud::visionai::v1::Series const &, google::protobuf::FieldMask const &, Options)
Updates the parameters of a single Event.
| Parameters | |
|---|---|
| Name | Description |
series |
google::cloud::visionai::v1::Series const &
Required. The resource being updated |
update_mask |
google::protobuf::FieldMask const &
Required. Field mask is used to specify the fields to be overwritten in the Series 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::Series > > |
A |
UpdateSeries(NoAwaitTag, google::cloud::visionai::v1::Series const &, google::protobuf::FieldMask const &, Options)
Updates the parameters of a single Event.
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
|
series |
google::cloud::visionai::v1::Series const &
|
update_mask |
google::protobuf::FieldMask const &
|
opts |
Options
|
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::longrunning::Operation > |
|
UpdateSeries(google::cloud::visionai::v1::UpdateSeriesRequest const &, Options)
Updates the parameters of a single Event.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::visionai::v1::UpdateSeriesRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
future< StatusOr< google::cloud::visionai::v1::Series > > |
A |
UpdateSeries(NoAwaitTag, google::cloud::visionai::v1::UpdateSeriesRequest const &, Options)
Updates the parameters of a single Event.
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::UpdateSeriesRequest const &
|
opts |
Options
|
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::longrunning::Operation > |
|
UpdateSeries(google::longrunning::Operation const &, Options)
Updates the parameters of a single Event.
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::Series > > |
|
DeleteSeries(std::string const &, Options)
Deletes a single Series.
| 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 |
DeleteSeries(NoAwaitTag, std::string const &, Options)
Deletes a single Series.
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 > |
|
DeleteSeries(google::cloud::visionai::v1::DeleteSeriesRequest const &, Options)
Deletes a single Series.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::visionai::v1::DeleteSeriesRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
future< StatusOr< google::cloud::visionai::v1::OperationMetadata > > |
A |
DeleteSeries(NoAwaitTag, google::cloud::visionai::v1::DeleteSeriesRequest const &, Options)
Deletes a single Series.
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::DeleteSeriesRequest const &
|
opts |
Options
|
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::longrunning::Operation > |
|
DeleteSeries(google::longrunning::Operation const &, Options)
Deletes a single Series.
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 > > |
|
MaterializeChannel(std::string const &, google::cloud::visionai::v1::Channel const &, std::string const &, Options)
Materialize a channel.
| Parameters | |
|---|---|
| Name | Description |
parent |
std::string const &
Required. Value for parent. |
channel |
google::cloud::visionai::v1::Channel const &
Required. The resource being created. |
channel_id |
std::string const &
Required. Id of the channel. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
future< StatusOr< google::cloud::visionai::v1::Channel > > |
A |
MaterializeChannel(NoAwaitTag, std::string const &, google::cloud::visionai::v1::Channel const &, std::string const &, Options)
Materialize a channel.
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 &
|
channel |
google::cloud::visionai::v1::Channel const &
|
channel_id |
std::string const &
|
opts |
Options
|
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::longrunning::Operation > |
|
MaterializeChannel(google::cloud::visionai::v1::MaterializeChannelRequest const &, Options)
Materialize a channel.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::visionai::v1::MaterializeChannelRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
future< StatusOr< google::cloud::visionai::v1::Channel > > |
A |
MaterializeChannel(NoAwaitTag, google::cloud::visionai::v1::MaterializeChannelRequest const &, Options)
Materialize a channel.
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::MaterializeChannelRequest const &
|
opts |
Options
|
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::longrunning::Operation > |
|
MaterializeChannel(google::longrunning::Operation const &, Options)
Materialize a channel.
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::Channel > > |
|
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
Status |
a |
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 |
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 |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
Status |
a |