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

#add_media_asset_lock(add_lock_details, media_asset_id, opts = {}) ⇒ Response

Note:

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

Add a lock to an MediaAsset.

Parameters:

  • add_lock_details (OCI::MediaServices::Models::AddLockDetails) —

    The details to be updated for the AddLock.

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

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



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

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

  raise "Missing the required parameter 'add_lock_details' when calling add_media_asset_lock." if add_lock_details.nil?
  raise "Missing the required parameter 'media_asset_id' when calling add_media_asset_lock." 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}/actions/addLock'.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[:'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
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(add_lock_details)

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

#add_media_workflow_configuration_lock(add_resource_lock_details, media_workflow_configuration_id, opts = {}) ⇒ Response

Note:

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

Add a lock to a MediaWorkflowConfiguration.

Parameters:

  • add_resource_lock_details (OCI::MediaServices::Models::AddLockDetails) —

    AddResourceLockDetails body parameter

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

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



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
236
237
238
239
 
# File 'lib/oci/media_services/media_services_client.rb', line 199

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

  raise "Missing the required parameter 'add_resource_lock_details' when calling add_media_workflow_configuration_lock." if add_resource_lock_details.nil?
  raise "Missing the required parameter 'media_workflow_configuration_id' when calling add_media_workflow_configuration_lock." 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}/actions/addLock'.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]
  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(add_resource_lock_details)

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

#add_media_workflow_job_lock(add_lock_details, media_workflow_job_id, opts = {}) ⇒ Response

Note:

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

Add a lock to a MediaWorkflowJob.

Parameters:

  • add_lock_details (OCI::MediaServices::Models::AddLockDetails) —

    The details to be updated for the AddLock.

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

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



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
306
307
308
309
310
311
 
# File 'lib/oci/media_services/media_services_client.rb', line 271

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

  raise "Missing the required parameter 'add_lock_details' when calling add_media_workflow_job_lock." if add_lock_details.nil?
  raise "Missing the required parameter 'media_workflow_job_id' when calling add_media_workflow_job_lock." 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}/actions/addLock'.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[:'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
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(add_lock_details)

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

#add_media_workflow_lock(add_resource_lock_details, media_workflow_id, opts = {}) ⇒ Response

Note:

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

Add a lock to a MediaWorkflow.

Parameters:

  • add_resource_lock_details (OCI::MediaServices::Models::AddLockDetails) —

    AddResourceLockDetails body parameter

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

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



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
376
377
378
379
380
381
382
383
 
# File 'lib/oci/media_services/media_services_client.rb', line 343

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

  raise "Missing the required parameter 'add_resource_lock_details' when calling add_media_workflow_lock." if add_resource_lock_details.nil?
  raise "Missing the required parameter 'media_workflow_id' when calling add_media_workflow_lock." 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}/actions/addLock'.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[:'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
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(add_resource_lock_details)

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

#add_stream_cdn_config_lock(add_resource_lock_details, stream_cdn_config_id, opts = {}) ⇒ Response

Note:

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

Add a lock to a StreamCdnConfig.

Parameters:

  • add_resource_lock_details (OCI::MediaServices::Models::AddLockDetails) —

    AddResourceLockDetails body parameter

  • 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

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

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



415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
 
# File 'lib/oci/media_services/media_services_client.rb', line 415

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

  raise "Missing the required parameter 'add_resource_lock_details' when calling add_stream_cdn_config_lock." if add_resource_lock_details.nil?
  raise "Missing the required parameter 'stream_cdn_config_id' when calling add_stream_cdn_config_lock." 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}/actions/addLock'.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]
  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(add_resource_lock_details)

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

#add_stream_distribution_channel_lock(add_resource_lock_details, stream_distribution_channel_id, opts = {}) ⇒ Response

Note:

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

Add a lock to a StreamDistributionChannel.

Parameters:

  • add_resource_lock_details (OCI::MediaServices::Models::AddLockDetails) —

    AddResourceLockDetails body parameter

  • 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

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

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



487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
 
# File 'lib/oci/media_services/media_services_client.rb', line 487

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

  raise "Missing the required parameter 'add_resource_lock_details' when calling add_stream_distribution_channel_lock." if add_resource_lock_details.nil?
  raise "Missing the required parameter 'stream_distribution_channel_id' when calling add_stream_distribution_channel_lock." 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}/actions/addLock'.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]
  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(add_resource_lock_details)

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

#add_stream_packaging_config_lock(add_resource_lock_details, stream_packaging_config_id, opts = {}) ⇒ Response

Note:

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

Add a lock to a StreamPackagingConfig.

Parameters:

  • add_resource_lock_details (OCI::MediaServices::Models::AddLockDetails) —

    AddResourceLockDetails body parameter

  • 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

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

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



559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
 
