Class: OCI::TenantManagerControlPlane::GovernanceClient
- Inherits:
-
Object
- Object
- OCI::TenantManagerControlPlane::GovernanceClient
- Defined in:
- lib/oci/tenant_manager_control_plane/governance_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
-
#add_governance(organization_id, organization_tenancy_id, opts = {}) ⇒ Response
Starts a work request to opt the tenancy in to governance rules.
-
#initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ GovernanceClient
constructor
Creates a new GovernanceClient.
-
#logger ⇒ Logger
The logger for this client.
-
#remove_governance(organization_id, organization_tenancy_id, opts = {}) ⇒ Response
Starts a work request to opt the tenancy out of governance rules.
Constructor Details
#initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ GovernanceClient
Creates a new GovernanceClient. 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/governance_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 "GovernanceClient 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/governance_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/governance_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/governance_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/governance_client.rb', line 25 def retry_config @retry_config end |
Instance Method Details
#add_governance(organization_id, organization_tenancy_id, opts = {}) ⇒ Response
Click here to see an example of how to use add_governance API.
Starts a work request to opt the tenancy in to governance rules.
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 155 156 157 158 159 160 161 162 163 164 |
# File 'lib/oci/tenant_manager_control_plane/governance_client.rb', line 124 def add_governance(organization_id, organization_tenancy_id, opts = {}) logger.debug 'Calling operation GovernanceClient#add_governance.' if logger raise "Missing the required parameter 'organization_id' when calling add_governance." if organization_id.nil? raise "Missing the required parameter 'organization_tenancy_id' when calling add_governance." if organization_tenancy_id.nil? raise "Parameter value for 'organization_id' must not be blank" if OCI::Internal::Util.blank_string?(organization_id) raise "Parameter value for 'organization_tenancy_id' must not be blank" if OCI::Internal::Util.blank_string?(organization_tenancy_id) path = '/organizations/{organizationId}/tenancies/{organizationTenancyId}/actions/addGovernance'.sub('{organizationId}', organization_id.to_s).sub('{organizationTenancyId}', organization_tenancy_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-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 = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'GovernanceClient#add_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 ) 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/governance_client.rb', line 94 def logger @api_client.config.logger end |
#remove_governance(organization_id, organization_tenancy_id, opts = {}) ⇒ Response
Click here to see an example of how to use remove_governance API.
Starts a work request to opt the tenancy out of governance rules.
195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 |
# File 'lib/oci/tenant_manager_control_plane/governance_client.rb', line 195 def remove_governance(organization_id, organization_tenancy_id, opts = {}) logger.debug 'Calling operation GovernanceClient#remove_governance.' if logger raise "Missing the required parameter 'organization_id' when calling remove_governance." if organization_id.nil? raise "Missing the required parameter 'organization_tenancy_id' when calling remove_governance." if organization_tenancy_id.nil? raise "Parameter value for 'organization_id' must not be blank" if OCI::Internal::Util.blank_string?(organization_id) raise "Parameter value for 'organization_tenancy_id' must not be blank" if OCI::Internal::Util.blank_string?(organization_tenancy_id) path = '/organizations/{organizationId}/tenancies/{organizationTenancyId}/actions/removeGovernance'.sub('{organizationId}', organization_id.to_s).sub('{organizationTenancyId}', organization_tenancy_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-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 = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'GovernanceClient#remove_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 ) end # rubocop:enable Metrics/BlockLength end |