Vision AI V1 API - Class Google::Cloud::VisionAI::V1::AppPlatform::Client (v0.2.0)

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

Client for the AppPlatform service.

Service describing handlers for resources

Inherits

  • Object

Includes

Methods

.configure

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

Configure the AppPlatform 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 AppPlatform clients
::Google::Cloud::VisionAI::V1::AppPlatform::Client.configure do |config|
  config.timeout = 10.0
end

#add_application_stream_input

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

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

Overloads 
def add_application_stream_input(request, options = nil) -> ::Gapic::Operation
Pass arguments to add_application_stream_input via a request object, either of type Google::Cloud::VisionAI::V1::AddApplicationStreamInputRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::VisionAI::V1::AddApplicationStreamInputRequest, ::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 add_application_stream_input(name: nil, application_stream_inputs: nil, request_id: nil) -> ::Gapic::Operation
Pass arguments to add_application_stream_input 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. the name of the application to retrieve. Format: "projects/{project}/locations/{location}/applications/{application}"
  • application_stream_inputs (::Array<::Google::Cloud::VisionAI::V1::ApplicationStreamInput, ::Hash>) — The stream inputs to add, the stream resource name is the key of each StreamInput, and it must be unique within each application.
  • 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::AppPlatform::Client.new

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

# Call the add_application_stream_input method.
result = client.add_application_stream_input 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 AppPlatform 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_application

def create_application(request, options = nil) -> ::Gapic::Operation
def create_application(parent: nil, application_id: nil, application: nil, request_id: nil) -> ::Gapic::Operation

Creates a new Application in a given project and location.

