Class: Google::Apis::WalletobjectsV1::Media

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

Overview

A reference to data stored on the filesystem, on GFS or in blobstore.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Media

Returns a new instance of Media.



5703
5704
5705
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 5703

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

Instance Attribute Details

#algorithm ⇒ String

Deprecated, use one of explicit hash type fields instead. Algorithm used for calculating the hash. As of 2011/01/21, "MD5" is the only possible value for this field. New values may be added at any time. Corresponds to the JSON property algorithm

Returns:

  • (String) 


5507
5508
5509
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 5507

def algorithm
  @algorithm
end

#bigstore_object_ref ⇒ String

Use object_id instead. Corresponds to the JSON property bigstoreObjectRef NOTE: Values are automatically base64 encoded/decoded in the client library.

Returns:

  • (String) 


5513
5514
5515
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 5513

def bigstore_object_ref
  @bigstore_object_ref
end

#blob_ref ⇒ String

Blobstore v1 reference, set if reference_type is BLOBSTORE_REF This should be the byte representation of a blobstore.BlobRef. Since Blobstore is deprecating v1, use blobstore2_info instead. For now, any v2 blob will also be represented in this field as v1 BlobRef. Corresponds to the JSON property blobRef NOTE: Values are automatically base64 encoded/decoded in the client library.

Returns:

  • (String) 


5522
5523
5524
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 5522

def blob_ref
  @blob_ref
end

#blobstore2_info ⇒ Google::Apis::WalletobjectsV1::Blobstore2Info

Information to read/write to blobstore2. Corresponds to the JSON property blobstore2Info

Returns:



5527
5528
5529
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 5527

def blobstore2_info
  @blobstore2_info
end

#composite_media ⇒ Array<Google::Apis::WalletobjectsV1::CompositeMedia>

A composite media composed of one or more media objects, set if reference_type is COMPOSITE_MEDIA. The media length field must be set to the sum of the lengths of all composite media objects. Note: All composite media must have length specified. Corresponds to the JSON property compositeMedia

Returns:



5535
5536
5537
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 5535

def composite_media
  @composite_media
end

#content_type ⇒ String

MIME type of the data Corresponds to the JSON property contentType

Returns:

  • (String) 


5540
5541
5542
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 5540

def content_type
  @content_type
end

#content_type_info ⇒ Google::Apis::WalletobjectsV1::ContentTypeInfo

Detailed Content-Type information from Scotty. The Content-Type of the media will typically be filled in by the header or Scotty's best_guess, but this extended information provides the backend with more information so that it can make a better decision if needed. This is only used on media upload requests from Scotty. Corresponds to the JSON property contentTypeInfo

Returns:



5549
5550
5551
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 5549

def content_type_info
  @content_type_info
end

#cosmo_binary_reference ⇒ String

A binary data reference for a media download. Serves as a technology-agnostic binary reference in some Google infrastructure. This value is a serialized storage_cosmo.BinaryReference proto. Storing it as bytes is a hack to get around the fact that the cosmo proto (as well as others it includes) doesn't support JavaScript. This prevents us from including the actual type of this field. Corresponds to the JSON property cosmoBinaryReference NOTE: Values are automatically base64 encoded/decoded in the client library.

Returns:

  • (String) 


5560
5561
5562
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 5560

def cosmo_binary_reference
  @cosmo_binary_reference
end

#crc32c_hash ⇒ Fixnum

For Scotty Uploads: Scotty-provided hashes for uploads For Scotty Downloads: ( WARNING: DO NOT USE WITHOUT PERMISSION FROM THE SCOTTY TEAM.) A Hash provided by the agent to be used to verify the data being downloaded. Currently only supported for inline payloads. Further, only crc32c_hash is currently supported. Corresponds to the JSON property crc32cHash

Returns:

  • (Fixnum) 


5569
5570
5571
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 5569

def crc32c_hash
  @crc32c_hash
end

#diff_checksums_response ⇒ Google::Apis::WalletobjectsV1::DiffChecksumsResponse

Backend response for a Diff get checksums response. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol. Corresponds to the JSON property diffChecksumsResponse

Returns:



5575
5576
5577
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 5575

def diff_checksums_response
  @diff_checksums_response
end

#diff_download_response ⇒ Google::Apis::WalletobjectsV1::DiffDownloadResponse

