Class: OCI::JmsJavaDownloads::JavaDownloadClient

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/jms_java_downloads/java_download_client.rb

Overview

The APIs for the download engine of the Java Management Service.

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) ⇒ JavaDownloadClient

Creates a new JavaDownloadClient. 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/jms_java_downloads/java_download_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 + '/'
  else
    region ||= config.region
    region ||= signer.region if signer.respond_to?(:region)
    self.region = region
  end
  logger.info "JavaDownloadClient 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/jms_java_downloads/java_download_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/jms_java_downloads/java_download_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/jms_java_downloads/java_download_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/jms_java_downloads/java_download_client.rb', line 25

def retry_config
  @retry_config
end

Instance Method Details

#cancel_work_request(work_request_id, opts = {}) ⇒ Response

Note:

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

Cancels the work request with the given ID.

Parameters:

  • work_request_id (String) —

    The ID of the asynchronous request.

  • 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



117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
 
# File 'lib/oci/jms_java_downloads/java_download_client.rb', line 117

def cancel_work_request(work_request_id, opts = {})
  logger.debug 'Calling operation JavaDownloadClient#cancel_work_request.' if logger

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

  path = '/20230601/workRequests/{workRequestId}'.sub('{workRequestId}', work_request_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: 'JavaDownloadClient#cancel_work_request') 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

#create_java_download_report(create_java_download_report_details, opts = {}) ⇒ Response

Note:

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

Create a new report in the specified format containing the download details for the tenancy.

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:

  • (Response) —

    A Response object with data of type nil



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
 
# File 'lib/oci/jms_java_downloads/java_download_client.rb', line 179

def create_java_download_report(create_java_download_report_details, opts = {})
  logger.debug 'Calling operation JavaDownloadClient#create_java_download_report.' if logger

  raise "Missing the required parameter 'create_java_download_report_details' when calling create_java_download_report." if create_java_download_report_details.nil?

  path = '/20230601/javaDownloadReports'
  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_java_download_report_details)

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

#create_java_download_token(create_java_download_token_details, opts = {}) ⇒ Response

Note:

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

Creates a new JavaDownloadToken in the tenancy with specified attributes.

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:



240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
 
# File 'lib/oci/jms_java_downloads/java_download_client.rb', line 240

def create_java_download_token(create_java_download_token_details, opts = {})
  logger.debug 'Calling operation JavaDownloadClient#create_java_download_token.' if logger

  raise "Missing the required parameter 'create_java_download_token_details' when calling create_java_download_token." if create_java_download_token_details.nil?

  path = '/20230601/javaDownloadTokens'
  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_java_download_token_details)

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

#create_java_license_acceptance_record(create_java_license_acceptance_record_details, opts = {}) ⇒ Response

Note:

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

Creates a Java license acceptance record for the specified license type in a tenancy.

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:



302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
 
# File 'lib/oci/jms_java_downloads/java_download_client.rb', line 302

def create_java_license_acceptance_record(create_java_license_acceptance_record_details, opts = {})
  logger.debug 'Calling operation JavaDownloadClient#create_java_license_acceptance_record.' if logger

  raise "Missing the required parameter 'create_java_license_acceptance_record_details' when calling create_java_license_acceptance_record." if create_java_license_acceptance_record_details.nil?

  path = '/20230601/javaLicenseAcceptanceRecords'
  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_java_license_acceptance_record_details)

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

#delete_java_download_report(java_download_report_id, opts = {}) ⇒ Response

Note:

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

Deletes a JavaDownloadReport resource by identifier.

Parameters:

  • java_download_report_id (String) —

    Unique Java download report 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



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
392
393
394
395
396
397
398
399
 
# File 'lib/oci/jms_java_downloads/java_download_client.rb', line 363

def delete_java_download_report(java_download_report_id, opts = {})
  logger.debug 'Calling operation JavaDownloadClient#delete_java_download_report.' if logger

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

  path = '/20230601/javaDownloadReports/{javaDownloadReportId}'.sub('{javaDownloadReportId}', java_download_report_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: 'JavaDownloadClient#delete_java_download_report') 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_java_download_token(java_download_token_id, opts = {}) ⇒ Response

