Class: OCI::GovernanceRulesControlPlane::GovernanceRuleClient

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/governance_rules_control_plane/governance_rule_client.rb

Overview

A description of the GovernanceRulesControlPlane API

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ GovernanceRuleClient

Creates a new GovernanceRuleClient. 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.

Parameters:

  • config (Config) (defaults to: nil) —

    A Config object.

  • region (String) (defaults to: nil) —

    A region used to determine the service endpoint. This will usually correspond to a value in Regions::REGION_ENUM, but may be an arbitrary string.

  • endpoint (String) (defaults to: nil) —

    The fully qualified endpoint URL

  • signer (OCI::BaseSigner) (defaults to: nil) —

    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

  • proxy_settings (OCI::ApiClientProxySettings) (defaults to: nil) —

    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

  • retry_config (OCI::Retry::RetryConfig) (defaults to: nil) —

    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



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/governance_rules_control_plane/governance_rule_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 + '/20220504'
  else
    region ||= config.region
    region ||= signer.region if signer.respond_to?(:region)
    self.region = region
  end
  logger.info "GovernanceRuleClient endpoint set to '#{@endpoint}'." if logger
end

Instance Attribute Details

#api_client ⇒ OCI::ApiClient (readonly)

Client used to make HTTP requests.

Returns:



15
16
17
 
# File 'lib/oci/governance_rules_control_plane/governance_rule_client.rb', line 15

def api_client
  @api_client
end

#endpoint ⇒ String (readonly)

Fully qualified endpoint URL

Returns:

  • (String) 


19
20
21
 
# File 'lib/oci/governance_rules_control_plane/governance_rule_client.rb', line 19

def endpoint
  @endpoint
end

#region ⇒ String

The region, which will usually correspond to a value in Regions::REGION_ENUM.

Returns:

  • (String) 


29
30
31
 
# File 'lib/oci/governance_rules_control_plane/governance_rule_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

Returns:



25
26
27
 
# File 'lib/oci/governance_rules_control_plane/governance_rule_client.rb', line 25

def retry_config
  @retry_config
end

Instance Method Details

#create_governance_rule(create_governance_rule_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use create_governance_rule API.

Create governance rule in the root compartment only. Either relatedResourceId or template must be supplied.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    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

  • :opc_retry_token (String) —

    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.

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



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
155
 
# File 'lib/oci/governance_rules_control_plane/governance_rule_client.rb', line 118

def create_governance_rule(create_governance_rule_details, opts = {})
  logger.debug 'Calling operation GovernanceRuleClient#create_governance_rule.' if logger

  raise "Missing the required parameter 'create_governance_rule_details' when calling create_governance_rule." if create_governance_rule_details.nil?

  path = '/governanceRules'
  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_governance_rule_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'GovernanceRuleClient#create_governance_rule') 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::GovernanceRulesControlPlane::Models::GovernanceRule'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_inclusion_criterion(create_inclusion_criterion_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use create_inclusion_criterion API.

Create inclusion criterion of type tenancy or tag for the governance rule.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    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

  • :opc_retry_token (String) —

    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.

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



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
215
216
217
 
# File 'lib/oci/governance_rules_control_plane/governance_rule_client.rb', line 180

def create_inclusion_criterion(create_inclusion_criterion_details, opts = {})
  logger.debug 'Calling operation GovernanceRuleClient#create_inclusion_criterion.' if logger

  raise "Missing the required parameter 'create_inclusion_criterion_details' when calling create_inclusion_criterion." if create_inclusion_criterion_details.nil?

  path = '/inclusionCriteria'
  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_inclusion_criterion_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'GovernanceRuleClient#create_inclusion_criterion') 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::GovernanceRulesControlPlane::Models::InclusionCriterion'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_governance_rule(governance_rule_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_governance_rule API.

Delete the specified governance rule.

Parameters:

  • governance_rule_id (String) —

    Unique governance rule identifier.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    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

  • :if_match (String) —

    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.

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type nil



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
269
270
271
272
273
274
275
276
277
 
# File 'lib/oci/governance_rules_control_plane/governance_rule_client.rb', line 241

def delete_governance_rule(governance_rule_id, opts = {})
  logger.debug 'Calling operation GovernanceRuleClient#delete_governance_rule.' if logger

  raise "Missing the required parameter 'governance_rule_id' when calling delete_governance_rule." if governance_rule_id.nil?
  raise "Parameter value for 'governance_rule_id' must not be blank" if OCI::Internal::Util.blank_string?(governance_rule_id)

  path = '/governanceRules/{governanceRuleId}'.sub('{governanceRuleId}', governance_rule_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: 'GovernanceRuleClient#delete_governance_rule') 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

