Reference documentation and code samples for the Cloud Vision V1 API class Google::Cloud::Vision::V1::AnnotateFileResponse.
Response to a single file annotation request. A file may contain one or more images, which individually have their own responses.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#error
def error() -> ::Google::Rpc::Status
    Returns
    
  - 
        (::Google::Rpc::Status) — If set, represents the error message for the failed request. The
responsesfield will not be set in this case.
#error=
def error=(value) -> ::Google::Rpc::Status
    Parameter
    
  - 
        value (::Google::Rpc::Status) — If set, represents the error message for the failed request. The
responsesfield will not be set in this case.
    Returns
    
  - 
        (::Google::Rpc::Status) — If set, represents the error message for the failed request. The
responsesfield will not be set in this case.
#input_config
def input_config() -> ::Google::Cloud::Vision::V1::InputConfig
    Returns
    
  - (::Google::Cloud::Vision::V1::InputConfig) — Information about the file for which this response is generated.
#input_config=
def input_config=(value) -> ::Google::Cloud::Vision::V1::InputConfig
    Parameter
    
  - value (::Google::Cloud::Vision::V1::InputConfig) — 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.
#responses
def responses() -> ::Array<::Google::Cloud::Vision::V1::AnnotateImageResponse>
    Returns
    
  - 
        (::Array<::Google::Cloud::Vision::V1::AnnotateImageResponse>) — Individual responses to images found within the file. This field will be
empty if the errorfield is set.
#responses=
def responses=(value) -> ::Array<::Google::Cloud::Vision::V1::AnnotateImageResponse>
    Parameter
    
  - 
        value (::Array<::Google::Cloud::Vision::V1::AnnotateImageResponse>) — Individual responses to images found within the file. This field will be
empty if the errorfield is set.
    Returns
    
  - 
        (::Array<::Google::Cloud::Vision::V1::AnnotateImageResponse>) — Individual responses to images found within the file. This field will be
empty if the errorfield is set.
#total_pages
def total_pages() -> ::Integer
    Returns
    
  - (::Integer) — This field gives the total number of pages in the file.
#total_pages=
def total_pages=(value) -> ::Integer
    Parameter
    
  - value (::Integer) — This field gives the total number of pages in the file.
    Returns
    
- (::Integer) — This field gives the total number of pages in the file.