Class: Google::Cloud::Vision::V1::ImageAnnotator::Rest::Client

Inherits:
Object
  • Object
show all
Includes:
Paths
Defined in:
lib/google/cloud/vision/v1/image_annotator/rest/client.rb

Overview

REST client for the ImageAnnotator service.

Service that performs Google Cloud Vision API detection tasks over client images, such as face, landmark, logo, label, and text detection. The ImageAnnotator service returns detected entities from the images.

Defined Under Namespace

Classes: Configuration

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Paths

#product_set_path

Constructor Details

#initialize {|config| ... } ⇒ Client

Create a new ImageAnnotator REST client object.

Examples:


# Create a client using the default configuration
client = ::Google::Cloud::Vision::V1::ImageAnnotator::Rest::Client.new

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

Yields:

  • (config) —

    Configure the ImageAnnotator client.

Yield Parameters:



148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/google/cloud/vision/v1/image_annotator/rest/client.rb', line 148

def initialize
  # Create the configuration object
  @config = Configuration.new Client.configure

  # Yield the configuration if needed
  yield @config if block_given?

  # Create credentials
  credentials = @config.credentials
  # Use self-signed JWT if the endpoint is unchanged from default,
  # but only if the default endpoint does not have a region prefix.
  enable_self_signed_jwt = @config.endpoint.nil? ||
                           (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
                           !@config.endpoint.split(".").first.include?("-"))
  credentials ||= Credentials.default scope: @config.scope,
                                      enable_self_signed_jwt: enable_self_signed_jwt
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
    credentials = Credentials.new credentials, scope: @config.scope
  end

  @quota_project_id = @config.quota_project
  @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id

  @operations_client = ::Google::Cloud::Vision::V1::ImageAnnotator::Rest::Operations.new do |config|
    config.credentials = credentials
    config.quota_project = @quota_project_id
    config.endpoint = @config.endpoint
    config.universe_domain = @config.universe_domain
  end

  @image_annotator_stub = ::Google::Cloud::Vision::V1::ImageAnnotator::Rest::ServiceStub.new(
    endpoint: @config.endpoint,
    endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
    universe_domain: @config.universe_domain,
    credentials: credentials,
    logger: @config.logger
  )

  @image_annotator_stub.logger(stub: true)&.info do |entry|
    entry.set_system_name
    entry.set_service
    entry.message = "Created client for #{entry.service}"
    entry.set_credentials_fields credentials
    entry.set "customEndpoint", @config.endpoint if @config.endpoint
    entry.set "defaultTimeout", @config.timeout if @config.timeout
    entry.set "quotaProject", @quota_project_id if @quota_project_id
  end
end

Instance Attribute Details

#operations_client ⇒ ::Google::Cloud::Vision::V1::ImageAnnotator::Rest::Operations (readonly)

Get the associated client for long-running operations.

Returns:



202
203
204
 
# File 'lib/google/cloud/vision/v1/image_annotator/rest/client.rb', line 202

def operations_client
  @operations_client
end

Class Method Details

.configure {|config| ... } ⇒ Client::Configuration

Configure the ImageAnnotator Client class.

See Configuration for a description of the configuration fields.

Examples:


# Modify the configuration for all ImageAnnotator clients
::Google::Cloud::Vision::V1::ImageAnnotator::Rest::Client.configure do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/google/cloud/vision/v1/image_annotator/rest/client.rb', line 66

def self.configure
  @configure ||= begin
    namespace = ["Google", "Cloud", "Vision", "V1"]
    parent_config = while namespace.any?
                      parent_name = namespace.join "::"
                      parent_const = const_get parent_name
                      break parent_const.configure if parent_const.respond_to? :configure
                      namespace.pop
                    end
    default_config = Client::Configuration.new parent_config

    default_config.rpcs.batch_annotate_images.timeout = 600.0
    default_config.rpcs.batch_annotate_images.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 14]
    }

    default_config.rpcs.batch_annotate_files.timeout = 600.0
    default_config.rpcs.batch_annotate_files.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 14]
    }

    default_config.rpcs.async_batch_annotate_images.timeout = 600.0
    default_config.rpcs.async_batch_annotate_images.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 14]
    }

    default_config.rpcs.async_batch_annotate_files.timeout = 600.0
    default_config.rpcs.async_batch_annotate_files.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 14]
    }

    default_config
  end
  yield @configure if block_given?
  @configure
end

Instance Method Details

#async_batch_annotate_files(request, options = nil) ⇒ ::Gapic::Operation #async_batch_annotate_files(requests: nil, parent: nil, labels: nil) ⇒ ::Gapic::Operation

Run asynchronous image detection and annotation for a list of generic files, such as PDF files, which may contain multiple pages and multiple images per page. Progress and results can be retrieved through the google.longrunning.Operations interface. Operation.metadata contains OperationMetadata (metadata). Operation.response contains AsyncBatchAnnotateFilesResponse (results).

