Class: OCI::MediaServices::MediaServicesClient

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/media_services/media_services_client.rb

Overview

Media Services (includes Media Flow and Media Streams) is a fully managed service for processing media (video) source content. Use Media Flow and Media Streams to transcode and package digital video using configurable workflows and stream video outputs.

Use the Media Services API to configure media workflows and run Media Flow jobs, create distribution channels, ingest assets, create Preview URLs and play assets. For more information, see Media Flow and Media Streams.

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

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



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/oci/media_services/media_services_client.rb', line 57

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

Instance Attribute Details

#api_client ⇒ OCI::ApiClient (readonly)

Client used to make HTTP requests.

Returns:



17
18
19
 
# File 'lib/oci/media_services/media_services_client.rb', line 17

def api_client
  @api_client
end

#endpoint ⇒ String (readonly)

Fully qualified endpoint URL

Returns:

  • (String) 


21
22
23
 
# File 'lib/oci/media_services/media_services_client.rb', line 21

def endpoint
  @endpoint
end

#region ⇒ String

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

Returns:

  • (String) 


31
32
33
 
# File 'lib/oci/media_services/media_services_client.rb', line 31

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:



27
28
29
 
# File 'lib/oci/media_services/media_services_client.rb', line 27

def retry_config
  @retry_config
end

Instance Method Details

#change_media_asset_compartment(media_asset_id, change_media_asset_compartment_details, opts = {}) ⇒ Response

Note:

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

Moves a MediaAsset resource from one compartment identifier to another.

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 the risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type nil



126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'lib/oci/media_services/media_services_client.rb', line 126

def change_media_asset_compartment(media_asset_id, change_media_asset_compartment_details, opts = {})
  logger.debug 'Calling operation MediaServicesClient#change_media_asset_compartment.' if logger

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

  path = '/mediaAssets/{mediaAssetId}/actions/changeCompartment'.sub('{mediaAssetId}', media_asset_id.to_s)
  operation_signing_strategy = :standard

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

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(change_media_asset_compartment_details)

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

#change_media_workflow_compartment(media_workflow_id, change_media_workflow_compartment_details, opts = {}) ⇒ Response

Note:

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

Moves a MediaWorkflow resource from one compartment identifier to another.

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 the risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type nil



196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
 
# File 'lib/oci/media_services/media_services_client.rb', line 196

def change_media_workflow_compartment(media_workflow_id, change_media_workflow_compartment_details, opts = {})
  logger.debug 'Calling operation MediaServicesClient#change_media_workflow_compartment.' if logger

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

  path = '/mediaWorkflows/{mediaWorkflowId}/actions/changeCompartment'.sub('{mediaWorkflowId}', media_workflow_id.to_s)
  operation_signing_strategy = :standard

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

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(change_media_workflow_compartment_details)

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

#change_media_workflow_configuration_compartment(media_workflow_configuration_id, change_media_workflow_configuration_compartment_details, opts = {}) ⇒ Response

Note:

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

Moves a MediaWorkflowConfiguration resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource.

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 the risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type nil



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
302
303
304
305
 
# File 'lib/oci/media_services/media_services_client.rb', line 266

def change_media_workflow_configuration_compartment(media_workflow_configuration_id, change_media_workflow_configuration_compartment_details, opts = {})
  logger.debug 'Calling operation MediaServicesClient#change_media_workflow_configuration_compartment.' if logger

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

  path = '/mediaWorkflowConfigurations/{mediaWorkflowConfigurationId}/actions/changeCompartment'.sub('{mediaWorkflowConfigurationId}', media_workflow_configuration_id.to_s)
  operation_signing_strategy = :standard

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

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(change_media_workflow_configuration_compartment_details)

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

#change_media_workflow_job_compartment(media_workflow_job_id, change_media_workflow_job_compartment_details, opts = {}) ⇒ Response

Note:

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

Moves a MediaWorkflowJob resource from one compartment identifier to another.

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 the risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type nil



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
375
 
# File 'lib/oci/media_services/media_services_client.rb', line 336

def change_media_workflow_job_compartment(media_workflow_job_id, change_media_workflow_job_compartment_details, opts = {})
  logger.debug 'Calling operation MediaServicesClient#change_media_workflow_job_compartment.' if logger

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

  path = '/mediaWorkflowJobs/{mediaWorkflowJobId}/actions/changeCompartment'.sub('{mediaWorkflowJobId}', media_workflow_job_id.to_s)
  operation_signing_strategy = :standard

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

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(change_media_workflow_job_compartment_details)

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

#change_stream_distribution_channel_compartment(stream_distribution_channel_id, change_stream_distribution_channel_compartment_details, opts = {}) ⇒ Response

Note:

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

Moves a Stream Distribution Channel resource from one compartment identifier to another.

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 the risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type nil



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
 
# File 'lib/oci/media_services/media_services_client.rb', line 406

def change_stream_distribution_channel_compartment(stream_distribution_channel_id, change_stream_distribution_channel_compartment_details, opts = {})
  logger.debug 'Calling operation MediaServicesClient#change_stream_distribution_channel_compartment.' if logger

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

  path = '/streamDistributionChannels/{streamDistributionChannelId}/actions/changeCompartment'.sub('{streamDistributionChannelId}', stream_distribution_channel_id.to_s)
  operation_signing_strategy = :standard

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

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(change_stream_distribution_channel_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'MediaServicesClient#change_stream_distribution_channel_compartment') 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_media_asset(create_media_asset_details, opts = {}) ⇒ Response

Note:

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

Creates a new MediaAsset.

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



470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
 
# File 'lib/oci/media_services/media_services_client.rb', line 470