# File 'lib/oci/media_services/media_services_client.rb', line 559

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

  raise "Missing the required parameter 'add_resource_lock_details' when calling add_stream_packaging_config_lock." if add_resource_lock_details.nil?
  raise "Missing the required parameter 'stream_packaging_config_id' when calling add_stream_packaging_config_lock." 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}/actions/addLock'.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]
  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(add_resource_lock_details)

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

#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

  • :is_lock_override (BOOLEAN) —

    Whether to override locks (if any exist). (default to false)

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



631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
 
# File 'lib/oci/media_services/media_services_client.rb', line 631

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 = {}
  query_params[:isLockOverride] = opts[:is_lock_override] if !opts[:is_lock_override].nil?

  # 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

  • :is_lock_override (BOOLEAN) —

    Whether to override locks (if any exist). (default to false)

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



703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
 
# File 'lib/oci/media_services/media_services_client.rb', line 703

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 = {}
  query_params[:isLockOverride] = opts[:is_lock_override] if !opts[:is_lock_override].nil?

  # 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

  • :is_lock_override (BOOLEAN) —

    Whether to override locks (if any exist). (default to false)

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



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

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 = {}
  query_params[:isLockOverride] = opts[:is_lock_override] if !opts[:is_lock_override].nil?

  # 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

  • :is_lock_override (BOOLEAN) —

    Whether to override locks (if any exist). (default to false)

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



847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
 
# File 'lib/oci/media_services/media_services_client.rb', line 847

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 = {}
  query_params[:isLockOverride] = opts[:is_lock_override] if !opts[:is_lock_override].nil?

  # 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

  • :is_lock_override (BOOLEAN) —

    Whether to override locks (if any exist). (default to false)

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



919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
 
# File 'lib/oci/media_services/media_services_client.rb', line 919

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 = {}
  query_params[:isLockOverride] = opts[:is_lock_override] if !opts[:is_lock_override].nil?

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



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
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
 
# File 'lib/oci/media_services/media_services_client.rb', line 984

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:



1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
 
# File 'lib/oci/media_services/media_services_client.rb', line 1046

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:



1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
 
# File 'lib/oci/media_services/media_services_client.rb', line 1108

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:



1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
 
# File 'lib/oci/media_services/media_services_client.rb', line 1169

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:



1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
 
# File 'lib/oci/media_services/media_services_client.rb', line 1231

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:



1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
 
# File 'lib/oci/media_services/media_services_client.rb', line 1293

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:



1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
 
# File 'lib/oci/media_services/media_services_client.rb', line 1355

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

  • :is_lock_override (BOOLEAN) —

    Whether to override locks (if any exist). (default to false)

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



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

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[:isLockOverride] = opts[:is_lock_override] if !opts[:is_lock_override].nil?
  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

  • :is_lock_override (BOOLEAN) —

    Whether to override locks (if any exist). (default to false)

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



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

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[:isLockOverride] = opts[:is_lock_override] if !opts[:is_lock_override].nil?
  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

  • :is_lock_override (BOOLEAN) —

    Whether to override locks (if any exist). (default to false)

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



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

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 = {}
  query_params[:isLockOverride] = opts[:is_lock_override] if !opts[:is_lock_override].nil?

  # 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

  • :is_lock_override (BOOLEAN) —

    Whether to override locks (if any exist). (default to false)

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



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
1645
1646
1647
1648
1649
1650
1651
 
# File 'lib/oci/media_services/media_services_client.rb', line 1614

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 = {}
  query_params[:isLockOverride] = opts[:is_lock_override] if !opts[:is_lock_override].nil?

  # 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

  • :is_lock_override (BOOLEAN) —

    Whether to override locks (if any exist). (default to false)

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



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
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
 
# File 'lib/oci/media_services/media_services_client.rb', line 1676

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 = {}
  query_params[:isLockOverride] = opts[:is_lock_override] if !opts[:is_lock_override].nil?

  # 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

  • :is_lock_override (BOOLEAN) —

    Whether to override locks (if any exist). (default to false)

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



1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
 
# File 'lib/oci/media_services/media_services_client.rb', line 1738

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 = {}
  query_params[:isLockOverride] = opts[:is_lock_override] if !opts[:is_lock_override].nil?

  # 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

  • :is_lock_override (BOOLEAN) —

    Whether to override locks (if any exist). (default to false)

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



1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
 
# File 'lib/oci/media_services/media_services_client.rb', line 1800

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 = {}
  query_params[:isLockOverride] = opts[:is_lock_override] if !opts[:is_lock_override].nil?

  # 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

  • :is_lock_override (BOOLEAN) —

    Whether to override locks (if any exist). (default to false)

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



1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
 
# File 'lib/oci/media_services/media_services_client.rb', line 1862

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 = {}
  query_params[:isLockOverride] = opts[:is_lock_override] if !opts[:is_lock_override].nil?

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



