Class: Google::Apis::ServiceuserV1::MediaDownload
- Inherits:
-
Object
- Object
- Google::Apis::ServiceuserV1::MediaDownload
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- generated/google/apis/serviceuser_v1/classes.rb,
generated/google/apis/serviceuser_v1/representations.rb,
generated/google/apis/serviceuser_v1/representations.rb
Overview
Defines the Media configuration for a service in case of a download. Use this only for Scotty Requests. Do not use this for media support using Bytestream, add instead [][google.bytestream.RestByteStream] as an API to your configuration for Bytestream methods.
Instance Attribute Summary collapse
-
#complete_notification ⇒ Boolean
(also: #complete_notification?)
A boolean that determines whether a notification for the completion of a download should be sent to the backend.
-
#download_service ⇒ String
DO NOT USE FIELDS BELOW THIS LINE UNTIL THIS WARNING IS REMOVED.
-
#dropzone ⇒ String
Name of the Scotty dropzone to use for the current API.
-
#enabled ⇒ Boolean
(also: #enabled?)
Whether download is enabled.
-
#max_direct_download_size ⇒ Fixnum
Optional maximum acceptable size for direct download.
-
#use_direct_download ⇒ Boolean
(also: #use_direct_download?)
A boolean that determines if direct download from ESF should be used for download of this media.
Instance Method Summary collapse
-
#initialize(**args) ⇒ MediaDownload
constructor
A new instance of MediaDownload.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ MediaDownload
Returns a new instance of MediaDownload
1629 1630 1631 |
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 1629 def initialize(**args) update!(**args) end |
Instance Attribute Details
#complete_notification ⇒ Boolean Also known as: complete_notification?
A boolean that determines whether a notification for the completion of a
download should be sent to the backend.
Corresponds to the JSON property completeNotification
1596 1597 1598 |
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 1596 def complete_notification @complete_notification end |
#download_service ⇒ String
DO NOT USE FIELDS BELOW THIS LINE UNTIL THIS WARNING IS REMOVED.
Specify name of the download service if one is used for download.
Corresponds to the JSON property downloadService
1603 1604 1605 |
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 1603 def download_service @download_service end |
#dropzone ⇒ String
Name of the Scotty dropzone to use for the current API.
Corresponds to the JSON property dropzone
1608 1609 1610 |
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 1608 def dropzone @dropzone end |
#enabled ⇒ Boolean Also known as: enabled?
Whether download is enabled.
Corresponds to the JSON property enabled
1613 1614 1615 |
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 1613 def enabled @enabled end |
#max_direct_download_size ⇒ Fixnum
Optional maximum acceptable size for direct download.
The size is specified in bytes.
Corresponds to the JSON property maxDirectDownloadSize
1620 1621 1622 |
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 1620 def max_direct_download_size @max_direct_download_size end |
#use_direct_download ⇒ Boolean Also known as: use_direct_download?
A boolean that determines if direct download from ESF should be used for
download of this media.
Corresponds to the JSON property useDirectDownload
1626 1627 1628 |
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 1626 def use_direct_download @use_direct_download end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
1634 1635 1636 1637 1638 1639 1640 1641 |
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 1634 def update!(**args) @complete_notification = args[:complete_notification] if args.key?(:complete_notification) @download_service = args[:download_service] if args.key?(:download_service) @dropzone = args[:dropzone] if args.key?(:dropzone) @enabled = args[:enabled] if args.key?(:enabled) @max_direct_download_size = args[:max_direct_download_size] if args.key?(:max_direct_download_size) @use_direct_download = args[:use_direct_download] if args.key?(:use_direct_download) end |