Class: OCI::TenantManagerControlPlane::DomainClient
- Inherits:
-
Object
- Object
- OCI::TenantManagerControlPlane::DomainClient
- Defined in:
- lib/oci/tenant_manager_control_plane/domain_client.rb
Overview
Use the Organizations API to consolidate multiple OCI tenancies into an organization, and centrally manage your tenancies and organization resources. For more information, see Organization Management Overview.
Instance Attribute Summary collapse
-
#api_client ⇒ OCI::ApiClient
readonly
Client used to make HTTP requests.
-
#endpoint ⇒ String
readonly
Fully qualified endpoint URL.
-
#region ⇒ String
The region, which will usually correspond to a value in Regions::REGION_ENUM.
-
#retry_config ⇒ OCI::Retry::RetryConfig
readonly
The default retry configuration to apply to all operations in this service client.
Instance Method Summary collapse
-
#create_domain(create_domain_details, opts = {}) ⇒ Response
Begins the registration process for claiming a domain.
-
#delete_domain(domain_id, opts = {}) ⇒ Response
Releases the domain, making it available to be claimed again by another tenancy.
-
#get_domain(domain_id, opts = {}) ⇒ Response
Gets information about the domain.
-
#initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ DomainClient
constructor
Creates a new DomainClient.
-
#list_domains(compartment_id, opts = {}) ⇒ Response
Return a (paginated) list of domains.
-
#logger ⇒ Logger
The logger for this client.
-
#update_domain(domain_id, update_domain_details, opts = {}) ⇒ Response
Updates the domain.
Constructor Details
#initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ DomainClient
Creates a new DomainClient. Notes: If a config is not specified, then the global OCI.config will be used.
This client is not thread-safe
Either a region or an endpoint must be specified. If an endpoint is specified, it will be used instead of the region. A region may be specified in the config or via or the region parameter. If specified in both, then the region parameter will be used.
55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 |
# File 'lib/oci/tenant_manager_control_plane/domain_client.rb', line 55 def initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) # If the signer is an InstancePrincipalsSecurityTokenSigner or SecurityTokenSigner and no config was supplied (they are self-sufficient signers) # then create a dummy config to pass to the ApiClient constructor. If customers wish to create a client which uses instance principals # and has config (either populated programmatically or loaded from a file), they must construct that config themselves and then # pass it to this constructor. # # If there is no signer (or the signer is not an instance principals signer) and no config was supplied, this is not valid # so try and load the config from the default file. config = OCI::Config.validate_and_build_config_with_signer(config, signer) signer = OCI::Signer.config_file_auth_builder(config) if signer.nil? @api_client = OCI::ApiClient.new(config, signer, proxy_settings: proxy_settings) @retry_config = retry_config if endpoint @endpoint = endpoint + '/20230401' else region ||= config.region region ||= signer.region if signer.respond_to?(:region) self.region = region end logger.info "DomainClient endpoint set to '#{@endpoint}'." if logger end |
Instance Attribute Details
#api_client ⇒ OCI::ApiClient (readonly)
Client used to make HTTP requests.
15 16 17 |
# File 'lib/oci/tenant_manager_control_plane/domain_client.rb', line 15 def api_client @api_client end |
#endpoint ⇒ String (readonly)
Fully qualified endpoint URL
19 20 21 |
# File 'lib/oci/tenant_manager_control_plane/domain_client.rb', line 19 def endpoint @endpoint end |
#region ⇒ String
The region, which will usually correspond to a value in Regions::REGION_ENUM.
29 30 31 |
# File 'lib/oci/tenant_manager_control_plane/domain_client.rb', line 29 def region @region end |
#retry_config ⇒ OCI::Retry::RetryConfig (readonly)
The default retry configuration to apply to all operations in this service client. This can be overridden on a per-operation basis. The default retry configuration value is nil
, which means that an operation will not perform any retries
25 26 27 |
# File 'lib/oci/tenant_manager_control_plane/domain_client.rb', line 25 def retry_config @retry_config end |
Instance Method Details
#create_domain(create_domain_details, opts = {}) ⇒ Response
Click here to see an example of how to use create_domain API.
Begins the registration process for claiming a domain.
117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 |
# File 'lib/oci/tenant_manager_control_plane/domain_client.rb', line 117 def create_domain(create_domain_details, opts = {}) logger.debug 'Calling operation DomainClient#create_domain.' if logger raise "Missing the required parameter 'create_domain_details' when calling create_domain." if create_domain_details.nil? path = '/domains' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(create_domain_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'DomainClient#create_domain') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::TenantManagerControlPlane::Models::Domain' ) end # rubocop:enable Metrics/BlockLength end |
#delete_domain(domain_id, opts = {}) ⇒ Response
Click here to see an example of how to use delete_domain API.
Releases the domain, making it available to be claimed again by another tenancy.
178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 |
# File 'lib/oci/tenant_manager_control_plane/domain_client.rb', line 178 def delete_domain(domain_id, opts = {}) logger.debug 'Calling operation DomainClient#delete_domain.' if logger raise "Missing the required parameter 'domain_id' when calling delete_domain." if domain_id.nil? raise "Parameter value for 'domain_id' must not be blank" if OCI::Internal::Util.blank_string?(domain_id) path = '/domains/{domainId}'.sub('{domainId}', domain_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'DomainClient#delete_domain') do @api_client.call_api( :DELETE, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#get_domain(domain_id, opts = {}) ⇒ Response
Click here to see an example of how to use get_domain API.
Gets information about the domain.
232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 |
# File 'lib/oci/tenant_manager_control_plane/domain_client.rb', line 232 def get_domain(domain_id, opts = {}) logger.debug 'Calling operation DomainClient#get_domain.' if logger raise "Missing the required parameter 'domain_id' when calling get_domain." if domain_id.nil? raise "Parameter value for 'domain_id' must not be blank" if OCI::Internal::Util.blank_string?(domain_id) path = '/domains/{domainId}'.sub('{domainId}', domain_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'DomainClient#get_domain') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::TenantManagerControlPlane::Models::Domain' ) end # rubocop:enable Metrics/BlockLength end |
#list_domains(compartment_id, opts = {}) ⇒ Response
Click here to see an example of how to use list_domains API.
Return a (paginated) list of domains.
300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 |
# File 'lib/oci/tenant_manager_control_plane/domain_client.rb', line 300 def list_domains(compartment_id, opts = {}) logger.debug 'Calling operation DomainClient#list_domains.' if logger raise "Missing the required parameter 'compartment_id' when calling list_domains." if compartment_id.nil? if opts[:lifecycle_state] && !OCI::TenantManagerControlPlane::Models::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state]) raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::TenantManagerControlPlane::Models::LIFECYCLE_STATE_ENUM.' end if opts[:status] && !OCI::TenantManagerControlPlane::Models::Domain::STATUS_ENUM.include?(opts[:status]) raise 'Invalid value for "status", must be one of the values in OCI::TenantManagerControlPlane::Models::Domain::STATUS_ENUM.' end if opts[:sort_by] && !%w[timeCreated displayName].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of timeCreated, displayName.' end if opts[:sort_order] && !OCI::TenantManagerControlPlane::Models::SORT_ORDER_ENUM.include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of the values in OCI::TenantManagerControlPlane::Models::SORT_ORDER_ENUM.' end path = '/domains' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = compartment_id query_params[:domainId] = opts[:domain_id] if opts[:domain_id] query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state] query_params[:status] = opts[:status] if opts[:status] query_params[:name] = opts[:name] if opts[:name] query_params[:page] = opts[:page] if opts[:page] query_params[:limit] = opts[:limit] if opts[:limit] query_params[:sortBy] = opts[:sort_by] if opts[:sort_by] query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'DomainClient#list_domains') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::TenantManagerControlPlane::Models::DomainCollection' ) end # rubocop:enable Metrics/BlockLength end |
#logger ⇒ Logger
Returns The logger for this client. May be nil.
94 95 96 |
# File 'lib/oci/tenant_manager_control_plane/domain_client.rb', line 94 def logger @api_client.config.logger end |
#update_domain(domain_id, update_domain_details, opts = {}) ⇒ Response
Click here to see an example of how to use update_domain API.
Updates the domain.
385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 |
# File 'lib/oci/tenant_manager_control_plane/domain_client.rb', line 385 def update_domain(domain_id, update_domain_details, opts = {}) logger.debug 'Calling operation DomainClient#update_domain.' if logger raise "Missing the required parameter 'domain_id' when calling update_domain." if domain_id.nil? raise "Missing the required parameter 'update_domain_details' when calling update_domain." if update_domain_details.nil? raise "Parameter value for 'domain_id' must not be blank" if OCI::Internal::Util.blank_string?(domain_id) path = '/domains/{domainId}'.sub('{domainId}', domain_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = @api_client.object_to_http_body(update_domain_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'DomainClient#update_domain') do @api_client.call_api( :PUT, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::TenantManagerControlPlane::Models::Domain' ) end # rubocop:enable Metrics/BlockLength end |