Class: MicrosoftGraph::Domains::Item::DomainItemRequestBuilder

Inherits:
MicrosoftKiotaAbstractions::BaseRequestBuilder
  • Object
show all
Defined in:
lib/domains/item/domain_item_request_builder.rb

Overview

Provides operations to manage the collection of domain entities.

Defined Under Namespace

Classes: DomainItemRequestBuilderGetQueryParameters

Instance Method Summary collapse

Constructor Details

#initialize(path_parameters, request_adapter) ⇒ Object

Instantiates a new DomainItemRequestBuilder and sets the default values.

Parameters:

  • path_parameters —

    Path parameters for the request

  • request_adapter —

    The request adapter to use to execute the requests.



63
64
65
 
# File 'lib/domains/item/domain_item_request_builder.rb', line 63

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

Instance Method Details

#delete(request_configuration = nil) ⇒ Object

Deletes a domain from a tenant.

Parameters:

  • request_configuration (defaults to: nil) —

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

Returns:

  • a Fiber of void



71
72
73
74
75
76
77
78
79
 
# File 'lib/domains/item/domain_item_request_builder.rb', line 71

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

#domain_name_references ⇒ Object

Provides operations to manage the domainNameReferences property of the microsoft.graph.domain entity.



24
25
26
 
# File 'lib/domains/item/domain_item_request_builder.rb', line 24

def domain_name_references()
    return MicrosoftGraph::Domains::Item::DomainNameReferences::DomainNameReferencesRequestBuilder.new(@path_parameters, @request_adapter)
end

#federation_configuration ⇒ Object

Provides operations to manage the federationConfiguration property of the microsoft.graph.domain entity.



29
30
31
 
# File 'lib/domains/item/domain_item_request_builder.rb', line 29

def federation_configuration()
    return MicrosoftGraph::Domains::Item::FederationConfiguration::FederationConfigurationRequestBuilder.new(@path_parameters, @request_adapter)
end

#force_delete ⇒ Object

Provides operations to call the forceDelete method.



34
35
36
 
# File 'lib/domains/item/domain_item_request_builder.rb', line 34

def force_delete()
    return MicrosoftGraph::Domains::Item::ForceDelete::ForceDeleteRequestBuilder.new(@path_parameters, @request_adapter)
end

#get(request_configuration = nil) ⇒ Object

Retrieve the properties and relationships of domain object.

Parameters:

  • request_configuration (defaults to: nil) —

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

Returns:

  • a Fiber of domain



85
86
87
88
89
90
91
92
93
 
# File 'lib/domains/item/domain_item_request_builder.rb', line 85

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

#patch(body, request_configuration = nil) ⇒ Object

Update the properties of domain object.

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 domain

Raises:

  • (StandardError) 


100
101
102
103
104
105
106
107
108
109
 
# File 'lib/domains/item/domain_item_request_builder.rb', line 100

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

#promote ⇒ Object

Provides operations to call the promote method.



39
40
41
 
# File 'lib/domains/item/domain_item_request_builder.rb', line 39

def promote()
    return MicrosoftGraph::Domains::Item::Promote::PromoteRequestBuilder.new(@path_parameters, @request_adapter)
end

#service_configuration_records ⇒ Object

Provides operations to manage the serviceConfigurationRecords property of the microsoft.graph.domain entity.



44
45
46
 
# File 'lib/domains/item/domain_item_request_builder.rb', line 44

def service_configuration_records()
    return MicrosoftGraph::Domains::Item::ServiceConfigurationRecords::ServiceConfigurationRecordsRequestBuilder.new(@path_parameters, @request_adapter)
end

#to_delete_request_information(request_configuration = nil) ⇒ Object

Deletes a domain from a tenant.

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
 
# File 'lib/domains/item/domain_item_request_builder.rb', line 115

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 domain object.

Parameters:

  • request_configuration (defaults to: nil) —

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

Returns:

  • a request_information



131
132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/domains/item/domain_item_request_builder.rb', line 131

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 domain object.

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) 


150
151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/domains/item/domain_item_request_builder.rb', line 150

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

#verification_dns_records ⇒ Object

Provides operations to manage the verificationDnsRecords property of the microsoft.graph.domain entity.



49
50
51
 
# File 'lib/domains/item/domain_item_request_builder.rb', line 49

def verification_dns_records()
    return MicrosoftGraph::Domains::Item::VerificationDnsRecords::VerificationDnsRecordsRequestBuilder.new(@path_parameters, @request_adapter)
end

#verify ⇒ Object

Provides operations to call the verify method.



54
55
56
 
# File 'lib/domains/item/domain_item_request_builder.rb', line 54

def verify()
    return MicrosoftGraph::Domains::Item::Verify::VerifyRequestBuilder.new(@path_parameters, @request_adapter)
end