Class: Google::Apis::ServiceuserV1::MediaDownload

Inherits:
Object
  • Object
show all
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

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ MediaDownload

Returns a new instance of MediaDownload



1739
1740
1741
 
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 1739

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

Returns:

  • (Boolean) 


1736
1737
1738
 
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 1736

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

Returns:

  • (String) 


1730
1731
1732
 
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 1730

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

Returns:

  • (String) 


1705
1706
1707
 
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 1705

def dropzone
  @dropzone
end

#enabled ⇒ Boolean Also known as: enabled?

Whether download is enabled. Corresponds to the JSON property enabled

Returns:

  • (Boolean) 


1723
1724
1725
 
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 1723

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

Returns:

  • (Fixnum) 


1711
1712
1713
 
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 1711

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

Returns:

  • (Boolean) 


1717
1718
1719
 
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 1717

def use_direct_download
  @use_direct_download
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1744
1745
1746
1747
1748
1749
1750
1751
 
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 1744

def update!(**args)
  @dropzone = args[:dropzone] if args.key?(:dropzone)
  @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)
  @enabled = args[:enabled] if args.key?(:enabled)
  @download_service = args[:download_service] if args.key?(:download_service)
  @complete_notification = args[:complete_notification] if args.key?(:complete_notification)
end