com.oracle.bmc.mediaservices

Class MediaServicesClient

java.lang.Object

com.oracle.bmc.http.internal.BaseSyncClient

com.oracle.bmc.mediaservices.MediaServicesClient

All Implemented Interfaces:

MediaServices, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20211101")
public class MediaServicesClient
extends BaseSyncClient
implements MediaServices

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MediaServicesClient.Builder Builder class for this client.

Field Summary

Fields

Modifier and Type	Field and Description
String	clientCommonLibraryVersion Compatible SDK version, provided by the codegen.
Optional<String>	minimumClientCommonLibraryVersionFromClient Minimum compatible SDK version, maybe provided by the codegen.
static Service	SERVICE Service instance for MediaServices.

Constructor Summary

Constructors

Constructor and Description
MediaServicesClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory) Deprecated. Use the builder instead.
MediaServicesClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators) Deprecated. Use the builder instead.
MediaServicesClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint) Deprecated. Use the builder instead.
MediaServicesClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint) Deprecated. Use the builder instead.
MediaServicesClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService) Deprecated. Use the builder instead.
MediaServicesClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider) Deprecated. Use the builder instead.
MediaServicesClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration) Deprecated. Use the builder instead.
MediaServicesClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator) Deprecated. Use the builder instead.

Method Summary