def create_media_asset(create_media_asset_details, opts = {})
  logger.debug 'Calling operation MediaServicesClient#create_media_asset.' if logger

  raise "Missing the required parameter 'create_media_asset_details' when calling create_media_asset." if create_media_asset_details.nil?

  path = '/mediaAssets'
  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_media_asset_details)

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

#create_media_workflow(create_media_workflow_details, opts = {}) ⇒ Response

Note:

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

Creates a new MediaWorkflow.

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



532
533
534
535
536
537
538
539
540
541
542
543
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
 
# File 'lib/oci/media_services/media_services_client.rb', line 532

def create_media_workflow(create_media_workflow_details, opts = {})
  logger.debug 'Calling operation MediaServicesClient#create_media_workflow.' if logger

  raise "Missing the required parameter 'create_media_workflow_details' when calling create_media_workflow." if create_media_workflow_details.nil?

  path = '/mediaWorkflows'
  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_media_workflow_details)

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

#create_media_workflow_configuration(create_media_workflow_configuration_details, opts = {}) ⇒ Response

Note:

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

Creates a new MediaWorkflowConfiguration.

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



594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
 
# File 'lib/oci/media_services/media_services_client.rb', line 594

def create_media_workflow_configuration(create_media_workflow_configuration_details, opts = {})
  logger.debug 'Calling operation MediaServicesClient#create_media_workflow_configuration.' if logger

  raise "Missing the required parameter 'create_media_workflow_configuration_details' when calling create_media_workflow_configuration." if create_media_workflow_configuration_details.nil?

  path = '/mediaWorkflowConfigurations'
  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_media_workflow_configuration_details)

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

#create_media_workflow_job(create_media_workflow_job_details, opts = {}) ⇒ Response

Note:

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

Run the MediaWorkflow according to the given mediaWorkflow definition and configuration.

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.

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

Returns:



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
 
# File 'lib/oci/media_services/media_services_client.rb', line 655

def create_media_workflow_job(create_media_workflow_job_details, opts = {})
  logger.debug 'Calling operation MediaServicesClient#create_media_workflow_job.' if logger

  raise "Missing the required parameter 'create_media_workflow_job_details' when calling create_media_workflow_job." if create_media_workflow_job_details.nil?

  path = '/mediaWorkflowJobs'
  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]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(create_media_workflow_job_details)

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

#create_stream_cdn_config(create_stream_cdn_config_details, opts = {}) ⇒ Response

Note:

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

Creates a new CDN Configuration.

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



717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
 
# File 'lib/oci/media_services/media_services_client.rb', line 717

def create_stream_cdn_config(create_stream_cdn_config_details, opts = {})
  logger.debug 'Calling operation MediaServicesClient#create_stream_cdn_config.' if logger

  raise "Missing the required parameter 'create_stream_cdn_config_details' when calling create_stream_cdn_config." if create_stream_cdn_config_details.nil?

  path = '/streamCdnConfigs'
  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_stream_cdn_config_details)

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

#create_stream_distribution_channel(create_stream_distribution_channel_details, opts = {}) ⇒ Response

Note:

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

Creates a new Stream Distribution Channel.

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



779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
 
# File 'lib/oci/media_services/media_services_client.rb', line 779

def create_stream_distribution_channel(create_stream_distribution_channel_details, opts = {})
  logger.debug 'Calling operation MediaServicesClient#create_stream_distribution_channel.' if logger

  raise "Missing the required parameter 'create_stream_distribution_channel_details' when calling create_stream_distribution_channel." if create_stream_distribution_channel_details.nil?

  path = '/streamDistributionChannels'
  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_stream_distribution_channel_details)

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

#create_stream_packaging_config(create_stream_packaging_config_details, opts = {}) ⇒ Response

Note:

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

Creates a new Packaging Configuration.

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



841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
 
# File 'lib/oci/media_services/media_services_client.rb', line 841

def create_stream_packaging_config(create_stream_packaging_config_details, opts = {})
  logger.debug 'Calling operation MediaServicesClient#create_stream_packaging_config.' if logger

  raise "Missing the required parameter 'create_stream_packaging_config_details' when calling create_stream_packaging_config." if create_stream_packaging_config_details.nil?

  path = '/streamPackagingConfigs'
  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_stream_packaging_config_details)

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

#delete_media_asset(media_asset_id, opts = {}) ⇒ Response

Note:

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

Deletes a MediaAsset resource by identifier. If DeleteChildren is passed in as the mode, all the assets with the parentMediaAssetId matching the ID will be deleted. If DeleteDerivatives is set as the mode, all the assets with the masterMediaAssetId matching the ID will be deleted.

Parameters:

  • media_asset_id (String) —

    Unique MediaAsset 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.

  • :delete_mode (String) —

    DeleteMode decides whether to delete all the immediate children or all assets with the asset's ID as their masterMediaAssetId.

Returns:

  • (Response) —

    A Response object with data of type nil



903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
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
 
# File 'lib/oci/media_services/media_services_client.rb', line 903

def delete_media_asset(media_asset_id, opts = {})
  logger.debug 'Calling operation MediaServicesClient#delete_media_asset.' if logger

  raise "Missing the required parameter 'media_asset_id' when calling delete_media_asset." if media_asset_id.nil?

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

  path = '/mediaAssets/{mediaAssetId}'.sub('{mediaAssetId}', media_asset_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:deleteMode] = opts[:delete_mode] if opts[:delete_mode]

  # 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: 'MediaServicesClient#delete_media_asset') 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_media_asset_distribution_channel_attachment(media_asset_id, distribution_channel_id, opts = {}) ⇒ Response

Note:

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

Deletes a MediaAsset from the DistributionChannel by identifiers.

