Class: MicrosoftGraph::Print::Shares::Item::PrinterShareItemRequestBuilder

Inherits:
MicrosoftKiotaAbstractions::BaseRequestBuilder
  • Object
show all
Defined in:
lib/print/shares/item/printer_share_item_request_builder.rb

Overview

Provides operations to manage the shares property of the microsoft.graph.print entity.

Defined Under Namespace

Classes: PrinterShareItemRequestBuilderGetQueryParameters

Instance Method Summary collapse

Constructor Details

#initialize(path_parameters, request_adapter) ⇒ Object

Instantiates a new PrinterShareItemRequestBuilder and sets the default values.

Parameters:

  • path_parameters —

    Path parameters for the request

  • request_adapter —

    The request adapter to use to execute the requests.



47
48
49
 
# File 'lib/print/shares/item/printer_share_item_request_builder.rb', line 47

def initialize(path_parameters, request_adapter)
    super(path_parameters, request_adapter, "{+baseurl}/print/shares/{printerShare%2Did}{?%24select,%24expand}")
end

Instance Method Details

#allowed_groups ⇒ Object

Provides operations to manage the allowedGroups property of the microsoft.graph.printerShare entity.



23
24
25
 
# File 'lib/print/shares/item/printer_share_item_request_builder.rb', line 23

def allowed_groups()
    return MicrosoftGraph::Print::Shares::Item::AllowedGroups::AllowedGroupsRequestBuilder.new(@path_parameters, @request_adapter)
end

#allowed_users ⇒ Object

Provides operations to manage the allowedUsers property of the microsoft.graph.printerShare entity.



28
29
30
 
# File 'lib/print/shares/item/printer_share_item_request_builder.rb', line 28

def allowed_users()
    return MicrosoftGraph::Print::Shares::Item::AllowedUsers::AllowedUsersRequestBuilder.new(@path_parameters, @request_adapter)
end

#delete(request_configuration = nil) ⇒ Object

Delete a printer share (unshare the associated printer). This action cannot be undone. If the printer is shared again in the future, any Windows users who had previously installed the printer will need to discover and reinstall it.

Parameters:

  • request_configuration (defaults to: nil) —

    Configuration for the request such as headers, query parameters, and middleware options.

Returns:

  • a Fiber of void



55
56
57
58
59
60
61
62
63
 
# File 'lib/print/shares/item/printer_share_item_request_builder.rb', line 55

def delete(request_configuration=nil)
    request_info = self.to_delete_request_information(
        request_configuration
    )
    error_mapping = Hash.new
    error_mapping["4XX"] = lambda {|pn| MicrosoftGraph::Models::ODataErrorsODataError.create_from_discriminator_value(pn) }
    error_mapping["5XX"] = lambda {|pn| MicrosoftGraph::Models::ODataErrorsODataError.create_from_discriminator_value(pn) }
    return @request_adapter.send_async(request_info, nil, error_mapping)
end

#get(request_configuration = nil) ⇒ Object

Retrieve the properties and relationships of a printer share.

Parameters:

  • request_configuration (defaults to: nil) —

    Configuration for the request such as headers, query parameters, and middleware options.

Returns:

  • a Fiber of printer_share



69
70
71
72
73
74
75
76
77
 
# File 'lib/print/shares/item/printer_share_item_request_builder.rb', line 69

def get(request_configuration=nil)
    request_info = self.to_get_request_information(
        request_configuration
    )
    error_mapping = Hash.new
    error_mapping["4XX"] = lambda {|pn| MicrosoftGraph::Models::ODataErrorsODataError.create_from_discriminator_value(pn) }
    error_mapping["5XX"] = lambda {|pn| MicrosoftGraph::Models::ODataErrorsODataError.create_from_discriminator_value(pn) }
    return @request_adapter.send_async(request_info, lambda {|pn| MicrosoftGraph::Models::PrinterShare.create_from_discriminator_value(pn) }, error_mapping)
end

#jobs ⇒ Object

Provides operations to manage the jobs property of the microsoft.graph.printerBase entity.



33
34
35
 
# File 'lib/print/shares/item/printer_share_item_request_builder.rb', line 33

def jobs()
    return MicrosoftGraph::Print::Shares::Item::Jobs::JobsRequestBuilder.new(@path_parameters, @request_adapter)
end

#patch(body, request_configuration = nil) ⇒ Object

Update the properties of a printer share. This method can be used to swap printers. For example, if a physical printer device breaks, an administrator can register a new printer device and update this printerShare to point to the new printer without requiring users to take any action.