Backend response for a Diff download response. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol. Corresponds to the JSON property diffDownloadResponse

Returns:



5581
5582
5583
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 5581

def diff_download_response
  @diff_download_response
end

#diff_upload_request ⇒ Google::Apis::WalletobjectsV1::DiffUploadRequest

A Diff upload request. For details on the Scotty Diff protocol, visit http:// go/scotty-diff-protocol. Corresponds to the JSON property diffUploadRequest

Returns:



5587
5588
5589
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 5587

def diff_upload_request
  @diff_upload_request
end

#diff_upload_response ⇒ Google::Apis::WalletobjectsV1::DiffUploadResponse

Backend response for a Diff upload request. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol. Corresponds to the JSON property diffUploadResponse

Returns:



5593
5594
5595
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 5593

def diff_upload_response
  @diff_upload_response
end

#diff_version_response ⇒ Google::Apis::WalletobjectsV1::DiffVersionResponse

Backend response for a Diff get version response. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol. Corresponds to the JSON property diffVersionResponse

Returns:



5599
5600
5601
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 5599

def diff_version_response
  @diff_version_response
end

#download_parameters ⇒ Google::Apis::WalletobjectsV1::DownloadParameters

Parameters specific to media downloads. Corresponds to the JSON property downloadParameters

Returns:



5604
5605
5606
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 5604

def download_parameters
  @download_parameters
end

#filename ⇒ String

Original file name Corresponds to the JSON property filename

Returns:

  • (String) 


5609
5610
5611
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 5609

def filename
  @filename
end

#hash_prop ⇒ String

Deprecated, use one of explicit hash type fields instead. These two hash related fields will only be populated on Scotty based media uploads and will contain the content of the hash group in the NotificationRequest: http://cs/# google3/blobstore2/api/scotty/service/proto/upload_listener.proto&q=class:Hash Hex encoded hash value of the uploaded media. Corresponds to the JSON property hash

Returns:

  • (String) 


5618
5619
5620
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 5618

def hash_prop
  @hash_prop
end

#hash_verified ⇒ Boolean Also known as: hash_verified?

For Scotty uploads only. If a user sends a hash code and the backend has requested that Scotty verify the upload against the client hash, Scotty will perform the check on behalf of the backend and will reject it if the hashes don't match. This is set to true if Scotty performed this verification. Corresponds to the JSON property hashVerified

Returns:

  • (Boolean) 


5626
5627
5628
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 5626

def hash_verified
  @hash_verified
end

#inline ⇒ String

Media data, set if reference_type is INLINE Corresponds to the JSON property inline NOTE: Values are automatically base64 encoded/decoded in the client library.

Returns:

  • (String) 


5633
5634
5635
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 5633

def inline
  @inline
end

#is_potential_retry ⇒ Boolean Also known as: is_potential_retry?

|is_potential_retry| is set false only when Scotty is certain that it has not sent the request before. When a client resumes an upload, this field must be set true in agent calls, because Scotty cannot be certain that it has never sent the request before due to potential failure in the session state persistence. Corresponds to the JSON property isPotentialRetry

Returns:

  • (Boolean) 


5642
5643
5644
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 5642

def is_potential_retry
  @is_potential_retry
end

#length ⇒ Fixnum

Size of the data, in bytes Corresponds to the JSON property length

Returns:

  • (Fixnum) 


5648
5649
5650
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 5648

def length
  @length
end

#md5_hash ⇒ String

Scotty-provided MD5 hash for an upload. Corresponds to the JSON property md5Hash NOTE: Values are automatically base64 encoded/decoded in the client library.

Returns:

  • (String) 


5654
5655
5656
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 5654

def md5_hash
  @md5_hash
end

#media_id ⇒ String

Media id to forward to the operation GetMedia. Can be set if reference_type is GET_MEDIA. Corresponds to the JSON property mediaId NOTE: Values are automatically base64 encoded/decoded in the client library.

Returns:

  • (String) 


5661
5662
5663
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 5661

def media_id
  @media_id
end

#object_id_prop ⇒ Google::Apis::WalletobjectsV1::ObjectIdProp

This is a copy of the tech.blob.ObjectId proto, which could not be used directly here due to transitive closure issues with JavaScript support; see http://b/8801763. Corresponds to the JSON property objectId

