Class: Google::Apis::CloudsearchV1::DriveMetadata

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

Annotation metadata for Drive artifacts.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ DriveMetadata

Returns a new instance of DriveMetadata.



7020
7021
7022
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 7020

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

Instance Attribute Details

#acl_fix_request ⇒ Google::Apis::CloudsearchV1::AclFixRequest

The request set by clients to instruct Backend how the user intend to fix the ACL. Technically it's not a request to ACL Fixer, because Backend uses / DriveService.Share to modify Drive ACLs. Corresponds to the JSON property aclFixRequest

Returns:



6864
6865
6866
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 6864

def acl_fix_request
  @acl_fix_request
end

#acl_fix_status ⇒ Google::Apis::CloudsearchV1::AclFixStatus

The message reconstructed based on information in the response of / PermissionFixOptionsService.Query (or the Apiary API that wraps it). Indicates the ability of the requester to change the access to the Drive file for the room roster or the DM members. Used in GetMessagePreviewMetadataResponse only. Corresponds to the JSON property aclFixStatus

Returns:



6872
6873
6874
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 6872

def acl_fix_status
  @acl_fix_status
end

#can_edit ⇒ Boolean Also known as: can_edit?

Can the current user edit this resource Corresponds to the JSON property canEdit

Returns:

  • (Boolean) 


6877
6878
6879
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 6877

def can_edit
  @can_edit
end

#can_share ⇒ Boolean Also known as: can_share?

Can the current user share this resource Corresponds to the JSON property canShare

Returns:

  • (Boolean) 


6883
6884
6885
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 6883

def can_share
  @can_share
end

#can_view ⇒ Boolean Also known as: can_view?

Can the current user view this resource Corresponds to the JSON property canView

Returns:

  • (Boolean) 


6889
6890
6891
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 6889

def can_view
  @can_view
end

#drive_action ⇒ String

DriveAction for organizing this file in Drive. If the user does not have access to the Drive file, the value will be DriveAction. DRIVE_ACTION_UNSPECIFIED. This field is only set when part of a FileResult in a ListFilesResponse. Corresponds to the JSON property driveAction

Returns:

  • (String) 


6898
6899
6900
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 6898

def drive_action
  @drive_action
end

#drive_state ⇒ String

Corresponds to the JSON property driveState

Returns:

  • (String) 


6903
6904
6905
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 6903

def drive_state
  @drive_state
end

#embed_url ⇒ Google::Apis::CloudsearchV1::TrustedResourceUrlProto

Message containing a string that is safe to use in all URL contexts in DOM APIs and HTML documents; even where the referred-to resource is interpreted as code, e.g., as the src of a script element. Corresponds to the JSON property embedUrl

Returns:



6910
6911
6912
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 6910

def embed_url
  @embed_url
end

#encrypted_doc_id ⇒ Boolean Also known as: encrypted_doc_id?

Indicates whether the Drive link contains an encrypted doc ID. If true, Dynamite should not attempt to query the doc ID in Drive Service. See go/docid- encryption for details. Corresponds to the JSON property encryptedDocId

Returns:

  • (Boolean) 


6917
6918
6919
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 6917

def encrypted_doc_id
  @encrypted_doc_id
end

#encrypted_resource_key ⇒ String

This is deprecated and unneeded. TODO (b/182479059): Remove this. Corresponds to the JSON property encryptedResourceKey

Returns:

  • (String) 


6923
6924
6925
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 6923

def encrypted_resource_key
  @encrypted_resource_key
end

#external_mimetype ⇒ String

External mimetype of the Drive Resource (Useful for creating Drive URL) See: http://b/35219462 Corresponds to the JSON property externalMimetype

Returns:

  • (String) 


6929
6930
6931
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 6929

def external_mimetype
  @external_mimetype
end

#id ⇒ String

Drive resource ID of the artifact. Corresponds to the JSON property id

Returns:

  • (String) 


6934
6935
6936
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 6934

def id
  @id
end

#is_download_restricted ⇒ Boolean Also known as: is_download_restricted?

Deprecated. Whether the setting to restrict downloads is enabled for this file. This was previously used to determine whether to hide the download and print buttons in the UI, but is no longer used by clients, because Projector now independently queries Drive to ensure that we have the most up-to-date value. Corresponds to the JSON property isDownloadRestricted

Returns:

  • (Boolean) 


6942
6943
6944
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 6942

def is_download_restricted
  @is_download_restricted
end

#is_owner ⇒ Boolean Also known as: is_owner?

If the current user is the Drive file's owner. The field is currently only set for Annotations for the ListFiles action (as opposed to fetching Topics/ Messages with Drive annotations). Corresponds to the JSON property isOwner

Returns:

  • (Boolean) 


6950
6951
6952
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 6950

def is_owner
  @is_owner
end

#legacy_upload_metadata ⇒ Google::Apis::CloudsearchV1::LegacyUploadMetadata

The original UploadMetadata that this DriveMetadata was converted from. Corresponds to the JSON property legacyUploadMetadata

Returns:



6956
6957
6958
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 6956

def legacy_upload_metadata
  @legacy_upload_metadata
end

#mimetype ⇒ String

Mimetype of the Drive Resource Corresponds to the JSON property mimetype

Returns:

  • (String) 


