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



1870
1871
1872
 
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 1870

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) 


1838
1839
1840
 
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 1838

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) 


1844
1845
1846
 
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 1844

def dropzone
  @dropzone
end

#enabled ⇒ Boolean Also known as: enabled?

Whether upload is enabled. Corresponds to the JSON property enabled

Returns:

  • (Boolean) 


1824
1825
1826
 
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 1824

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) 


1868
1869
1870
 
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 1868

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>) 


1862
1863
1864
 
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 1862

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) 


1830
1831
1832
 
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 1830

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) 


1849
1850
1851
 
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 1849

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) 


1856
1857
1858
 
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 1856

def upload_service
  @upload_service
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
 
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 1875

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