Vision AI V1 API - Class Google::Cloud::VisionAI::V1::LiveVideoAnalytics::Client (v0.3.0)

Reference documentation and code samples for the Vision AI V1 API class Google::Cloud::VisionAI::V1::LiveVideoAnalytics::Client.

Client for the LiveVideoAnalytics service.

Service describing handlers for resources. The service enables clients to run Live Video Analytics (LVA) on the streaming inputs.

Inherits

  • Object

Includes

Methods

.configure

def self.configure() { |config| ... } -> Client::Configuration

Configure the LiveVideoAnalytics Client class.

See Configuration for a description of the configuration fields.

Yields
  • (config) — Configure the Client client.
Yield Parameter
Returns
Example 
# Modify the configuration for all LiveVideoAnalytics clients
::Google::Cloud::VisionAI::V1::LiveVideoAnalytics::Client.configure do |config|
  config.timeout = 10.0
end

#batch_run_process

def batch_run_process(request, options = nil) -> ::Gapic::Operation
def batch_run_process(parent: nil, requests: nil, options: nil) -> ::Gapic::Operation

Run all of the processes to "completion". Max time for each process is the LRO time limit.

Overloads 
def batch_run_process(request, options = nil) -> ::Gapic::Operation
Pass arguments to batch_run_process via a request object, either of type BatchRunProcessRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::VisionAI::V1::BatchRunProcessRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def batch_run_process(parent: nil, requests: nil, options: nil) -> ::Gapic::Operation
Pass arguments to batch_run_process via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/vision_ai/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::VisionAI::V1::LiveVideoAnalytics::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::VisionAI::V1::BatchRunProcessRequest.new

# Call the batch_run_process method.
result = client.batch_run_process request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#configure

def configure() { |config| ... } -> Client::Configuration

Configure the LiveVideoAnalytics Client instance.

The configuration is set to the derived mode, meaning that values can be changed, but structural changes (adding new fields, etc.) are not allowed. Structural changes should be made on Client.configure.

See Configuration for a description of the configuration fields.

Yields
  • (config) — Configure the Client client.
Yield Parameter
Returns

#create_analysis

def create_analysis(request, options = nil) -> ::Gapic::Operation
def create_analysis(parent: nil, analysis_id: nil, analysis: nil, request_id: nil) -> ::Gapic::Operation

Creates a new Analysis in a given project and location.

Overloads 
def create_analysis(request, options = nil) -> ::Gapic::Operation
Pass arguments to create_analysis via a request object, either of type CreateAnalysisRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::VisionAI::V1::CreateAnalysisRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def create_analysis(parent: nil, analysis_id: nil, analysis: nil, request_id: nil) -> ::Gapic::Operation
Pass arguments to create_analysis via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. Value for parent.
  • analysis_id (::String) — Required. Id of the requesting object.
  • analysis (::Google::Cloud::VisionAI::V1::Analysis, ::Hash) — Required. The resource being created.
  • request_id (::String) — Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.

    For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

    The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/vision_ai/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::VisionAI::V1::LiveVideoAnalytics::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::VisionAI::V1::CreateAnalysisRequest.new

# Call the create_analysis method.
result = client.create_analysis request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#create_operator

def create_operator(request, options = nil) -> ::Gapic::Operation
def create_operator(parent: nil, operator_id: nil, operator: nil, request_id: nil) -> ::Gapic::Operation

Creates a new Operator in a given project and location.

Overloads 
def create_operator(request, options = nil) -> ::Gapic::Operation
Pass arguments to create_operator via a request object, either of type CreateOperatorRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::VisionAI::V1::CreateOperatorRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def create_operator(parent: nil, operator_id: nil, operator: nil, request_id: nil) -> ::Gapic::Operation
Pass arguments to create_operator via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. Value for parent.
  • operator_id (::String) — Required. Id of the requesting object.
  • operator (::Google::Cloud::VisionAI::V1::Operator, ::Hash) — Required. The resource being created.
  • request_id (::String) — Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.

    For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

    The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/vision_ai/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::VisionAI::V1::LiveVideoAnalytics::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::VisionAI::V1::CreateOperatorRequest.new