Modifier and Type	Method and Description
AddMediaAssetLockResponse	addMediaAssetLock(AddMediaAssetLockRequest request) Add a lock to an MediaAsset.
AddMediaWorkflowConfigurationLockResponse	addMediaWorkflowConfigurationLock(AddMediaWorkflowConfigurationLockRequest request) Add a lock to a MediaWorkflowConfiguration.
AddMediaWorkflowJobLockResponse	addMediaWorkflowJobLock(AddMediaWorkflowJobLockRequest request) Add a lock to a MediaWorkflowJob.
AddMediaWorkflowLockResponse	addMediaWorkflowLock(AddMediaWorkflowLockRequest request) Add a lock to a MediaWorkflow.
AddStreamCdnConfigLockResponse	addStreamCdnConfigLock(AddStreamCdnConfigLockRequest request) Add a lock to a StreamCdnConfig.
AddStreamDistributionChannelLockResponse	addStreamDistributionChannelLock(AddStreamDistributionChannelLockRequest request) Add a lock to a StreamDistributionChannel.
AddStreamPackagingConfigLockResponse	addStreamPackagingConfigLock(AddStreamPackagingConfigLockRequest request) Add a lock to a StreamPackagingConfig.
static MediaServicesClient.Builder	builder() Create a builder for this client.
ChangeMediaAssetCompartmentResponse	changeMediaAssetCompartment(ChangeMediaAssetCompartmentRequest request) Moves a MediaAsset resource from one compartment identifier to another.
ChangeMediaWorkflowCompartmentResponse	changeMediaWorkflowCompartment(ChangeMediaWorkflowCompartmentRequest request) Moves a MediaWorkflow resource from one compartment identifier to another.
ChangeMediaWorkflowConfigurationCompartmentResponse	changeMediaWorkflowConfigurationCompartment(ChangeMediaWorkflowConfigurationCompartmentRequest request) Moves a MediaWorkflowConfiguration resource from one compartment identifier to another.
ChangeMediaWorkflowJobCompartmentResponse	changeMediaWorkflowJobCompartment(ChangeMediaWorkflowJobCompartmentRequest request) Moves a MediaWorkflowJob resource from one compartment identifier to another.
ChangeStreamDistributionChannelCompartmentResponse	changeStreamDistributionChannelCompartment(ChangeStreamDistributionChannelCompartmentRequest request) Moves a Stream Distribution Channel resource from one compartment identifier to another.
void	close()
CreateMediaAssetResponse	createMediaAsset(CreateMediaAssetRequest request) Creates a new MediaAsset.
CreateMediaWorkflowResponse	createMediaWorkflow(CreateMediaWorkflowRequest request) Creates a new MediaWorkflow.
CreateMediaWorkflowConfigurationResponse	createMediaWorkflowConfiguration(CreateMediaWorkflowConfigurationRequest request) Creates a new MediaWorkflowConfiguration.
CreateMediaWorkflowJobResponse	createMediaWorkflowJob(CreateMediaWorkflowJobRequest request) Run the MediaWorkflow according to the given mediaWorkflow definition and configuration.
CreateStreamCdnConfigResponse	createStreamCdnConfig(CreateStreamCdnConfigRequest request) Creates a new CDN Configuration.
CreateStreamDistributionChannelResponse	createStreamDistributionChannel(CreateStreamDistributionChannelRequest request) Creates a new Stream Distribution Channel.
CreateStreamPackagingConfigResponse	createStreamPackagingConfig(CreateStreamPackagingConfigRequest request) Creates a new Packaging Configuration.
DeleteMediaAssetResponse	deleteMediaAsset(DeleteMediaAssetRequest request) Deletes a MediaAsset resource by identifier.
DeleteMediaAssetDistributionChannelAttachmentResponse	deleteMediaAssetDistributionChannelAttachment(DeleteMediaAssetDistributionChannelAttachmentRequest request) Deletes a MediaAsset from the DistributionChannel by identifiers.
DeleteMediaWorkflowResponse	deleteMediaWorkflow(DeleteMediaWorkflowRequest request) The MediaWorkflow lifecycleState will change to DELETED.
DeleteMediaWorkflowConfigurationResponse	deleteMediaWorkflowConfiguration(DeleteMediaWorkflowConfigurationRequest request) Deletes a MediaWorkflowConfiguration resource by identifier.
DeleteMediaWorkflowJobResponse	deleteMediaWorkflowJob(DeleteMediaWorkflowJobRequest request) This is an asynchronous operation.
DeleteStreamCdnConfigResponse	deleteStreamCdnConfig(DeleteStreamCdnConfigRequest request) The StreamCdnConfig lifecycleState will change to DELETED.
DeleteStreamDistributionChannelResponse	deleteStreamDistributionChannel(DeleteStreamDistributionChannelRequest request) The Stream Distribution Channel lifecycleState will change to DELETED.
DeleteStreamPackagingConfigResponse	deleteStreamPackagingConfig(DeleteStreamPackagingConfigRequest request) The Stream Packaging Configuration lifecycleState will change to DELETED.
String	getClientCommonLibraryVersion()
protected ClientConfigurator	getDefaultConfigurator()
String	getEndpoint()
GetMediaAssetResponse	getMediaAsset(GetMediaAssetRequest request) Gets a MediaAsset by identifier.
GetMediaAssetDistributionChannelAttachmentResponse	getMediaAssetDistributionChannelAttachment(GetMediaAssetDistributionChannelAttachmentRequest request) Gets a MediaAssetDistributionChannelAttachment for a MediaAsset by identifiers.
GetMediaWorkflowResponse	getMediaWorkflow(GetMediaWorkflowRequest request) Gets a MediaWorkflow by identifier.
GetMediaWorkflowConfigurationResponse	getMediaWorkflowConfiguration(GetMediaWorkflowConfigurationRequest request) Gets a MediaWorkflowConfiguration by identifier
GetMediaWorkflowJobResponse	getMediaWorkflowJob(GetMediaWorkflowJobRequest request) Gets the MediaWorkflowJob.
Optional<String>	getMinimumClientCommonLibraryVersionFromClient()
MediaServicesPaginators	getPaginators() Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
GetStreamCdnConfigResponse	getStreamCdnConfig(GetStreamCdnConfigRequest request) Gets a StreamCdnConfig by identifier.
GetStreamDistributionChannelResponse	getStreamDistributionChannel(GetStreamDistributionChannelRequest request) Gets a Stream Distribution Channel by identifier.
GetStreamPackagingConfigResponse	getStreamPackagingConfig(GetStreamPackagingConfigRequest request) Gets a Stream Packaging Configuration by identifier.
MediaServicesWaiters	getWaiters() Gets the pre-configured waiters available for resources for this service.
IngestStreamDistributionChannelResponse	ingestStreamDistributionChannel(IngestStreamDistributionChannelRequest request) Ingests an Asset into a Distribution Channel.
ListMediaAssetDistributionChannelAttachmentsResponse	listMediaAssetDistributionChannelAttachments(ListMediaAssetDistributionChannelAttachmentsRequest request) Lists the MediaAssetDistributionChannelAttachments for a MediaAsset by identifier.
ListMediaAssetsResponse	listMediaAssets(ListMediaAssetsRequest request) Returns a list of MediaAssetSummary.
ListMediaWorkflowConfigurationsResponse	listMediaWorkflowConfigurations(ListMediaWorkflowConfigurationsRequest request) Returns a list of MediaWorkflowConfigurations.
ListMediaWorkflowJobsResponse	listMediaWorkflowJobs(ListMediaWorkflowJobsRequest request) Lists the MediaWorkflowJobs.
ListMediaWorkflowsResponse	listMediaWorkflows(ListMediaWorkflowsRequest request) Lists the MediaWorkflows.
ListMediaWorkflowTaskDeclarationsResponse	listMediaWorkflowTaskDeclarations(ListMediaWorkflowTaskDeclarationsRequest request) Returns a list of MediaWorkflowTaskDeclarations.
ListStreamCdnConfigsResponse	listStreamCdnConfigs(ListStreamCdnConfigsRequest request) Lists the StreamCdnConfig.
ListStreamDistributionChannelsResponse	listStreamDistributionChannels(ListStreamDistributionChannelsRequest request) Lists the Stream Distribution Channels.
ListStreamPackagingConfigsResponse	listStreamPackagingConfigs(ListStreamPackagingConfigsRequest request) Lists the Stream Packaging Configurations.
ListSystemMediaWorkflowsResponse	listSystemMediaWorkflows(ListSystemMediaWorkflowsRequest request) Lists the SystemMediaWorkflows that can be used to run a job by name or as a template to create a MediaWorkflow.
void	populateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap) Populate the parameters in the endpoint with its corresponding value and update the base endpoint.
void	refreshClient() Rebuild the backing HttpClient.
RemoveMediaAssetLockResponse	removeMediaAssetLock(RemoveMediaAssetLockRequest request) Remove a lock to an MediaAsset.
RemoveMediaWorkflowConfigurationLockResponse	removeMediaWorkflowConfigurationLock(RemoveMediaWorkflowConfigurationLockRequest request) Remove a lock from a MediaWorkflowConfiguration.
RemoveMediaWorkflowJobLockResponse	removeMediaWorkflowJobLock(RemoveMediaWorkflowJobLockRequest request) Remove a lock from a MediaWorkflowJob.
RemoveMediaWorkflowLockResponse	removeMediaWorkflowLock(RemoveMediaWorkflowLockRequest request) Remove a lock from a MediaWorkflow.
RemoveStreamCdnConfigLockResponse	removeStreamCdnConfigLock(RemoveStreamCdnConfigLockRequest request) Remove a lock from a StreamCdnConfig.
RemoveStreamDistributionChannelLockResponse	removeStreamDistributionChannelLock(RemoveStreamDistributionChannelLockRequest request) Remove a lock to a StreamDistributionChannel.
RemoveStreamPackagingConfigLockResponse	removeStreamPackagingConfigLock(RemoveStreamPackagingConfigLockRequest request) Remove a lock from a StreamPackagingConfig.
void	setEndpoint(String endpoint)
void	setRegion(Region region) Sets the region to call (ex, Region.US_PHOENIX_1).
void	setRegion(String regionId) Sets the region to call (ex, ‘us-phoenix-1’).
void	updateBaseEndpoint(String endpoint) This method should be used for parameterized endpoint templates only.
UpdateMediaAssetResponse	updateMediaAsset(UpdateMediaAssetRequest request) Updates the MediaAsset.
UpdateMediaWorkflowResponse	updateMediaWorkflow(UpdateMediaWorkflowRequest request) Updates the MediaWorkflow.
UpdateMediaWorkflowConfigurationResponse	updateMediaWorkflowConfiguration(UpdateMediaWorkflowConfigurationRequest request) Updates the MediaWorkflowConfiguration.
UpdateMediaWorkflowJobResponse	updateMediaWorkflowJob(UpdateMediaWorkflowJobRequest request) Updates the MediaWorkflowJob.
UpdateStreamCdnConfigResponse	updateStreamCdnConfig(UpdateStreamCdnConfigRequest request) Updates the StreamCdnConfig.
UpdateStreamDistributionChannelResponse	updateStreamDistributionChannel(UpdateStreamDistributionChannelRequest request) Updates the Stream Distribution Channel.
UpdateStreamPackagingConfigResponse	updateStreamPackagingConfig(UpdateStreamPackagingConfigRequest request) Updates the Stream Packaging Configuration.
void	useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled) This method should be used to enable or disable the use of realm-specific endpoint template.