Examples:

Basic example

require "google/cloud/vision/v1"

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

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

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

Overloads:

  • #async_batch_annotate_files(request, options = nil) ⇒ ::Gapic::Operation

    Pass arguments to async_batch_annotate_files via a request object, either of type AsyncBatchAnnotateFilesRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Vision::V1::AsyncBatchAnnotateFilesRequest, ::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.

  • #async_batch_annotate_files(requests: nil, parent: nil, labels: nil) ⇒ ::Gapic::Operation

    Pass arguments to async_batch_annotate_files 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:

    • requests (::Array<::Google::Cloud::Vision::V1::AsyncAnnotateFileRequest, ::Hash>) (defaults to: nil) —

      Required. Individual async file annotation requests for this batch.

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

      Optional. Target project and location to make a call.

      Format: projects/{project-id}/locations/{location-id}.

      If no parent is specified, a region will be chosen automatically.

      Supported location-ids: us: USA country only, asia: East asia areas, like Japan, Taiwan, eu: The European Union.

      Example: projects/project-A/locations/eu.

    • labels (::Hash{::String => ::String}) (defaults to: nil) —

      Optional. The labels with user-defined metadata for the request.

      Label keys and values can be no longer than 63 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)

Returns:

  • (::Gapic::Operation)

Raises:

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

    if the REST call is aborted.



610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
 
# File 'lib/google/cloud/vision/v1/image_annotator/rest/client.rb', line 610

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Vision::V1::AsyncBatchAnnotateFilesRequest

  # 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.async_batch_annotate_files.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::Vision::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.async_batch_annotate_files.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.async_batch_annotate_files.retry_policy

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

  @image_annotator_stub.async_batch_annotate_files request, options do |result, operation|
    result = ::Gapic::Operation.new result, @operations_client, options: options
    yield result, operation if block_given?
    throw :response, result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#async_batch_annotate_images(request, options = nil) ⇒ ::Gapic::Operation #async_batch_annotate_images(requests: nil, output_config: nil, parent: nil, labels: nil) ⇒ ::Gapic::Operation

Run asynchronous image detection and annotation for a list of images.

Progress and results can be retrieved through the google.longrunning.Operations interface. Operation.metadata contains OperationMetadata (metadata). Operation.response contains AsyncBatchAnnotateImagesResponse (results).

This service will write image annotation outputs to json files in customer GCS bucket, each json file containing BatchAnnotateImagesResponse proto.

Examples:

Basic example

require "google/cloud/vision/v1"

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

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

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

Overloads:

  • #async_batch_annotate_images(request, options = nil) ⇒ ::Gapic::Operation

    Pass arguments to async_batch_annotate_images via a request object, either of type AsyncBatchAnnotateImagesRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Vision::V1::AsyncBatchAnnotateImagesRequest, ::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.

  • #async_batch_annotate_images(requests: nil, output_config: nil, parent: nil, labels: nil) ⇒ ::Gapic::Operation

    Pass arguments to async_batch_annotate_images 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:

    • requests (::Array<::Google::Cloud::Vision::V1::AnnotateImageRequest, ::Hash>) (defaults to: nil) —

      Required. Individual image annotation requests for this batch.

    • output_config (::Google::Cloud::Vision::V1::OutputConfig, ::Hash) (defaults to: nil) —

      Required. The desired output location and metadata (e.g. format).

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

      Optional. Target project and location to make a call.

      Format: projects/{project-id}/locations/{location-id}.

      If no parent is specified, a region will be chosen automatically.

      Supported location-ids: us: USA country only, asia: East asia areas, like Japan, Taiwan, eu: The European Union.

      Example: projects/project-A/locations/eu.

    • labels (::Hash{::String => ::String}) (defaults to: nil) —

      Optional. The labels with user-defined metadata for the request.

      Label keys and values can be no longer than 63 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)

Returns:

  • (::Gapic::Operation)

Raises:

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

    if the REST call is aborted.



498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
 
# File 'lib/google/cloud/vision/v1/image_annotator/rest/client.rb', line 498

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Vision::V1::AsyncBatchAnnotateImagesRequest

  # 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.async_batch_annotate_images.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::Vision::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.async_batch_annotate_images.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.async_batch_annotate_images.retry_policy

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

  @image_annotator_stub.async_batch_annotate_images request, options do |result, operation|
    result = ::Gapic::Operation.new result, @operations_client, options: options
    yield result, operation if block_given?
    throw :response, result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#batch_annotate_files(request, options = nil) ⇒ ::Google::Cloud::Vision::V1::BatchAnnotateFilesResponse #batch_annotate_files(requests: nil, parent: nil, labels: nil) ⇒ ::Google::Cloud::Vision::V1::BatchAnnotateFilesResponse

Service that performs image detection and annotation for a batch of files. Now only "application/pdf", "image/tiff" and "image/gif" are supported.

