Class: Google::Cloud::Vision::V1::AnnotateFileResponse

Inherits:

Object

• Object
• Google::Cloud::Vision::V1::AnnotateFileResponse

Extended by:

Protobuf::MessageExts::ClassMethods

Includes:

Protobuf::MessageExts

Defined in:

proto_docs/google/cloud/vision/v1/image_annotator.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

• #error ⇒ ::Google::Rpc::Status

  If set, represents the error message for the failed request.

• #input_config ⇒ ::Google::Cloud::Vision::V1::InputConfig

  Information about the file for which this response is generated.

• #responses ⇒ ::Array<::Google::Cloud::Vision::V1::AnnotateImageResponse>

  Individual responses to images found within the file.

• #total_pages ⇒ ::Integer

  This field gives the total number of pages in the file.

Instance Attribute Details

#error ⇒ ::Google::Rpc::Status

Returns If set, represents the error message for the failed request. The responses field will not be set in this case.

Returns:

• (::Google::Rpc::Status) —

  If set, represents the error message for the failed request. The responses field will not be set in this case.

# File 'proto_docs/google/cloud/vision/v1/image_annotator.rb', line 769

class AnnotateFileResponse
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#input_config ⇒ ::Google::Cloud::Vision::V1::InputConfig

Returns Information about the file for which this response is generated.

Returns:

• (::Google::Cloud::Vision::V1::InputConfig) —

  Information about the file for which this response is generated.

# File 'proto_docs/google/cloud/vision/v1/image_annotator.rb', line 769

class AnnotateFileResponse
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#responses ⇒ ::Array<::Google::Cloud::Vision::V1::AnnotateImageResponse>

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

Returns:

• (::Array<::Google::Cloud::Vision::V1::AnnotateImageResponse>) —

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

# File 'proto_docs/google/cloud/vision/v1/image_annotator.rb', line 769

class AnnotateFileResponse
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#total_pages ⇒ ::Integer

Returns This field gives the total number of pages in the file.

Returns:

• (::Integer) —

  This field gives the total number of pages in the file.

# File 'proto_docs/google/cloud/vision/v1/image_annotator.rb', line 769

class AnnotateFileResponse
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end