Methods inherited from class com.oracle.bmc.http.internal.BaseSyncClient

clientCall

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.oracle.bmc.mediaservices.MediaServices

getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

Methods inherited from interface java.lang.AutoCloseable

close

Field Detail

SERVICE

public static final Service SERVICE

Service instance for MediaServices.

clientCommonLibraryVersion

public final String clientCommonLibraryVersion

Compatible SDK version, provided by the codegen.

minimumClientCommonLibraryVersionFromClient

public final Optional<String> minimumClientCommonLibraryVersionFromClient

Minimum compatible SDK version, maybe provided by the codegen.

Constructor Detail

MediaServicesClient

@Deprecated
public MediaServicesClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see MediaServicesClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

MediaServicesClient

@Deprecated
public MediaServicesClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                       ClientConfiguration configuration)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see MediaServicesClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

MediaServicesClient

@Deprecated
public MediaServicesClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                       ClientConfiguration configuration,
                                       ClientConfigurator clientConfigurator)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see MediaServicesClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

MediaServicesClient

@Deprecated
public MediaServicesClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                       ClientConfiguration configuration,
                                       ClientConfigurator clientConfigurator,
                                       RequestSignerFactory defaultRequestSignerFactory)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see MediaServicesClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

MediaServicesClient