# Call the create_operator method.
result = client.create_operator request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#create_process

def create_process(request, options = nil) -> ::Gapic::Operation
def create_process(parent: nil, process_id: nil, process: nil, request_id: nil) -> ::Gapic::Operation

Creates a new Process in a given project and location.

Overloads 
def create_process(request, options = nil) -> ::Gapic::Operation
Pass arguments to create_process via a request object, either of type CreateProcessRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::VisionAI::V1::CreateProcessRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def create_process(parent: nil, process_id: nil, process: nil, request_id: nil) -> ::Gapic::Operation
Pass arguments to create_process via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. Value for parent.
  • process_id (::String) — Required. Id of the requesting object.
  • process (::Google::Cloud::VisionAI::V1::Process, ::Hash) — Required. The resource being created.
  • request_id (::String) — Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.

    For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

    The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/vision_ai/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::VisionAI::V1::LiveVideoAnalytics::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::VisionAI::V1::CreateProcessRequest.new

# Call the create_process method.
result = client.create_process request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#delete_analysis

def delete_analysis(request, options = nil) -> ::Gapic::Operation
def delete_analysis(name: nil, request_id: nil) -> ::Gapic::Operation

Deletes a single Analysis.

Overloads 
def delete_analysis(request, options = nil) -> ::Gapic::Operation
Pass arguments to delete_analysis via a request object, either of type DeleteAnalysisRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::VisionAI::V1::DeleteAnalysisRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def delete_analysis(name: nil, request_id: nil) -> ::Gapic::Operation
Pass arguments to delete_analysis via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • name (::String) — Required. Name of the resource.
  • request_id (::String) — Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request.

    For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

    The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/vision_ai/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::VisionAI::V1::LiveVideoAnalytics::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::VisionAI::V1::DeleteAnalysisRequest.new

# Call the delete_analysis method.
result = client.delete_analysis request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#delete_operator

def delete_operator(request, options = nil) -> ::Gapic::Operation
def delete_operator(name: nil, request_id: nil) -> ::Gapic::Operation

Deletes a single Operator.

Overloads 
def delete_operator(request, options = nil) -> ::Gapic::Operation
Pass arguments to delete_operator via a request object, either of type DeleteOperatorRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::VisionAI::V1::DeleteOperatorRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def delete_operator(name: nil, request_id: nil) -> ::Gapic::Operation
Pass arguments to delete_operator via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • name (::String) — Required. Name of the resource
  • request_id (::String) — Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request.

    For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

    The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/vision_ai/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::VisionAI::V1::LiveVideoAnalytics::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::VisionAI::V1::DeleteOperatorRequest.new

# Call the delete_operator method.
result = client.delete_operator request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#delete_process

def delete_process(request, options = nil) -> ::Gapic::Operation
def delete_process(name: nil, request_id: nil) -> ::Gapic::Operation

Deletes a single Process.

Overloads 
def delete_process(request, options = nil) -> ::Gapic::Operation
Pass arguments to delete_process via a request object, either of type DeleteProcessRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::VisionAI::V1::DeleteProcessRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def delete_process(name: nil, request_id: nil) -> ::Gapic::Operation
Pass arguments to delete_process via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • name (::String) — Required. Name of the resource.
  • request_id (::String) — Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request.

    For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

    The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/vision_ai/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::VisionAI::V1::LiveVideoAnalytics::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::VisionAI::V1::DeleteProcessRequest.new

# Call the delete_process method.
result = client.delete_process request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#get_analysis

def get_analysis(request, options = nil) -> ::Google::Cloud::VisionAI::V1::Analysis
def get_analysis(name: nil) -> ::Google::Cloud::VisionAI::V1::Analysis

Gets details of a single Analysis.