This service will extract at most 5 (customers can specify which 5 in AnnotateFileRequest.pages) frames (gif) or pages (pdf or tiff) from each file provided and perform detection and annotation for each image extracted.

Examples:

Basic example

require "google/cloud/vision/v1"

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

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

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

# The returned object is of type Google::Cloud::Vision::V1::BatchAnnotateFilesResponse.
p result

Overloads:

  • #batch_annotate_files(request, options = nil) ⇒ ::Google::Cloud::Vision::V1::BatchAnnotateFilesResponse

    Pass arguments to batch_annotate_files via a request object, either of type BatchAnnotateFilesRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Vision::V1::BatchAnnotateFilesRequest, ::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.

  • #batch_annotate_files(requests: nil, parent: nil, labels: nil) ⇒ ::Google::Cloud::Vision::V1::BatchAnnotateFilesResponse

    Pass arguments to batch_annotate_files 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:

    • requests (::Array<::Google::Cloud::Vision::V1::AnnotateFileRequest, ::Hash>) (defaults to: nil) —

      Required. The list of file annotation requests. Right now we support only one AnnotateFileRequest in BatchAnnotateFilesRequest.

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

      Optional. Target project and location to make a call.

      Format: projects/{project-id}/locations/{location-id}.

      If no parent is specified, a region will be chosen automatically.

      Supported location-ids: us: USA country only, asia: East asia areas, like Japan, Taiwan, eu: The European Union.

      Example: projects/project-A/locations/eu.

    • labels (::Hash{::String => ::String}) (defaults to: nil) —

      Optional. The labels with user-defined metadata for the request.

      Label keys and values can be no longer than 63 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
 
# File 'lib/google/cloud/vision/v1/image_annotator/rest/client.rb', line 383

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Vision::V1::BatchAnnotateFilesRequest

  # 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.batch_annotate_files.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::Vision::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.batch_annotate_files.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.batch_annotate_files.retry_policy

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

  @image_annotator_stub.batch_annotate_files 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

#batch_annotate_images(request, options = nil) ⇒ ::Google::Cloud::Vision::V1::BatchAnnotateImagesResponse #batch_annotate_images(requests: nil, parent: nil, labels: nil) ⇒ ::Google::Cloud::Vision::V1::BatchAnnotateImagesResponse

Run image detection and annotation for a batch of images.

Examples:

Basic example

require "google/cloud/vision/v1"

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

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

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

# The returned object is of type Google::Cloud::Vision::V1::BatchAnnotateImagesResponse.
p result

Overloads:

  • #batch_annotate_images(request, options = nil) ⇒ ::Google::Cloud::Vision::V1::BatchAnnotateImagesResponse

    Pass arguments to batch_annotate_images via a request object, either of type BatchAnnotateImagesRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Vision::V1::BatchAnnotateImagesRequest, ::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.

  • #batch_annotate_images(requests: nil, parent: nil, labels: nil) ⇒ ::Google::Cloud::Vision::V1::BatchAnnotateImagesResponse

    Pass arguments to batch_annotate_images 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:

    • requests (::Array<::Google::Cloud::Vision::V1::AnnotateImageRequest, ::Hash>) (defaults to: nil) —

      Required. Individual image annotation requests for this batch.

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

      Optional. Target project and location to make a call.

      Format: projects/{project-id}/locations/{location-id}.

      If no parent is specified, a region will be chosen automatically.

      Supported location-ids: us: USA country only, asia: East asia areas, like Japan, Taiwan, eu: The European Union.

      Example: projects/project-A/locations/eu.

    • labels (::Hash{::String => ::String}) (defaults to: nil) —

      Optional. The labels with user-defined metadata for the request.

      Label keys and values can be no longer than 63 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
 
# File 'lib/google/cloud/vision/v1/image_annotator/rest/client.rb', line 278

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Vision::V1::BatchAnnotateImagesRequest

  # 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.batch_annotate_images.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::Vision::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.batch_annotate_images.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.batch_annotate_images.retry_policy

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

  @image_annotator_stub.batch_annotate_images 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

#configure {|config| ... } ⇒ Client::Configuration

Configure the ImageAnnotator 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 configure.

See Configuration for a description of the configuration fields.

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



118
119
120
121
 
# File 'lib/google/cloud/vision/v1/image_annotator/rest/client.rb', line 118

def configure
  yield @config if block_given?
  @config
end

#logger ⇒ Logger

The logger used for request/response debug logging.

Returns:

  • (Logger) 


209
210
211
 
# File 'lib/google/cloud/vision/v1/image_annotator/rest/client.rb', line 209

def logger
  @image_annotator_stub.logger
end

#universe_domain ⇒ String

The effective universe domain

Returns:

  • (String) 


128
129
130
 
# File 'lib/google/cloud/vision/v1/image_annotator/rest/client.rb', line 128

def universe_domain
  @image_annotator_stub.universe_domain
end