Note:

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

Deletes a JavaDownloadToken resource by identifier.

Parameters:

  • java_download_token_id (String) —

    Unique JavaDownloadToken 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



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
448
449
450
451
452
453
454
455
456
457
458
459
 
# File 'lib/oci/jms_java_downloads/java_download_client.rb', line 423

def delete_java_download_token(java_download_token_id, opts = {})
  logger.debug 'Calling operation JavaDownloadClient#delete_java_download_token.' if logger

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

  path = '/20230601/javaDownloadTokens/{javaDownloadTokenId}'.sub('{javaDownloadTokenId}', java_download_token_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: 'JavaDownloadClient#delete_java_download_token') 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_java_license_acceptance_record(java_license_acceptance_record_id, opts = {}) ⇒ Response

Note:

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

Deletes a Java license acceptance record with the specified identifier.

Parameters:

  • java_license_acceptance_record_id (String) —

    Unique Java license acceptance record 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



484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
 
# File 'lib/oci/jms_java_downloads/java_download_client.rb', line 484

def delete_java_license_acceptance_record(java_license_acceptance_record_id, opts = {})
  logger.debug 'Calling operation JavaDownloadClient#delete_java_license_acceptance_record.' if logger

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

  path = '/20230601/javaLicenseAcceptanceRecords/{javaLicenseAcceptanceRecordId}'.sub('{javaLicenseAcceptanceRecordId}', java_license_acceptance_record_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: 'JavaDownloadClient#delete_java_license_acceptance_record') 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

#generate_artifact_download_url(generate_artifact_download_url_details, opts = {}) ⇒ Response

Note:

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

Generates a short-lived download URL and returns it in the response payload. The returned URL can then be used for downloading the specific Java runtime artifact.

Use the get_java_release API to get information about available artifacts for a specific release. Each such artifact is uniquely identified by an artifactId. Refer java_artifact for more details.

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:



544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
 
# File 'lib/oci/jms_java_downloads/java_download_client.rb', line 544

def generate_artifact_download_url(generate_artifact_download_url_details, opts = {})
  logger.debug 'Calling operation JavaDownloadClient#generate_artifact_download_url.' if logger

  raise "Missing the required parameter 'generate_artifact_download_url_details' when calling generate_artifact_download_url." if generate_artifact_download_url_details.nil?

  path = '/20230601/actions/generateArtifactDownloadUrl'
  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 = @api_client.object_to_http_body(generate_artifact_download_url_details)

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

#get_java_download_report(java_download_report_id, opts = {}) ⇒ Response

Note:

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

Gets a JavaDownloadReport by the specified identifier.

Parameters:

  • java_download_report_id (String) —

    Unique Java download report 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:



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
 
# File 'lib/oci/jms_java_downloads/java_download_client.rb', line 597

def get_java_download_report(java_download_report_id, opts = {})
  logger.debug 'Calling operation JavaDownloadClient#get_java_download_report.' if logger

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

  path = '/20230601/javaDownloadReports/{javaDownloadReportId}'.sub('{javaDownloadReportId}', java_download_report_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: 'JavaDownloadClient#get_java_download_report') 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::JmsJavaDownloads::Models::JavaDownloadReport'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_java_download_report_content(java_download_report_id, opts = {}, &block) ⇒ Response

Note:

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

Retrieve a Java download report with the specified identifier.

Parameters:

  • java_download_report_id (String) —

    Unique Java download report identifier.

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

    the optional parameters

  • [Block] (Hash) —

    a customizable set of options

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.

  • :response_target (String, IO) —

    Streaming http body into a file (specified by file name or File object) or IO object if the block is not given

Returns:

  • (Response) —

    A Response object with data of type String if response_target and block are not given, otherwise with nil data



653
654
655
656
657
658
659
660
661
662
663
664
665
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
726
727
728
729
730
731
732
733
 