#delete_inclusion_criterion(inclusion_criterion_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_inclusion_criterion API.

Delete the specified inclusion criterion.

Parameters:

  • inclusion_criterion_id (String) —

    Unique inclusion criterion identifier.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    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

  • :if_match (String) —

    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.

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type nil



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
 
# File 'lib/oci/governance_rules_control_plane/governance_rule_client.rb', line 301

def delete_inclusion_criterion(inclusion_criterion_id, opts = {})
  logger.debug 'Calling operation GovernanceRuleClient#delete_inclusion_criterion.' if logger

  raise "Missing the required parameter 'inclusion_criterion_id' when calling delete_inclusion_criterion." if inclusion_criterion_id.nil?
  raise "Parameter value for 'inclusion_criterion_id' must not be blank" if OCI::Internal::Util.blank_string?(inclusion_criterion_id)

  path = '/inclusionCriteria/{inclusionCriterionId}'.sub('{inclusionCriterionId}', inclusion_criterion_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: 'GovernanceRuleClient#delete_inclusion_criterion') 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_enforced_governance_rule(enforced_governance_rule_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_enforced_governance_rule API.

Get the specified enforced governance rule's information.

Parameters:

  • enforced_governance_rule_id (String) —

    Unique enforced governance rule identifier.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    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

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
 
# File 'lib/oci/governance_rules_control_plane/governance_rule_client.rb', line 355

def get_enforced_governance_rule(enforced_governance_rule_id, opts = {})
  logger.debug 'Calling operation GovernanceRuleClient#get_enforced_governance_rule.' if logger

  raise "Missing the required parameter 'enforced_governance_rule_id' when calling get_enforced_governance_rule." if enforced_governance_rule_id.nil?
  raise "Parameter value for 'enforced_governance_rule_id' must not be blank" if OCI::Internal::Util.blank_string?(enforced_governance_rule_id)

  path = '/enforcedGovernanceRules/{enforcedGovernanceRuleId}'.sub('{enforcedGovernanceRuleId}', enforced_governance_rule_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: 'GovernanceRuleClient#get_enforced_governance_rule') 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::GovernanceRulesControlPlane::Models::EnforcedGovernanceRule'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_governance_rule(governance_rule_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_governance_rule API.

Get the specified governance rule's information.

Parameters:

  • governance_rule_id (String) —

    Unique governance rule identifier.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    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

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
 
# File 'lib/oci/governance_rules_control_plane/governance_rule_client.rb', line 409

def get_governance_rule(governance_rule_id, opts = {})
  logger.debug 'Calling operation GovernanceRuleClient#get_governance_rule.' if logger

  raise "Missing the required parameter 'governance_rule_id' when calling get_governance_rule." if governance_rule_id.nil?
  raise "Parameter value for 'governance_rule_id' must not be blank" if OCI::Internal::Util.blank_string?(governance_rule_id)

  path = '/governanceRules/{governanceRuleId}'.sub('{governanceRuleId}', governance_rule_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: 'GovernanceRuleClient#get_governance_rule') 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::GovernanceRulesControlPlane::Models::GovernanceRule'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_inclusion_criterion(inclusion_criterion_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_inclusion_criterion API.

Get the specified inclusion criterion's information.

Parameters:

  • inclusion_criterion_id (String) —

    Unique inclusion criterion identifier.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    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

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
 
# File 'lib/oci/governance_rules_control_plane/governance_rule_client.rb', line 463

def get_inclusion_criterion(inclusion_criterion_id, opts = {})
  logger.debug 'Calling operation GovernanceRuleClient#get_inclusion_criterion.' if logger

  raise "Missing the required parameter 'inclusion_criterion_id' when calling get_inclusion_criterion." if inclusion_criterion_id.nil?
  raise "Parameter value for 'inclusion_criterion_id' must not be blank" if OCI::Internal::Util.blank_string?(inclusion_criterion_id)

  path = '/inclusionCriteria/{inclusionCriterionId}'.sub('{inclusionCriterionId}', inclusion_criterion_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: 'GovernanceRuleClient#get_inclusion_criterion') 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::GovernanceRulesControlPlane::Models::InclusionCriterion'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_tenancy_attachment(tenancy_attachment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_tenancy_attachment API.

Get the specified tenancy attachment's information.

Parameters:

  • tenancy_attachment_id (String) —

    Unique tenancy attachment identifier.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    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

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
 
# File 'lib/oci/governance_rules_control_plane/governance_rule_client.rb', line 517

def get_tenancy_attachment(tenancy_attachment_id, opts = {})
  logger.debug 'Calling operation GovernanceRuleClient#get_tenancy_attachment.' if logger

  raise "Missing the required parameter 'tenancy_attachment_id' when calling get_tenancy_attachment." if tenancy_attachment_id.nil?
  raise "Parameter value for 'tenancy_attachment_id' must not be blank" if OCI::Internal::Util.blank_string?(tenancy_attachment_id)

  path = '/tenancyAttachments/{tenancyAttachmentId}'.sub('{tenancyAttachmentId}', tenancy_attachment_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: 'GovernanceRuleClient#get_tenancy_attachment') 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::GovernanceRulesControlPlane::Models::TenancyAttachment'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_enforced_governance_rules(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_enforced_governance_rules API.

List enforced governance rules. Either compartment id or enforced governance rule id must be supplied. An optional governance rule type or a display name can also be supplied.

Allowed values are: timeCreated, displayName

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    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

  • :compartment_id (String) —

    The ID of the compartment in which to list resources.

  • :enforced_governance_rule_id (String) —

    Unique enforced governance rule identifier.

  • :governance_rule_type (String) —

    A filter to return only resources that match the type given.

  • :display_name (String) —

    A filter to return only resources that match the entire name given.

  • :limit (Integer) —

    The maximum number of items to return. (default to 10)

  • :page (String) —

    A token representing the position at which to start retrieving results. This must come from the opc-next-page header field of a previous response.

  • :sort_order (String) —

    The sort order to use, either 'ASC' or 'DESC'.

  • :sort_by (String) —

    The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. (default to timeCreated)

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
 
# File 'lib/oci/governance_rules_control_plane/governance_rule_client.rb', line 582

def list_enforced_governance_rules(opts = {})
  logger.debug 'Calling operation GovernanceRuleClient#list_enforced_governance_rules.' if logger


  if opts[:governance_rule_type] && !OCI::GovernanceRulesControlPlane::Models::GOVERNANCE_RULE_TYPE_ENUM.include?(opts[:governance_rule_type])
    raise 'Invalid value for "governance_rule_type", must be one of the values in OCI::GovernanceRulesControlPlane::Models::GOVERNANCE_RULE_TYPE_ENUM.'
  end

  if opts[:sort_order] && !OCI::GovernanceRulesControlPlane::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::GovernanceRulesControlPlane::Models::SORT_ORDER_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

  path = '/enforcedGovernanceRules'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id]
  query_params[:enforcedGovernanceRuleId] = opts[:enforced_governance_rule_id] if opts[:enforced_governance_rule_id]
  query_params[:governanceRuleType] = opts[:governance_rule_type] if opts[:governance_rule_type]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

  # 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: 'GovernanceRuleClient#list_enforced_governance_rules') 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::GovernanceRulesControlPlane::Models::EnforcedGovernanceRuleCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_governance_rules(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_governance_rules API.

