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



442
443
444
 
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 442

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) 


409
410
411
 
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 409

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) 


422
423
424
 
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 422

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) 


433
434
435
 
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 433

def dropzone
  @dropzone
end

#enabled ⇒ Boolean Also known as: enabled?

Whether download is enabled. Corresponds to the JSON property enabled

Returns:

  • (Boolean) 


415
416
417
 
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 415

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) 


428
429
430
 
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 428

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) 


439
440
441
 
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 439

def use_direct_download
  @use_direct_download
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



447
448
449
450
451
452
453
454
 
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 447

def update!(**args)
  @complete_notification = args[:complete_notification] if args.key?(:complete_notification)
  @enabled = args[:enabled] if args.key?(:enabled)
  @download_service = args[:download_service] if args.key?(:download_service)
  @max_direct_download_size = args[:max_direct_download_size] if args.key?(:max_direct_download_size)
  @dropzone = args[:dropzone] if args.key?(:dropzone)
  @use_direct_download = args[:use_direct_download] if args.key?(:use_direct_download)
end