Class: Google::Apis::VisionV1::GoogleCloudVisionV1p2beta1AnnotateFileResponse

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/vision_v1/classes.rb,
lib/google/apis/vision_v1/representations.rb,
lib/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) ⇒ GoogleCloudVisionV1p2beta1AnnotateFileResponse

Returns a new instance of GoogleCloudVisionV1p2beta1AnnotateFileResponse.



3043
3044
3045
 
# File 'lib/google/apis/vision_v1/classes.rb', line 3043

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:



3025
3026
3027
 
# File 'lib/google/apis/vision_v1/classes.rb', line 3025

def error
  @error
end

#input_config ⇒ Google::Apis::VisionV1::GoogleCloudVisionV1p2beta1InputConfig

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

Returns:



3030
3031
3032
 
# File 'lib/google/apis/vision_v1/classes.rb', line 3030

def input_config
  @input_config
end

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

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:



3036
3037
3038
 
# File 'lib/google/apis/vision_v1/classes.rb', line 3036

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) 


3041
3042
3043
 
# File 'lib/google/apis/vision_v1/classes.rb', line 3041

def total_pages
  @total_pages
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3048
3049
3050
3051
3052
3053
 
# File 'lib/google/apis/vision_v1/classes.rb', line 3048

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