Class: Google::Apis::CloudsearchV1::DriveMetadata
- Inherits:
-
Object
- Object
- Google::Apis::CloudsearchV1::DriveMetadata
- 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
-
#acl_fix_request ⇒ Google::Apis::CloudsearchV1::AclFixRequest
The request set by clients to instruct Backend how the user intend to fix the ACL.
-
#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).
-
#can_edit ⇒ Boolean
(also: #can_edit?)
Can the current user edit this resource Corresponds to the JSON property
canEdit
. -
#can_share ⇒ Boolean
(also: #can_share?)
Can the current user share this resource Corresponds to the JSON property
canShare
. -
#can_view ⇒ Boolean
(also: #can_view?)
Can the current user view this resource Corresponds to the JSON property
canView
. -
#drive_action ⇒ String
DriveAction for organizing this file in Drive.
-
#drive_state ⇒ String
Corresponds to the JSON property
driveState
. -
#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.
-
#encrypted_doc_id ⇒ Boolean
(also: #encrypted_doc_id?)
Indicates whether the Drive link contains an encrypted doc ID.
-
#encrypted_resource_key ⇒ String
This is deprecated and unneeded.
-
#external_mimetype ⇒ String
External mimetype of the Drive Resource (Useful for creating Drive URL) See: http://b/35219462 Corresponds to the JSON property
externalMimetype
. -
#id ⇒ String
Drive resource ID of the artifact.
-
#is_download_restricted ⇒ Boolean
(also: #is_download_restricted?)
Deprecated.
-
#is_owner ⇒ Boolean
(also: #is_owner?)
If the current user is the Drive file's owner.
-
#legacy_upload_metadata ⇒ Google::Apis::CloudsearchV1::LegacyUploadMetadata
The original UploadMetadata that this DriveMetadata was converted from.
-
#mimetype ⇒ String
Mimetype of the Drive Resource Corresponds to the JSON property
mimetype
. -
#organization_display_name ⇒ String
The display name of the organization owning the Drive item.
-
#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.
-
#should_not_render ⇒ Boolean
(also: #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.
-
#thumbnail_height ⇒ Fixnum
Thumbnail image of the Drive Resource Corresponds to the JSON property
thumbnailHeight
. -
#thumbnail_url ⇒ String
Thumbnail image of the Drive Resource Corresponds to the JSON property
thumbnailUrl
. -
#thumbnail_width ⇒ Fixnum
Thumbnail image of the Drive Resource Corresponds to the JSON property
thumbnailWidth
. -
#title ⇒ String
Title of the Drive Resource Corresponds to the JSON property
title
. -
#url_fragment ⇒ String
Url string fragment that generally indicates the specific location in the linked file.
-
#wrapped_resource_key ⇒ Google::Apis::CloudsearchV1::WrappedResourceKey
A wrapper around a raw resource key.
Instance Method Summary collapse
-
#initialize(**args) ⇒ DriveMetadata
constructor
A new instance of DriveMetadata.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ DriveMetadata
Returns a new instance of DriveMetadata.
8157 8158 8159 |
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 8157 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
8001 8002 8003 |
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 8001 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
8009 8010 8011 |
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 8009 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
8014 8015 8016 |
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 8014 def can_edit @can_edit end |
#can_share ⇒ Boolean Also known as:
Can the current user share this resource
Corresponds to the JSON property canShare
8020 8021 8022 |
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 8020 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
8026 8027 8028 |
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 8026 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
8035 8036 8037 |
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 8035 def drive_action @drive_action end |
#drive_state ⇒ String
Corresponds to the JSON property driveState
8040 8041 8042 |
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 8040 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
8047 8048 8049 |
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 8047 def @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
8054 8055 8056 |
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 8054 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
8060 8061 8062 |
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 8060 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
8066 8067 8068 |
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 8066 def external_mimetype @external_mimetype end |
#id ⇒ String
Drive resource ID of the artifact.
Corresponds to the JSON property id
8071 8072 8073 |
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 8071 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
8079 8080 8081 |
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 8079 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
8087 8088 8089 |
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 8087 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
8093 8094 8095 |
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 8093 def @legacy_upload_metadata end |
#mimetype ⇒ String
Mimetype of the Drive Resource
Corresponds to the JSON property mimetype
8098 8099 8100 |
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 8098 def mimetype @mimetype end |
#organization_display_name ⇒ String
The display name of the organization owning the Drive item.
Corresponds to the JSON property organizationDisplayName
8103 8104 8105 |
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 8103 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
8112 8113 8114 |
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 8112 def @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
8118 8119 8120 |
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 8118 def should_not_render @should_not_render end |
#thumbnail_height ⇒ Fixnum
Thumbnail image of the Drive Resource
Corresponds to the JSON property thumbnailHeight
8124 8125 8126 |
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 8124 def thumbnail_height @thumbnail_height end |
#thumbnail_url ⇒ String
Thumbnail image of the Drive Resource
Corresponds to the JSON property thumbnailUrl
8129 8130 8131 |
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 8129 def thumbnail_url @thumbnail_url end |
#thumbnail_width ⇒ Fixnum
Thumbnail image of the Drive Resource
Corresponds to the JSON property thumbnailWidth
8134 8135 8136 |
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 8134 def thumbnail_width @thumbnail_width end |
#title ⇒ String
Title of the Drive Resource
Corresponds to the JSON property title
8139 8140 8141 |
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 8139 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
8147 8148 8149 |
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 8147 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
8155 8156 8157 |
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 8155 def wrapped_resource_key @wrapped_resource_key end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
8162 8163 8164 8165 8166 8167 8168 8169 8170 8171 8172 8173 8174 8175 8176 8177 8178 8179 8180 8181 8182 8183 8184 8185 8186 8187 8188 |
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 8162 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 |