Class: Google::Apis::VisionV1::GoogleCloudVisionV1p4beta1AnnotateFileResponse

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/vision_v1/classes.rb,
generated/google/apis/vision_v1/representations.rb,
generated/google/apis/vision_v1/representations.rb

Overview

Response to a single file annotation request. A file may contain one or more images, which individually have their own responses.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudVisionV1p4beta1AnnotateFileResponse

Returns a new instance of GoogleCloudVisionV1p4beta1AnnotateFileResponse.



6544
6545
6546
 
# File 'generated/google/apis/vision_v1/classes.rb', line 6544

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#error ⇒ Google::Apis::VisionV1::Status

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide. Corresponds to the JSON property error

Returns:



6526
6527
6528
 
# File 'generated/google/apis/vision_v1/classes.rb', line 6526

def error
  @error
end

#input_config ⇒ Google::Apis::VisionV1::GoogleCloudVisionV1p4beta1InputConfig

The desired input location and metadata. Corresponds to the JSON property inputConfig

Returns:



6531
6532
6533
 
# File 'generated/google/apis/vision_v1/classes.rb', line 6531

def input_config
  @input_config
end

#responses ⇒ Array<Google::Apis::VisionV1::GoogleCloudVisionV1p4beta1AnnotateImageResponse>

Individual responses to images found within the file. This field will be empty if the error field is set. Corresponds to the JSON property responses

Returns:



6537
6538
6539
 
# File 'generated/google/apis/vision_v1/classes.rb', line 6537

def responses
  @responses
end

#total_pages ⇒ Fixnum

This field gives the total number of pages in the file. Corresponds to the JSON property totalPages

Returns:

  • (Fixnum) 


6542
6543
6544
 
# File 'generated/google/apis/vision_v1/classes.rb', line 6542

def total_pages
  @total_pages
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



6549
6550
6551
6552
6553
6554
 
# File 'generated/google/apis/vision_v1/classes.rb', line 6549

def update!(**args)
  @error = args[:error] if args.key?(:error)
  @input_config = args[:input_config] if args.key?(:input_config)
  @responses = args[:responses] if args.key?(:responses)
  @total_pages = args[:total_pages] if args.key?(:total_pages)
end