1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
 
# File 'lib/oci/media_services/media_services_client.rb', line 1917

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:



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
2005
2006
2007
2008
2009
2010
2011
2012
 
# File 'lib/oci/media_services/media_services_client.rb', line 1973

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:



2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
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
 
# File 'lib/oci/media_services/media_services_client.rb', line 2030

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:



2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
 
# File 'lib/oci/media_services/media_services_client.rb', line 2084

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:



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

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



2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
 
# File 'lib/oci/media_services/media_services_client.rb', line 2192

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:



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
2274
2275
2276
2277
2278
2279
2280
2281
2282
 
# File 'lib/oci/media_services/media_services_client.rb', line 2246

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:



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

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:



2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
 
# File 'lib/oci/media_services/media_services_client.rb', line 2361

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:



2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
 
# File 'lib/oci/media_services/media_services_client.rb', line 2427

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:



2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
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
 
# File 'lib/oci/media_services/media_services_client.rb', line 2514

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:



2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
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
 
# File 'lib/oci/media_services/media_services_client.rb', line 2610

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



2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
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
 
# File 'lib/oci/media_services/media_services_client.rb', line 2692

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:



2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
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
 
# File 'lib/oci/media_services/media_services_client.rb', line 2776

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:



2855
2856
2857
2858
2859
2860
2861
2862
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
2902
2903
2904
2905
2906
2907
2908
2909
 
# File 'lib/oci/media_services/media_services_client.rb', line 2855

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:



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
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
 
# File 'lib/oci/media_services/media_services_client.rb', line 2939

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:



3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
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
 
# File 'lib/oci/media_services/media_services_client.rb', line 3023

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:



3106
3107
3108
3109
3110
3111
3112
3113
3114
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
3154
3155
3156
3157
3158
3159
3160
3161
 
# File 'lib/oci/media_services/media_services_client.rb', line 3106

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:



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
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
 
# File 'lib/oci/media_services/media_services_client.rb', line 3186

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

#remove_media_asset_lock(remove_lock_details, media_asset_id, opts = {}) ⇒ Response

Note:

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

Remove a lock to an MediaAsset.

Parameters:

  • remove_lock_details (OCI::MediaServices::Models::RemoveLockDetails) —

    The details to be updated for the RemoveLock.

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

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



3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
 
# File 'lib/oci/media_services/media_services_client.rb', line 3261

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

  raise "Missing the required parameter 'remove_lock_details' when calling remove_media_asset_lock." if remove_lock_details.nil?
  raise "Missing the required parameter 'media_asset_id' when calling remove_media_asset_lock." 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}/actions/removeLock'.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[:'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
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(remove_lock_details)

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

#remove_media_workflow_configuration_lock(remove_resource_lock_details, media_workflow_configuration_id, opts = {}) ⇒ Response

Note:

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

Remove a lock from a MediaWorkflowConfiguration.

Parameters:

  • remove_resource_lock_details (OCI::MediaServices::Models::RemoveLockDetails) —

    RemoveResourceLockDetails body parameter

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

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



3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
 
# File 'lib/oci/media_services/media_services_client.rb', line 3333

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

  raise "Missing the required parameter 'remove_resource_lock_details' when calling remove_media_workflow_configuration_lock." if remove_resource_lock_details.nil?
  raise "Missing the required parameter 'media_workflow_configuration_id' when calling remove_media_workflow_configuration_lock." 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}/actions/removeLock'.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]
  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(remove_resource_lock_details)

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

#remove_media_workflow_job_lock(remove_lock_details, media_workflow_job_id, opts = {}) ⇒ Response

Note:

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

Remove a lock from a MediaWorkflowJob.

Parameters:

  • remove_lock_details (OCI::MediaServices::Models::RemoveLockDetails) —

    The details to be updated for the RemoveLock.

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

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



3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
 
# File 'lib/oci/media_services/media_services_client.rb', line 3405

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

  raise "Missing the required parameter 'remove_lock_details' when calling remove_media_workflow_job_lock." if remove_lock_details.nil?
  raise "Missing the required parameter 'media_workflow_job_id' when calling remove_media_workflow_job_lock." 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}/actions/removeLock'.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[:'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
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(remove_lock_details)

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

#remove_media_workflow_lock(remove_resource_lock_details, media_workflow_id, opts = {}) ⇒ Response

Note:

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

Remove a lock from a MediaWorkflow.

Parameters:

  • remove_resource_lock_details (OCI::MediaServices::Models::RemoveLockDetails) —

    RemoveResourceLockDetails body parameter

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

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



3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
 
# File 'lib/oci/media_services/media_services_client.rb', line 3477

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

  raise "Missing the required parameter 'remove_resource_lock_details' when calling remove_media_workflow_lock." if remove_resource_lock_details.nil?
  raise "Missing the required parameter 'media_workflow_id' when calling remove_media_workflow_lock." 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}/actions/removeLock'.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[:'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
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(remove_resource_lock_details)

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

