class OCI::TenantManagerControlPlane::DomainGovernanceClient
The Organizations API allows you to consolidate multiple OCI
tenancies into an organization, and centrally manage your tenancies and its resources.
Attributes
Client used to make HTTP requests. @return [OCI::ApiClient]
Fully qualified endpoint URL @return [String]
The region, which will usually correspond to a value in {OCI::Regions::REGION_ENUM}. @return [String]
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 @return [OCI::Retry::RetryConfig]
Public Class Methods
Creates a new DomainGovernanceClient
. 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.
@param [Config] config A Config
object. @param [String] region A region used to determine the service endpoint. This will usually
correspond to a value in {OCI::Regions::REGION_ENUM}, but may be an arbitrary string.
@param [String] endpoint The fully qualified endpoint URL @param [OCI::BaseSigner] signer A signer implementation which can be used by this client. If this is not provided then
a signer will be constructed via the provided config. One use case of this parameter is instance principals authentication, so that the instance principals signer can be provided to the client
@param [OCI::ApiClientProxySettings] proxy_settings If your environment requires you to use a proxy server for outgoing HTTP requests
the details for the proxy can be provided in this parameter
@param [OCI::Retry::RetryConfig] retry_config
The retry configuration for this service client. This represents the default retry configuration to
apply across all operations. 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
# File lib/oci/tenant_manager_control_plane/domain_governance_client.rb, line 53 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 + '/20200801' else region ||= config.region region ||= signer.region if signer.respond_to?(:region) self.region = region end logger.info "DomainGovernanceClient endpoint set to '#{@endpoint}'." if logger end
Public Instance Methods
Adds domain governance to a claimed domain. @param [OCI::TenantManagerControlPlane::Models::CreateDomainGovernanceDetails] create_domain_governance_details Parameters for adding domain governance to a claimed domain. @param [Hash] opts the optional parameters @option opts [OCI::Retry::RetryConfig] :retry_config The retry configuration to apply to this operation. If no key is provided then the service-level
retry configuration defined by {#retry_config} will be used. If an explicit `nil` value is provided then the operation will not retry
@option opts [String] :opc_retry_token A token that uniquely identifies a request, so it can be retried in case of a timeout or
server error, without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
@option opts [String] :opc_request_id The client request ID for tracing. @return [Response] A Response
object with data of type {OCI::TenantManagerControlPlane::Models::DomainGovernance DomainGovernance} @note Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/tenantmanagercontrolplane/create_domain_governance.rb.html) to see an example of how to use create_domain_governance
API.
# File lib/oci/tenant_manager_control_plane/domain_governance_client.rb, line 115 def create_domain_governance(create_domain_governance_details, opts = {}) logger.debug 'Calling operation DomainGovernanceClient#create_domain_governance.' if logger raise "Missing the required parameter 'create_domain_governance_details' when calling create_domain_governance." if create_domain_governance_details.nil? path = '/domainGovernances' 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_governance_details) # rubocop:disable Metrics/BlockLength OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DomainGovernanceClient#create_domain_governance') 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::DomainGovernance' ) end # rubocop:enable Metrics/BlockLength end
Removes domain governance from a claimed domain. @param [String] domain_governance_id The domain governance OCID. @param [Hash] opts the optional parameters @option opts [OCI::Retry::RetryConfig] :retry_config The retry configuration to apply to this operation. If no key is provided then the service-level
retry configuration defined by {#retry_config} will be used. If an explicit `nil` value is provided then the operation will not retry
@option opts [String] :if_match For optimistic concurrency control. In the PUT or DELETE call
for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
@option opts [String] :opc_request_id The client request ID for tracing. @return [Response] A Response
object with data of type nil @note Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/tenantmanagercontrolplane/delete_domain_governance.rb.html) to see an example of how to use delete_domain_governance
API.
# File lib/oci/tenant_manager_control_plane/domain_governance_client.rb, line 176 def delete_domain_governance(domain_governance_id, opts = {}) logger.debug 'Calling operation DomainGovernanceClient#delete_domain_governance.' if logger raise "Missing the required parameter 'domain_governance_id' when calling delete_domain_governance." if domain_governance_id.nil? raise "Parameter value for 'domain_governance_id' must not be blank" if OCI::Internal::Util.blank_string?(domain_governance_id) path = '/domainGovernances/{domainGovernanceId}'.sub('{domainGovernanceId}', domain_governance_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.make_retrying_call(applicable_retry_config(opts), call_name: 'DomainGovernanceClient#delete_domain_governance') 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
Gets information about the domain governance entity. @param [String] domain_governance_id The domain governance OCID. @param [Hash] opts the optional parameters @option opts [OCI::Retry::RetryConfig] :retry_config The retry configuration to apply to this operation. If no key is provided then the service-level
retry configuration defined by {#retry_config} will be used. If an explicit `nil` value is provided then the operation will not retry
@option opts [String] :opc_request_id The client request ID for tracing. @return [Response] A Response
object with data of type {OCI::TenantManagerControlPlane::Models::DomainGovernance DomainGovernance} @note Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/tenantmanagercontrolplane/get_domain_governance.rb.html) to see an example of how to use get_domain_governance
API.
# File lib/oci/tenant_manager_control_plane/domain_governance_client.rb, line 230 def get_domain_governance(domain_governance_id, opts = {}) logger.debug 'Calling operation DomainGovernanceClient#get_domain_governance.' if logger raise "Missing the required parameter 'domain_governance_id' when calling get_domain_governance." if domain_governance_id.nil? raise "Parameter value for 'domain_governance_id' must not be blank" if OCI::Internal::Util.blank_string?(domain_governance_id) path = '/domainGovernances/{domainGovernanceId}'.sub('{domainGovernanceId}', domain_governance_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.make_retrying_call(applicable_retry_config(opts), call_name: 'DomainGovernanceClient#get_domain_governance') 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::DomainGovernance' ) end # rubocop:enable Metrics/BlockLength end
Return a (paginated) list of domain governance entities.
@param [String] compartment_id The ID of the compartment in which to list resources. @param [Hash] opts the optional parameters @option opts [OCI::Retry::RetryConfig] :retry_config The retry configuration to apply to this operation. If no key is provided then the service-level
retry configuration defined by {#retry_config} will be used. If an explicit `nil` value is provided then the operation will not retry
@option opts [String] :domain_id The domain OCID. @option opts [String] :domain_governance_id The domain governance OCID. @option opts [String] :lifecycle_state The lifecycle state of the resource. @option opts [String] :name A filter to return only resources that exactly match the name given. @option opts [String] :opc_request_id The client request ID for tracing. @option opts [String] :page The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. @option opts [Integer] :limit The maximum number of items to return. (default to 100) @option opts [String] :sort_by The field to sort by. Only one sort order can be provided.
* The default order for timeCreated is descending. * The default order for displayName is ascending. * If no value is specified, timeCreated is the default. (default to timeCreated) Allowed values are: timeCreated, displayName
@option opts [String] :sort_order The sort order to use, whether 'asc' or 'desc'. @return [Response] A Response
object with data of type {OCI::TenantManagerControlPlane::Models::DomainGovernanceCollection DomainGovernanceCollection} @note Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/tenantmanagercontrolplane/list_domain_governances.rb.html) to see an example of how to use list_domain_governances
API.
# File lib/oci/tenant_manager_control_plane/domain_governance_client.rb, line 298 def list_domain_governances(compartment_id, opts = {}) logger.debug 'Calling operation DomainGovernanceClient#list_domain_governances.' if logger raise "Missing the required parameter 'compartment_id' when calling list_domain_governances." 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[: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 = '/domainGovernances' 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[:domainGovernanceId] = opts[:domain_governance_id] if opts[:domain_governance_id] query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state] 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.make_retrying_call(applicable_retry_config(opts), call_name: 'DomainGovernanceClient#list_domain_governances') 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::DomainGovernanceCollection' ) end # rubocop:enable Metrics/BlockLength end
@return [Logger] The logger for this client. May be nil.
# File lib/oci/tenant_manager_control_plane/domain_governance_client.rb, line 92 def logger @api_client.config.logger end
Set the region that will be used to determine the service endpoint. This will usually correspond to a value in {OCI::Regions::REGION_ENUM}, but may be an arbitrary string.
# File lib/oci/tenant_manager_control_plane/domain_governance_client.rb, line 82 def region=(new_region) @region = new_region raise 'A region must be specified.' unless @region @endpoint = OCI::Regions.get_service_endpoint_for_template(@region, 'https://organizations.{region}.oci.{secondLevelDomain}') + '/20200801' logger.info "DomainGovernanceClient endpoint set to '#{@endpoint} from region #{@region}'." if logger end
Updates the domain governance entity. @param [String] domain_governance_id The domain governance OCID. @param [OCI::TenantManagerControlPlane::Models::UpdateDomainGovernanceDetails] update_domain_governance_details The information to be updated. @param [Hash] opts the optional parameters @option opts [OCI::Retry::RetryConfig] :retry_config The retry configuration to apply to this operation. If no key is provided then the service-level
retry configuration defined by {#retry_config} will be used. If an explicit `nil` value is provided then the operation will not retry
@option opts [String] :if_match For optimistic concurrency control. In the PUT or DELETE call
for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
@option opts [String] :opc_request_id The client request ID for tracing. @return [Response] A Response
object with data of type {OCI::TenantManagerControlPlane::Models::DomainGovernance DomainGovernance} @note Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/tenantmanagercontrolplane/update_domain_governance.rb.html) to see an example of how to use update_domain_governance
API.
# File lib/oci/tenant_manager_control_plane/domain_governance_client.rb, line 379 def update_domain_governance(domain_governance_id, update_domain_governance_details, opts = {}) logger.debug 'Calling operation DomainGovernanceClient#update_domain_governance.' if logger raise "Missing the required parameter 'domain_governance_id' when calling update_domain_governance." if domain_governance_id.nil? raise "Missing the required parameter 'update_domain_governance_details' when calling update_domain_governance." if update_domain_governance_details.nil? raise "Parameter value for 'domain_governance_id' must not be blank" if OCI::Internal::Util.blank_string?(domain_governance_id) path = '/domainGovernances/{domainGovernanceId}'.sub('{domainGovernanceId}', domain_governance_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_governance_details) # rubocop:disable Metrics/BlockLength OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DomainGovernanceClient#update_domain_governance') 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::DomainGovernance' ) end # rubocop:enable Metrics/BlockLength end
Private Instance Methods
rubocop:enable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/PerceivedComplexity rubocop:enable Style/IfUnlessModifier, Metrics/ParameterLists rubocop:enable Metrics/MethodLength, Layout/EmptyLines
# File lib/oci/tenant_manager_control_plane/domain_governance_client.rb, line 424 def applicable_retry_config(opts = {}) return @retry_config unless opts.key?(:retry_config) opts[:retry_config] end