@Deprecated
public MediaServicesClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                       ClientConfiguration configuration,
                                       ClientConfigurator clientConfigurator,
                                       RequestSignerFactory defaultRequestSignerFactory,
                                       List<ClientConfigurator> additionalClientConfigurators)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see MediaServicesClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

MediaServicesClient

@Deprecated
public MediaServicesClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                       ClientConfiguration configuration,
                                       ClientConfigurator clientConfigurator,
                                       RequestSignerFactory defaultRequestSignerFactory,
                                       List<ClientConfigurator> additionalClientConfigurators,
                                       String endpoint)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see MediaServicesClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

endpoint - ClientBuilderBase.endpoint(java.lang.String)

MediaServicesClient

@Deprecated
public MediaServicesClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                       ClientConfiguration configuration,
                                       ClientConfigurator clientConfigurator,
                                       RequestSignerFactory defaultRequestSignerFactory,
                                       Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                                       List<ClientConfigurator> additionalClientConfigurators,
                                       String endpoint)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see MediaServicesClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

endpoint - ClientBuilderBase.endpoint(java.lang.String)

signingStrategyRequestSignerFactories - ClientBuilderBase.signingStrategyRequestSignerFactories

MediaServicesClient

@Deprecated
public MediaServicesClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                       ClientConfiguration configuration,
                                       ClientConfigurator clientConfigurator,
                                       RequestSignerFactory defaultRequestSignerFactory,
                                       Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                                       List<ClientConfigurator> additionalClientConfigurators,
                                       String endpoint,
                                       ExecutorService executorService)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see MediaServicesClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

endpoint - ClientBuilderBase.endpoint(java.lang.String)

signingStrategyRequestSignerFactories - ClientBuilderBase.signingStrategyRequestSignerFactories

executorService - MediaServicesClient.Builder.executorService

Method Detail

builder

public static MediaServicesClient.Builder builder()

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: MediaServices

Sets the region to call (ex, Region.US_PHOENIX_1).

Note, this will call setEndpoint after resolving the endpoint. If the service is not available in this Region, however, an IllegalArgumentException will be raised.

Specified by:

setRegion in interface MediaServices

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: MediaServices

Sets the region to call (ex, ‘us-phoenix-1’).

Note, this will first try to map the region ID to a known Region and call setRegion.

