Class: MicrosoftGraph::Sites::Item::Onenote::Operations::OperationsRequestBuilder::OperationsRequestBuilderGetQueryParameters

Inherits:
Object
  • Object
show all
Defined in:
lib/sites/item/onenote/operations/operations_request_builder.rb

Overview

Get the status of a long-running OneNote operation. This applies to operations that return the Operation-Location header in the response, such as CopyNotebook, CopyToNotebook, CopyToSectionGroup, and CopyToSection. You can poll the Operation-Location endpoint until the status property returns completed or failed. If the status is completed, the resourceLocation property contains the resource endpoint URI. If the status is failed, the error and @api.diagnostics properties provide error information.

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#countObject

Include count of items



122
123
124
# File 'lib/sites/item/onenote/operations/operations_request_builder.rb', line 122

def count
  @count
end

#expandObject

Expand related entities



125
126
127
# File 'lib/sites/item/onenote/operations/operations_request_builder.rb', line 125

def expand
  @expand
end

#filterObject

Filter items by property values



128
129
130
# File 'lib/sites/item/onenote/operations/operations_request_builder.rb', line 128

def filter
  @filter
end

#orderbyObject

Order items by property values



131
132
133
# File 'lib/sites/item/onenote/operations/operations_request_builder.rb', line 131

def orderby
  @orderby
end

#searchObject

Search items by search phrases



134
135
136
# File 'lib/sites/item/onenote/operations/operations_request_builder.rb', line 134

def search
  @search
end

#selectObject

Select properties to be returned



137
138
139
# File 'lib/sites/item/onenote/operations/operations_request_builder.rb', line 137

def select
  @select
end

#skipObject

Skip the first n items



140
141
142
# File 'lib/sites/item/onenote/operations/operations_request_builder.rb', line 140

def skip
  @skip
end

#topObject

Show only the first n items



143
144
145
# File 'lib/sites/item/onenote/operations/operations_request_builder.rb', line 143

def top
  @top
end

Instance Method Details

#get_query_parameter(original_name) ⇒ Object

Maps the query parameters names to their encoded names for the URI template parsing.

Parameters:

  • original_name

    The original query parameter name in the class.

Returns:

  • a string

Raises:

  • (StandardError)


149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
# File 'lib/sites/item/onenote/operations/operations_request_builder.rb', line 149

def get_query_parameter(original_name)
    raise StandardError, 'original_name cannot be null' if original_name.nil?
    case original_name
        when "count"
            return "%24count"
        when "expand"
            return "%24expand"
        when "filter"
            return "%24filter"
        when "orderby"
            return "%24orderby"
        when "search"
            return "%24search"
        when "select"
            return "%24select"
        when "skip"
            return "%24skip"
        when "top"
            return "%24top"
        else
            return original_name
    end
end