Parameters:

  • media_asset_id (String) —

    Unique MediaAsset identifier

  • distribution_channel_id (String) —

    Unique DistributionChannel 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.

  • :version (Integer) —

    Version of the attachment.

Returns:

  • (Response) —

    A Response object with data of type nil



970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
 
# File 'lib/oci/media_services/media_services_client.rb', line 970

def delete_media_asset_distribution_channel_attachment(media_asset_id, distribution_channel_id, opts = {})
  logger.debug 'Calling operation MediaServicesClient#delete_media_asset_distribution_channel_attachment.' if logger

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

  path = '/mediaAssets/{mediaAssetId}/distributionChannelAttachments/{distributionChannelId}'.sub('{mediaAssetId}', media_asset_id.to_s).sub('{distributionChannelId}', distribution_channel_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:version] = opts[:version] if opts[:version]

  # 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: 'MediaServicesClient#delete_media_asset_distribution_channel_attachment') 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_media_workflow(media_workflow_id, opts = {}) ⇒ Response

Note:

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

The MediaWorkflow lifecycleState will change to DELETED.

Parameters:

  • media_workflow_id (String) —

    Unique MediaWorkflow 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.

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

Returns:

  • (Response) —

    A Response object with data of type nil



1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
 
# File 'lib/oci/media_services/media_services_client.rb', line 1033

def delete_media_workflow(media_workflow_id, opts = {})
  logger.debug 'Calling operation MediaServicesClient#delete_media_workflow.' if logger

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

  path = '/mediaWorkflows/{mediaWorkflowId}'.sub('{mediaWorkflowId}', media_workflow_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]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'MediaServicesClient#delete_media_workflow') 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_media_workflow_configuration(media_workflow_configuration_id, opts = {}) ⇒ Response

Note:

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

Deletes a MediaWorkflowConfiguration resource by identifier.

Parameters:

  • media_workflow_configuration_id (String) —

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



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
1128
1129
 
# File 'lib/oci/media_services/media_services_client.rb', line 1093

def delete_media_workflow_configuration(media_workflow_configuration_id, opts = {})
  logger.debug 'Calling operation MediaServicesClient#delete_media_workflow_configuration.' if logger

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

  path = '/mediaWorkflowConfigurations/{mediaWorkflowConfigurationId}'.sub('{mediaWorkflowConfigurationId}', media_workflow_configuration_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: 'MediaServicesClient#delete_media_workflow_configuration') 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_media_workflow_job(media_workflow_job_id, opts = {}) ⇒ Response

Note:

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

This is an asynchronous operation. The MediaWorkflowJob lifecycleState will change to CANCELING temporarily until the job is completely CANCELED.

Parameters:

  • media_workflow_job_id (String) —

    Unique MediaWorkflowJob 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.

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

Returns:

  • (Response) —

    A Response object with data of type nil



1153
1154
1155
1156
1157
1158
1159
1160
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
 
# File 'lib/oci/media_services/media_services_client.rb', line 1153

def delete_media_workflow_job(media_workflow_job_id, opts = {})
  logger.debug 'Calling operation MediaServicesClient#delete_media_workflow_job.' if logger

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

  path = '/mediaWorkflowJobs/{mediaWorkflowJobId}'.sub('{mediaWorkflowJobId}', media_workflow_job_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]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'MediaServicesClient#delete_media_workflow_job') 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_stream_cdn_config(stream_cdn_config_id, opts = {}) ⇒ Response

Note:

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

The StreamCdnConfig lifecycleState will change to DELETED.

Parameters:

  • stream_cdn_config_id (String) —

    Unique StreamCdnConfig 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.

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

Returns:

  • (Response) —

    A Response object with data of type nil



1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
 
# File 'lib/oci/media_services/media_services_client.rb', line 1213

def delete_stream_cdn_config(stream_cdn_config_id, opts = {})
  logger.debug 'Calling operation MediaServicesClient#delete_stream_cdn_config.' if logger

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

  path = '/streamCdnConfigs/{streamCdnConfigId}'.sub('{streamCdnConfigId}', stream_cdn_config_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]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'MediaServicesClient#delete_stream_cdn_config') 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_stream_distribution_channel(stream_distribution_channel_id, opts = {}) ⇒ Response

Note:

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

The Stream Distribution Channel lifecycleState will change to DELETED.

Parameters:

  • stream_distribution_channel_id (String) —

    Unique Stream Distribution Channel path 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.

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

Returns:

  • (Response) —

    A Response object with data of type nil



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
 
# File 'lib/oci/media_services/media_services_client.rb', line 1273

def delete_stream_distribution_channel(stream_distribution_channel_id, opts = {})
  logger.debug 'Calling operation MediaServicesClient#delete_stream_distribution_channel.' if logger

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

  path = '/streamDistributionChannels/{streamDistributionChannelId}'.sub('{streamDistributionChannelId}', stream_distribution_channel_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]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'MediaServicesClient#delete_stream_distribution_channel') 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_stream_packaging_config(stream_packaging_config_id, opts = {}) ⇒ Response

Note:

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

The Stream Packaging Configuration lifecycleState will change to DELETED.

Parameters:

  • stream_packaging_config_id (String) —

    Unique Stream Packaging Configuration path 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.

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

Returns:

  • (Response) —

    A Response object with data of type nil



1333
1334
1335
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
 
# File 'lib/oci/media_services/media_services_client.rb', line 1333

