Class: Google::Apis::CloudsearchV1::GoogleDocsMetadata

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
lib/google/apis/cloudsearch_v1/classes.rb,
lib/google/apis/cloudsearch_v1/representations.rb,
lib/google/apis/cloudsearch_v1/representations.rb

Overview

The corpus specific metadata for office-type documents, from Google Docs and other sources. This message is passed to the scorer and beyond. Next tag: 9

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleDocsMetadata

Returns a new instance of GoogleDocsMetadata.



3834
3835
3836
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 3834

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

Instance Attribute Details

#acl_info ⇒ Google::Apis::CloudsearchV1::AclInfo

Next tag: 4 Corresponds to the JSON property aclInfo

Returns:



3792
3793
3794
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 3792

def acl_info
  @acl_info
end

#document_type ⇒ String

The conceptual type (presentation, document, etc.) of this document. Corresponds to the JSON property documentType

Returns:

  • (String) 


3797
3798
3799
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 3797

def document_type
  @document_type
end

#file_extension ⇒ String

The file extension of the document. NOTE: As of October 2018 this field is not backfilled for old documents. Corresponds to the JSON property fileExtension

Returns:

  • (String) 


3803
3804
3805
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 3803

def file_extension
  @file_extension
end

#last_content_modified_timestamp ⇒ Fixnum

The last time this document was modified, in seconds since epoch. Only counts content modifications. Corresponds to the JSON property lastContentModifiedTimestamp

Returns:

  • (Fixnum) 


3809
3810
3811
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 3809

def last_content_modified_timestamp
  @last_content_modified_timestamp
end

#num_subscribers ⇒ Fixnum

Contains number of subscribers for the document. Corresponds to the JSON property numSubscribers

Returns:

  • (Fixnum) 


3814
3815
3816
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 3814

def num_subscribers
  @num_subscribers
end

#num_viewers ⇒ Fixnum

Size of untruncated viewers list. Corresponds to the JSON property numViewers

Returns:

  • (Fixnum) 


3819
3820
3821
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 3819

def num_viewers
  @num_viewers
end

#result_info ⇒ Google::Apis::CloudsearchV1::GoogleDocsResultInfo

A message containing information about a specific result. This information is passed to the scorer and beyond; in particular, GWS relies on it to format the result in the UI. Split from GoogleDocsMetadata in case we later want to reuse the message. Corresponds to the JSON property resultInfo

Returns:



3827
3828
3829
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 3827

def result_info
  @result_info
end

#type_info ⇒ Google::Apis::CloudsearchV1::TypeInfo

Next tag: 2 Corresponds to the JSON property typeInfo

Returns:



3832
3833
3834
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 3832

def type_info
  @type_info
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 3839

def update!(**args)
  @acl_info = args[:acl_info] if args.key?(:acl_info)
  @document_type = args[:document_type] if args.key?(:document_type)
  @file_extension = args[:file_extension] if args.key?(:file_extension)
  @last_content_modified_timestamp = args[:last_content_modified_timestamp] if args.key?(:last_content_modified_timestamp)
  @num_subscribers = args[:num_subscribers] if args.key?(:num_subscribers)
  @num_viewers = args[:num_viewers] if args.key?(:num_viewers)
  @result_info = args[:result_info] if args.key?(:result_info)
  @type_info = args[:type_info] if args.key?(:type_info)
end