# Cloud Vision V1p3beta1 API - Class Google::Cloud::Vision::V1p3beta1::ImageAnnotator::Rest::Client (v0.20.0)

0.20.0 (latest) 0.19.1 0.18.1 0.17.0 0.16.0 0.15.1 0.14.0 0.13.1 0.12.2 0.11.0 0.10.1 0.9.0 0.8.0 0.7.0 0.6.0 0.5.5 Reference documentation and code samples for the Cloud Vision V1p3beta1 API class Google::Cloud::Vision::V1p3beta1::ImageAnnotator::Rest::Client.

REST client for the ImageAnnotator service.


<br />

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.

## Inherits

- Object

## Includes

- [Google::Cloud::Vision::V1p3beta1::ImageAnnotator::Paths](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-vision-v1p3beta1/latest/Google-Cloud-Vision-V1p3beta1-ImageAnnotator-Paths)

## Methods

### .configure

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

Configure the ImageAnnotator Client class.


<br />

See [Configuration](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-vision-v1p3beta1/latest/Google-Cloud-Vision-V1p3beta1-ImageAnnotator-Rest-Client-Configuration "Google::Cloud::Vision::V1p3beta1::ImageAnnotator::Rest::Client::Configuration (class)")
for a description of the configuration fields.
**Yields**

- (config) --- Configure the Client client.
**Yield Parameter**

- **config** ([Client::Configuration](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-vision-v1p3beta1/latest/Google-Cloud-Vision-V1p3beta1-ImageAnnotator-Rest-Client-Configuration))
**Returns**

- ([Client::Configuration](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-vision-v1p3beta1/latest/Google-Cloud-Vision-V1p3beta1-ImageAnnotator-Rest-Client-Configuration))
**Example**

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

### #async_batch_annotate_files

    def async_batch_annotate_files(request, options = nil) -> ::Gapic::Operation
    def async_batch_annotate_files(requests: 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).
**Overloads**

    def async_batch_annotate_files(request, options = nil) -> ::Gapic::Operation

Pass arguments to `async_batch_annotate_files` via a request object, either of type [AsyncBatchAnnotateFilesRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-vision-v1p3beta1/latest/Google-Cloud-Vision-V1p3beta1-AsyncBatchAnnotateFilesRequest "Google::Cloud::Vision::V1p3beta1::AsyncBatchAnnotateFilesRequest (class)") or an equivalent Hash. **Parameters**

