Method: Google::Cloud::VisionAI::V1::AppPlatform::Rest::Client#list_prebuilt_processors

Defined in:
lib/google/cloud/vision_ai/v1/app_platform/rest/client.rb

#list_prebuilt_processors(request, options = nil) ⇒ ::Google::Cloud::VisionAI::V1::ListPrebuiltProcessorsResponse #list_prebuilt_processors(parent: nil) ⇒ ::Google::Cloud::VisionAI::V1::ListPrebuiltProcessorsResponse

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

Examples:

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

Overloads:

  • #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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #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).

    Parameters:

    • parent (::String) (defaults to: nil) —

      Required. Parent path.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
 
# File 'lib/google/cloud/vision_ai/v1/app_platform/rest/client.rb', line 2364

def list_prebuilt_processors request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::VisionAI::V1::ListPrebuiltProcessorsRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.list_prebuilt_processors.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::VisionAI::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.list_prebuilt_processors.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.list_prebuilt_processors.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @app_platform_stub.list_prebuilt_processors request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end