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.



7029
7030
7031
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 7029

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:



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

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:



6881
6882
6883
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 6881

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) 


6886
6887
6888
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 6886

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) 


6892
6893
6894
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 6892

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) 


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

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) 


6907
6908
6909
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 6907

def drive_action
  @drive_action
end

#drive_state ⇒ String

Corresponds to the JSON property driveState

Returns:

  • (String) 


6912
6913
6914
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 6912

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:



6919
6920
6921
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 6919

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) 


6926
6927
6928
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 6926

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) 


6932
6933
6934
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 6932

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) 


6938
6939
6940
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 6938

def external_mimetype
  @external_mimetype
end

#id ⇒ String

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

Returns:

  • (String) 


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

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) 


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

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) 


6959
6960
6961
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 6959

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:



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

def legacy_upload_metadata
  @legacy_upload_metadata
end

#mimetype ⇒ String

Mimetype of the Drive Resource Corresponds to the JSON property mimetype

Returns:

  • (String) 


6970
6971
6972
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 6970

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) 


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

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:



6984
6985
6986
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 6984

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) 


6990
6991
6992
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 6990

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) 


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

def thumbnail_height
  @thumbnail_height
end

#thumbnail_url ⇒ String

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

Returns:

  • (String) 


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

def thumbnail_url
  @thumbnail_url
end

#thumbnail_width ⇒ Fixnum

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

Returns:

  • (Fixnum) 


7006
7007
7008
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 7006

def thumbnail_width
  @thumbnail_width
end

#title ⇒ String

Title of the Drive Resource Corresponds to the JSON property title

Returns:

  • (String) 


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

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) 


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

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:



7027
7028
7029
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 7027

def wrapped_resource_key
  @wrapped_resource_key
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



7034
7035
7036
7037
7038
7039
7040
7041
7042
7043
7044
7045
7046
7047
7048
7049
7050
7051
7052
7053
7054
7055
7056
7057
7058
7059
7060
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 7034

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