# File 'lib/oci/jms_java_downloads/java_download_client.rb', line 653

def get_java_download_report_content(java_download_report_id, opts = {}, &block)
  logger.debug 'Calling operation JavaDownloadClient#get_java_download_report_content.' if logger

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

  path = '/20230601/javaDownloadReports/{javaDownloadReportId}/content'.sub('{javaDownloadReportId}', java_download_report_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = opts[:accept] if opts[:accept]
  header_params[:accept] ||= 'text/csv'
  header_params[:'accept-encoding'] = opts[:accept_encoding] if opts[:accept_encoding]
  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: 'JavaDownloadClient#get_java_download_report_content') do
    if !block.nil?
      @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: 'Stream',
        &block
      )
    elsif opts[:response_target]
      if opts[:response_target].respond_to? :write
        @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: 'Stream',
          &proc { |chunk, _response| opts[:response_target].write(chunk) }
        )
      elsif opts[:response_target].is_a?(String)
        File.open(opts[:response_target], 'wb') do |output|
          return @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: 'Stream',
            &proc { |chunk, _response| output.write(chunk) }
          )
        end
      end
    else
      @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: 'String'
      )
    end
  end
  # rubocop:enable Metrics/BlockLength
end

#get_java_download_token(java_download_token_id, opts = {}) ⇒ Response

Note:

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

Gets a JavaDownloadToken by identifier

Parameters:

  • java_download_token_id (String) —

    Unique JavaDownloadToken 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:



751
752
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
 
# File 'lib/oci/jms_java_downloads/java_download_client.rb', line 751

def get_java_download_token(java_download_token_id, opts = {})
  logger.debug 'Calling operation JavaDownloadClient#get_java_download_token.' if logger

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

  path = '/20230601/javaDownloadTokens/{javaDownloadTokenId}'.sub('{javaDownloadTokenId}', java_download_token_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: 'JavaDownloadClient#get_java_download_token') 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::JmsJavaDownloads::Models::JavaDownloadToken'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_java_license(license_type, opts = {}) ⇒ Response

Note:

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

Return details of the specified Java license type.

Parameters:

  • license_type (String) —

    Unique Java license type.

  • 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:



806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
 
# File 'lib/oci/jms_java_downloads/java_download_client.rb', line 806

def get_java_license(license_type, opts = {})
  logger.debug 'Calling operation JavaDownloadClient#get_java_license.' if logger

  raise "Missing the required parameter 'license_type' when calling get_java_license." if license_type.nil?
  unless OCI::JmsJavaDownloads::Models::LICENSE_TYPE_ENUM.include?(license_type)
    raise 'Invalid value for "license_type", must be one of the values in OCI::JmsJavaDownloads::Models::LICENSE_TYPE_ENUM.'
  end

  raise "Parameter value for 'license_type' must not be blank" if OCI::Internal::Util.blank_string?(license_type)

  path = '/20230601/javaLicenses/{licenseType}'.sub('{licenseType}', license_type.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: 'JavaDownloadClient#get_java_license') 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::JmsJavaDownloads::Models::JavaLicense'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_java_license_acceptance_record(java_license_acceptance_record_id, opts = {}) ⇒ Response

Note:

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

Returns a specific Java license acceptance record in a tenancy.

Parameters:

  • java_license_acceptance_record_id (String) —

    Unique Java license acceptance record 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:



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
893
894
895
896
897
898
899
900
901
 
# File 'lib/oci/jms_java_downloads/java_download_client.rb', line 865

def get_java_license_acceptance_record(java_license_acceptance_record_id, opts = {})
  logger.debug 'Calling operation JavaDownloadClient#get_java_license_acceptance_record.' if logger

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

  path = '/20230601/javaLicenseAcceptanceRecords/{javaLicenseAcceptanceRecordId}'.sub('{javaLicenseAcceptanceRecordId}', java_license_acceptance_record_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: 'JavaDownloadClient#get_java_license_acceptance_record') 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::JmsJavaDownloads::Models::JavaLicenseAcceptanceRecord'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_work_request(work_request_id, opts = {}) ⇒ Response

