Class: Google::Apis::YoutubePartnerV1::MediaResponseInfo

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/youtube_partner_v1/classes.rb,
generated/google/apis/youtube_partner_v1/representations.rb,
generated/google/apis/youtube_partner_v1/representations.rb

Overview

This message is for backends to pass their scotty media specific fields to ESF. Backend will include this in their response message to ESF. Example: ExportFile is an rpc defined for upload using scotty from ESF. rpc ExportFile( ExportFileRequest) returns (ExportFileResponse) Message ExportFileResponse will include apiserving.MediaResponseInfo to tell ESF about data like dynamic_dropzone it needs to pass to Scotty. message ExportFileResponse optional gdata.Media blob = 1; optional apiserving.MediaResponseInfo media_response_info = 2

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ MediaResponseInfo

Returns a new instance of MediaResponseInfo.



2389
2390
2391
 
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 2389

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

Instance Attribute Details

#custom_data ⇒ String

Data to copy from backend response to the next backend requests. Custom data is returned to Scotty in the agent_state field, which Scotty will then provide in subsequent upload notifications. Corresponds to the JSON property customData

Returns:

  • (String) 


2333
2334
2335
 
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 2333

def custom_data
  @custom_data
end

#data_storage_transform ⇒ String

Specifies any transformation to be applied to data before persisting it or retrieving from storage. E.g., encryption options for blobstore2. This should be of the form uploader_service.DataStorageTransform. Corresponds to the JSON property dataStorageTransform NOTE: Values are automatically base64 encoded/decoded in the client library.

Returns:

  • (String) 


2341
2342
2343
 
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 2341

def data_storage_transform
  @data_storage_transform
end

#dynamic_drop_target ⇒ String

Specifies the Scotty Drop Target to use for uploads. If present in a media response, Scotty does not upload to a standard drop zone. Instead, Scotty saves the upload directly to the location specified in this drop target. Unlike drop zones, the drop target is the final storage location for an upload. So, the agent does not need to clone the blob at the end of the upload. The agent is responsible for garbage collecting any orphaned blobs that may occur due to aborted uploads. For more information, see the drop target design doc here: http://goto/ScottyDropTarget This field will be preferred to dynamicDropzone. If provided, the identified field in the response must be of the type uploader.agent.DropTarget. Corresponds to the JSON property dynamicDropTarget NOTE: Values are automatically base64 encoded/decoded in the client library.

Returns:

  • (String) 


2356
2357
2358
 
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 2356

def dynamic_drop_target
  @dynamic_drop_target
end

#dynamic_dropzone ⇒ String

Specifies the Scotty dropzone to use for uploads. Corresponds to the JSON property dynamicDropzone

Returns:

  • (String) 


2361
2362
2363
 
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 2361

def dynamic_dropzone
  @dynamic_dropzone
end

#media_for_diff ⇒ Google::Apis::YoutubePartnerV1::Media

A reference to data stored on the filesystem, on GFS or in blobstore. Corresponds to the JSON property mediaForDiff

Returns:



2366
2367
2368
 
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 2366

def media_for_diff
  @media_for_diff
end

#request_class ⇒ String

Request class to use for all Blobstore operations for this request. Corresponds to the JSON property requestClass

Returns:

  • (String) 


2371
2372
2373
 
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 2371

def request_class
  @request_class
end

#traffic_class_field ⇒ String

Specifies the TrafficClass that Scotty should use for any RPCs to fetch the response bytes. Will override the traffic class GTOS of the incoming http request. This is a temporary field to facilitate whitelisting and experimentation by the bigstore agent only. For instance, this does not apply to RTMP reads. WARNING: DO NOT USE WITHOUT PERMISSION FROM THE SCOTTY TEAM. Corresponds to the JSON property trafficClassField

Returns:

  • (String) 


2380
2381
2382
 
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 2380

def traffic_class_field
  @traffic_class_field
end

#verify_hash_from_header ⇒ Boolean Also known as: verify_hash_from_header?

Tells Scotty to verify hashes on the agent's behalf by parsing out the X-Goog- Hash header. Corresponds to the JSON property verifyHashFromHeader

Returns:

  • (Boolean) 


2386
2387
2388
 
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 2386

def verify_hash_from_header
  @verify_hash_from_header
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
 
# File 'generated/google/apis/youtube_partner_v1/classes.rb', line 2394

def update!(**args)
  @custom_data = args[:custom_data] if args.key?(:custom_data)
  @data_storage_transform = args[:data_storage_transform] if args.key?(:data_storage_transform)
  @dynamic_drop_target = args[:dynamic_drop_target] if args.key?(:dynamic_drop_target)
  @dynamic_dropzone = args[:dynamic_dropzone] if args.key?(:dynamic_dropzone)
  @media_for_diff = args[:media_for_diff] if args.key?(:media_for_diff)
  @request_class = args[:request_class] if args.key?(:request_class)
  @traffic_class_field = args[:traffic_class_field] if args.key?(:traffic_class_field)
  @verify_hash_from_header = args[:verify_hash_from_header] if args.key?(:verify_hash_from_header)
end