If no known Region could be determined, it will create an endpoint based on the default endpoint format (Region.formatDefaultRegionEndpoint(Service, String) and then call setEndpoint.

Specified by:

setRegion in interface MediaServices

Parameters:

regionId - The public region ID.

addMediaAssetLock

public AddMediaAssetLockResponse addMediaAssetLock(AddMediaAssetLockRequest request)

Description copied from interface: MediaServices

Add a lock to an MediaAsset.

Specified by:

addMediaAssetLock in interface MediaServices

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

addMediaWorkflowConfigurationLock

public AddMediaWorkflowConfigurationLockResponse addMediaWorkflowConfigurationLock(AddMediaWorkflowConfigurationLockRequest request)

Description copied from interface: MediaServices

Add a lock to a MediaWorkflowConfiguration.

Specified by:

addMediaWorkflowConfigurationLock in interface MediaServices

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

addMediaWorkflowJobLock

public AddMediaWorkflowJobLockResponse addMediaWorkflowJobLock(AddMediaWorkflowJobLockRequest request)

Description copied from interface: MediaServices

Add a lock to a MediaWorkflowJob.

Specified by:

addMediaWorkflowJobLock in interface MediaServices

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

addMediaWorkflowLock

public AddMediaWorkflowLockResponse addMediaWorkflowLock(AddMediaWorkflowLockRequest request)

Description copied from interface: MediaServices

Add a lock to a MediaWorkflow.

Specified by:

addMediaWorkflowLock in interface MediaServices

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

addStreamCdnConfigLock

public AddStreamCdnConfigLockResponse addStreamCdnConfigLock(AddStreamCdnConfigLockRequest request)

Description copied from interface: MediaServices

Add a lock to a StreamCdnConfig.

Specified by:

addStreamCdnConfigLock in interface MediaServices

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

addStreamDistributionChannelLock

public AddStreamDistributionChannelLockResponse addStreamDistributionChannelLock(AddStreamDistributionChannelLockRequest request)

Description copied from interface: MediaServices

Add a lock to a StreamDistributionChannel.

Specified by:

addStreamDistributionChannelLock in interface MediaServices

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

addStreamPackagingConfigLock

public AddStreamPackagingConfigLockResponse addStreamPackagingConfigLock(AddStreamPackagingConfigLockRequest request)

Description copied from interface: MediaServices

Add a lock to a StreamPackagingConfig.

Specified by:

addStreamPackagingConfigLock in interface MediaServices

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

changeMediaAssetCompartment

public ChangeMediaAssetCompartmentResponse changeMediaAssetCompartment(ChangeMediaAssetCompartmentRequest request)

Description copied from interface: MediaServices

Moves a MediaAsset resource from one compartment identifier to another.

Specified by:

changeMediaAssetCompartment in interface MediaServices

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

changeMediaWorkflowCompartment

public ChangeMediaWorkflowCompartmentResponse changeMediaWorkflowCompartment(ChangeMediaWorkflowCompartmentRequest request)

Description copied from interface: MediaServices

Moves a MediaWorkflow resource from one compartment identifier to another.

Specified by:

changeMediaWorkflowCompartment in interface MediaServices

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

changeMediaWorkflowConfigurationCompartment

public ChangeMediaWorkflowConfigurationCompartmentResponse changeMediaWorkflowConfigurationCompartment(ChangeMediaWorkflowConfigurationCompartmentRequest request)

Description copied from interface: MediaServices

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

Specified by:

changeMediaWorkflowConfigurationCompartment in interface MediaServices

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

changeMediaWorkflowJobCompartment

public ChangeMediaWorkflowJobCompartmentResponse changeMediaWorkflowJobCompartment(ChangeMediaWorkflowJobCompartmentRequest request)

Description copied from interface: MediaServices

Moves a MediaWorkflowJob resource from one compartment identifier to another.

Specified by:

changeMediaWorkflowJobCompartment in interface MediaServices

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

changeStreamDistributionChannelCompartment

public ChangeStreamDistributionChannelCompartmentResponse changeStreamDistributionChannelCompartment(ChangeStreamDistributionChannelCompartmentRequest request)

Description copied from interface: MediaServices

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

Specified by:

changeStreamDistributionChannelCompartment in interface MediaServices

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createMediaAsset

public CreateMediaAssetResponse createMediaAsset(CreateMediaAssetRequest request)

Description copied from interface: MediaServices

Creates a new MediaAsset.

Specified by:

createMediaAsset in interface MediaServices

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createMediaWorkflow

public CreateMediaWorkflowResponse createMediaWorkflow(CreateMediaWorkflowRequest request)

Description copied from interface: MediaServices

Creates a new MediaWorkflow.

Specified by:

createMediaWorkflow in interface MediaServices

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createMediaWorkflowConfiguration

public CreateMediaWorkflowConfigurationResponse createMediaWorkflowConfiguration(CreateMediaWorkflowConfigurationRequest request)

Description copied from interface: MediaServices

Creates a new MediaWorkflowConfiguration.

Specified by:

createMediaWorkflowConfiguration in interface MediaServices

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createMediaWorkflowJob

public CreateMediaWorkflowJobResponse createMediaWorkflowJob(CreateMediaWorkflowJobRequest request)

Description copied from interface: MediaServices

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

Specified by:

createMediaWorkflowJob in interface MediaServices

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createStreamCdnConfig

public CreateStreamCdnConfigResponse createStreamCdnConfig(CreateStreamCdnConfigRequest request)

Description copied from interface: MediaServices

Creates a new CDN Configuration.

Specified by:

createStreamCdnConfig in interface MediaServices

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createStreamDistributionChannel

public CreateStreamDistributionChannelResponse createStreamDistributionChannel(CreateStreamDistributionChannelRequest request)

Description copied from interface: MediaServices

Creates a new Stream Distribution Channel.

Specified by:

createStreamDistributionChannel in interface MediaServices

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createStreamPackagingConfig

public CreateStreamPackagingConfigResponse createStreamPackagingConfig(CreateStreamPackagingConfigRequest request)

Description copied from interface: MediaServices

Creates a new Packaging Configuration.

Specified by:

createStreamPackagingConfig in interface MediaServices

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteMediaAsset

public DeleteMediaAssetResponse deleteMediaAsset(DeleteMediaAssetRequest request)

Description copied from interface: MediaServices

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.

Specified by:

deleteMediaAsset in interface MediaServices

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteMediaAssetDistributionChannelAttachment

public DeleteMediaAssetDistributionChannelAttachmentResponse deleteMediaAssetDistributionChannelAttachment(DeleteMediaAssetDistributionChannelAttachmentRequest request)

Description copied from interface: MediaServices

Deletes a MediaAsset from the DistributionChannel by identifiers.

Specified by:

deleteMediaAssetDistributionChannelAttachment in interface MediaServices

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteMediaWorkflow

public DeleteMediaWorkflowResponse deleteMediaWorkflow(DeleteMediaWorkflowRequest request)

Description copied from interface: MediaServices

The MediaWorkflow lifecycleState will change to DELETED.

Specified by:

deleteMediaWorkflow in interface MediaServices

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteMediaWorkflowConfiguration

public DeleteMediaWorkflowConfigurationResponse deleteMediaWorkflowConfiguration(DeleteMediaWorkflowConfigurationRequest request)

Description copied from interface: MediaServices

Deletes a MediaWorkflowConfiguration resource by identifier.

Specified by:

deleteMediaWorkflowConfiguration in interface MediaServices

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteMediaWorkflowJob

public DeleteMediaWorkflowJobResponse deleteMediaWorkflowJob(DeleteMediaWorkflowJobRequest request)

Description copied from interface: MediaServices

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

Specified by:

deleteMediaWorkflowJob in interface MediaServices

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteStreamCdnConfig

public DeleteStreamCdnConfigResponse deleteStreamCdnConfig(DeleteStreamCdnConfigRequest request)

Description copied from interface: MediaServices

The StreamCdnConfig lifecycleState will change to DELETED.

Specified by:

deleteStreamCdnConfig in interface MediaServices

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteStreamDistributionChannel

public DeleteStreamDistributionChannelResponse deleteStreamDistributionChannel(DeleteStreamDistributionChannelRequest request)

Description copied from interface: MediaServices

The Stream Distribution Channel lifecycleState will change to DELETED.

Specified by:

deleteStreamDistributionChannel in interface MediaServices

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteStreamPackagingConfig

public DeleteStreamPackagingConfigResponse deleteStreamPackagingConfig(DeleteStreamPackagingConfigRequest request)

Description copied from interface: MediaServices

The Stream Packaging Configuration lifecycleState will change to DELETED.

Specified by:

deleteStreamPackagingConfig in interface MediaServices

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getMediaAsset

public GetMediaAssetResponse getMediaAsset(GetMediaAssetRequest request)

Description copied from interface: MediaServices

Gets a MediaAsset by identifier.

Specified by:

getMediaAsset in interface MediaServices

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getMediaAssetDistributionChannelAttachment

public GetMediaAssetDistributionChannelAttachmentResponse getMediaAssetDistributionChannelAttachment(GetMediaAssetDistributionChannelAttachmentRequest request)

Description copied from interface: MediaServices

Gets a MediaAssetDistributionChannelAttachment for a MediaAsset by identifiers.

Specified by:

getMediaAssetDistributionChannelAttachment in interface MediaServices

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getMediaWorkflow

public GetMediaWorkflowResponse getMediaWorkflow(GetMediaWorkflowRequest request)

Description copied from interface: MediaServices

Gets a MediaWorkflow by identifier.

Specified by:

getMediaWorkflow in interface MediaServices

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getMediaWorkflowConfiguration

public GetMediaWorkflowConfigurationResponse getMediaWorkflowConfiguration(GetMediaWorkflowConfigurationRequest request)

Description copied from interface: MediaServices

Gets a MediaWorkflowConfiguration by identifier

Specified by:

getMediaWorkflowConfiguration in interface MediaServices

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getMediaWorkflowJob

public GetMediaWorkflowJobResponse getMediaWorkflowJob(GetMediaWorkflowJobRequest request)

Description copied from interface: MediaServices

Gets the MediaWorkflowJob.

Specified by:

getMediaWorkflowJob in interface MediaServices

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getStreamCdnConfig

public GetStreamCdnConfigResponse getStreamCdnConfig(GetStreamCdnConfigRequest request)

Description copied from interface: MediaServices

Gets a StreamCdnConfig by identifier.

Specified by:

getStreamCdnConfig in interface MediaServices

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getStreamDistributionChannel

public GetStreamDistributionChannelResponse getStreamDistributionChannel(GetStreamDistributionChannelRequest request)

Description copied from interface: MediaServices

Gets a Stream Distribution Channel by identifier.

Specified by:

getStreamDistributionChannel in interface MediaServices

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getStreamPackagingConfig

public GetStreamPackagingConfigResponse getStreamPackagingConfig(GetStreamPackagingConfigRequest request)

Description copied from interface: MediaServices

Gets a Stream Packaging Configuration by identifier.

Specified by:

getStreamPackagingConfig in interface MediaServices

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

ingestStreamDistributionChannel

public IngestStreamDistributionChannelResponse ingestStreamDistributionChannel(IngestStreamDistributionChannelRequest request)

Description copied from interface: MediaServices

Ingests an Asset into a Distribution Channel.

Specified by:

ingestStreamDistributionChannel in interface MediaServices

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listMediaAssetDistributionChannelAttachments

public ListMediaAssetDistributionChannelAttachmentsResponse listMediaAssetDistributionChannelAttachments(ListMediaAssetDistributionChannelAttachmentsRequest request)

Description copied from interface: MediaServices

Lists the MediaAssetDistributionChannelAttachments for a MediaAsset by identifier.

Specified by:

listMediaAssetDistributionChannelAttachments in interface MediaServices

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listMediaAssets

public ListMediaAssetsResponse listMediaAssets(ListMediaAssetsRequest request)

Description copied from interface: MediaServices

Returns a list of MediaAssetSummary.

Specified by:

listMediaAssets in interface MediaServices

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listMediaWorkflowConfigurations

public ListMediaWorkflowConfigurationsResponse listMediaWorkflowConfigurations(ListMediaWorkflowConfigurationsRequest request)

Description copied from interface: MediaServices

Returns a list of MediaWorkflowConfigurations.

Specified by:

listMediaWorkflowConfigurations in interface MediaServices

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listMediaWorkflowJobs

public ListMediaWorkflowJobsResponse listMediaWorkflowJobs(ListMediaWorkflowJobsRequest request)

Description copied from interface: MediaServices

Lists the MediaWorkflowJobs.

Specified by:

listMediaWorkflowJobs in interface MediaServices

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listMediaWorkflowTaskDeclarations

public ListMediaWorkflowTaskDeclarationsResponse listMediaWorkflowTaskDeclarations(ListMediaWorkflowTaskDeclarationsRequest request)

Description copied from interface: MediaServices

Returns a list of MediaWorkflowTaskDeclarations.

Specified by:

listMediaWorkflowTaskDeclarations in interface MediaServices

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listMediaWorkflows

public ListMediaWorkflowsResponse listMediaWorkflows(ListMediaWorkflowsRequest request)

Description copied from interface: MediaServices

Lists the MediaWorkflows.

Specified by:

listMediaWorkflows in interface MediaServices

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listStreamCdnConfigs

public ListStreamCdnConfigsResponse listStreamCdnConfigs(ListStreamCdnConfigsRequest request)

Description copied from interface: MediaServices

Lists the StreamCdnConfig.

Specified by:

listStreamCdnConfigs in interface MediaServices

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listStreamDistributionChannels

public ListStreamDistributionChannelsResponse listStreamDistributionChannels(ListStreamDistributionChannelsRequest request)

Description copied from interface: MediaServices

Lists the Stream Distribution Channels.

Specified by:

listStreamDistributionChannels in interface MediaServices

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listStreamPackagingConfigs

public ListStreamPackagingConfigsResponse listStreamPackagingConfigs(ListStreamPackagingConfigsRequest request)

Description copied from interface: MediaServices

Lists the Stream Packaging Configurations.

Specified by:

listStreamPackagingConfigs in interface MediaServices

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listSystemMediaWorkflows

public ListSystemMediaWorkflowsResponse listSystemMediaWorkflows(ListSystemMediaWorkflowsRequest request)

Description copied from interface: MediaServices

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

Specified by:

listSystemMediaWorkflows in interface MediaServices

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

removeMediaAssetLock

public RemoveMediaAssetLockResponse removeMediaAssetLock(RemoveMediaAssetLockRequest request)

Description copied from interface: MediaServices

Remove a lock to an MediaAsset.

Specified by:

removeMediaAssetLock in interface MediaServices

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

removeMediaWorkflowConfigurationLock

public RemoveMediaWorkflowConfigurationLockResponse removeMediaWorkflowConfigurationLock(RemoveMediaWorkflowConfigurationLockRequest request)

Description copied from interface: MediaServices

Remove a lock from a MediaWorkflowConfiguration.

Specified by:

removeMediaWorkflowConfigurationLock in interface MediaServices

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

removeMediaWorkflowJobLock

public RemoveMediaWorkflowJobLockResponse removeMediaWorkflowJobLock(RemoveMediaWorkflowJobLockRequest request)

Description copied from interface: MediaServices

Remove a lock from a MediaWorkflowJob.

Specified by:

removeMediaWorkflowJobLock in interface MediaServices

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

removeMediaWorkflowLock

public RemoveMediaWorkflowLockResponse removeMediaWorkflowLock(RemoveMediaWorkflowLockRequest request)

Description copied from interface: MediaServices

Remove a lock from a MediaWorkflow.

Specified by:

removeMediaWorkflowLock in interface MediaServices

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

removeStreamCdnConfigLock

public RemoveStreamCdnConfigLockResponse removeStreamCdnConfigLock(RemoveStreamCdnConfigLockRequest request)

Description copied from interface: MediaServices

Remove a lock from a StreamCdnConfig.

Specified by:

removeStreamCdnConfigLock in interface MediaServices

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

removeStreamDistributionChannelLock

public RemoveStreamDistributionChannelLockResponse removeStreamDistributionChannelLock(RemoveStreamDistributionChannelLockRequest request)

Description copied from interface: MediaServices

Remove a lock to a StreamDistributionChannel.

Specified by:

removeStreamDistributionChannelLock in interface MediaServices

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

removeStreamPackagingConfigLock

public RemoveStreamPackagingConfigLockResponse removeStreamPackagingConfigLock(RemoveStreamPackagingConfigLockRequest request)

Description copied from interface: MediaServices

Remove a lock from a StreamPackagingConfig.

Specified by:

removeStreamPackagingConfigLock in interface MediaServices

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateMediaAsset

public UpdateMediaAssetResponse updateMediaAsset(UpdateMediaAssetRequest request)

Description copied from interface: MediaServices

Updates the MediaAsset.

Specified by:

updateMediaAsset in interface MediaServices

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateMediaWorkflow

public UpdateMediaWorkflowResponse updateMediaWorkflow(UpdateMediaWorkflowRequest request)

Description copied from interface: MediaServices

Updates the MediaWorkflow.

Specified by:

updateMediaWorkflow in interface MediaServices

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateMediaWorkflowConfiguration

public UpdateMediaWorkflowConfigurationResponse updateMediaWorkflowConfiguration(UpdateMediaWorkflowConfigurationRequest request)

Description copied from interface: MediaServices

Updates the MediaWorkflowConfiguration.

Specified by:

updateMediaWorkflowConfiguration in interface MediaServices

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateMediaWorkflowJob

public UpdateMediaWorkflowJobResponse updateMediaWorkflowJob(UpdateMediaWorkflowJobRequest request)

Description copied from interface: MediaServices

Updates the MediaWorkflowJob.

Specified by:

updateMediaWorkflowJob in interface MediaServices

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateStreamCdnConfig

public UpdateStreamCdnConfigResponse updateStreamCdnConfig(UpdateStreamCdnConfigRequest request)

Description copied from interface: MediaServices

Updates the StreamCdnConfig.

Specified by:

updateStreamCdnConfig in interface MediaServices

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateStreamDistributionChannel

public UpdateStreamDistributionChannelResponse updateStreamDistributionChannel(UpdateStreamDistributionChannelRequest request)

Description copied from interface: MediaServices

Updates the Stream Distribution Channel.

Specified by:

updateStreamDistributionChannel in interface MediaServices

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateStreamPackagingConfig

public UpdateStreamPackagingConfigResponse updateStreamPackagingConfig(UpdateStreamPackagingConfigRequest request)

Description copied from interface: MediaServices

Updates the Stream Packaging Configuration.

Specified by:

updateStreamPackagingConfig in interface MediaServices

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getWaiters

public MediaServicesWaiters getWaiters()

Description copied from interface: MediaServices

Gets the pre-configured waiters available for resources for this service.

Specified by:

getWaiters in interface MediaServices

Returns:

The service waiters.

getPaginators

public MediaServicesPaginators getPaginators()

Description copied from interface: MediaServices

Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data. These paginators provide an Iterable interface so that service responses, or resources/records, can be iterated through without having to manually deal with pagination and page tokens.

Specified by:

getPaginators in interface MediaServices

Returns:

The service paginators.

getDefaultConfigurator

protected ClientConfigurator getDefaultConfigurator()

useRealmSpecificEndpointTemplate

public void useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)