Note:

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

Gets details of the work request with the given ID.

Parameters:

  • work_request_id (String) —

    The ID of the asynchronous request.

  • 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:



919
920
921
922
923
924
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
 
# File 'lib/oci/jms_java_downloads/java_download_client.rb', line 919

def get_work_request(work_request_id, opts = {})
  logger.debug 'Calling operation JavaDownloadClient#get_work_request.' if logger

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

  path = '/20230601/workRequests/{workRequestId}'.sub('{workRequestId}', work_request_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: 'JavaDownloadClient#get_work_request') 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::JmsJavaDownloads::Models::WorkRequest'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_java_download_records(compartment_id, opts = {}) ⇒ Response

Note:

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

Returns a list of Java download records in a tenancy based on specified parameters. See list_java_releases for possible values of javaFamilyVersion and javaReleaseVersion parameters.

Parameters:

  • compartment_id (String) —

    The OCID of the tenancy.

  • 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

  • :family_version (String) —

    Unique Java family version identifier.

  • :release_version (String) —

    Unique Java release version identifier.

  • :os_family (String) —

    Target Operating System family of the artifact.

  • :architecture (String) —

    Target Operating System architecture of the artifact.

  • :package_type_detail (String) —

    Packaging type detail of the artifact.

  • :time_start (DateTime) —

    The start of the time period for which reports are searched (formatted according to RFC3339).

  • :time_end (DateTime) —

    The end of the time period for which reports are searched (formatted according to RFC3339).

  • :limit (Integer) —

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

  • :page (String) —

    The page token representing the page at which to start retrieving results. The token is usually retrieved from a previous list call.

  • :sort_order (String) —

    The sort order, either 'asc' or 'desc'. (default to ASC)

  • :sort_by (String) —

    If no value is specified timeDownloaded is default. (default to timeDownloaded)

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



989
990
991
992
993
994
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
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
 
# File 'lib/oci/jms_java_downloads/java_download_client.rb', line 989

def list_java_download_records(compartment_id, opts = {})
  logger.debug 'Calling operation JavaDownloadClient#list_java_download_records.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_java_download_records." if compartment_id.nil?

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

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

  path = '/20230601/javaDownloadRecords'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:familyVersion] = opts[:family_version] if opts[:family_version]
  query_params[:releaseVersion] = opts[:release_version] if opts[:release_version]
  query_params[:osFamily] = opts[:os_family] if opts[:os_family]
  query_params[:architecture] = opts[:architecture] if opts[:architecture]
  query_params[:packageTypeDetail] = opts[:package_type_detail] if opts[:package_type_detail]
  query_params[:timeStart] = opts[:time_start] if opts[:time_start]
  query_params[:timeEnd] = opts[:time_end] if opts[:time_end]
  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: 'JavaDownloadClient#list_java_download_records') 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::JmsJavaDownloads::Models::JavaDownloadRecordCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_java_download_reports(compartment_id, opts = {}) ⇒ Response

Note:

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

Returns a list of JavaDownloadReports.

Parameters:

  • compartment_id (String) —

    The OCID of the tenancy.

  • 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

  • :lifecycle_state (String) —

    A filter to return only resources their lifecycleState matches the given lifecycleState.

  • :display_name (String) —

    A filter to return only resources that match the display name.

  • :java_download_report_id (String) —

    Unique Java download report identifier.

  • :limit (Integer) —

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

  • :page (String) —

    The page token representing the page at which to start retrieving results. The token is usually retrieved from a previous list call.

  • :sort_order (String) —

    The sort order, either 'asc' or 'desc'. (default to ASC)

  • :sort_by (String) —

    The field to sort by. If no value is specified, timeCreated is the default. (default to timeCreated)

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
 
# File 'lib/oci/jms_java_downloads/java_download_client.rb', line 1072