Overloads 
def create_application(request, options = nil) -> ::Gapic::Operation
Pass arguments to create_application via a request object, either of type CreateApplicationRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::VisionAI::V1::CreateApplicationRequest, ::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_application(parent: nil, application_id: nil, application: nil, request_id: nil) -> ::Gapic::Operation
Pass arguments to create_application 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.
  • application_id (::String) — Required. Id of the requesting object.
  • application (::Google::Cloud::VisionAI::V1::Application, ::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::AppPlatform::Client.new

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

# Call the create_application method.
result = client.create_application 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_application_instances

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

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

Overloads 
def create_application_instances(request, options = nil) -> ::Gapic::Operation
Pass arguments to create_application_instances via a request object, either of type CreateApplicationInstancesRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::VisionAI::V1::CreateApplicationInstancesRequest, ::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_application_instances(name: nil, application_instances: nil, request_id: nil) -> ::Gapic::Operation
Pass arguments to create_application_instances 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. the name of the application to retrieve. Format: "projects/{project}/locations/{location}/applications/{application}"
  • application_instances (::Array<::Google::Cloud::VisionAI::V1::ApplicationInstance, ::Hash>) — Required. The resources 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::AppPlatform::Client.new

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

# Call the create_application_instances method.
result = client.create_application_instances 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_draft

def create_draft(request, options = nil) -> ::Gapic::Operation
def create_draft(parent: nil, draft_id: nil, draft: nil, request_id: nil) -> ::Gapic::Operation

Creates a new Draft in a given project and location.

Overloads 
def create_draft(request, options = nil) -> ::Gapic::Operation
Pass arguments to create_draft via a request object, either of type CreateDraftRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::VisionAI::V1::CreateDraftRequest, ::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_draft(parent: nil, draft_id: nil, draft: nil, request_id: nil) -> ::Gapic::Operation
Pass arguments to create_draft 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.
  • draft_id (::String) — Required. Id of the requesting object.
  • draft (::Google::Cloud::VisionAI::V1::Draft, ::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::AppPlatform::Client.new

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

# Call the create_draft method.
result = client.create_draft 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_processor

def create_processor(request, options = nil) -> ::Gapic::Operation
def create_processor(parent: nil, processor_id: nil, processor: nil, request_id: nil) -> ::Gapic::Operation

Creates a new Processor in a given project and location.

Overloads 
def create_processor(request, options = nil) -> ::Gapic::Operation
Pass arguments to create_processor via a request object, either of type CreateProcessorRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::VisionAI::V1::CreateProcessorRequest, ::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_processor(parent: nil, processor_id: nil, processor: nil, request_id: nil) -> ::Gapic::Operation
Pass arguments to create_processor 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.
  • processor_id (::String) — Required. Id of the requesting object.
  • processor (::Google::Cloud::VisionAI::V1::Processor, ::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::AppPlatform::Client.new

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

# Call the create_processor method.
result = client.create_processor 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_application

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

Deletes a single Application.

Overloads 
def delete_application(request, options = nil) -> ::Gapic::Operation
Pass arguments to delete_application via a request object, either of type DeleteApplicationRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::VisionAI::V1::DeleteApplicationRequest, ::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_application(name: nil, request_id: nil, force: nil) -> ::Gapic::Operation
Pass arguments to delete_application 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).

  • force (::Boolean) — Optional. If set to true, any instances and drafts from this application will also be deleted. (Otherwise, the request will only work if the application has no instances and drafts.)
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::AppPlatform::Client.new

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

# Call the delete_application method.
result = client.delete_application 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_application_instances

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

Remove target stream input to the Application, if the Application is deployed, the corresponding instance based will be deleted. If the stream is not in the Application, the RPC will fail.

Overloads 
def delete_application_instances(request, options = nil) -> ::Gapic::Operation
Pass arguments to delete_application_instances via a request object, either of type DeleteApplicationInstancesRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::VisionAI::V1::DeleteApplicationInstancesRequest, ::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_application_instances(name: nil, instance_ids: nil, request_id: nil) -> ::Gapic::Operation
Pass arguments to delete_application_instances 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. the name of the application to retrieve. Format: "projects/{project}/locations/{location}/applications/{application}"
  • instance_ids (::Array<::String>) — Required. Id of the requesting object.
  • 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::AppPlatform::Client.new

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

# Call the delete_application_instances method.
result = client.delete_application_instances 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_draft

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

Deletes a single Draft.

Overloads 
def delete_draft(request, options = nil) -> ::Gapic::Operation
Pass arguments to delete_draft via a request object, either of type DeleteDraftRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::VisionAI::V1::DeleteDraftRequest, ::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_draft(name: nil, request_id: nil) -> ::Gapic::Operation
Pass arguments to delete_draft 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::AppPlatform::Client.new

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

# Call the delete_draft method.
result = client.delete_draft 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_processor

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

Deletes a single Processor.

Overloads 
def delete_processor(request, options = nil) -> ::Gapic::Operation
Pass arguments to delete_processor via a request object, either of type DeleteProcessorRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::VisionAI::V1::DeleteProcessorRequest, ::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_processor(name: nil, request_id: nil) -> ::Gapic::Operation
Pass arguments to delete_processor 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::AppPlatform::Client.new

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

# Call the delete_processor method.
result = client.delete_processor 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

#deploy_application

def deploy_application(request, options = nil) -> ::Gapic::Operation
def deploy_application(name: nil, validate_only: nil, request_id: nil, enable_monitoring: nil) -> ::Gapic::Operation

Deploys a single Application.

Overloads 
def deploy_application(request, options = nil) -> ::Gapic::Operation
Pass arguments to deploy_application via a request object, either of type DeployApplicationRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::VisionAI::V1::DeployApplicationRequest, ::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 deploy_application(name: nil, validate_only: nil, request_id: nil, enable_monitoring: nil) -> ::Gapic::Operation
Pass arguments to deploy_application 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. the name of the application to retrieve. Format: "projects/{project}/locations/{location}/applications/{application}"
  • validate_only (::Boolean) — If set, validate the request and preview the application graph, but do not actually deploy it.
  • 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).

  • enable_monitoring (::Boolean) — Optional. Whether or not to enable monitoring for the application on deployment.
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::AppPlatform::Client.new

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

# Call the deploy_application method.
result = client.deploy_application 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_application

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

Gets details of a single Application.

Overloads 
def get_application(request, options = nil) -> ::Google::Cloud::VisionAI::V1::Application
Pass arguments to get_application via a request object, either of type GetApplicationRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::VisionAI::V1::GetApplicationRequest, ::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_application(name: nil) -> ::Google::Cloud::VisionAI::V1::Application
Pass arguments to get_application 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::AppPlatform::Client.new

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

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

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

#get_draft

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

Gets details of a single Draft.

Overloads 
def get_draft(request, options = nil) -> ::Google::Cloud::VisionAI::V1::Draft
Pass arguments to get_draft via a request object, either of type GetDraftRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::VisionAI::V1::GetDraftRequest, ::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_draft(name: nil) -> ::Google::Cloud::VisionAI::V1::Draft
Pass arguments to get_draft 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::AppPlatform::Client.new

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

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

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

#get_instance

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

Gets details of a single Instance.

Overloads 
def get_instance(request, options = nil) -> ::Google::Cloud::VisionAI::V1::Instance
Pass arguments to get_instance via a request object, either of type GetInstanceRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::VisionAI::V1::GetInstanceRequest, ::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_instance(name: nil) -> ::Google::Cloud::VisionAI::V1::Instance
Pass arguments to get_instance 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::AppPlatform::Client.new

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

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

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

#get_processor

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

Gets details of a single Processor.

Overloads 
def get_processor(request, options = nil) -> ::Google::Cloud::VisionAI::V1::Processor
Pass arguments to get_processor via a request object, either of type GetProcessorRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::VisionAI::V1::GetProcessorRequest, ::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_processor(name: nil) -> ::Google::Cloud::VisionAI::V1::Processor
Pass arguments to get_processor 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::AppPlatform::Client.new

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

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

# The returned object is of type Google::Cloud::VisionAI::V1::Processor.
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 AppPlatform client object.

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

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

#list_applications

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

Lists Applications in a given project and location.

Overloads 
def list_applications(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::VisionAI::V1::Application>
Pass arguments to list_applications via a request object, either of type ListApplicationsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::VisionAI::V1::ListApplicationsRequest, ::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_applications(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::VisionAI::V1::Application>
Pass arguments to list_applications 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 ListApplicationsRequest.
  • 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::AppPlatform::Client.new

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

# Call the list_applications method.
result = client.list_applications 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::Application.
  p item
end

#list_drafts

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

Lists Drafts in a given project and location.

Overloads 
def list_drafts(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::VisionAI::V1::Draft>
Pass arguments to list_drafts via a request object, either of type ListDraftsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::VisionAI::V1::ListDraftsRequest, ::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_drafts(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::VisionAI::V1::Draft>
Pass arguments to list_drafts 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 ListDraftsRequest.
  • 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::AppPlatform::Client.new

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

# Call the list_drafts method.
result = client.list_drafts 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::Draft.
  p item
end

#list_instances

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

Lists Instances in a given project and location.

Overloads 
def list_instances(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::VisionAI::V1::Instance>
Pass arguments to list_instances via a request object, either of type ListInstancesRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::VisionAI::V1::ListInstancesRequest, ::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_instances(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::VisionAI::V1::Instance>
Pass arguments to list_instances 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 ListInstancesRequest.
  • 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::AppPlatform::Client.new

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

# Call the list_instances method.
result = client.list_instances 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::Instance.
  p item
end

#list_prebuilt_processors

def list_prebuilt_processors(request, options = nil) -> ::Google::Cloud::VisionAI::V1::ListPrebuiltProcessorsResponse
def list_prebuilt_processors(parent: nil) -> ::Google::Cloud::VisionAI::V1::ListPrebuiltProcessorsResponse

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

Overloads 
def list_prebuilt_processors(request, options = nil) -> ::Google::Cloud::VisionAI::V1::ListPrebuiltProcessorsResponse
Pass arguments to list_prebuilt_processors via a request object, either of type ListPrebuiltProcessorsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::VisionAI::V1::ListPrebuiltProcessorsRequest, ::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_prebuilt_processors(parent: nil) -> ::Google::Cloud::VisionAI::V1::ListPrebuiltProcessorsResponse
Pass arguments to list_prebuilt_processors 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
  • parent (::String) — Required. Parent path.
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::AppPlatform::Client.new

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

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

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

#list_processors

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

Lists Processors in a given project and location.

Overloads 
def list_processors(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::VisionAI::V1::Processor>
Pass arguments to list_processors via a request object, either of type ListProcessorsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::VisionAI::V1::ListProcessorsRequest, ::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_processors(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::VisionAI::V1::Processor>
Pass arguments to list_processors 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 ListProcessorsRequest.
  • 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::AppPlatform::Client.new

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

# Call the list_processors method.
result = client.list_processors 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::Processor.
  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)

#operations_client

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

Get the associated client for long-running operations.

Returns

#remove_application_stream_input

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

Remove target stream input to the Application, if the Application is deployed, the corresponding instance based will be deleted. If the stream is not in the Application, the RPC will fail.

Overloads 
def remove_application_stream_input(request, options = nil) -> ::Gapic::Operation
Pass arguments to remove_application_stream_input via a request object, either of type RemoveApplicationStreamInputRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::VisionAI::V1::RemoveApplicationStreamInputRequest, ::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 remove_application_stream_input(name: nil, target_stream_inputs: nil, request_id: nil) -> ::Gapic::Operation
Pass arguments to remove_application_stream_input 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. the name of the application to retrieve. Format: "projects/{project}/locations/{location}/applications/{application}"
  • target_stream_inputs (::Array<::Google::Cloud::VisionAI::V1::RemoveApplicationStreamInputRequest::TargetStreamInput, ::Hash>) — The target stream to remove.
  • 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::AppPlatform::Client.new

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

# Call the remove_application_stream_input method.
result = client.remove_application_stream_input 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

#undeploy_application

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

Undeploys a single Application.

Overloads 
def undeploy_application(request, options = nil) -> ::Gapic::Operation
Pass arguments to undeploy_application via a request object, either of type UndeployApplicationRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::VisionAI::V1::UndeployApplicationRequest, ::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 undeploy_application(name: nil, request_id: nil) -> ::Gapic::Operation
Pass arguments to undeploy_application 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. the name of the application to retrieve. Format: "projects/{project}/locations/{location}/applications/{application}"
  • 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::AppPlatform::Client.new

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

# Call the undeploy_application method.
result = client.undeploy_application 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

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns
  • (String)

#update_application

def update_application(request, options = nil) -> ::Gapic::Operation
def update_application(update_mask: nil, application: nil, request_id: nil) -> ::Gapic::Operation

Updates the parameters of a single Application.

Overloads 
def update_application(request, options = nil) -> ::Gapic::Operation
Pass arguments to update_application via a request object, either of type UpdateApplicationRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::VisionAI::V1::UpdateApplicationRequest, ::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_application(update_mask: nil, application: nil, request_id: nil) -> ::Gapic::Operation
Pass arguments to update_application 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) — Optional. Field mask is used to specify the fields to be overwritten in the Application resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.
  • application (::Google::Cloud::VisionAI::V1::Application, ::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::AppPlatform::Client.new

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

# Call the update_application method.
result = client.update_application 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_application_instances

def update_application_instances(request, options = nil) -> ::Gapic::Operation
def update_application_instances(name: nil, application_instances: nil, request_id: nil, allow_missing: nil) -> ::Gapic::Operation

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

Overloads 
def update_application_instances(request, options = nil) -> ::Gapic::Operation
Pass arguments to update_application_instances via a request object, either of type UpdateApplicationInstancesRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::VisionAI::V1::UpdateApplicationInstancesRequest, ::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_application_instances(name: nil, application_instances: nil, request_id: nil, allow_missing: nil) -> ::Gapic::Operation
Pass arguments to update_application_instances 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. the name of the application to retrieve. Format: "projects/{project}/locations/{location}/applications/{application}"
  • application_instances (::Array<::Google::Cloud::VisionAI::V1::UpdateApplicationInstancesRequest::UpdateApplicationInstance, ::Hash>)
  • 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).

  • allow_missing (::Boolean) — If true, Update Request will create one resource if the target resource doesn't exist, this time, the field_mask will be ignored.
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::AppPlatform::Client.new

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

# Call the update_application_instances method.
result = client.update_application_instances 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_application_stream_input

def update_application_stream_input(request, options = nil) -> ::Gapic::Operation
def update_application_stream_input(name: nil, application_stream_inputs: nil, request_id: nil, allow_missing: nil) -> ::Gapic::Operation

Update target stream input to the Application, if the Application is deployed, the corresponding instance based will be deployed. For CreateOrUpdate behavior, set allow_missing to true.

Overloads 
def update_application_stream_input(request, options = nil) -> ::Gapic::Operation
Pass arguments to update_application_stream_input via a request object, either of type UpdateApplicationStreamInputRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::VisionAI::V1::UpdateApplicationStreamInputRequest, ::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_application_stream_input(name: nil, application_stream_inputs: nil, request_id: nil, allow_missing: nil) -> ::Gapic::Operation
Pass arguments to update_application_stream_input 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. the name of the application to retrieve. Format: "projects/{project}/locations/{location}/applications/{application}"
  • application_stream_inputs (::Array<::Google::Cloud::VisionAI::V1::ApplicationStreamInput, ::Hash>) — The stream inputs to update, the stream resource name is the key of each StreamInput, and it must be unique within each application.
  • 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).

  • allow_missing (::Boolean) — If true, UpdateApplicationStreamInput will insert stream input to application even if the target stream is not included in the application.
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::AppPlatform::Client.new

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

# Call the update_application_stream_input method.
result = client.update_application_stream_input 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_draft

def update_draft(request, options = nil) -> ::Gapic::Operation
def update_draft(update_mask: nil, draft: nil, request_id: nil, allow_missing: nil) -> ::Gapic::Operation

Updates the parameters of a single Draft.

Overloads 
def update_draft(request, options = nil) -> ::Gapic::Operation
Pass arguments to update_draft via a request object, either of type UpdateDraftRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::VisionAI::V1::UpdateDraftRequest, ::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_draft(update_mask: nil, draft: nil, request_id: nil, allow_missing: nil) -> ::Gapic::Operation
Pass arguments to update_draft 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) — Optional. Field mask is used to specify the fields to be overwritten in the Draft resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.
  • draft (::Google::Cloud::VisionAI::V1::Draft, ::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).

  • allow_missing (::Boolean) — If true, UpdateDraftRequest will create one resource if the target resource doesn't exist, this time, the field_mask will be ignored.
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::AppPlatform::Client.new

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

# Call the update_draft method.
result = client.update_draft 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_processor

def update_processor(request, options = nil) -> ::Gapic::Operation
def update_processor(update_mask: nil, processor: nil, request_id: nil) -> ::Gapic::Operation

Updates the parameters of a single Processor.

Overloads 
def update_processor(request, options = nil) -> ::Gapic::Operation
Pass arguments to update_processor via a request object, either of type UpdateProcessorRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::VisionAI::V1::UpdateProcessorRequest, ::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_processor(update_mask: nil, processor: nil, request_id: nil) -> ::Gapic::Operation
Pass arguments to update_processor 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) — Optional. Field mask is used to specify the fields to be overwritten in the Processor resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.
  • processor (::Google::Cloud::VisionAI::V1::Processor, ::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::AppPlatform::Client.new

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

# Call the update_processor method.
result = client.update_processor 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