def delete_stream_packaging_config(stream_packaging_config_id, opts = {})
  logger.debug 'Calling operation MediaServicesClient#delete_stream_packaging_config.' if logger

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

  path = '/streamPackagingConfigs/{streamPackagingConfigId}'.sub('{streamPackagingConfigId}', stream_packaging_config_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]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'MediaServicesClient#delete_stream_packaging_config') do
    @api_client.call_api(
      :DELETE,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_media_asset(media_asset_id, opts = {}) ⇒ Response

Note:

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

Gets a MediaAsset by identifier.

Parameters:

  • media_asset_id (String) —

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



1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
 
# File 'lib/oci/media_services/media_services_client.rb', line 1387

def get_media_asset(media_asset_id, opts = {})
  logger.debug 'Calling operation MediaServicesClient#get_media_asset.' if logger

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

  path = '/mediaAssets/{mediaAssetId}'.sub('{mediaAssetId}', media_asset_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: 'MediaServicesClient#get_media_asset') 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::MediaServices::Models::MediaAsset'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_media_asset_distribution_channel_attachment(media_asset_id, distribution_channel_id, opts = {}) ⇒ Response

Note:

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

Gets a MediaAssetDistributionChannelAttachment for a MediaAsset by identifiers.

Parameters:

  • media_asset_id (String) —

    Unique MediaAsset identifier

  • distribution_channel_id (String) —

    Unique DistributionChannel 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.

  • :version (Integer) —

    Version of the attachment.

Returns:



1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
 
# File 'lib/oci/media_services/media_services_client.rb', line 1443

def get_media_asset_distribution_channel_attachment(media_asset_id, distribution_channel_id, opts = {})
  logger.debug 'Calling operation MediaServicesClient#get_media_asset_distribution_channel_attachment.' if logger

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

  path = '/mediaAssets/{mediaAssetId}/distributionChannelAttachments/{distributionChannelId}'.sub('{mediaAssetId}', media_asset_id.to_s).sub('{distributionChannelId}', distribution_channel_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:version] = opts[:version] if opts[:version]

  # 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: 'MediaServicesClient#get_media_asset_distribution_channel_attachment') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::MediaServices::Models::MediaAssetDistributionChannelAttachment'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_media_workflow(media_workflow_id, opts = {}) ⇒ Response

Note:

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

Gets a MediaWorkflow by identifier.

Parameters:

  • media_workflow_id (String) —

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



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
1535
1536
 
# File 'lib/oci/media_services/media_services_client.rb', line 1500

def get_media_workflow(media_workflow_id, opts = {})
  logger.debug 'Calling operation MediaServicesClient#get_media_workflow.' if logger

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

  path = '/mediaWorkflows/{mediaWorkflowId}'.sub('{mediaWorkflowId}', media_workflow_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: 'MediaServicesClient#get_media_workflow') 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::MediaServices::Models::MediaWorkflow'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_media_workflow_configuration(media_workflow_configuration_id, opts = {}) ⇒ Response

Note:

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

Gets a MediaWorkflowConfiguration by identifier

Parameters:

  • media_workflow_configuration_id (String) —

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



1554
1555
1556
1557
1558
1559
1560
1561
1562
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
 
# File 'lib/oci/media_services/media_services_client.rb', line 1554

def get_media_workflow_configuration(media_workflow_configuration_id, opts = {})
  logger.debug 'Calling operation MediaServicesClient#get_media_workflow_configuration.' if logger

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

  path = '/mediaWorkflowConfigurations/{mediaWorkflowConfigurationId}'.sub('{mediaWorkflowConfigurationId}', media_workflow_configuration_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: 'MediaServicesClient#get_media_workflow_configuration') 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::MediaServices::Models::MediaWorkflowConfiguration'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_media_workflow_job(media_workflow_job_id, opts = {}) ⇒ Response

Note:

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

Gets the MediaWorkflowJob.

Parameters:

  • media_workflow_job_id (String) —

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



1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
 
# File 'lib/oci/media_services/media_services_client.rb', line 1608

def get_media_workflow_job(media_workflow_job_id, opts = {})
  logger.debug 'Calling operation MediaServicesClient#get_media_workflow_job.' if logger

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

  path = '/mediaWorkflowJobs/{mediaWorkflowJobId}'.sub('{mediaWorkflowJobId}', media_workflow_job_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: 'MediaServicesClient#get_media_workflow_job') 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::MediaServices::Models::MediaWorkflowJob'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_media_workflow_job_fact(media_workflow_job_id, key, opts = {}) ⇒ Response

Note:

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

Get the MediaWorkflowJobFact identified by the mediaWorkflowJobId and Fact ID.

Parameters:

  • media_workflow_job_id (String) —

    Unique MediaWorkflowJob identifier.

  • key (Integer) —

    Identifier of the MediaWorkflowJobFact within a MediaWorkflowJob.

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



1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
 
# File 'lib/oci/media_services/media_services_client.rb', line 1663

def get_media_workflow_job_fact(media_workflow_job_id, key, opts = {})
  logger.debug 'Calling operation MediaServicesClient#get_media_workflow_job_fact.' if logger

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

  path = '/mediaWorkflowJobs/{mediaWorkflowJobId}/facts/{key}'.sub('{mediaWorkflowJobId}', media_workflow_job_id.to_s).sub('{key}', key.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: 'MediaServicesClient#get_media_workflow_job_fact') 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::MediaServices::Models::MediaWorkflowJobFact'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_stream_cdn_config(stream_cdn_config_id, opts = {}) ⇒ Response

Note:

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

Gets a StreamCdnConfig by identifier.

Parameters:

  • stream_cdn_config_id (String) —

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



1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
 
# File 'lib/oci/media_services/media_services_client.rb', line 1719

def get_stream_cdn_config(stream_cdn_config_id, opts = {})
  logger.debug 'Calling operation MediaServicesClient#get_stream_cdn_config.' if logger

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

  path = '/streamCdnConfigs/{streamCdnConfigId}'.sub('{streamCdnConfigId}', stream_cdn_config_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: 'MediaServicesClient#get_stream_cdn_config') 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::MediaServices::Models::StreamCdnConfig'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_stream_distribution_channel(stream_distribution_channel_id, opts = {}) ⇒ Response

Note:

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

Gets a Stream Distribution Channel by identifier.

Parameters:

  • stream_distribution_channel_id (String) —

    Unique Stream Distribution Channel path 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:



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
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
 
# File 'lib/oci/media_services/media_services_client.rb', line 1773

def get_stream_distribution_channel(stream_distribution_channel_id, opts = {})
  logger.debug 'Calling operation MediaServicesClient#get_stream_distribution_channel.' if logger

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

  path = '/streamDistributionChannels/{streamDistributionChannelId}'.sub('{streamDistributionChannelId}', stream_distribution_channel_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: 'MediaServicesClient#get_stream_distribution_channel') 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::MediaServices::Models::StreamDistributionChannel'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_stream_packaging_config(stream_packaging_config_id, opts = {}) ⇒ Response

Note:

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

Gets a Stream Packaging Configuration by identifier.

Parameters:

  • stream_packaging_config_id (String) —

    Unique Stream Packaging Configuration path 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:



1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
 
# File 'lib/oci/media_services/media_services_client.rb', line 1827

def get_stream_packaging_config(stream_packaging_config_id, opts = {})
  logger.debug 'Calling operation MediaServicesClient#get_stream_packaging_config.' if logger

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

  path = '/streamPackagingConfigs/{streamPackagingConfigId}'.sub('{streamPackagingConfigId}', stream_packaging_config_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: 'MediaServicesClient#get_stream_packaging_config') 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::MediaServices::Models::StreamPackagingConfig'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#ingest_stream_distribution_channel(stream_distribution_channel_id, ingest_stream_distribution_channel_details, opts = {}) ⇒ Response

Note:

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

Ingests an Asset into a Distribution Channel.

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



1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
 
# File 'lib/oci/media_services/media_services_client.rb', line 1888

def ingest_stream_distribution_channel(stream_distribution_channel_id, ingest_stream_distribution_channel_details, opts = {})
  logger.debug 'Calling operation MediaServicesClient#ingest_stream_distribution_channel.' if logger

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

  path = '/streamDistributionChannels/{streamDistributionChannelId}/actions/ingest'.sub('{streamDistributionChannelId}', stream_distribution_channel_id.to_s)
  operation_signing_strategy = :standard

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

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'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(ingest_stream_distribution_channel_details)

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

#list_media_asset_distribution_channel_attachments(media_asset_id, opts = {}) ⇒ Response

Note:

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

Lists the MediaAssetDistributionChannelAttachments for a MediaAsset by identifier.

Parameters:

  • media_asset_id (String) —

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

  • :display_name (String) —

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

  • :limit (Integer) —

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

  • :page (String) —

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

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :sort_order (String) —

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

  • :sort_by (String) —

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

  • :distribution_channel_id (String) —

    Unique DistributionChannel identifier.

Returns:



1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
 
# File 'lib/oci/media_services/media_services_client.rb', line 1954

def list_media_asset_distribution_channel_attachments(media_asset_id, opts = {})
  logger.debug 'Calling operation MediaServicesClient#list_media_asset_distribution_channel_attachments.' if logger

  raise "Missing the required parameter 'media_asset_id' when calling list_media_asset_distribution_channel_attachments." if media_asset_id.nil?

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

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

  path = '/mediaAssets/{mediaAssetId}/distributionChannelAttachments'.sub('{mediaAssetId}', media_asset_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  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]
  query_params[:distributionChannelId] = opts[:distribution_channel_id] if opts[:distribution_channel_id]

  # 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: 'MediaServicesClient#list_media_asset_distribution_channel_attachments') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::MediaServices::Models::MediaAssetDistributionChannelAttachmentCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_media_assets(opts = {}) ⇒ Response

Note:

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

Returns a list of MediaAssetSummary.

Parameters:

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

    the optional parameters

Options Hash (opts):

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

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :compartment_id (String) —

    The ID of the compartment in which to list resources.

  • :display_name (String) —

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

  • :limit (Integer) —

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

  • :page (String) —

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

  • :lifecycle_state (String) —

    A filter to return only the resources with lifecycleState matching the given lifecycleState.

  • :sort_order (String) —

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

  • :sort_by (String) —

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

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :distribution_channel_id (String) —

    Unique DistributionChannel identifier.

  • :parent_media_asset_id (String) —

    Unique MediaAsset identifier of the asset from which this asset is derived.

  • :master_media_asset_id (String) —

    Unique MediaAsset identifier of the first asset upload.

  • :type (String) —

    Filter MediaAsset by the asset type.

  • :bucket_name (String) —

    Filter MediaAsset by the bucket where the object is stored.

  • :object_name (String) —

    Filter MediaAsset by the name of the object in object storage.

  • :media_workflow_job_id (String) —

    The ID of the MediaWorkflowJob used to produce this asset, if this parameter is supplied then the workflow ID must also be supplied.

  • :source_media_workflow_id (String) —

    The ID of the MediaWorkflow used to produce this asset.

  • :source_media_workflow_version (Integer) —

    The version of the MediaWorkflow used to produce this asset.

Returns:



2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
 
# File 'lib/oci/media_services/media_services_client.rb', line 2041

def list_media_assets(opts = {})
  logger.debug 'Calling operation MediaServicesClient#list_media_assets.' if logger


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

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

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

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

  path = '/mediaAssets'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id]
  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[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:distributionChannelId] = opts[:distribution_channel_id] if opts[:distribution_channel_id]
  query_params[:parentMediaAssetId] = opts[:parent_media_asset_id] if opts[:parent_media_asset_id]
  query_params[:masterMediaAssetId] = opts[:master_media_asset_id] if opts[:master_media_asset_id]
  query_params[:type] = opts[:type] if opts[:type]
  query_params[:bucketName] = opts[:bucket_name] if opts[:bucket_name]
  query_params[:objectName] = opts[:object_name] if opts[:object_name]
  query_params[:mediaWorkflowJobId] = opts[:media_workflow_job_id] if opts[:media_workflow_job_id]
  query_params[:sourceMediaWorkflowId] = opts[:source_media_workflow_id] if opts[:source_media_workflow_id]
  query_params[:sourceMediaWorkflowVersion] = opts[:source_media_workflow_version] if opts[:source_media_workflow_version]

  # 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: 'MediaServicesClient#list_media_assets') 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::MediaServices::Models::MediaAssetCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_media_workflow_configurations(opts = {}) ⇒ Response