Overloads 
def get_analysis(request, options = nil) -> ::Google::Cloud::VisionAI::V1::Analysis
Pass arguments to get_analysis via a request object, either of type GetAnalysisRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::VisionAI::V1::GetAnalysisRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def get_analysis(name: nil) -> ::Google::Cloud::VisionAI::V1::Analysis
Pass arguments to get_analysis via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameter
  • name (::String) — Required. Name of the resource.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/vision_ai/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::VisionAI::V1::LiveVideoAnalytics::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::VisionAI::V1::GetAnalysisRequest.new

# Call the get_analysis method.
result = client.get_analysis request

# The returned object is of type Google::Cloud::VisionAI::V1::Analysis.
p result

#get_operator

def get_operator(request, options = nil) -> ::Google::Cloud::VisionAI::V1::Operator
def get_operator(name: nil) -> ::Google::Cloud::VisionAI::V1::Operator

Gets details of a single Operator.

Overloads 
def get_operator(request, options = nil) -> ::Google::Cloud::VisionAI::V1::Operator
Pass arguments to get_operator via a request object, either of type GetOperatorRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::VisionAI::V1::GetOperatorRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def get_operator(name: nil) -> ::Google::Cloud::VisionAI::V1::Operator
Pass arguments to get_operator via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameter
  • name (::String) — Required. Name of the resource.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/vision_ai/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::VisionAI::V1::LiveVideoAnalytics::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::VisionAI::V1::GetOperatorRequest.new

# Call the get_operator method.
result = client.get_operator request

# The returned object is of type Google::Cloud::VisionAI::V1::Operator.
p result

#get_process

def get_process(request, options = nil) -> ::Google::Cloud::VisionAI::V1::Process
def get_process(name: nil) -> ::Google::Cloud::VisionAI::V1::Process

Gets details of a single Process.

Overloads 
def get_process(request, options = nil) -> ::Google::Cloud::VisionAI::V1::Process
Pass arguments to get_process via a request object, either of type GetProcessRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::VisionAI::V1::GetProcessRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def get_process(name: nil) -> ::Google::Cloud::VisionAI::V1::Process
Pass arguments to get_process via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameter
  • name (::String) — Required. Name of the resource.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/vision_ai/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::VisionAI::V1::LiveVideoAnalytics::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::VisionAI::V1::GetProcessRequest.new

# Call the get_process method.
result = client.get_process request

# The returned object is of type Google::Cloud::VisionAI::V1::Process.
p result

#iam_policy_client

def iam_policy_client() -> Google::Iam::V1::IAMPolicy::Client

Get the associated client for mix-in of the IAMPolicy.

Returns
  • (Google::Iam::V1::IAMPolicy::Client)

#initialize

def initialize() { |config| ... } -> Client

Create a new LiveVideoAnalytics client object.

Yields
  • (config) — Configure the LiveVideoAnalytics client.
Yield Parameter
Returns
  • (Client) — a new instance of Client
Example 
# Create a client using the default configuration
client = ::Google::Cloud::VisionAI::V1::LiveVideoAnalytics::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::VisionAI::V1::LiveVideoAnalytics::Client.new do |config|
  config.timeout = 10.0
end

#list_analyses