def list_java_download_reports(compartment_id, opts = {})
  logger.debug 'Calling operation JavaDownloadClient#list_java_download_reports.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_java_download_reports." if compartment_id.nil?

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

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

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

  path = '/20230601/javaDownloadReports'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:javaDownloadReportId] = opts[:java_download_report_id] if opts[:java_download_report_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: 'JavaDownloadClient#list_java_download_reports') 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::JmsJavaDownloads::Models::JavaDownloadReportCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_java_download_tokens(compartment_id, opts = {}) ⇒ Response

Note:

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

Returns a list of JavaDownloadTokens.

Parameters:

  • compartment_id (String) —

    The OCID of the tenancy.

  • 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

  • :lifecycle_state (String) —

    A filter to return only resources their lifecycleState matches the given lifecycleState.

  • :display_name (String) —

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

  • :id (String) —

    Unique JavaDownloadToken identifier.

  • :value (String) —

    Unique JavaDownloadToken value.

  • :family_version (String) —

    Unique Java family version identifier.

  • :search_by_user (String) —

    A filter to return only resources that match the user principal detail. The search string can be any of the property values from the principal object. This object is used as response datatype for the createdBy and lastUpdatedBy fields in applicable resource.

  • :limit (Integer) —

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

  • :page (String) —

    The page token representing the page at which to start retrieving results. The token is usually retrieved from a previous list call.

  • :sort_order (String) —

    The sort order, either 'asc' or 'desc'. (default to ASC)

  • :sort_by (String) —

    The field to sort by. If no value is specified, timeCreated is the default. (default to timeCreated)

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
 
# File 'lib/oci/jms_java_downloads/java_download_client.rb', line 1161

def list_java_download_tokens(compartment_id, opts = {})
  logger.debug 'Calling operation JavaDownloadClient#list_java_download_tokens.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_java_download_tokens." if compartment_id.nil?

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

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

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

  path = '/20230601/javaDownloadTokens'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:id] = opts[:id] if opts[:id]
  query_params[:value] = opts[:value] if opts[:value]
  query_params[:familyVersion] = opts[:family_version] if opts[:family_version]
  query_params[:searchByUser] = opts[:search_by_user] if opts[:search_by_user]
  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: 'JavaDownloadClient#list_java_download_tokens') 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::JmsJavaDownloads::Models::JavaDownloadTokenCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_java_license_acceptance_records(compartment_id, opts = {}) ⇒ Response

Note:

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

Returns a list of all the Java license acceptance records in a tenancy.

Parameters:

  • compartment_id (String) —

    The OCID of the tenancy.

  • 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

  • :search_by_user (String) —

    A filter to return only resources that match the user principal detail. The search string can be any of the property values from the principal object. This object is used as response datatype for the createdBy and lastUpdatedBy fields in applicable resource.

  • :id (String) —

    Unique Java license acceptance record identifier.

  • :license_type (String) —

    Unique Java license type.

  • :status (String) —

    The status of license acceptance.

  • :limit (Integer) —

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

  • :page (String) —

    The page token representing the page at which to start retrieving results. The token is usually retrieved from a previous list call.

  • :sort_order (String) —

    The sort order, either 'asc' or 'desc'. (default to ASC)

  • :sort_by (String) —

    The field to sort by. If no value is specified, timeAccepted is the default. (default to timeAccepted)

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
 
# File 'lib/oci/jms_java_downloads/java_download_client.rb', line 1251

def list_java_license_acceptance_records(compartment_id, opts = {})
  logger.debug 'Calling operation JavaDownloadClient#list_java_license_acceptance_records.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_java_license_acceptance_records." if compartment_id.nil?

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

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

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

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

  path = '/20230601/javaLicenseAcceptanceRecords'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:searchByUser] = opts[:search_by_user] if opts[:search_by_user]
  query_params[:id] = opts[:id] if opts[:id]
  query_params[:licenseType] = opts[:license_type] if opts[:license_type]
  query_params[:status] = opts[:status] if opts[:status]
  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: 'JavaDownloadClient#list_java_license_acceptance_records') 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::JmsJavaDownloads::Models::JavaLicenseAcceptanceRecordCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_java_licenses(opts = {}) ⇒ Response