#remove_stream_cdn_config_lock(remove_resource_lock_details, stream_cdn_config_id, opts = {}) ⇒ Response

Note:

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

Remove a lock from a StreamCdnConfig.

Parameters:

  • remove_resource_lock_details (OCI::MediaServices::Models::RemoveLockDetails) —

    RemoveResourceLockDetails body parameter

  • 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

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

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



3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
 
# File 'lib/oci/media_services/media_services_client.rb', line 3549

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

  raise "Missing the required parameter 'remove_resource_lock_details' when calling remove_stream_cdn_config_lock." if remove_resource_lock_details.nil?
  raise "Missing the required parameter 'stream_cdn_config_id' when calling remove_stream_cdn_config_lock." 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}/actions/removeLock'.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]
  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(remove_resource_lock_details)

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

#remove_stream_distribution_channel_lock(remove_resource_lock_details, stream_distribution_channel_id, opts = {}) ⇒ Response

Note:

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

Remove a lock to a StreamDistributionChannel.

Parameters:

  • remove_resource_lock_details (OCI::MediaServices::Models::RemoveLockDetails) —

    RemoveResourceLockDetails body parameter

  • 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

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

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



3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
 
# File 'lib/oci/media_services/media_services_client.rb', line 3621

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

  raise "Missing the required parameter 'remove_resource_lock_details' when calling remove_stream_distribution_channel_lock." if remove_resource_lock_details.nil?
  raise "Missing the required parameter 'stream_distribution_channel_id' when calling remove_stream_distribution_channel_lock." 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}/actions/removeLock'.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]
  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(remove_resource_lock_details)

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

#remove_stream_packaging_config_lock(remove_resource_lock_details, stream_packaging_config_id, opts = {}) ⇒ Response

Note:

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

Remove a lock from a StreamPackagingConfig.

Parameters:

  • remove_resource_lock_details (OCI::MediaServices::Models::RemoveLockDetails) —

    RemoveResourceLockDetails body parameter

  • 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

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

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



3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
 
# File 'lib/oci/media_services/media_services_client.rb', line 3693

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

  raise "Missing the required parameter 'remove_resource_lock_details' when calling remove_stream_packaging_config_lock." if remove_resource_lock_details.nil?
  raise "Missing the required parameter 'stream_packaging_config_id' when calling remove_stream_packaging_config_lock." 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}/actions/removeLock'.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]
  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(remove_resource_lock_details)

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

#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

  • :is_lock_override (BOOLEAN) —

    Whether to override locks (if any exist). (default to false)

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



3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
 
# File 'lib/oci/media_services/media_services_client.rb', line 3759

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 = {}
  query_params[:isLockOverride] = opts[:is_lock_override] if !opts[:is_lock_override].nil?

  # 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

  • :is_lock_override (BOOLEAN) —

    Whether to override locks (if any exist). (default to false)

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



3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
 
# File 'lib/oci/media_services/media_services_client.rb', line 3824

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 = {}
  query_params[:isLockOverride] = opts[:is_lock_override] if !opts[:is_lock_override].nil?

  # 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

  • :is_lock_override (BOOLEAN) —

    Whether to override locks (if any exist). (default to false)

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



3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
 
# File 'lib/oci/media_services/media_services_client.rb', line 3889

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 = {}
  query_params[:isLockOverride] = opts[:is_lock_override] if !opts[:is_lock_override].nil?

  # 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

  • :is_lock_override (BOOLEAN) —

    Whether to override locks (if any exist). (default to false)

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



3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
 
# File 'lib/oci/media_services/media_services_client.rb', line 3954

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 = {}
  query_params[:isLockOverride] = opts[:is_lock_override] if !opts[:is_lock_override].nil?

  # 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

  • :is_lock_override (BOOLEAN) —

    Whether to override locks (if any exist). (default to false)

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



4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
 
# File 'lib/oci/media_services/media_services_client.rb', line 4019

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 = {}
  query_params[:isLockOverride] = opts[:is_lock_override] if !opts[:is_lock_override].nil?

  # 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

  • :is_lock_override (BOOLEAN) —

    Whether to override locks (if any exist). (default to false)

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



4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
 
# File 'lib/oci/media_services/media_services_client.rb', line 4084

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 = {}
  query_params[:isLockOverride] = opts[:is_lock_override] if !opts[:is_lock_override].nil?

  # 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

  • :is_lock_override (BOOLEAN) —

    Whether to override locks (if any exist). (default to false)

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



4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
 
# File 'lib/oci/media_services/media_services_client.rb', line 4149

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 = {}
  query_params[:isLockOverride] = opts[:is_lock_override] if !opts[:is_lock_override].nil?

  # 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