List governance rules. Either compartment id or governance rule id must be supplied. An optional lifecycle state, display name or a governance rule type can also be supplied.

Allowed values are: timeCreated, displayName

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    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

  • :compartment_id (String) —

    The ID of the compartment in which to list resources.

  • :governance_rule_id (String) —

    Unique governance rule identifier.

  • :lifecycle_state (String) —

    A filter to return only resources whose lifecycle state matches the given lifecycle state.

  • :display_name (String) —

    A filter to return only resources that match the entire name given.

  • :governance_rule_type (String) —

    A filter to return only resources that match the type given.

  • :limit (Integer) —

    The maximum number of items to return. (default to 10)

  • :page (String) —

    A token representing the position at which to start retrieving results. This must come from the opc-next-page header field of a previous response.

  • :sort_order (String) —

    The sort order to use, either 'ASC' or 'DESC'.

  • :sort_by (String) —

    The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. (default to timeCreated)

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
 
# File 'lib/oci/governance_rules_control_plane/governance_rule_client.rb', line 666

def list_governance_rules(opts = {})
  logger.debug 'Calling operation GovernanceRuleClient#list_governance_rules.' if logger


  if opts[:lifecycle_state] && !OCI::GovernanceRulesControlPlane::Models::GOVERNANCE_RULE_LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::GovernanceRulesControlPlane::Models::GOVERNANCE_RULE_LIFECYCLE_STATE_ENUM.'
  end

  if opts[:governance_rule_type] && !OCI::GovernanceRulesControlPlane::Models::GOVERNANCE_RULE_TYPE_ENUM.include?(opts[:governance_rule_type])
    raise 'Invalid value for "governance_rule_type", must be one of the values in OCI::GovernanceRulesControlPlane::Models::GOVERNANCE_RULE_TYPE_ENUM.'
  end

  if opts[:sort_order] && !OCI::GovernanceRulesControlPlane::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::GovernanceRulesControlPlane::Models::SORT_ORDER_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

  path = '/governanceRules'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id]
  query_params[:governanceRuleId] = opts[:governance_rule_id] if opts[:governance_rule_id]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:governanceRuleType] = opts[:governance_rule_type] if opts[:governance_rule_type]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

  # 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: 'GovernanceRuleClient#list_governance_rules') 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::GovernanceRulesControlPlane::Models::GovernanceRuleCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_inclusion_criteria(governance_rule_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_inclusion_criteria API.