Note:

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

Return a list with details of all Java licenses.

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

  • :license_type (String) —

    Unique Java license type.

  • :display_name (String) —

    A filter to return only resources that match the display name.

  • :limit (Integer) —

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

  • :page (String) —

    The page token representing the page at which to start retrieving results. The token is usually retrieved from a previous list call.

  • :sort_order (String) —

    The sort order, either 'asc' or 'desc'. (default to ASC)

  • :sort_by (String) —

    The field to sort by. If no value is specified, licenseType is the default. (default to licenseType)

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
 
# File 'lib/oci/jms_java_downloads/java_download_client.rb', line 1336

def list_java_licenses(opts = {})
  logger.debug 'Calling operation JavaDownloadClient#list_java_licenses.' if logger


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

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

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

  path = '/20230601/javaLicenses'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:licenseType] = opts[:license_type] if opts[:license_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: 'JavaDownloadClient#list_java_licenses') 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::JmsJavaDownloads::Models::JavaLicenseCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_work_request_errors(work_request_id, opts = {}) ⇒ Response

Note:

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

Returns a (paginated) list of errors for the work request with the given ID.

Allowed values are: timestamp

Parameters:

  • work_request_id (String) —

    The ID of the asynchronous request.

  • 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.

  • :page (String) —

    The page token representing the page at which to start retrieving results. The token is usually retrieved from a previous list call.

  • :limit (Integer) —

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

  • :sort_by (String) —

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

  • :sort_order (String) —

    The sort order, either 'asc' or 'desc'. (default to ASC)

Returns:



1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
 
# File 'lib/oci/jms_java_downloads/java_download_client.rb', line 1413

def list_work_request_errors(work_request_id, opts = {})
  logger.debug 'Calling operation JavaDownloadClient#list_work_request_errors.' if logger

  raise "Missing the required parameter 'work_request_id' when calling list_work_request_errors." if work_request_id.nil?

  if opts[:sort_by] && !%w[timestamp].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of timestamp.'
  end

  if opts[:sort_order] && !OCI::JmsJavaDownloads::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::JmsJavaDownloads::Models::SORT_ORDER_ENUM.'
  end
  raise "Parameter value for 'work_request_id' must not be blank" if OCI::Internal::Util.blank_string?(work_request_id)

  path = '/20230601/workRequests/{workRequestId}/errors'.sub('{workRequestId}', work_request_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  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: 'JavaDownloadClient#list_work_request_errors') 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::JmsJavaDownloads::Models::WorkRequestErrorCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_work_request_logs(work_request_id, opts = {}) ⇒ Response

Note:

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

Returns a (paginated) list of logs for the work request with the given ID.

Allowed values are: timestamp

Parameters:

  • work_request_id (String) —

    The ID of the asynchronous request.

  • 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.

  • :page (String) —

    The page token representing the page at which to start retrieving results. The token is usually retrieved from a previous list call.

  • :limit (Integer) —

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

  • :sort_by (String) —

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

  • :sort_order (String) —

    The sort order, either 'asc' or 'desc'. (default to ASC)

Returns:



1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
 
# File 'lib/oci/jms_java_downloads/java_download_client.rb', line 1486

def list_work_request_logs(work_request_id, opts = {})
  logger.debug 'Calling operation JavaDownloadClient#list_work_request_logs.' if logger

  raise "Missing the required parameter 'work_request_id' when calling list_work_request_logs." if work_request_id.nil?

  if opts[:sort_by] && !%w[timestamp].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of timestamp.'
  end

  if opts[:sort_order] && !OCI::JmsJavaDownloads::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::JmsJavaDownloads::Models::SORT_ORDER_ENUM.'
  end
  raise "Parameter value for 'work_request_id' must not be blank" if OCI::Internal::Util.blank_string?(work_request_id)

  path = '/20230601/workRequests/{workRequestId}/logs'.sub('{workRequestId}', work_request_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  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: 'JavaDownloadClient#list_work_request_logs') 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::JmsJavaDownloads::Models::WorkRequestLogEntryCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_work_requests(compartment_id, opts = {}) ⇒ Response

