Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MediaServicesClient

This service client uses {@link common.CircuitBreaker.DefaultConfiguration} for all the operations by default if no circuit breaker configuration is defined by the user.

Hierarchy

  • MediaServicesClient

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new MediaServicesClient(params: common.AuthParams, clientConfiguration?: common.ClientConfiguration): MediaServicesClient

Properties

Protected _bodyDuplexMode

_bodyDuplexMode: any = undefined

Protected _circuitBreaker

_circuitBreaker: typeof Breaker | null = null

Protected _clientConfiguration

_clientConfiguration: ClientConfiguration

Protected _defaultHeaders

_defaultHeaders: any

Protected _endpoint

_endpoint: string = ""

Protected _httpClient

_httpClient: HttpClient

Protected _httpOptions

_httpOptions: any = undefined

Protected _lastSetRegionOrRegionId

_lastSetRegionOrRegionId: string = ""

Protected _realmSpecificEndpointTemplateEnabled

_realmSpecificEndpointTemplateEnabled: boolean | undefined = undefined

Protected _region

_region: Region

Protected _regionId

_regionId: string = ""

Protected _waiters

targetService

targetService: string = "MediaServices"

Static Protected endpointServiceName

endpointServiceName: string = ""

Static Protected serviceEndpointTemplate

serviceEndpointTemplate: string = "https://mediaservices.{region}.oci.{secondLevelDomain}"

Accessors

endpoint

  • get endpoint(): string
  • set endpoint(endpoint: string): void

logger

region

  • set region(region: Region): void
  • Sets the region to call (ex, Region.US_PHOENIX_1). Note, this will call {@link #endpoint(String) endpoint} after resolving the endpoint.

    Parameters

    • region: Region

      The region of the service.

    Returns void

regionId

  • set regionId(regionId: string): void
  • Sets the regionId to call (ex, 'us-phoenix-1').

    Note, this will first try to map the region ID to a known Region and call {@link #region(Region) region}. If no known Region could be determined, it will create an endpoint assuming its in default Realm OC1 and then call {@link #endpoint(String) endpoint}.

    Parameters

    • regionId: string

      The public region ID.

    Returns void

useRealmSpecificEndpointTemplate

  • set useRealmSpecificEndpointTemplate(realmSpecificEndpointTemplateEnabled: boolean): void
  • Determines whether realm specific endpoint should be used or not. Set realmSpecificEndpointTemplateEnabled to "true" if the user wants to enable use of realm specific endpoint template, otherwise set it to "false"

    Parameters

    • realmSpecificEndpointTemplateEnabled: boolean

      flag to enable the use of realm specific endpoint template

    Returns void

Methods

addMediaAssetLock

addMediaWorkflowConfigurationLock

addMediaWorkflowJobLock

addMediaWorkflowLock

addStreamCdnConfigLock

addStreamDistributionChannelLock

addStreamPackagingConfigLock

changeMediaAssetCompartment

changeMediaWorkflowCompartment

changeMediaWorkflowConfigurationCompartment

changeMediaWorkflowJobCompartment

changeStreamDistributionChannelCompartment

close

  • close(): void

createMediaAsset

createMediaWorkflow

createMediaWorkflowConfiguration

createMediaWorkflowJob

  • Run the MediaWorkflow according to the given mediaWorkflow definition and configuration. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateMediaWorkflowJob API.

    Parameters

    Returns Promise<CreateMediaWorkflowJobResponse>

    CreateMediaWorkflowJobResponse

createStreamCdnConfig

createStreamDistributionChannel

createStreamPackagingConfig

createWaiters

deleteMediaAsset

  • 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. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeleteMediaAsset API.

    Parameters

    Returns Promise<DeleteMediaAssetResponse>

    DeleteMediaAssetResponse

deleteMediaAssetDistributionChannelAttachment

deleteMediaWorkflow

deleteMediaWorkflowConfiguration

deleteMediaWorkflowJob

  • This is an asynchronous operation. The MediaWorkflowJob lifecycleState will change to CANCELING temporarily until the job is completely CANCELED. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeleteMediaWorkflowJob API.

    Parameters

    Returns Promise<DeleteMediaWorkflowJobResponse>

    DeleteMediaWorkflowJobResponse

deleteStreamCdnConfig

deleteStreamDistributionChannel

deleteStreamPackagingConfig

getMediaAsset

  • Gets a MediaAsset by identifier. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetMediaAsset API.

    Parameters

    Returns Promise<GetMediaAssetResponse>

    GetMediaAssetResponse

getMediaAssetDistributionChannelAttachment

getMediaWorkflow

getMediaWorkflowConfiguration

getMediaWorkflowJob

getStreamCdnConfig

getStreamDistributionChannel

getStreamPackagingConfig

getWaiters

ingestStreamDistributionChannel

listMediaAssetDistributionChannelAttachments

listMediaAssets

listMediaWorkflowConfigurations

listMediaWorkflowJobs

listMediaWorkflowTaskDeclarations

listMediaWorkflows

listStreamCdnConfigs

listStreamDistributionChannels

listStreamPackagingConfigs

listSystemMediaWorkflows

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListSystemMediaWorkflows API.

    Parameters

    Returns Promise<ListSystemMediaWorkflowsResponse>

    ListSystemMediaWorkflowsResponse

removeMediaAssetLock

removeMediaWorkflowConfigurationLock

removeMediaWorkflowJobLock

removeMediaWorkflowLock

removeStreamCdnConfigLock

removeStreamDistributionChannelLock

removeStreamPackagingConfigLock

shutdownCircuitBreaker

  • shutdownCircuitBreaker(): void

updateMediaAsset

updateMediaWorkflow

updateMediaWorkflowConfiguration

updateMediaWorkflowJob

updateStreamCdnConfig

updateStreamDistributionChannel

updateStreamPackagingConfig