Class: MicrosoftGraph::Security::Cases::EdiscoveryCases::Item::Custodians::CustodiansRequestBuilder

Inherits:
MicrosoftKiotaAbstractions::BaseRequestBuilder
  • Object
show all
Defined in:
lib/security/cases/ediscovery_cases/item/custodians/custodians_request_builder.rb

Overview

Provides operations to manage the custodians property of the microsoft.graph.security.ediscoveryCase entity.

Defined Under Namespace

Classes: CustodiansRequestBuilderGetQueryParameters

Instance Method Summary collapse

Constructor Details

#initialize(path_parameters, request_adapter) ⇒ Object

Instantiates a new CustodiansRequestBuilder and sets the default values.

Parameters:

  • path_parameters —

    Path parameters for the request

  • request_adapter —

    The request adapter to use to execute the requests.



58
59
60
 
# File 'lib/security/cases/ediscovery_cases/item/custodians/custodians_request_builder.rb', line 58

def initialize(path_parameters, request_adapter)
    super(path_parameters, request_adapter, "{+baseurl}/security/cases/ediscoveryCases/{ediscoveryCase%2Did}/custodians{?%24top,%24skip,%24search,%24filter,%24count,%24orderby,%24select,%24expand}")
end

Instance Method Details

#by_ediscovery_custodian_id(ediscovery_custodian_id) ⇒ Object

Provides operations to manage the custodians property of the microsoft.graph.security.ediscoveryCase entity.

Parameters:

  • ediscovery_custodian_id —

    The unique identifier of ediscoveryCustodian

Returns:

  • a ediscovery_custodian_item_request_builder

Raises:

  • (StandardError) 


46
47
48
49
50
51
 
# File 'lib/security/cases/ediscovery_cases/item/custodians/custodians_request_builder.rb', line 46

def by_ediscovery_custodian_id(ediscovery_custodian_id)
    raise StandardError, 'ediscovery_custodian_id cannot be null' if ediscovery_custodian_id.nil?
    url_tpl_params = @path_parameters.clone
    url_tpl_params["ediscoveryCustodian%2Did"] = ediscovery_custodian_id
    return MicrosoftGraph::Security::Cases::EdiscoveryCases::Item::Custodians::Item::EdiscoveryCustodianItemRequestBuilder.new(url_tpl_params, @request_adapter)
end

#count ⇒ Object

Provides operations to count the resources in the collection.



28
29
30
 
# File 'lib/security/cases/ediscovery_cases/item/custodians/custodians_request_builder.rb', line 28

def count()
    return MicrosoftGraph::Security::Cases::EdiscoveryCases::Item::Custodians::Count::CountRequestBuilder.new(@path_parameters, @request_adapter)
end

#get(request_configuration = nil) ⇒ Object

Get a list of the custodian objects and their properties.

Parameters:

  • request_configuration (defaults to: nil) —

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

Returns:

  • a Fiber of security_ediscovery_custodian_collection_response



66
67
68
69
70
71
72
73
74
 
# File 'lib/security/cases/ediscovery_cases/item/custodians/custodians_request_builder.rb', line 66

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::SecurityEdiscoveryCustodianCollectionResponse.create_from_discriminator_value(pn) }, error_mapping)
end

#microsoft_graph_security_apply_hold ⇒ Object

Provides operations to call the applyHold method.



33
34
35
 
# File 'lib/security/cases/ediscovery_cases/item/custodians/custodians_request_builder.rb', line 33

def microsoft_graph_security_apply_hold()
    return MicrosoftGraph::Security::Cases::EdiscoveryCases::Item::Custodians::MicrosoftGraphSecurityApplyHold::MicrosoftGraphSecurityApplyHoldRequestBuilder.new(@path_parameters, @request_adapter)
end

#microsoft_graph_security_remove_hold ⇒ Object

Provides operations to call the removeHold method.



38
39
40
 
# File 'lib/security/cases/ediscovery_cases/item/custodians/custodians_request_builder.rb', line 38

def microsoft_graph_security_remove_hold()
    return MicrosoftGraph::Security::Cases::EdiscoveryCases::Item::Custodians::MicrosoftGraphSecurityRemoveHold::MicrosoftGraphSecurityRemoveHoldRequestBuilder.new(@path_parameters, @request_adapter)
end

#post(body, request_configuration = nil) ⇒ Object

Create a new ediscoveryCustodian object.After the custodian object is created, you will need to create the custodian’s userSource to reference their mailbox and OneDrive for Business site.

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 security_ediscovery_custodian

Raises:

  • (StandardError) 


81
82
83
84
85
86
87
88
89
90
 
# File 'lib/security/cases/ediscovery_cases/item/custodians/custodians_request_builder.rb', line 81

def post(body, request_configuration=nil)
    raise StandardError, 'body cannot be null' if body.nil?
    request_info = self.to_post_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::SecurityEdiscoveryCustodian.create_from_discriminator_value(pn) }, error_mapping)
end

#to_get_request_information(request_configuration = nil) ⇒ Object

Get a list of the custodian objects and their properties.

Parameters:

  • request_configuration (defaults to: nil) —

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

Returns:

  • a request_information



96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/security/cases/ediscovery_cases/item/custodians/custodians_request_builder.rb', line 96

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_post_request_information(body, request_configuration = nil) ⇒ Object

Create a new ediscoveryCustodian object.After the custodian object is created, you will need to create the custodian’s userSource to reference their mailbox and OneDrive for Business site.

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) 


115
116
117
118
119
120
121
122
123
124
125
126
127
128
 
# File 'lib/security/cases/ediscovery_cases/item/custodians/custodians_request_builder.rb', line 115

def to_post_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 = :POST
    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