Class: OCI::Certificates::CertificatesClient
- Inherits:
-
Object
- Object
- OCI::Certificates::CertificatesClient
- Defined in:
- lib/oci/certificates/certificates_client.rb
Overview
API for retrieving certificates.
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
-
#get_ca_bundle(ca_bundle_id, opts = {}) ⇒ Response
Gets a ca-bundle bundle.
-
#get_certificate_authority_bundle(certificate_authority_id, opts = {}) ⇒ Response
Gets a certificate authority bundle that matches either the specified
stage
,name
, orversionNumber
parameter. -
#get_certificate_bundle(certificate_id, opts = {}) ⇒ Response
Gets a certificate bundle that matches either the specified
stage
,versionName
, orversionNumber
parameter. -
#initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ CertificatesClient
constructor
Creates a new CertificatesClient.
-
#list_certificate_authority_bundle_versions(certificate_authority_id, opts = {}) ⇒ Response
Lists all certificate authority bundle versions for the specified certificate authority.
-
#list_certificate_bundle_versions(certificate_id, opts = {}) ⇒ Response
Lists all certificate bundle versions for the specified certificate.
-
#logger ⇒ Logger
The logger for this client.
Constructor Details
#initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ CertificatesClient
Creates a new CertificatesClient. 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/certificates/certificates_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 + '/20210224' else region ||= config.region region ||= signer.region if signer.respond_to?(:region) self.region = region end logger.info "CertificatesClient 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/certificates/certificates_client.rb', line 15 def api_client @api_client end |
#endpoint ⇒ String (readonly)
Fully qualified endpoint URL
19 20 21 |
# File 'lib/oci/certificates/certificates_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/certificates/certificates_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/certificates/certificates_client.rb', line 25 def retry_config @retry_config end |
Instance Method Details
#get_ca_bundle(ca_bundle_id, opts = {}) ⇒ Response
Click here to see an example of how to use get_ca_bundle API.
Gets a ca-bundle bundle.
114 115 116 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 |
# File 'lib/oci/certificates/certificates_client.rb', line 114 def get_ca_bundle(ca_bundle_id, opts = {}) logger.debug 'Calling operation CertificatesClient#get_ca_bundle.' if logger raise "Missing the required parameter 'ca_bundle_id' when calling get_ca_bundle." if ca_bundle_id.nil? raise "Parameter value for 'ca_bundle_id' must not be blank" if OCI::Internal::Util.blank_string?(ca_bundle_id) path = '/caBundles/{caBundleId}'.sub('{caBundleId}', ca_bundle_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: 'CertificatesClient#get_ca_bundle') 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::Certificates::Models::CaBundle' ) end # rubocop:enable Metrics/BlockLength end |
#get_certificate_authority_bundle(certificate_authority_id, opts = {}) ⇒ Response
Click here to see an example of how to use get_certificate_authority_bundle API.
Gets a certificate authority bundle that matches either the specified stage
, name
, or versionNumber
parameter. If none of these parameters are provided, the bundle for the certificate authority version marked as CURRENT
will be returned.
177 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 215 216 217 218 219 220 |
# File 'lib/oci/certificates/certificates_client.rb', line 177 def (, opts = {}) logger.debug 'Calling operation CertificatesClient#get_certificate_authority_bundle.' if logger raise "Missing the required parameter 'certificate_authority_id' when calling get_certificate_authority_bundle." if .nil? if opts[:stage] && !%w[CURRENT PENDING LATEST PREVIOUS DEPRECATED].include?(opts[:stage]) raise 'Invalid value for "stage", must be one of CURRENT, PENDING, LATEST, PREVIOUS, DEPRECATED.' end raise "Parameter value for 'certificate_authority_id' must not be blank" if OCI::Internal::Util.blank_string?() path = '/certificateAuthorityBundles/{certificateAuthorityId}'.sub('{certificateAuthorityId}', .to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:versionNumber] = opts[:version_number] if opts[:version_number] query_params[:certificateAuthorityVersionName] = opts[:certificate_authority_version_name] if opts[:certificate_authority_version_name] query_params[:stage] = opts[:stage] if opts[:stage] # 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: 'CertificatesClient#get_certificate_authority_bundle') 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::Certificates::Models::CertificateAuthorityBundle' ) end # rubocop:enable Metrics/BlockLength end |
#get_certificate_bundle(certificate_id, opts = {}) ⇒ Response
Click here to see an example of how to use get_certificate_bundle API.
Gets a certificate bundle that matches either the specified stage
, versionName
, or versionNumber
parameter. If none of these parameters are provided, the bundle for the certificate version marked as CURRENT
will be returned.
By default, the private key is not included in the query result, and a CertificateBundlePublicOnly is returned. If the private key is needed, use the CertificateBundleTypeQueryParam parameter to get a CertificateBundleWithPrivateKey response.
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 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 |
# File 'lib/oci/certificates/certificates_client.rb', line 253 def get_certificate_bundle(certificate_id, opts = {}) logger.debug 'Calling operation CertificatesClient#get_certificate_bundle.' if logger raise "Missing the required parameter 'certificate_id' when calling get_certificate_bundle." if certificate_id.nil? if opts[:stage] && !%w[CURRENT PENDING LATEST PREVIOUS DEPRECATED].include?(opts[:stage]) raise 'Invalid value for "stage", must be one of CURRENT, PENDING, LATEST, PREVIOUS, DEPRECATED.' end if opts[:certificate_bundle_type] && !%w[CERTIFICATE_CONTENT_PUBLIC_ONLY CERTIFICATE_CONTENT_WITH_PRIVATE_KEY].include?(opts[:certificate_bundle_type]) raise 'Invalid value for "certificate_bundle_type", must be one of CERTIFICATE_CONTENT_PUBLIC_ONLY, CERTIFICATE_CONTENT_WITH_PRIVATE_KEY.' end raise "Parameter value for 'certificate_id' must not be blank" if OCI::Internal::Util.blank_string?(certificate_id) path = '/certificateBundles/{certificateId}'.sub('{certificateId}', certificate_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:versionNumber] = opts[:version_number] if opts[:version_number] query_params[:certificateVersionName] = opts[:certificate_version_name] if opts[:certificate_version_name] query_params[:stage] = opts[:stage] if opts[:stage] query_params[:certificateBundleType] = opts[:certificate_bundle_type] if opts[:certificate_bundle_type] # 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: 'CertificatesClient#get_certificate_bundle') 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::Certificates::Models::CertificateBundle' ) end # rubocop:enable Metrics/BlockLength end |
#list_certificate_authority_bundle_versions(certificate_authority_id, opts = {}) ⇒ Response
Click here to see an example of how to use list_certificate_authority_bundle_versions API.
Lists all certificate authority bundle versions for the specified certificate authority. Allowed values are: ASC, DESC
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 361 362 363 364 365 366 367 368 369 370 371 372 373 374 |
# File 'lib/oci/certificates/certificates_client.rb', line 328 def (, opts = {}) logger.debug 'Calling operation CertificatesClient#list_certificate_authority_bundle_versions.' if logger raise "Missing the required parameter 'certificate_authority_id' when calling list_certificate_authority_bundle_versions." if .nil? if opts[:sort_by] && !%w[VERSION_NUMBER].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of VERSION_NUMBER.' end if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of ASC, DESC.' end raise "Parameter value for 'certificate_authority_id' must not be blank" if OCI::Internal::Util.blank_string?() path = '/certificateAuthorityBundles/{certificateAuthorityId}/versions'.sub('{certificateAuthorityId}', .to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} 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: 'CertificatesClient#list_certificate_authority_bundle_versions') 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::Certificates::Models::CertificateAuthorityBundleVersionCollection' ) end # rubocop:enable Metrics/BlockLength end |
#list_certificate_bundle_versions(certificate_id, opts = {}) ⇒ Response
Click here to see an example of how to use list_certificate_bundle_versions API.
Lists all certificate bundle versions for the specified certificate. Allowed values are: ASC, DESC
401 402 403 404 405 406 407 408 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 446 447 |
# File 'lib/oci/certificates/certificates_client.rb', line 401 def list_certificate_bundle_versions(certificate_id, opts = {}) logger.debug 'Calling operation CertificatesClient#list_certificate_bundle_versions.' if logger raise "Missing the required parameter 'certificate_id' when calling list_certificate_bundle_versions." if certificate_id.nil? if opts[:sort_by] && !%w[VERSION_NUMBER].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of VERSION_NUMBER.' end if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of ASC, DESC.' end raise "Parameter value for 'certificate_id' must not be blank" if OCI::Internal::Util.blank_string?(certificate_id) path = '/certificateBundles/{certificateId}/versions'.sub('{certificateId}', certificate_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} 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: 'CertificatesClient#list_certificate_bundle_versions') 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::Certificates::Models::CertificateBundleVersionCollection' ) end # rubocop:enable Metrics/BlockLength end |
#logger ⇒ Logger
Returns The logger for this client. May be nil.
94 95 96 |
# File 'lib/oci/certificates/certificates_client.rb', line 94 def logger @api_client.config.logger end |