Note:

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

Returns a list of MediaWorkflowConfigurations.

Parameters:

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

    the optional parameters

Options Hash (opts):

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

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :compartment_id (String) —

    The ID of the compartment in which to list resources.

  • :lifecycle_state (String) —

    A filter to return only the resources with lifecycleState matching the given lifecycleState.

  • :display_name (String) —

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

  • :id (String) —

    Unique MediaWorkflowConfiguration identifier.

  • :limit (Integer) —

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

  • :page (String) —

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

  • :sort_order (String) —

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

  • :sort_by (String) —

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

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
 
# File 'lib/oci/media_services/media_services_client.rb', line 2137

def list_media_workflow_configurations(opts = {})
  logger.debug 'Calling operation MediaServicesClient#list_media_workflow_configurations.' if logger


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

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

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

  path = '/mediaWorkflowConfigurations'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = opts[:compartment_id] if opts[: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[: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: 'MediaServicesClient#list_media_workflow_configurations') 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::MediaServices::Models::MediaWorkflowConfigurationCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_media_workflow_job_facts(media_workflow_job_id, opts = {}) ⇒ Response

Note:

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

Internal API to get a point-in-time snapshot of a MediaWorkflowJob.

Parameters:

  • media_workflow_job_id (String) —

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

  • :key (Integer) —

    Filter by MediaWorkflowJob ID and MediaWorkflowJobFact key. (default to 0)

  • :type (String) —

    Types of details to include. Allowed values are: runnableJob, taskDeclaration, workflow, configuration, parameterResolutionEvent

  • :sort_by (String) —

    Types of details to include. (default to key)

  • :sort_order (String) —

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

  • :page (String) —

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

  • :limit (Integer) —

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

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
 
# File 'lib/oci/media_services/media_services_client.rb', line 2219

def list_media_workflow_job_facts(media_workflow_job_id, opts = {})
  logger.debug 'Calling operation MediaServicesClient#list_media_workflow_job_facts.' if logger

  raise "Missing the required parameter 'media_workflow_job_id' when calling list_media_workflow_job_facts." if media_workflow_job_id.nil?

  if opts[:type] && !%w[runnableJob taskDeclaration workflow configuration parameterResolutionEvent].include?(opts[:type])
    raise 'Invalid value for "type", must be one of runnableJob, taskDeclaration, workflow, configuration, parameterResolutionEvent.'
  end

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

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

  path = '/mediaWorkflowJobs/{mediaWorkflowJobId}/facts'.sub('{mediaWorkflowJobId}', media_workflow_job_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:key] = opts[:key] if opts[:key]
  query_params[:type] = opts[:type] if opts[:type]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:limit] = opts[:limit] if opts[:limit]

  # 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: 'MediaServicesClient#list_media_workflow_job_facts') 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::MediaServices::Models::MediaWorkflowJobFactCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_media_workflow_jobs(opts = {}) ⇒ Response