List inclusion criteria associated with a governance rule. Governance rule id must be supplied. An optional inclusion criterion id or a lifecycle state can also be supplied.

Allowed values are: timeCreated, displayName

Parameters:

  • governance_rule_id (String) —

    Unique governance rule identifier.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    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

  • :inclusion_criterion_id (String) —

    Unique inclusion criterion identifier.

  • :lifecycle_state (String) —

    A filter to return only resources when their lifecycle state matches the given lifecycle state.

  • :limit (Integer) —

    The maximum number of items to return. (default to 10)

  • :page (String) —

    A token representing the position at which to start retrieving results. This must come from the opc-next-page header field of a previous response.

  • :sort_order (String) —

    The sort order to use, either 'ASC' or 'DESC'.

  • :sort_by (String) —

    The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. (default to timeCreated)

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
 
# File 'lib/oci/governance_rules_control_plane/governance_rule_client.rb', line 753

def list_inclusion_criteria(governance_rule_id, opts = {})
  logger.debug 'Calling operation GovernanceRuleClient#list_inclusion_criteria.' if logger

  raise "Missing the required parameter 'governance_rule_id' when calling list_inclusion_criteria." if governance_rule_id.nil?

  if opts[:lifecycle_state] && !OCI::GovernanceRulesControlPlane::Models::InclusionCriterion::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::GovernanceRulesControlPlane::Models::InclusionCriterion::LIFECYCLE_STATE_ENUM.'
  end

  if opts[:sort_order] && !OCI::GovernanceRulesControlPlane::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::GovernanceRulesControlPlane::Models::SORT_ORDER_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

  path = '/inclusionCriteria'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:governanceRuleId] = governance_rule_id
  query_params[:inclusionCriterionId] = opts[:inclusion_criterion_id] if opts[:inclusion_criterion_id]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

  # 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: 'GovernanceRuleClient#list_inclusion_criteria') 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::GovernanceRulesControlPlane::Models::InclusionCriterionCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_tenancy_attachments(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_tenancy_attachments API.

List tenancy attachments. Either compartment id, governance rule id or tenancy attachment id must be supplied. An optional lifecycle state or a child tenancy id can also be supplied.

Allowed values are: timeCreated, displayName

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    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

  • :compartment_id (String) —

    The ID of the compartment in which to list resources.

  • :tenancy_attachment_id (String) —

    Unique tenancy attachment identifier.

  • :governance_rule_id (String) —

    Unique governance rule identifier.

  • :lifecycle_state (String) —

    A filter to return only resources when their lifecycle state matches the given lifecycle state.

  • :child_tenancy_id (String) —

    A filter to return only governance rules that match the given tenancy id.

  • :limit (Integer) —

    The maximum number of items to return. (default to 10)

  • :page (String) —

    A token representing the position at which to start retrieving results. This must come from the opc-next-page header field of a previous response.

  • :sort_order (String) —

    The sort order to use, either 'ASC' or 'DESC'.

  • :sort_by (String) —

    The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. (default to timeCreated)

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
 
# File 'lib/oci/governance_rules_control_plane/governance_rule_client.rb', line 837

