Class: Google::Apis::ServiceuserV1::MediaUpload

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 an upload. 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) ⇒ MediaUpload

Returns a new instance of MediaUpload



3552
3553
3554
 
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 3552

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 an upload should be sent to the backend. These notifications will not be seen by the client and will not consume quota. Corresponds to the JSON property completeNotification

Returns:

  • (Boolean) 


3508
3509
3510
 
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 3508

def complete_notification
  @complete_notification
end

#dropzone ⇒ String

Name of the Scotty dropzone to use for the current API. Corresponds to the JSON property dropzone

Returns:

  • (String) 


3526
3527
3528
 
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 3526

def dropzone
  @dropzone
end

#enabled ⇒ Boolean Also known as: enabled?

Whether upload is enabled. Corresponds to the JSON property enabled

Returns:

  • (Boolean) 


3520
3521
3522
 
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 3520

def enabled
  @enabled
end

#max_size ⇒ Fixnum

Optional maximum acceptable size for an upload. The size is specified in bytes. Corresponds to the JSON property maxSize

Returns:

  • (Fixnum) 


3550
3551
3552
 
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 3550

def max_size
  @max_size
end

#mime_types ⇒ Array<String>

An array of mimetype patterns. Esf will only accept uploads that match one of the given patterns. Corresponds to the JSON property mimeTypes

Returns:

  • (Array<String>) 


3544
3545
3546
 
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 3544

def mime_types
  @mime_types
end

#progress_notification ⇒ Boolean Also known as: progress_notification?

Whether to receive a notification for progress changes of media upload. Corresponds to the JSON property progressNotification

Returns:

  • (Boolean) 


3514
3515
3516
 
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 3514

def progress_notification
  @progress_notification
end

#start_notification ⇒ Boolean Also known as: start_notification?

Whether to receive a notification on the start of media upload. Corresponds to the JSON property startNotification

Returns:

  • (Boolean) 


3531
3532
3533
 
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 3531

def start_notification
  @start_notification
end

#upload_service ⇒ String

DO NOT USE FIELDS BELOW THIS LINE UNTIL THIS WARNING IS REMOVED. Specify name of the upload service if one is used for upload. Corresponds to the JSON property uploadService

Returns:

  • (String) 


3538
3539
3540
 
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 3538

def upload_service
  @upload_service
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
 
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 3557

def update!(**args)
  @complete_notification = args[:complete_notification] if args.key?(:complete_notification)
  @progress_notification = args[:progress_notification] if args.key?(:progress_notification)
  @enabled = args[:enabled] if args.key?(:enabled)
  @dropzone = args[:dropzone] if args.key?(:dropzone)
  @start_notification = args[:start_notification] if args.key?(:start_notification)
  @upload_service = args[:upload_service] if args.key?(:upload_service)
  @mime_types = args[:mime_types] if args.key?(:mime_types)
  @max_size = args[:max_size] if args.key?(:max_size)
end