- **request** ([::Google::Cloud::Vision::V1p3beta1::AsyncBatchAnnotateFilesRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-vision-v1p3beta1/latest/Google-Cloud-Vision-V1p3beta1-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) --- Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

    def async_batch_annotate_files(requests: 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). **Parameter**

- **requests** (::Array\<[::Google::Cloud::Vision::V1p3beta1::AsyncAnnotateFileRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-vision-v1p3beta1/latest/Google-Cloud-Vision-V1p3beta1-AsyncAnnotateFileRequest), ::Hash\>) --- Required. Individual async file annotation requests for this batch.
**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.
**Example**

Basic example

```ruby
require "google/cloud/vision/v1p3beta1"

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

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Vision::V1p3beta1::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
```

### #batch_annotate_images

    def batch_annotate_images(request, options = nil) -> ::Google::Cloud::Vision::V1p3beta1::BatchAnnotateImagesResponse
    def batch_annotate_images(requests: nil) -> ::Google::Cloud::Vision::V1p3beta1::BatchAnnotateImagesResponse

Run image detection and annotation for a batch of images.
**Overloads**

    def batch_annotate_images(request, options = nil) -> ::Google::Cloud::Vision::V1p3beta1::BatchAnnotateImagesResponse

Pass arguments to `batch_annotate_images` via a request object, either of type [BatchAnnotateImagesRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-vision-v1p3beta1/latest/Google-Cloud-Vision-V1p3beta1-BatchAnnotateImagesRequest "Google::Cloud::Vision::V1p3beta1::BatchAnnotateImagesRequest (class)") or an equivalent Hash. **Parameters**

- **request** ([::Google::Cloud::Vision::V1p3beta1::BatchAnnotateImagesRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-vision-v1p3beta1/latest/Google-Cloud-Vision-V1p3beta1-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) --- Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

    def batch_annotate_images(requests: nil) -> ::Google::Cloud::Vision::V1p3beta1::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). **Parameter**

- **requests** (::Array\<[::Google::Cloud::Vision::V1p3beta1::AnnotateImageRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-vision-v1p3beta1/latest/Google-Cloud-Vision-V1p3beta1-AnnotateImageRequest), ::Hash\>) --- Individual image annotation requests for this batch.
**Yields**

- (result, operation) --- Access the result along with the TransportOperation object
**Yield Parameters**

- **result** ([::Google::Cloud::Vision::V1p3beta1::BatchAnnotateImagesResponse](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-vision-v1p3beta1/latest/Google-Cloud-Vision-V1p3beta1-BatchAnnotateImagesResponse))
- **operation** (::Gapic::Rest::TransportOperation)
**Returns**

- ([::Google::Cloud::Vision::V1p3beta1::BatchAnnotateImagesResponse](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-vision-v1p3beta1/latest/Google-Cloud-Vision-V1p3beta1-BatchAnnotateImagesResponse))
**Raises**

- (::Google::Cloud::Error) --- if the REST call is aborted.
**Example**

Basic example

```ruby
require "google/cloud/vision/v1p3beta1"

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

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

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

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

### #configure

    def 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 [Client.configure](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-vision-v1p3beta1/latest/Google-Cloud-Vision-V1p3beta1-ImageAnnotator-Rest-Client#Google__Cloud__Vision__V1p3beta1__ImageAnnotator__Rest__Client_configure_class_ "Google::Cloud::Vision::V1p3beta1::ImageAnnotator::Rest::Client.configure (method)").

<br />

See [Configuration](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-vision-v1p3beta1/latest/Google-Cloud-Vision-V1p3beta1-ImageAnnotator-Rest-Client-Configuration "Google::Cloud::Vision::V1p3beta1::ImageAnnotator::Rest::Client::Configuration (class)")
for a description of the configuration fields.
**Yields**

- (config) --- Configure the Client client.
**Yield Parameter**

- **config** ([Client::Configuration](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-vision-v1p3beta1/latest/Google-Cloud-Vision-V1p3beta1-ImageAnnotator-Rest-Client-Configuration))
**Returns**

- ([Client::Configuration](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-vision-v1p3beta1/latest/Google-Cloud-Vision-V1p3beta1-ImageAnnotator-Rest-Client-Configuration))

### #initialize

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

Create a new ImageAnnotator REST client object.
**Yields**

- (config) --- Configure the ImageAnnotator client.
**Yield Parameter**

- **config** ([Client::Configuration](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-vision-v1p3beta1/latest/Google-Cloud-Vision-V1p3beta1-ImageAnnotator-Rest-Client-Configuration))
**Returns**

- ([Client](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-vision-v1p3beta1/latest/Google-Cloud-Vision-V1p3beta1-ImageAnnotator-Rest-Client)) --- a new instance of Client
**Example**

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

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

### #logger

    def logger() -> Logger

The logger used for request/response debug logging.
**Returns**

- (Logger)

### #operations_client

    def operations_client() -> ::Google::Cloud::Vision::V1p3beta1::ImageAnnotator::Rest::Operations

Get the associated client for long-running operations.
**Returns**

- ([::Google::Cloud::Vision::V1p3beta1::ImageAnnotator::Rest::Operations](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-vision-v1p3beta1/latest/Google-Cloud-Vision-V1p3beta1-ImageAnnotator-Rest-Operations))

### #universe_domain

    def universe_domain() -> String

The effective universe domain
**Returns**

- (String)