Note:

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

Lists the MediaWorkflowJobs.

Parameters:

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

    the optional parameters

Options Hash (opts):

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

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :compartment_id (String) —

    The ID of the compartment in which to list resources.

  • :id (String) —

    unique MediaWorkflowJob identifier

  • :media_workflow_id (String) —

    Unique MediaWorkflow identifier.

  • :display_name (String) —

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

  • :lifecycle_state (String) —

    A filter to return only the resources with lifecycleState matching the given lifecycleState.

  • :page (String) —

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

  • :limit (Integer) —

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

  • :sort_by (String) —

    The parameter sort by. (default to timeCreated)

  • :sort_order (String) —

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

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
 
# File 'lib/oci/media_services/media_services_client.rb', line 2301

def list_media_workflow_jobs(opts = {})
  logger.debug 'Calling operation MediaServicesClient#list_media_workflow_jobs.' if logger


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

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

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

  path = '/mediaWorkflowJobs'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id]
  query_params[:id] = opts[:id] if opts[:id]
  query_params[:mediaWorkflowId] = opts[:media_workflow_id] if opts[:media_workflow_id]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  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: 'MediaServicesClient#list_media_workflow_jobs') 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::MediaServices::Models::MediaWorkflowJobCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_media_workflow_task_declarations(opts = {}) ⇒ Response

Note:

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

Returns a list of MediaWorkflowTaskDeclarations.

Parameters:

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

    the optional parameters

Options Hash (opts):

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

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :compartment_id (String) —

    The ID of the compartment in which to list resources.

  • :name (String) —

    A filter to return only the resources with their system defined, unique name matching the given name.

  • :version (Integer) —

    A filter to select MediaWorkflowTaskDeclaration by version.

  • :is_current (BOOLEAN) —

    A filter to only select the newest version for each MediaWorkflowTaskDeclaration name. (default to false)

  • :sort_by (String) —

    The field to sort by. Only one sort order may be provided. (default to name)

  • :limit (Integer) —

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

  • :page (String) —

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

  • :sort_order (String) —

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

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
 