This method should be used to enable or disable the use of realm-specific endpoint template. The default value is null. To enable the use of endpoint template defined for the realm in use, set the flag to true To disable the use of endpoint template defined for the realm in use, set the flag to false

Parameters:

useOfRealmSpecificEndpointTemplateEnabled - This flag can be set to true or false to enable or disable the use of realm-specific endpoint template respectively

populateServiceParametersInEndpoint

public final void populateServiceParametersInEndpoint(String endpoint,
                                                      Map<String,Object> requiredParametersMap)

Populate the parameters in the endpoint with its corresponding value and update the base endpoint. The value will be populated iff the parameter in endpoint is a required request path parameter or a required request query parameter. If not, the parameter in the endpoint will be ignored and left blank.

Parameters:

endpoint - The endpoint template in use

requiredParametersMap - Map of parameter name as key and value set in request path or query parameter as value

updateBaseEndpoint

public final void updateBaseEndpoint(String endpoint)

This method should be used for parameterized endpoint templates only. This does not include {region} and {secondLevelDomain} parameters.

Parameters:

endpoint - The updated endpoint to use

setEndpoint

public final void setEndpoint(String endpoint)

getEndpoint

public final String getEndpoint()

refreshClient

public final void refreshClient()

Rebuild the backing HttpClient. This will call ClientConfigurators again, and can be used to e.g. refresh the SSL certificate.

close

public final void close()

Specified by:

close in interface AutoCloseable

getClientCommonLibraryVersion

public String getClientCommonLibraryVersion()

getMinimumClientCommonLibraryVersionFromClient

public Optional<String> getMinimumClientCommonLibraryVersionFromClient()