Parameters:

  • body —

    The request body

  • request_configuration (defaults to: nil) —

    Configuration for the request such as headers, query parameters, and middleware options.

Returns:

  • a Fiber of printer_share

Raises:

  • (StandardError) 


84
85
86
87
88
89
90
91
92
93
 
# File 'lib/print/shares/item/printer_share_item_request_builder.rb', line 84

def patch(body, request_configuration=nil)
    raise StandardError, 'body cannot be null' if body.nil?
    request_info = self.to_patch_request_information(
        body, request_configuration
    )
    error_mapping = Hash.new
    error_mapping["4XX"] = lambda {|pn| MicrosoftGraph::Models::ODataErrorsODataError.create_from_discriminator_value(pn) }
    error_mapping["5XX"] = lambda {|pn| MicrosoftGraph::Models::ODataErrorsODataError.create_from_discriminator_value(pn) }
    return @request_adapter.send_async(request_info, lambda {|pn| MicrosoftGraph::Models::PrinterShare.create_from_discriminator_value(pn) }, error_mapping)
end

#printer ⇒ Object

Provides operations to manage the printer property of the microsoft.graph.printerShare entity.



38
39
40
 
# File 'lib/print/shares/item/printer_share_item_request_builder.rb', line 38

def printer()
    return MicrosoftGraph::Print::Shares::Item::Printer::PrinterRequestBuilder.new(@path_parameters, @request_adapter)
end

#to_delete_request_information(request_configuration = nil) ⇒ Object

Delete a printer share (unshare the associated printer). This action cannot be undone. If the printer is shared again in the future, any Windows users who had previously installed the printer will need to discover and reinstall it.

Parameters:

  • request_configuration (defaults to: nil) —

    Configuration for the request such as headers, query parameters, and middleware options.

Returns:

  • a request_information



99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/print/shares/item/printer_share_item_request_builder.rb', line 99

def to_delete_request_information(request_configuration=nil)
    request_info = MicrosoftKiotaAbstractions::RequestInformation.new()
    request_info.url_template = @url_template
    request_info.path_parameters = @path_parameters
    request_info.http_method = :DELETE
    unless request_configuration.nil?
        request_info.add_headers_from_raw_object(request_configuration.headers)
        request_info.add_request_options(request_configuration.options)
    end
    return request_info
end

#to_get_request_information(request_configuration = nil) ⇒ Object

Retrieve the properties and relationships of a printer share.

Parameters:

  • request_configuration (defaults to: nil) —

    Configuration for the request such as headers, query parameters, and middleware options.

Returns:

  • a request_information



115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/print/shares/item/printer_share_item_request_builder.rb', line 115

def to_get_request_information(request_configuration=nil)
    request_info = MicrosoftKiotaAbstractions::RequestInformation.new()
    request_info.url_template = @url_template
    request_info.path_parameters = @path_parameters
    request_info.http_method = :GET
    request_info.headers.add('Accept', 'application/json')
    unless request_configuration.nil?
        request_info.add_headers_from_raw_object(request_configuration.headers)
        request_info.set_query_string_parameters_from_raw_object(request_configuration.query_parameters)
        request_info.add_request_options(request_configuration.options)
    end
    return request_info
end

#to_patch_request_information(body, request_configuration = nil) ⇒ Object

Update the properties of a printer share. This method can be used to swap printers. For example, if a physical printer device breaks, an administrator can register a new printer device and update this printerShare to point to the new printer without requiring users to take any action.

Parameters:

  • body —

    The request body

  • request_configuration (defaults to: nil) —

    Configuration for the request such as headers, query parameters, and middleware options.

Returns:

  • a request_information

Raises:

  • (StandardError) 


134
135
136
137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/print/shares/item/printer_share_item_request_builder.rb', line 134

def to_patch_request_information(body, request_configuration=nil)
    raise StandardError, 'body cannot be null' if body.nil?
    request_info = MicrosoftKiotaAbstractions::RequestInformation.new()
    request_info.url_template = @url_template
    request_info.path_parameters = @path_parameters
    request_info.http_method = :PATCH
    request_info.headers.add('Accept', 'application/json')
    unless request_configuration.nil?
        request_info.add_headers_from_raw_object(request_configuration.headers)
        request_info.add_request_options(request_configuration.options)
    end
    request_info.set_content_from_parsable(@request_adapter, "application/json", body)
    return request_info
end