# File 'lib/oci/media_services/media_services_client.rb', line 2385

def list_media_workflow_task_declarations(opts = {})
  logger.debug 'Calling operation MediaServicesClient#list_media_workflow_task_declarations.' if logger


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

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

  path = '/mediaWorkflowTaskDeclarations'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id]
  query_params[:name] = opts[:name] if opts[:name]
  query_params[:version] = opts[:version] if opts[:version]
  query_params[:isCurrent] = opts[:is_current] if !opts[:is_current].nil?
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  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]

  # 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: 'MediaServicesClient#list_media_workflow_task_declarations') 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::MediaServices::Models::MediaWorkflowTaskDeclarationCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_media_workflows(opts = {}) ⇒ Response

Note:

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

Lists the MediaWorkflows.

Parameters:

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

    the optional parameters

Options Hash (opts):

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

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :compartment_id (String) —

    The ID of the compartment in which to list resources.

  • :id (String) —

    Unique MediaWorkflow identifier.

  • :lifecycle_state (String) —

    A filter to return only the resources with lifecycleState matching the given lifecycleState.

  • :display_name (String) —

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

  • :sort_order (String) —

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

  • :sort_by (String) —

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

  • :page (String) —

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

  • :limit (Integer) —

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

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
 
# File 'lib/oci/media_services/media_services_client.rb', line 2464

def list_media_workflows(opts = {})
  logger.debug 'Calling operation MediaServicesClient#list_media_workflows.' if logger


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

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

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

  path = '/mediaWorkflows'
  operation_signing_strategy = :standard

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

  # 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: 'MediaServicesClient#list_media_workflows') 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::MediaServices::Models::MediaWorkflowCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_stream_cdn_configs(distribution_channel_id, opts = {}) ⇒ Response

Note:

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

Lists the StreamCdnConfig.

Parameters:

  • distribution_channel_id (String) —

    The Stream Distribution Channel identifier this CdnConfig belongs to.

  • 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) —

    Unique StreamCdnConfig identifier.

  • :lifecycle_state (String) —

    A filter to return only the resources with lifecycleState matching the given lifecycleState.

  • :display_name (String) —

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

  • :sort_order (String) —

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

  • :sort_by (String) —

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

  • :page (String) —

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

  • :limit (Integer) —

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

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
 
# File 'lib/oci/media_services/media_services_client.rb', line 2548

def list_stream_cdn_configs(distribution_channel_id, opts = {})
  logger.debug 'Calling operation MediaServicesClient#list_stream_cdn_configs.' if logger

  raise "Missing the required parameter 'distribution_channel_id' when calling list_stream_cdn_configs." if distribution_channel_id.nil?

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

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

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

  path = '/streamCdnConfigs'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:distributionChannelId] = distribution_channel_id
  query_params[:id] = opts[:id] if opts[:id]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:limit] = opts[:limit] if opts[:limit]

  # 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: 'MediaServicesClient#list_stream_cdn_configs') 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::MediaServices::Models::StreamCdnConfigCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_stream_distribution_channels(opts = {}) ⇒ Response

Note:

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

Lists the Stream Distribution Channels.

Parameters:

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

    the optional parameters

Options Hash (opts):

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

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :compartment_id (String) —

    The ID of the compartment in which to list resources.

  • :id (String) —

    Unique Stream Distribution Channel identifier.

  • :lifecycle_state (String) —

    A filter to return only the resources with lifecycleState matching the given lifecycleState.

  • :display_name (String) —

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

  • :sort_order (String) —

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

  • :sort_by (String) —

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

  • :page (String) —

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

  • :limit (Integer) —

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

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
 
# File 'lib/oci/media_services/media_services_client.rb', line 2632

def list_stream_distribution_channels(opts = {})
  logger.debug 'Calling operation MediaServicesClient#list_stream_distribution_channels.' if logger


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

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

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

  path = '/streamDistributionChannels'
  operation_signing_strategy = :standard

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

  # 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: 'MediaServicesClient#list_stream_distribution_channels') 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::MediaServices::Models::StreamDistributionChannelCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_stream_packaging_configs(distribution_channel_id, opts = {}) ⇒ Response

Note:

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

Lists the Stream Packaging Configurations.

Parameters:

  • distribution_channel_id (String) —

    Unique Stream Distribution Channel 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

  • :stream_packaging_config_id (String) —

    Unique Stream Packaging Configuration identifier.

  • :lifecycle_state (String) —

    A filter to return only the resources with lifecycleState matching the given lifecycleState.

  • :display_name (String) —

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

  • :sort_order (String) —

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

  • :sort_by (String) —

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

  • :page (String) —

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

  • :limit (Integer) —

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

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
 
# File 'lib/oci/media_services/media_services_client.rb', line 2715

def list_stream_packaging_configs(distribution_channel_id, opts = {})
  logger.debug 'Calling operation MediaServicesClient#list_stream_packaging_configs.' if logger

  raise "Missing the required parameter 'distribution_channel_id' when calling list_stream_packaging_configs." if distribution_channel_id.nil?

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

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

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

  path = '/streamPackagingConfigs'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:distributionChannelId] = distribution_channel_id
  query_params[:streamPackagingConfigId] = opts[:stream_packaging_config_id] if opts[:stream_packaging_config_id]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:limit] = opts[:limit] if opts[:limit]

  # 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: 'MediaServicesClient#list_stream_packaging_configs') 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::MediaServices::Models::StreamPackagingConfigCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_system_media_workflows(opts = {}) ⇒ Response

