Class: Google::Apis::ServiceusageV1beta1::MediaUpload

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/serviceusage_v1beta1/classes.rb,
generated/google/apis/serviceusage_v1beta1/representations.rb,
generated/google/apis/serviceusage_v1beta1/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



2619
2620
2621
# File 'generated/google/apis/serviceusage_v1beta1/classes.rb', line 2619

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

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


2575
2576
2577
# File 'generated/google/apis/serviceusage_v1beta1/classes.rb', line 2575

def complete_notification
  @complete_notification
end

#dropzoneString

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

Returns:

  • (String)


2581
2582
2583
# File 'generated/google/apis/serviceusage_v1beta1/classes.rb', line 2581

def dropzone
  @dropzone
end

#enabledBoolean Also known as: enabled?

Whether upload is enabled. Corresponds to the JSON property enabled

Returns:

  • (Boolean)


2586
2587
2588
# File 'generated/google/apis/serviceusage_v1beta1/classes.rb', line 2586

def enabled
  @enabled
end

#max_sizeFixnum

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

Returns:

  • (Fixnum)


2593
2594
2595
# File 'generated/google/apis/serviceusage_v1beta1/classes.rb', line 2593

def max_size
  @max_size
end

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


2599
2600
2601
# File 'generated/google/apis/serviceusage_v1beta1/classes.rb', line 2599

def mime_types
  @mime_types
end

#progress_notificationBoolean Also known as: progress_notification?

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

Returns:

  • (Boolean)


2604
2605
2606
# File 'generated/google/apis/serviceusage_v1beta1/classes.rb', line 2604

def progress_notification
  @progress_notification
end

#start_notificationBoolean Also known as: start_notification?

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

Returns:

  • (Boolean)


2610
2611
2612
# File 'generated/google/apis/serviceusage_v1beta1/classes.rb', line 2610

def start_notification
  @start_notification
end

#upload_serviceString

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)


2617
2618
2619
# File 'generated/google/apis/serviceusage_v1beta1/classes.rb', line 2617

def upload_service
  @upload_service
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
# File 'generated/google/apis/serviceusage_v1beta1/classes.rb', line 2624

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