Class: MicrosoftGraph::Models::UploadSession

Inherits:
Object
  • Object
show all
Includes:
MicrosoftKiotaAbstractions::AdditionalDataHolder, MicrosoftKiotaAbstractions::Parsable
Defined in:
lib/models/upload_session.rb

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initializeObject

Instantiates a new uploadSession and sets the default values.



44
45
46
# File 'lib/models/upload_session.rb', line 44

def initialize()
    @additional_data = Hash.new
end

Class Method Details

.create_from_discriminator_value(parse_node) ⇒ Object

Creates a new instance of the appropriate class based on discriminator value

Parameters:

  • parse_node

    The parse node to use to read the discriminator value and create the object

Returns:

  • a upload_session

Raises:

  • (StandardError)


52
53
54
55
# File 'lib/models/upload_session.rb', line 52

def self.create_from_discriminator_value(parse_node)
    raise StandardError, 'parse_node cannot be null' if parse_node.nil?
    return UploadSession.new
end

Instance Method Details

#additional_dataObject

Gets the additionalData property value. Stores additional data not described in the OpenAPI description found when deserializing. Can be used for serialization as well.

Returns:

  • a i_dictionary



29
30
31
# File 'lib/models/upload_session.rb', line 29

def additional_data
    return @additional_data
end

#additional_data=(value) ⇒ Object

Sets the additionalData property value. Stores additional data not described in the OpenAPI description found when deserializing. Can be used for serialization as well.

Parameters:

  • value

    Value to set for the additionalData property.

Returns:

  • a void



37
38
39
# File 'lib/models/upload_session.rb', line 37

def additional_data=(value)
    @additional_data = value
end

#expiration_date_timeObject

Gets the expirationDateTime property value. The date and time in UTC that the upload session will expire. The complete file must be uploaded before this expiration time is reached.

Returns:

  • a date_time



60
61
62
# File 'lib/models/upload_session.rb', line 60

def expiration_date_time
    return @expiration_date_time
end

#expiration_date_time=(value) ⇒ Object

Sets the expirationDateTime property value. The date and time in UTC that the upload session will expire. The complete file must be uploaded before this expiration time is reached.

Parameters:

  • value

    Value to set for the expirationDateTime property.

Returns:

  • a void



68
69
70
# File 'lib/models/upload_session.rb', line 68

def expiration_date_time=(value)
    @expiration_date_time = value
end

#get_field_deserializersObject

The deserialization information for the current model

Returns:

  • a i_dictionary



75
76
77
78
79
80
81
82
# File 'lib/models/upload_session.rb', line 75

def get_field_deserializers()
    return {
        "expirationDateTime" => lambda {|n| @expiration_date_time = n.get_date_time_value() },
        "nextExpectedRanges" => lambda {|n| @next_expected_ranges = n.get_collection_of_primitive_values(String) },
        "@odata.type" => lambda {|n| @odata_type = n.get_string_value() },
        "uploadUrl" => lambda {|n| @upload_url = n.get_string_value() },
    }
end

#next_expected_rangesObject

Gets the nextExpectedRanges property value. A collection of byte ranges that the server is missing for the file. These ranges are zero indexed and of the format ‘start-end’ (e.g. ‘0-26’ to indicate the first 27 bytes of the file). When uploading files as Outlook attachments, instead of a collection of ranges, this property always indicates a single value ‘start’, the location in the file where the next upload should begin.

Returns:

  • a string



87
88
89
# File 'lib/models/upload_session.rb', line 87

def next_expected_ranges
    return @next_expected_ranges
end

#next_expected_ranges=(value) ⇒ Object

Sets the nextExpectedRanges property value. A collection of byte ranges that the server is missing for the file. These ranges are zero indexed and of the format ‘start-end’ (e.g. ‘0-26’ to indicate the first 27 bytes of the file). When uploading files as Outlook attachments, instead of a collection of ranges, this property always indicates a single value ‘start’, the location in the file where the next upload should begin.

Parameters:

  • value

    Value to set for the nextExpectedRanges property.

Returns:

  • a void



95
96
97
# File 'lib/models/upload_session.rb', line 95

def next_expected_ranges=(value)
    @next_expected_ranges = value
end

#odata_typeObject

Gets the @odata.type property value. The OdataType property

Returns:

  • a string



102
103
104
# File 'lib/models/upload_session.rb', line 102

def odata_type
    return @odata_type
end

#odata_type=(value) ⇒ Object

Sets the @odata.type property value. The OdataType property

Parameters:

  • value

    Value to set for the @odata.type property.

Returns:

  • a void



110
111
112
# File 'lib/models/upload_session.rb', line 110

def odata_type=(value)
    @odata_type = value
end

#serialize(writer) ⇒ Object

Serializes information the current object

Parameters:

  • writer

    Serialization writer to use to serialize this model

Returns:

  • a void

Raises:

  • (StandardError)


118
119
120
121
122
123
124
125
# File 'lib/models/upload_session.rb', line 118

def serialize(writer)
    raise StandardError, 'writer cannot be null' if writer.nil?
    writer.write_date_time_value("expirationDateTime", @expiration_date_time)
    writer.write_collection_of_primitive_values("nextExpectedRanges", @next_expected_ranges)
    writer.write_string_value("@odata.type", @odata_type)
    writer.write_string_value("uploadUrl", @upload_url)
    writer.write_additional_data(@additional_data)
end

#upload_urlObject

Gets the uploadUrl property value. The URL endpoint that accepts PUT requests for byte ranges of the file.

Returns:

  • a string



130
131
132
# File 'lib/models/upload_session.rb', line 130

def upload_url
    return @upload_url
end

#upload_url=(value) ⇒ Object

Sets the uploadUrl property value. The URL endpoint that accepts PUT requests for byte ranges of the file.

Parameters:

  • value

    Value to set for the uploadUrl property.

Returns:

  • a void



138
139
140
# File 'lib/models/upload_session.rb', line 138

def upload_url=(value)
    @upload_url = value
end