Note:

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

Lists the SystemMediaWorkflows that can be used to run a job by name or as a template to create a MediaWorkflow.

Parameters:

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

    the optional parameters

Options Hash (opts):

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

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :compartment_id (String) —

    The ID of the compartment in which to list resources.

  • :name (String) —

    A filter to return only the resources with their system defined, unique name matching the given name.

  • :sort_order (String) —

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

  • :page (String) —

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

  • :limit (Integer) —

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

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
 
# File 'lib/oci/media_services/media_services_client.rb', line 2795

def list_system_media_workflows(opts = {})
  logger.debug 'Calling operation MediaServicesClient#list_system_media_workflows.' if logger


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

  path = '/systemMediaWorkflows'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id]
  query_params[:name] = opts[:name] if opts[:name]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:limit] = opts[:limit] if opts[:limit]

  # 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: 'MediaServicesClient#list_system_media_workflows') 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::MediaServices::Models::SystemMediaWorkflowCollection'
    )
  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.



96
97
98
 
# File 'lib/oci/media_services/media_services_client.rb', line 96

def logger
  @api_client.config.logger
end

#update_media_asset(media_asset_id, update_media_asset_details, opts = {}) ⇒ Response

Note:

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

Updates the MediaAsset.

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:



2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
 
# File 'lib/oci/media_services/media_services_client.rb', line 2863

def update_media_asset(media_asset_id, update_media_asset_details, opts = {})
  logger.debug 'Calling operation MediaServicesClient#update_media_asset.' if logger

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

  path = '/mediaAssets/{mediaAssetId}'.sub('{mediaAssetId}', media_asset_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_media_asset_details)

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

#update_media_workflow(media_workflow_id, update_media_workflow_details, opts = {}) ⇒ Response

Note:

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

Updates the MediaWorkflow.

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:



2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
 
# File 'lib/oci/media_services/media_services_client.rb', line 2926

def update_media_workflow(media_workflow_id, update_media_workflow_details, opts = {})
  logger.debug 'Calling operation MediaServicesClient#update_media_workflow.' if logger

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

  path = '/mediaWorkflows/{mediaWorkflowId}'.sub('{mediaWorkflowId}', media_workflow_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_media_workflow_details)

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

#update_media_workflow_configuration(media_workflow_configuration_id, update_media_workflow_configuration_details, opts = {}) ⇒ Response

Note:

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

Updates the MediaWorkflowConfiguration.

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:



2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
 
# File 'lib/oci/media_services/media_services_client.rb', line 2989

def update_media_workflow_configuration(media_workflow_configuration_id, update_media_workflow_configuration_details, opts = {})
  logger.debug 'Calling operation MediaServicesClient#update_media_workflow_configuration.' if logger

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

  path = '/mediaWorkflowConfigurations/{mediaWorkflowConfigurationId}'.sub('{mediaWorkflowConfigurationId}', media_workflow_configuration_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_media_workflow_configuration_details)

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

#update_media_workflow_job(media_workflow_job_id, update_media_workflow_job_details, opts = {}) ⇒ Response

Note:

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

Updates the MediaWorkflowJob.

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:



3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
 
# File 'lib/oci/media_services/media_services_client.rb', line 3052

def update_media_workflow_job(media_workflow_job_id, update_media_workflow_job_details, opts = {})
  logger.debug 'Calling operation MediaServicesClient#update_media_workflow_job.' if logger

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

  path = '/mediaWorkflowJobs/{mediaWorkflowJobId}'.sub('{mediaWorkflowJobId}', media_workflow_job_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_media_workflow_job_details)

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

#update_stream_cdn_config(stream_cdn_config_id, update_stream_cdn_config_details, opts = {}) ⇒ Response

Note:

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

Updates the StreamCdnConfig.

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:



3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
 
# File 'lib/oci/media_services/media_services_client.rb', line 3115

def update_stream_cdn_config(stream_cdn_config_id, update_stream_cdn_config_details, opts = {})
  logger.debug 'Calling operation MediaServicesClient#update_stream_cdn_config.' if logger

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

  path = '/streamCdnConfigs/{streamCdnConfigId}'.sub('{streamCdnConfigId}', stream_cdn_config_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_stream_cdn_config_details)

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

#update_stream_distribution_channel(stream_distribution_channel_id, update_stream_distribution_channel_details, opts = {}) ⇒ Response

Note:

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

Updates the Stream Distribution Channel.

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:



3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
 
# File 'lib/oci/media_services/media_services_client.rb', line 3178

def update_stream_distribution_channel(stream_distribution_channel_id, update_stream_distribution_channel_details, opts = {})
  logger.debug 'Calling operation MediaServicesClient#update_stream_distribution_channel.' if logger

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

  path = '/streamDistributionChannels/{streamDistributionChannelId}'.sub('{streamDistributionChannelId}', stream_distribution_channel_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_stream_distribution_channel_details)

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

#update_stream_packaging_config(stream_packaging_config_id, update_stream_packaging_config_details, opts = {}) ⇒ Response

Note:

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

Updates the Stream Packaging Configuration.

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:



3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
 
# File 'lib/oci/media_services/media_services_client.rb', line 3241

def update_stream_packaging_config(stream_packaging_config_id, update_stream_packaging_config_details, opts = {})
  logger.debug 'Calling operation MediaServicesClient#update_stream_packaging_config.' if logger

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

  path = '/streamPackagingConfigs/{streamPackagingConfigId}'.sub('{streamPackagingConfigId}', stream_packaging_config_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_stream_packaging_config_details)

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