Returns:



5668
5669
5670
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 5668

def object_id_prop
  @object_id_prop
end

#path ⇒ String

Path to the data, set if reference_type is PATH Corresponds to the JSON property path

Returns:

  • (String) 


5673
5674
5675
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 5673

def path
  @path
end

#reference_type ⇒ String

Describes what the field reference contains. Corresponds to the JSON property referenceType

Returns:

  • (String) 


5678
5679
5680
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 5678

def reference_type
  @reference_type
end

#sha1_hash ⇒ String

Scotty-provided SHA1 hash for an upload. Corresponds to the JSON property sha1Hash NOTE: Values are automatically base64 encoded/decoded in the client library.

Returns:

  • (String) 


5684
5685
5686
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 5684

def sha1_hash
  @sha1_hash
end

#sha256_hash ⇒ String

Scotty-provided SHA256 hash for an upload. Corresponds to the JSON property sha256Hash NOTE: Values are automatically base64 encoded/decoded in the client library.

Returns:

  • (String) 


5690
5691
5692
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 5690

def sha256_hash
  @sha256_hash
end

#timestamp ⇒ Fixnum

Time at which the media data was last updated, in milliseconds since UNIX epoch Corresponds to the JSON property timestamp

Returns:

  • (Fixnum) 


5696
5697
5698
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 5696

def timestamp
  @timestamp
end

#token ⇒ String

A unique fingerprint/version id for the media data Corresponds to the JSON property token

Returns:

  • (String) 


5701
5702
5703
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 5701

def token
  @token
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5708
5709
5710
5711
5712
5713
5714
5715
5716
5717
5718
5719
5720
5721
5722
5723
5724
5725
5726
5727
5728
5729
5730
5731
5732
5733
5734
5735
5736
5737
5738
5739
 
# File 'lib/google/apis/walletobjects_v1/classes.rb', line 5708

def update!(**args)
  @algorithm = args[:algorithm] if args.key?(:algorithm)
  @bigstore_object_ref = args[:bigstore_object_ref] if args.key?(:bigstore_object_ref)
  @blob_ref = args[:blob_ref] if args.key?(:blob_ref)
  @blobstore2_info = args[:blobstore2_info] if args.key?(:blobstore2_info)
  @composite_media = args[:composite_media] if args.key?(:composite_media)
  @content_type = args[:content_type] if args.key?(:content_type)
  @content_type_info = args[:content_type_info] if args.key?(:content_type_info)
  @cosmo_binary_reference = args[:cosmo_binary_reference] if args.key?(:cosmo_binary_reference)
  @crc32c_hash = args[:crc32c_hash] if args.key?(:crc32c_hash)
  @diff_checksums_response = args[:diff_checksums_response] if args.key?(:diff_checksums_response)
  @diff_download_response = args[:diff_download_response] if args.key?(:diff_download_response)
  @diff_upload_request = args[:diff_upload_request] if args.key?(:diff_upload_request)
  @diff_upload_response = args[:diff_upload_response] if args.key?(:diff_upload_response)
  @diff_version_response = args[:diff_version_response] if args.key?(:diff_version_response)
  @download_parameters = args[:download_parameters] if args.key?(:download_parameters)
  @filename = args[:filename] if args.key?(:filename)
  @hash_prop = args[:hash_prop] if args.key?(:hash_prop)
  @hash_verified = args[:hash_verified] if args.key?(:hash_verified)
  @inline = args[:inline] if args.key?(:inline)
  @is_potential_retry = args[:is_potential_retry] if args.key?(:is_potential_retry)
  @length = args[:length] if args.key?(:length)
  @md5_hash = args[:md5_hash] if args.key?(:md5_hash)
  @media_id = args[:media_id] if args.key?(:media_id)
  @object_id_prop = args[:object_id_prop] if args.key?(:object_id_prop)
  @path = args[:path] if args.key?(:path)
  @reference_type = args[:reference_type] if args.key?(:reference_type)
  @sha1_hash = args[:sha1_hash] if args.key?(:sha1_hash)
  @sha256_hash = args[:sha256_hash] if args.key?(:sha256_hash)
  @timestamp = args[:timestamp] if args.key?(:timestamp)
  @token = args[:token] if args.key?(:token)
end