Class: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1AnnotateFileResponse

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

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ GoogleCloudVisionV1p1beta1AnnotateFileResponse

Returns a new instance of GoogleCloudVisionV1p1beta1AnnotateFileResponse.



1090
1091
1092
 
# File 'generated/google/apis/vision_v1p1beta1/classes.rb', line 1090

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

Instance Attribute Details

#error ⇒ Google::Apis::VisionV1p1beta1::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:



1072
1073
1074
 
# File 'generated/google/apis/vision_v1p1beta1/classes.rb', line 1072

def error
  @error
end

#input_config ⇒ Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1InputConfig

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

Returns:



1077
1078
1079
 
# File 'generated/google/apis/vision_v1p1beta1/classes.rb', line 1077

def input_config
  @input_config
end

#responses ⇒ Array<Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1AnnotateImageResponse>

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:



1083
1084
1085
 
# File 'generated/google/apis/vision_v1p1beta1/classes.rb', line 1083

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) 


1088
1089
1090
 
# File 'generated/google/apis/vision_v1p1beta1/classes.rb', line 1088

def total_pages
  @total_pages
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1095
1096
1097
1098
1099
1100
 
# File 'generated/google/apis/vision_v1p1beta1/classes.rb', line 1095

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