Note:

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

Lists the work requests in a tenancy.

Allowed values are: timeAccepted

Parameters:

  • compartment_id (String) —

    The OCID of the tenancy.

  • 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

  • :id (String) —

    The ID of an asynchronous work request.

  • :status (String) —

    A filter to return only resources their lifecycleState matches the given OperationStatus.

  • :resource_id (String) —

    The ID of the resource affected by the work request.

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :page (String) —

    The page token representing the page at which to start retrieving results. The token is usually retrieved from a previous list call.

  • :limit (Integer) —

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

  • :sort_order (String) —

    The sort order, either 'asc' or 'desc'. (default to ASC)

  • :sort_by (String) —

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

Returns:



1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
 
# File 'lib/oci/jms_java_downloads/java_download_client.rb', line 1563

def list_work_requests(compartment_id, opts = {})
  logger.debug 'Calling operation JavaDownloadClient#list_work_requests.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_work_requests." if compartment_id.nil?

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

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

  if opts[:sort_by] && !%w[timeAccepted].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of timeAccepted.'
  end

  path = '/20230601/workRequests'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:id] = opts[:id] if opts[:id]
  query_params[:status] = opts[:status] if opts[:status]
  query_params[:resourceId] = opts[:resource_id] if opts[:resource_id]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:limit] = opts[:limit] if opts[:limit]
  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: 'JavaDownloadClient#list_work_requests') 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::JmsJavaDownloads::Models::WorkRequestSummaryCollection'
    )
  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/jms_java_downloads/java_download_client.rb', line 94

def logger
  @api_client.config.logger
end

#request_summarized_java_download_counts(request_summarized_java_download_counts_details, opts = {}) ⇒ Response

Note:

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

Returns list of download counts grouped by the specified property.

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:



1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
 
# File 'lib/oci/jms_java_downloads/java_download_client.rb', line 1637

def request_summarized_java_download_counts(request_summarized_java_download_counts_details, opts = {})
  logger.debug 'Calling operation JavaDownloadClient#request_summarized_java_download_counts.' if logger

  raise "Missing the required parameter 'request_summarized_java_download_counts_details' when calling request_summarized_java_download_counts." if request_summarized_java_download_counts_details.nil?

  path = '/20230601/actions/requestSummarizedJavaDownloadCounts'
  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 = @api_client.object_to_http_body(request_summarized_java_download_counts_details)

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

#update_java_download_token(java_download_token_id, update_java_download_token_details, opts = {}) ⇒ Response

Note:

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

Updates the JavaDownloadToken specified by the identifier.

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



1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
 
# File 'lib/oci/jms_java_downloads/java_download_client.rb', line 1697

def update_java_download_token(java_download_token_id, update_java_download_token_details, opts = {})
  logger.debug 'Calling operation JavaDownloadClient#update_java_download_token.' if logger

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

  path = '/20230601/javaDownloadTokens/{javaDownloadTokenId}'.sub('{javaDownloadTokenId}', java_download_token_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_java_download_token_details)

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

#update_java_license_acceptance_record(java_license_acceptance_record_id, update_java_license_acceptance_record_details, opts = {}) ⇒ Response

Note:

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

Updates a specific Java license acceptance record in a tenancy.

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:



1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
 
# File 'lib/oci/jms_java_downloads/java_download_client.rb', line 1760

def update_java_license_acceptance_record(java_license_acceptance_record_id, update_java_license_acceptance_record_details, opts = {})
  logger.debug 'Calling operation JavaDownloadClient#update_java_license_acceptance_record.' if logger

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

  path = '/20230601/javaLicenseAcceptanceRecords/{javaLicenseAcceptanceRecordId}'.sub('{javaLicenseAcceptanceRecordId}', java_license_acceptance_record_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_java_license_acceptance_record_details)

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