def list_tenancy_attachments(opts = {})
  logger.debug 'Calling operation GovernanceRuleClient#list_tenancy_attachments.' if logger


  if opts[:lifecycle_state] && !OCI::GovernanceRulesControlPlane::Models::TenancyAttachment::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::GovernanceRulesControlPlane::Models::TenancyAttachment::LIFECYCLE_STATE_ENUM.'
  end

  if opts[:sort_order] && !OCI::GovernanceRulesControlPlane::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::GovernanceRulesControlPlane::Models::SORT_ORDER_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

  path = '/tenancyAttachments'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id]
  query_params[:tenancyAttachmentId] = opts[:tenancy_attachment_id] if opts[:tenancy_attachment_id]
  query_params[:governanceRuleId] = opts[:governance_rule_id] if opts[:governance_rule_id]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:childTenancyId] = opts[:child_tenancy_id] if opts[:child_tenancy_id]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

  # 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: 'GovernanceRuleClient#list_tenancy_attachments') 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::GovernanceRulesControlPlane::Models::TenancyAttachmentCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#logger ⇒ Logger

Returns The logger for this client. May be nil.

Returns:

  • (Logger) —

    The logger for this client. May be nil.



94
95
96
 
# File 'lib/oci/governance_rules_control_plane/governance_rule_client.rb', line 94

def logger
  @api_client.config.logger
end

#retry_governance_rule(governance_rule_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use retry_governance_rule API.

Retry the creation of the specified governance rule. Used by the tenancy admins when all the workflow retries have exhausted. When provided, If-Match is checked against ETag values of the resource.

Parameters:

  • governance_rule_id (String) —

    Unique governance rule identifier.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    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

  • :opc_retry_token (String) —

    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.

  • :if_match (String) —

    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.

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type nil



925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
 
# File 'lib/oci/governance_rules_control_plane/governance_rule_client.rb', line 925

def retry_governance_rule(governance_rule_id, opts = {})
  logger.debug 'Calling operation GovernanceRuleClient#retry_governance_rule.' if logger

  raise "Missing the required parameter 'governance_rule_id' when calling retry_governance_rule." if governance_rule_id.nil?
  raise "Parameter value for 'governance_rule_id' must not be blank" if OCI::Internal::Util.blank_string?(governance_rule_id)

  path = '/governanceRules/{governanceRuleId}/actions/retry'.sub('{governanceRuleId}', governance_rule_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-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  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
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'GovernanceRuleClient#retry_governance_rule') 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

#retry_tenancy_attachment(tenancy_attachment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use retry_tenancy_attachment API.

Retry governance rule application for the specified tenancy attachment id. Used by the tenancy admins when all the workflow retries have exhausted.

Parameters:

  • tenancy_attachment_id (String) —

    Unique tenancy attachment identifier.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    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

  • :opc_retry_token (String) —

    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.

  • :if_match (String) —

    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.

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type nil



995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
 
# File 'lib/oci/governance_rules_control_plane/governance_rule_client.rb', line 995

def retry_tenancy_attachment(tenancy_attachment_id, opts = {})
  logger.debug 'Calling operation GovernanceRuleClient#retry_tenancy_attachment.' if logger

  raise "Missing the required parameter 'tenancy_attachment_id' when calling retry_tenancy_attachment." if tenancy_attachment_id.nil?
  raise "Parameter value for 'tenancy_attachment_id' must not be blank" if OCI::Internal::Util.blank_string?(tenancy_attachment_id)

  path = '/tenancyAttachments/{tenancyAttachmentId}/actions/retry'.sub('{tenancyAttachmentId}', tenancy_attachment_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-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  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
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'GovernanceRuleClient#retry_tenancy_attachment') 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

#update_governance_rule(governance_rule_id, update_governance_rule_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_governance_rule API.

Update the specified governance rule.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    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

  • :if_match (String) —

    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.

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type nil



1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
 
# File 'lib/oci/governance_rules_control_plane/governance_rule_client.rb', line 1058

def update_governance_rule(governance_rule_id, update_governance_rule_details, opts = {})
  logger.debug 'Calling operation GovernanceRuleClient#update_governance_rule.' if logger

  raise "Missing the required parameter 'governance_rule_id' when calling update_governance_rule." if governance_rule_id.nil?
  raise "Missing the required parameter 'update_governance_rule_details' when calling update_governance_rule." if update_governance_rule_details.nil?
  raise "Parameter value for 'governance_rule_id' must not be blank" if OCI::Internal::Util.blank_string?(governance_rule_id)

  path = '/governanceRules/{governanceRuleId}'.sub('{governanceRuleId}', governance_rule_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_governance_rule_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'GovernanceRuleClient#update_governance_rule') 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
    )
  end
  # rubocop:enable Metrics/BlockLength
end