6961
6962
6963
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 6961

def mimetype
  @mimetype
end

#organization_display_name ⇒ String

The display name of the organization owning the Drive item. Corresponds to the JSON property organizationDisplayName

Returns:

  • (String) 


6966
6967
6968
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 6966

def organization_display_name
  @organization_display_name
end

#shortcut_authorized_item_id ⇒ Google::Apis::CloudsearchV1::AuthorizedItemId

A combination of an identifier for a Drive resource (e.g. file, folder, or drive) and any secrets needed to access it. The secrets should never be logged, and this proto annotates those secret fields to ensure that they are not. Clients are encouraged to use this proto rather than defining their own, to ensure that secrets are correctly annotated. Corresponds to the JSON property shortcutAuthorizedItemId

Returns:



6975
6976
6977
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 6975

def shortcut_authorized_item_id
  @shortcut_authorized_item_id
end

#should_not_render ⇒ Boolean Also known as: should_not_render?

If this field is set to true, server should still contact external backends to get metadata for search but clients should not render this chip. Corresponds to the JSON property shouldNotRender

Returns:

  • (Boolean) 


6981
6982
6983
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 6981

def should_not_render
  @should_not_render
end

#thumbnail_height ⇒ Fixnum

Thumbnail image of the Drive Resource Corresponds to the JSON property thumbnailHeight

Returns:

  • (Fixnum) 


6987
6988
6989
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 6987

def thumbnail_height
  @thumbnail_height
end

#thumbnail_url ⇒ String

Thumbnail image of the Drive Resource Corresponds to the JSON property thumbnailUrl

Returns:

  • (String) 


6992
6993
6994
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 6992

def thumbnail_url
  @thumbnail_url
end

#thumbnail_width ⇒ Fixnum

Thumbnail image of the Drive Resource Corresponds to the JSON property thumbnailWidth

Returns:

  • (Fixnum) 


6997
6998
6999
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 6997

def thumbnail_width
  @thumbnail_width
end

#title ⇒ String

Title of the Drive Resource Corresponds to the JSON property title

Returns:

  • (String) 


7002
7003
7004
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 7002

def title
  @title
end

#url_fragment ⇒ String

Url string fragment that generally indicates the specific location in the linked file. Example: #header=h.123abc456. If the fragment is not present this will not be present and therefore default to an empty string. The "#" will not be included. Corresponds to the JSON property urlFragment

Returns:

  • (String) 


7010
7011
7012
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 7010

def url_fragment
  @url_fragment
end

#wrapped_resource_key ⇒ Google::Apis::CloudsearchV1::WrappedResourceKey

A wrapper around a raw resource key. The secret should never be logged, and this proto annotates those secret fields to ensure that they are not. Clients are encouraged to use this proto rather than defining their own, to ensure that secrets are correctly annotated. Corresponds to the JSON property wrappedResourceKey

Returns:



7018
7019
7020
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 7018

def wrapped_resource_key
  @wrapped_resource_key
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



7025
7026
7027
7028
7029
7030
7031
7032
7033
7034
7035
7036
7037
7038
7039
7040
7041
7042
7043
7044
7045
7046
7047
7048
7049
7050
7051
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 7025

def update!(**args)
  @acl_fix_request = args[:acl_fix_request] if args.key?(:acl_fix_request)
  @acl_fix_status = args[:acl_fix_status] if args.key?(:acl_fix_status)
  @can_edit = args[:can_edit] if args.key?(:can_edit)
  @can_share = args[:can_share] if args.key?(:can_share)
  @can_view = args[:can_view] if args.key?(:can_view)
  @drive_action = args[:drive_action] if args.key?(:drive_action)
  @drive_state = args[:drive_state] if args.key?(:drive_state)
  @embed_url = args[:embed_url] if args.key?(:embed_url)
  @encrypted_doc_id = args[:encrypted_doc_id] if args.key?(:encrypted_doc_id)
  @encrypted_resource_key = args[:encrypted_resource_key] if args.key?(:encrypted_resource_key)
  @external_mimetype = args[:external_mimetype] if args.key?(:external_mimetype)
  @id = args[:id] if args.key?(:id)
  @is_download_restricted = args[:is_download_restricted] if args.key?(:is_download_restricted)
  @is_owner = args[:is_owner] if args.key?(:is_owner)
  @legacy_upload_metadata = args[:legacy_upload_metadata] if args.key?(:legacy_upload_metadata)
  @mimetype = args[:mimetype] if args.key?(:mimetype)
  @organization_display_name = args[:organization_display_name] if args.key?(:organization_display_name)
  @shortcut_authorized_item_id = args[:shortcut_authorized_item_id] if args.key?(:shortcut_authorized_item_id)
  @should_not_render = args[:should_not_render] if args.key?(:should_not_render)
  @thumbnail_height = args[:thumbnail_height] if args.key?(:thumbnail_height)
  @thumbnail_url = args[:thumbnail_url] if args.key?(:thumbnail_url)
  @thumbnail_width = args[:thumbnail_width] if args.key?(:thumbnail_width)
  @title = args[:title] if args.key?(:title)
  @url_fragment = args[:url_fragment] if args.key?(:url_fragment)
  @wrapped_resource_key = args[:wrapped_resource_key] if args.key?(:wrapped_resource_key)
end