Class: Google::Apis::CloudsearchV1::GoogleDocsResultInfo

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

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.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleDocsResultInfo

Returns a new instance of GoogleDocsResultInfo.



1988
1989
1990
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 1988

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

Instance Attribute Details

#attachment_sha1 ⇒ String

The SHA1 hash of the object in Drive, if any. Corresponds to the JSON property attachmentSha1

Returns:

  • (String) 


1955
1956
1957
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 1955

def attachment_sha1
  @attachment_sha1
end

#cosmo_id ⇒ Google::Apis::CloudsearchV1::Id

Identifies a particular object, including both Users and DirEntries. This Id is unique across the entire server instance, such as the production or qa instance. Corresponds to the JSON property cosmoId

Returns:



1962
1963
1964
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 1962

def cosmo_id
  @cosmo_id
end

#cosmo_name_space ⇒ Fixnum

For Cosmo objects, the Cosmo namespace the object was in. This allows downstream clients to identify whether a document was created in Writely or Kix, Presently or Punch, or whether it was uploaded from GDrive. See storage_cosmo.Id.NAME_SPACE for a list of all Cosmo name spaces. Corresponds to the JSON property cosmoNameSpace

Returns:

  • (Fixnum) 


1970
1971
1972
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 1970

def cosmo_name_space
  @cosmo_name_space
end

#encrypted_id ⇒ String

The encrypted (user-visible) id of this object. Knowing the id is sufficient to create a canonical URL for this document. Corresponds to the JSON property encryptedId

Returns:

  • (String) 


1976
1977
1978
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 1976

def encrypted_id
  @encrypted_id
end

#mime_type ⇒ String

The mimetype of the document. Corresponds to the JSON property mimeType

Returns:

  • (String) 


1981
1982
1983
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 1981

def mime_type
  @mime_type
end

#share_scope ⇒ Google::Apis::CloudsearchV1::ShareScope

The visibility indicator in the UI will be based upon this. Corresponds to the JSON property shareScope

Returns:



1986
1987
1988
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 1986

def share_scope
  @share_scope
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1993
1994
1995
1996
1997
1998
1999
2000
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 1993

def update!(**args)
  @attachment_sha1 = args[:attachment_sha1] if args.key?(:attachment_sha1)
  @cosmo_id = args[:cosmo_id] if args.key?(:cosmo_id)
  @cosmo_name_space = args[:cosmo_name_space] if args.key?(:cosmo_name_space)
  @encrypted_id = args[:encrypted_id] if args.key?(:encrypted_id)
  @mime_type = args[:mime_type] if args.key?(:mime_type)
  @share_scope = args[:share_scope] if args.key?(:share_scope)
end