def list_analyses(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::VisionAI::V1::Analysis>
def list_analyses(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::VisionAI::V1::Analysis>

Lists Analyses in a given project and location.

Overloads 
def list_analyses(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::VisionAI::V1::Analysis>
Pass arguments to list_analyses via a request object, either of type Google::Cloud::VisionAI::V1::ListAnalysesRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::VisionAI::V1::ListAnalysesRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def list_analyses(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::VisionAI::V1::Analysis>
Pass arguments to list_analyses via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. Parent value for ListAnalysesRequest
  • page_size (::Integer) — Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
  • page_token (::String) — A token identifying a page of results the server should return.
  • filter (::String) — Filtering results
  • order_by (::String) — Hint for how to order the results
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/vision_ai/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::VisionAI::V1::LiveVideoAnalytics::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::VisionAI::V1::ListAnalysesRequest.new

# Call the list_analyses method.
result = client.list_analyses request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::VisionAI::V1::Analysis.
  p item
end

#list_operators

def list_operators(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::VisionAI::V1::Operator>
def list_operators(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::VisionAI::V1::Operator>

Lists Operators in a given project and location.

Overloads 
def list_operators(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::VisionAI::V1::Operator>
Pass arguments to list_operators via a request object, either of type Google::Cloud::VisionAI::V1::ListOperatorsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::VisionAI::V1::ListOperatorsRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def list_operators(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::VisionAI::V1::Operator>
Pass arguments to list_operators via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. Parent value for ListOperatorsRequest.
  • page_size (::Integer) — Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
  • page_token (::String) — A token identifying a page of results the server should return.
  • filter (::String) — Filtering results.
  • order_by (::String) — Hint for how to order the results.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/vision_ai/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::VisionAI::V1::LiveVideoAnalytics::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::VisionAI::V1::ListOperatorsRequest.new

# Call the list_operators method.
result = client.list_operators request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::VisionAI::V1::Operator.
  p item
end

#list_processes

def list_processes(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::VisionAI::V1::Process>
def list_processes(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::VisionAI::V1::Process>

Lists Processes in a given project and location.

Overloads 
def list_processes(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::VisionAI::V1::Process>
Pass arguments to list_processes via a request object, either of type Google::Cloud::VisionAI::V1::ListProcessesRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::VisionAI::V1::ListProcessesRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def list_processes(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::VisionAI::V1::Process>
Pass arguments to list_processes via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. Parent value for ListProcessesRequest.
  • page_size (::Integer) — Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
  • page_token (::String) — A token identifying a page of results the server should return.
  • filter (::String) — Filtering results
  • order_by (::String) — Hint for how to order the results
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/vision_ai/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::VisionAI::V1::LiveVideoAnalytics::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::VisionAI::V1::ListProcessesRequest.new

# Call the list_processes method.
result = client.list_processes request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::VisionAI::V1::Process.
  p item
end

#list_public_operators

def list_public_operators(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::VisionAI::V1::Operator>
def list_public_operators(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::VisionAI::V1::Operator>

ListPublicOperators returns all the operators in public registry.

Overloads 
def list_public_operators(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::VisionAI::V1::Operator>
Pass arguments to list_public_operators via a request object, either of type Google::Cloud::VisionAI::V1::ListPublicOperatorsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::VisionAI::V1::ListPublicOperatorsRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def list_public_operators(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::VisionAI::V1::Operator>
Pass arguments to list_public_operators via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. Parent value for ListPublicOperatorsRequest.
  • page_size (::Integer) — Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
  • page_token (::String) — A token identifying a page of results the server should return.
  • filter (::String) — Filtering results.
  • order_by (::String) — Hint for how to order the results.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/vision_ai/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::VisionAI::V1::LiveVideoAnalytics::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::VisionAI::V1::ListPublicOperatorsRequest.new

# Call the list_public_operators method.
result = client.list_public_operators request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::VisionAI::V1::Operator.
  p item
end

#location_client

def location_client() -> Google::Cloud::Location::Locations::Client

Get the associated client for mix-in of the Locations.

Returns
  • (Google::Cloud::Location::Locations::Client)

#logger

def logger() -> Logger

The logger used for request/response debug logging.

Returns
  • (Logger)

#operations_client

def operations_client() -> ::Google::Cloud::VisionAI::V1::LiveVideoAnalytics::Operations

Get the associated client for long-running operations.

Returns

#resolve_operator_info

def resolve_operator_info(request, options = nil) -> ::Google::Cloud::VisionAI::V1::ResolveOperatorInfoResponse
def resolve_operator_info(parent: nil, queries: nil) -> ::Google::Cloud::VisionAI::V1::ResolveOperatorInfoResponse

ResolveOperatorInfo returns the operator information based on the request.

Overloads 
def resolve_operator_info(request, options = nil) -> ::Google::Cloud::VisionAI::V1::ResolveOperatorInfoResponse
Pass arguments to resolve_operator_info via a request object, either of type ResolveOperatorInfoRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::VisionAI::V1::ResolveOperatorInfoRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def resolve_operator_info(parent: nil, queries: nil) -> ::Google::Cloud::VisionAI::V1::ResolveOperatorInfoResponse
Pass arguments to resolve_operator_info via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/vision_ai/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::VisionAI::V1::LiveVideoAnalytics::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::VisionAI::V1::ResolveOperatorInfoRequest.new

# Call the resolve_operator_info method.
result = client.resolve_operator_info request

# The returned object is of type Google::Cloud::VisionAI::V1::ResolveOperatorInfoResponse.
p result

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns
  • (String)

#update_analysis

def update_analysis(request, options = nil) -> ::Gapic::Operation
def update_analysis(update_mask: nil, analysis: nil, request_id: nil) -> ::Gapic::Operation

Updates the parameters of a single Analysis.

Overloads 
def update_analysis(request, options = nil) -> ::Gapic::Operation
Pass arguments to update_analysis via a request object, either of type UpdateAnalysisRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::VisionAI::V1::UpdateAnalysisRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def update_analysis(update_mask: nil, analysis: nil, request_id: nil) -> ::Gapic::Operation
Pass arguments to update_analysis via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • update_mask (::Google::Protobuf::FieldMask, ::Hash) — Required. Field mask is used to specify the fields to be overwritten in the Analysis resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.
  • analysis (::Google::Cloud::VisionAI::V1::Analysis, ::Hash) — Required. The resource being updated.
  • request_id (::String) — Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.

    For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

    The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/vision_ai/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::VisionAI::V1::LiveVideoAnalytics::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::VisionAI::V1::UpdateAnalysisRequest.new

# Call the update_analysis method.
result = client.update_analysis request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#update_operator

def update_operator(request, options = nil) -> ::Gapic::Operation
def update_operator(update_mask: nil, operator: nil, request_id: nil) -> ::Gapic::Operation

Updates the parameters of a single Operator.

Overloads 
def update_operator(request, options = nil) -> ::Gapic::Operation
Pass arguments to update_operator via a request object, either of type UpdateOperatorRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::VisionAI::V1::UpdateOperatorRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def update_operator(update_mask: nil, operator: nil, request_id: nil) -> ::Gapic::Operation
Pass arguments to update_operator via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • update_mask (::Google::Protobuf::FieldMask, ::Hash) — Required. Field mask is used to specify the fields to be overwritten in the Operator resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.
  • operator (::Google::Cloud::VisionAI::V1::Operator, ::Hash) — Required. The resource being updated
  • request_id (::String) — Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.

    For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

    The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/vision_ai/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::VisionAI::V1::LiveVideoAnalytics::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::VisionAI::V1::UpdateOperatorRequest.new

# Call the update_operator method.
result = client.update_operator request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#update_process

def update_process(request, options = nil) -> ::Gapic::Operation
def update_process(update_mask: nil, process: nil, request_id: nil) -> ::Gapic::Operation

Updates the parameters of a single Process.

Overloads 
def update_process(request, options = nil) -> ::Gapic::Operation
Pass arguments to update_process via a request object, either of type UpdateProcessRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::VisionAI::V1::UpdateProcessRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def update_process(update_mask: nil, process: nil, request_id: nil) -> ::Gapic::Operation
Pass arguments to update_process via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • update_mask (::Google::Protobuf::FieldMask, ::Hash) — Required. Field mask is used to specify the fields to be overwritten in the Process resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.
  • process (::Google::Cloud::VisionAI::V1::Process, ::Hash) — Required. The resource being updated.
  • request_id (::String) — Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.

    For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

    The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/vision_ai/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::VisionAI::V1::LiveVideoAnalytics::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::VisionAI::V1::UpdateProcessRequest.new

# Call the update_process method.
result = client.update_process request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end