Class: Google::Apis::CloudsearchV1::EnterpriseTopazSidekickCommonDocument

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

Representation of a document. NEXT_TAG: 15

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ EnterpriseTopazSidekickCommonDocument

Returns a new instance of EnterpriseTopazSidekickCommonDocument.



1865
1866
1867
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 1865

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

Instance Attribute Details

#access_type ⇒ String

Access type, i.e., whether the user has access to the document or not. Corresponds to the JSON property accessType

Returns:

  • (String) 


1797
1798
1799
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 1797

def access_type
  @access_type
end

#debug_info ⇒ Google::Apis::CloudsearchV1::EnterpriseTopazSidekickCommonDebugInfo

Container of debugging information in all object levels. Extend as needed. Corresponds to the JSON property debugInfo

Returns:



1802
1803
1804
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 1802

def debug_info
  @debug_info
end

#document_id ⇒ String

Document id. Corresponds to the JSON property documentId

Returns:

  • (String) 


1807
1808
1809
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 1807

def document_id
  @document_id
end

#drive_document_metadata ⇒ Google::Apis::CloudsearchV1::EnterpriseTopazSidekickCommonDocumentDriveDocumentMetadata

Meta data for drive documents. Corresponds to the JSON property driveDocumentMetadata

Returns:



1812
1813
1814
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 1812

def drive_document_metadata
  @drive_document_metadata
end

#generic_url ⇒ String

Generic Drive-based url in the format of drive.google.com/open to be used for deeplink Corresponds to the JSON property genericUrl

Returns:

  • (String) 


1818
1819
1820
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 1818

def generic_url
  @generic_url
end

#justification ⇒ Google::Apis::CloudsearchV1::EnterpriseTopazSidekickCommonDocumentJustification

Justification of why we are reporting the document. Corresponds to the JSON property justification

Returns:



1823
1824
1825
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 1823

def justification
  @justification
end

#mime_type ⇒ String

MIME type Corresponds to the JSON property mimeType

Returns:

  • (String) 


1828
1829
1830
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 1828

def mime_type
  @mime_type
end

#provenance ⇒ String

Document provenance. Corresponds to the JSON property provenance

Returns:

  • (String) 


1833
1834
1835
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 1833

def provenance
  @provenance
end

#reason ⇒ String

Justification of why this document is being returned. Corresponds to the JSON property reason

Returns:

  • (String) 


1838
1839
1840
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 1838

def reason
  @reason
end

#snippet ⇒ String

A sampling of the text from the document. Corresponds to the JSON property snippet

Returns:

  • (String) 


1843
1844
1845
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 1843

def snippet
  @snippet
end

#thumbnail_url ⇒ String

Thumbnail URL. Corresponds to the JSON property thumbnailUrl

Returns:

  • (String) 


1848
1849
1850
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 1848

def thumbnail_url
  @thumbnail_url
end

#title ⇒ String

Title of the document. Corresponds to the JSON property title

Returns:

  • (String) 


1853
1854
1855
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 1853

def title
  @title
end

#type ⇒ String

Type of the document. Corresponds to the JSON property type

Returns:

  • (String) 


1858
1859
1860
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 1858

def type
  @type
end

#url ⇒ String

Absolute URL of the document. Corresponds to the JSON property url

Returns:

  • (String) 


1863
1864
1865
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 1863

def url
  @url
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 1870

def update!(**args)
  @access_type = args[:access_type] if args.key?(:access_type)
  @debug_info = args[:debug_info] if args.key?(:debug_info)
  @document_id = args[:document_id] if args.key?(:document_id)
  @drive_document_metadata = args[:drive_document_metadata] if args.key?(:drive_document_metadata)
  @generic_url = args[:generic_url] if args.key?(:generic_url)
  @justification = args[:justification] if args.key?(:justification)
  @mime_type = args[:mime_type] if args.key?(:mime_type)
  @provenance = args[:provenance] if args.key?(:provenance)
  @reason = args[:reason] if args.key?(:reason)
  @snippet = args[:snippet] if args.key?(:snippet)
  @thumbnail_url = args[:thumbnail_url] if args.key?(:thumbnail_url)
  @title = args[:title] if args.key?(:title)
  @type = args[:type] if args.key?(:type)
  @url = args[:url] if args.key?(:url)
end