Web Service: CdnConfigurationService

Port type CdnConfigurationServiceInterfaceSource code

1. createCdnConfigurations
   Source code
   Description:
   Creates new {@link CdnConfiguration} objects.
   Operation type:
   Request-response. The endpoint receives a message, and sends a correlated message.
   Input:
   createCdnConfigurationsRequest (wsdlsoap:header, use = literal, part = RequestHeader)Source code
   parameters type createCdnConfigurations

   Creates new {@link CdnConfiguration} objects.

   • cdnConfigurations - optional, unbounded; type CdnConfiguration
     A {@link CdnConfiguration} encapsulates information about where and how to ingest and deliver content enabled for DAI (Dynamic Ad Insertion).
     • id - optional; type long
       The unique ID of the {@link CdnConfiguration}. This value is read-only and is assigned by Google.
     • name - optional; type string
       The name of the {@link CdnConfiguration}. This value is required to create a CDN configuration and has a maximum length of 255 characters.
     • cdnConfigurationType - optional; type CdnConfigurationType - type string with restriction - enum { 'UNKNOWN', 'LIVE_STREAM_SOURCE_CONTENT' }
       The type of CDN configuration represented by this {@link CdnConfiguration}. This value is required to create a CDN configuration
     • sourceContentConfiguration - optional; type SourceContentConfiguration
       Parameters about this CDN configuration as a source of content. This facilitates fetching the original content for conditioning and delivering the original content as part of a modified stream.
       Parameters about this CDN configuration as a source of content. This facilitates fetching the original content for conditioning and delivering the original content as part of a modified stream.
       • ingestSettings - optional; type MediaLocationSettings
         Configuration that associates a media location with a security policy and the authentication credentials needed to access the content.
         • name - optional; type string
           The name of the media location. This value is read-only and is assigned by Google.
         • urlPrefix - optional; type string
           The url prefix of the media location. This value is required for a valid media location.
         • securityPolicy - optional; type SecurityPolicySettings
           The security policy and authentication credentials needed to access the content in this media location. This value is required for a valid media location.
           A set of security requirements to authenticate against in order to access video content. Different locations (e.g. different CDNs) can have different security policies.
           • securityPolicyType - optional; type SecurityPolicyType - type string with restriction - enum { 'UNKNOWN', 'NONE', 'AKAMAI', 'CLOUD_MEDIA' }
             Type of security policy. This determines which other fields should be populated. This value is required for a valid security policy.
           • tokenAuthenticationKey - optional; type string
             Shared security key used to generate the Akamai HMAC token for authenticating requests. This field is only applicable when the value of {@link #securityPolicyType} is equal to {@link SecurityPolicyType#AKAMAI} and will be set to null otherwise.

             This field is required when the {@link CdnConfiguration#cdnConfigurationType} is equal to {@link CdnConfigurationType#LIVE_STREAM_SOURCE_CONTENT} and this {@link SecurityPolicyDto} is being configured for {@link SourceContentConfiguration#ingestSettings}.

           • disableServerSideUrlSigning - optional; type boolean
             Whether the segment URLs should be signed using the {@link #tokenAuthenticationKey} on the server. This is only applicable for delivery media locations that have token authentication enabled.
           • originForwardingType - optional; type OriginForwardingType - type string with restriction - enum { 'ORIGIN_PATH', 'CONVENTIONAL', 'NONE', 'UNKNOWN' }
             The type of origin forwarding used to support Akamai authentication policies for the master playlist. This field is not applicable to ingest locations, and is only applicable to delivery media locations with the {@link #securityPolicyType} set to {@link SecurityPolicyType#AKAMAI}. If set elsewhere it will be reset to null.
           • originPathPrefix - optional; type string
             The origin path prefix provided by the publisher for the master playlist. This field is only applicable for delivery media locations with the value of {@link #originForwardingType} set to {@link OriginForwardingType#CONVENTIONAL}, and will be set to null otherwise.
           • mediaPlaylistOriginForwardingType - optional; type OriginForwardingType - type string with restriction - enum { 'ORIGIN_PATH', 'CONVENTIONAL', 'NONE', 'UNKNOWN' }
             The type of origin forwarding used to support Akamai authentication policies for media playlists. This setting can only be used with CDN configurations with a {@code cdnConfigurationType} of {@link CdnConfigurationType#LIVE_STREAM_SOURCE_CONTENT}, is not applicable to ingest locations, and is only applicable to delivery media locations with the {@link #securityPolicyType} set to {@link SecurityPolicyType#AKAMAI}. Valid options are {@code OriginForwardingType#NONE} or {@code OriginForwardingType#ORIGIN_PATH}.

             This setting can only be used with CDN configurations with a {@code cdnConfigurationType} of {@link CdnConfigurationType#LIVE_STREAM_SOURCE_CONTENT}.

           • mediaPlaylistOriginPathPrefix - optional; type string
             The origin path prefix provided by the publisher for the media playlists. This field is only applicable for delivery media locations with the value of {@link #mediaPlaylistOriginForwardingType} set to {@link OriginForwardingType#CONVENTIONAL}, and will be set to null otherwise.
           • keysetName - optional; type string
             The name of the EdgeCacheKeyset on the Media CDN configuration that will be used to validate signed requests from DAI to ingest content.
           • signedRequestExpirationTtlSeconds - optional; type long
             The amount of time in seconds for which a request signed with a short token will be valid. Only required if signedRequestMaximumExpirationTtl has been set in the Media CDN configuration.
         Configuration for how DAI should ingest media. At ingest time, we match the url prefix of media in a stream's playlist with an ingest location and use the authentication credentials from the corresponding ingest settings to download the media. This value is required for a valid source content configuration.
       • defaultDeliverySettings - optional; type MediaLocationSettings
         Configuration that associates a media location with a security policy and the authentication credentials needed to access the content.
         • name - optional; type string
           The name of the media location. This value is read-only and is assigned by Google.
         • urlPrefix - optional; type string
           The url prefix of the media location. This value is required for a valid media location.
         • securityPolicy - optional; type SecurityPolicySettings
           The security policy and authentication credentials needed to access the content in this media location. This value is required for a valid media location.
           A set of security requirements to authenticate against in order to access video content. Different locations (e.g. different CDNs) can have different security policies.
           • securityPolicyType - optional; type SecurityPolicyType - type string with restriction - enum { 'UNKNOWN', 'NONE', 'AKAMAI', 'CLOUD_MEDIA' }
             Type of security policy. This determines which other fields should be populated. This value is required for a valid security policy.
           • tokenAuthenticationKey - optional; type string
             Shared security key used to generate the Akamai HMAC token for authenticating requests. This field is only applicable when the value of {@link #securityPolicyType} is equal to {@link SecurityPolicyType#AKAMAI} and will be set to null otherwise.

             This field is required when the {@link CdnConfiguration#cdnConfigurationType} is equal to {@link CdnConfigurationType#LIVE_STREAM_SOURCE_CONTENT} and this {@link SecurityPolicyDto} is being configured for {@link SourceContentConfiguration#ingestSettings}.

           • disableServerSideUrlSigning - optional; type boolean
             Whether the segment URLs should be signed using the {@link #tokenAuthenticationKey} on the server. This is only applicable for delivery media locations that have token authentication enabled.
           • originForwardingType - optional; type OriginForwardingType - type string with restriction - enum { 'ORIGIN_PATH', 'CONVENTIONAL', 'NONE', 'UNKNOWN' }
             The type of origin forwarding used to support Akamai authentication policies for the master playlist. This field is not applicable to ingest locations, and is only applicable to delivery media locations with the {@link #securityPolicyType} set to {@link SecurityPolicyType#AKAMAI}. If set elsewhere it will be reset to null.
           • originPathPrefix - optional; type string
             The origin path prefix provided by the publisher for the master playlist. This field is only applicable for delivery media locations with the value of {@link #originForwardingType} set to {@link OriginForwardingType#CONVENTIONAL}, and will be set to null otherwise.
           • mediaPlaylistOriginForwardingType - optional; type OriginForwardingType - type string with restriction - enum { 'ORIGIN_PATH', 'CONVENTIONAL', 'NONE', 'UNKNOWN' }
             The type of origin forwarding used to support Akamai authentication policies for media playlists. This setting can only be used with CDN configurations with a {@code cdnConfigurationType} of {@link CdnConfigurationType#LIVE_STREAM_SOURCE_CONTENT}, is not applicable to ingest locations, and is only applicable to delivery media locations with the {@link #securityPolicyType} set to {@link SecurityPolicyType#AKAMAI}. Valid options are {@code OriginForwardingType#NONE} or {@code OriginForwardingType#ORIGIN_PATH}.

             This setting can only be used with CDN configurations with a {@code cdnConfigurationType} of {@link CdnConfigurationType#LIVE_STREAM_SOURCE_CONTENT}.

           • mediaPlaylistOriginPathPrefix - optional; type string
             The origin path prefix provided by the publisher for the media playlists. This field is only applicable for delivery media locations with the value of {@link #mediaPlaylistOriginForwardingType} set to {@link OriginForwardingType#CONVENTIONAL}, and will be set to null otherwise.
           • keysetName - optional; type string
             The name of the EdgeCacheKeyset on the Media CDN configuration that will be used to validate signed requests from DAI to ingest content.
           • signedRequestExpirationTtlSeconds - optional; type long
             The amount of time in seconds for which a request signed with a short token will be valid. Only required if signedRequestMaximumExpirationTtl has been set in the Media CDN configuration.
         Default configuration for how DAI should deliver the non-modified media segments. At delivery time, we replace the ingest location's url prefix with the delivery location's URL prefix and use the security policy from the delivery settings to determine how DAI needs to deliver the media so that users can access it. This value is required for a valid source content configuration.
     • cdnConfigurationStatus - optional; type CdnConfigurationStatus - type string with restriction - enum { 'UNKNOWN', 'ACTIVE', 'ARCHIVED' }
       The status of the CDN configuration.
   Output:
   createCdnConfigurationsResponse (wsdlsoap:header, use = literal, part = ResponseHeader)Source code
   parameters type createCdnConfigurationsResponse

   • rval - optional, unbounded; type CdnConfiguration
     A {@link CdnConfiguration} encapsulates information about where and how to ingest and deliver content enabled for DAI (Dynamic Ad Insertion).
     • id - optional; type long
       The unique ID of the {@link CdnConfiguration}. This value is read-only and is assigned by Google.
     • name - optional; type string
       The name of the {@link CdnConfiguration}. This value is required to create a CDN configuration and has a maximum length of 255 characters.
     • cdnConfigurationType - optional; type CdnConfigurationType - type string with restriction - enum { 'UNKNOWN', 'LIVE_STREAM_SOURCE_CONTENT' }
       The type of CDN configuration represented by this {@link CdnConfiguration}. This value is required to create a CDN configuration
     • sourceContentConfiguration - optional; type SourceContentConfiguration
       Parameters about this CDN configuration as a source of content. This facilitates fetching the original content for conditioning and delivering the original content as part of a modified stream.
       Parameters about this CDN configuration as a source of content. This facilitates fetching the original content for conditioning and delivering the original content as part of a modified stream.
       • ingestSettings - optional; type MediaLocationSettings
         Configuration that associates a media location with a security policy and the authentication credentials needed to access the content.
         • name - optional; type string
           The name of the media location. This value is read-only and is assigned by Google.
         • urlPrefix - optional; type string
           The url prefix of the media location. This value is required for a valid media location.
         • securityPolicy - optional; type SecurityPolicySettings
           The security policy and authentication credentials needed to access the content in this media location. This value is required for a valid media location.
           A set of security requirements to authenticate against in order to access video content. Different locations (e.g. different CDNs) can have different security policies.
           • securityPolicyType - optional; type SecurityPolicyType - type string with restriction - enum { 'UNKNOWN', 'NONE', 'AKAMAI', 'CLOUD_MEDIA' }
             Type of security policy. This determines which other fields should be populated. This value is required for a valid security policy.
           • tokenAuthenticationKey - optional; type string
             Shared security key used to generate the Akamai HMAC token for authenticating requests. This field is only applicable when the value of {@link #securityPolicyType} is equal to {@link SecurityPolicyType#AKAMAI} and will be set to null otherwise.

             This field is required when the {@link CdnConfiguration#cdnConfigurationType} is equal to {@link CdnConfigurationType#LIVE_STREAM_SOURCE_CONTENT} and this {@link SecurityPolicyDto} is being configured for {@link SourceContentConfiguration#ingestSettings}.

           • disableServerSideUrlSigning - optional; type boolean
             Whether the segment URLs should be signed using the {@link #tokenAuthenticationKey} on the server. This is only applicable for delivery media locations that have token authentication enabled.
           • originForwardingType - optional; type OriginForwardingType - type string with restriction - enum { 'ORIGIN_PATH', 'CONVENTIONAL', 'NONE', 'UNKNOWN' }
             The type of origin forwarding used to support Akamai authentication policies for the master playlist. This field is not applicable to ingest locations, and is only applicable to delivery media locations with the {@link #securityPolicyType} set to {@link SecurityPolicyType#AKAMAI}. If set elsewhere it will be reset to null.
           • originPathPrefix - optional; type string
             The origin path prefix provided by the publisher for the master playlist. This field is only applicable for delivery media locations with the value of {@link #originForwardingType} set to {@link OriginForwardingType#CONVENTIONAL}, and will be set to null otherwise.
           • mediaPlaylistOriginForwardingType - optional; type OriginForwardingType - type string with restriction - enum { 'ORIGIN_PATH', 'CONVENTIONAL', 'NONE', 'UNKNOWN' }
             The type of origin forwarding used to support Akamai authentication policies for media playlists. This setting can only be used with CDN configurations with a {@code cdnConfigurationType} of {@link CdnConfigurationType#LIVE_STREAM_SOURCE_CONTENT}, is not applicable to ingest locations, and is only applicable to delivery media locations with the {@link #securityPolicyType} set to {@link SecurityPolicyType#AKAMAI}. Valid options are {@code OriginForwardingType#NONE} or {@code OriginForwardingType#ORIGIN_PATH}.

             This setting can only be used with CDN configurations with a {@code cdnConfigurationType} of {@link CdnConfigurationType#LIVE_STREAM_SOURCE_CONTENT}.

           • mediaPlaylistOriginPathPrefix - optional; type string
             The origin path prefix provided by the publisher for the media playlists. This field is only applicable for delivery media locations with the value of {@link #mediaPlaylistOriginForwardingType} set to {@link OriginForwardingType#CONVENTIONAL}, and will be set to null otherwise.
           • keysetName - optional; type string
             The name of the EdgeCacheKeyset on the Media CDN configuration that will be used to validate signed requests from DAI to ingest content.
           • signedRequestExpirationTtlSeconds - optional; type long
             The amount of time in seconds for which a request signed with a short token will be valid. Only required if signedRequestMaximumExpirationTtl has been set in the Media CDN configuration.
         Configuration for how DAI should ingest media. At ingest time, we match the url prefix of media in a stream's playlist with an ingest location and use the authentication credentials from the corresponding ingest settings to download the media. This value is required for a valid source content configuration.
       • defaultDeliverySettings - optional; type MediaLocationSettings
         Configuration that associates a media location with a security policy and the authentication credentials needed to access the content.
         • name - optional; type string
           The name of the media location. This value is read-only and is assigned by Google.
         • urlPrefix - optional; type string
           The url prefix of the media location. This value is required for a valid media location.
         • securityPolicy - optional; type SecurityPolicySettings
           The security policy and authentication credentials needed to access the content in this media location. This value is required for a valid media location.
           A set of security requirements to authenticate against in order to access video content. Different locations (e.g. different CDNs) can have different security policies.
           • securityPolicyType - optional; type SecurityPolicyType - type string with restriction - enum { 'UNKNOWN', 'NONE', 'AKAMAI', 'CLOUD_MEDIA' }
             Type of security policy. This determines which other fields should be populated. This value is required for a valid security policy.
           • tokenAuthenticationKey - optional; type string
             Shared security key used to generate the Akamai HMAC token for authenticating requests. This field is only applicable when the value of {@link #securityPolicyType} is equal to {@link SecurityPolicyType#AKAMAI} and will be set to null otherwise.

             This field is required when the {@link CdnConfiguration#cdnConfigurationType} is equal to {@link CdnConfigurationType#LIVE_STREAM_SOURCE_CONTENT} and this {@link SecurityPolicyDto} is being configured for {@link SourceContentConfiguration#ingestSettings}.

           • disableServerSideUrlSigning - optional; type boolean
             Whether the segment URLs should be signed using the {@link #tokenAuthenticationKey} on the server. This is only applicable for delivery media locations that have token authentication enabled.
           • originForwardingType - optional; type OriginForwardingType - type string with restriction - enum { 'ORIGIN_PATH', 'CONVENTIONAL', 'NONE', 'UNKNOWN' }
             The type of origin forwarding used to support Akamai authentication policies for the master playlist. This field is not applicable to ingest locations, and is only applicable to delivery media locations with the {@link #securityPolicyType} set to {@link SecurityPolicyType#AKAMAI}. If set elsewhere it will be reset to null.
           • originPathPrefix - optional; type string
             The origin path prefix provided by the publisher for the master playlist. This field is only applicable for delivery media locations with the value of {@link #originForwardingType} set to {@link OriginForwardingType#CONVENTIONAL}, and will be set to null otherwise.
           • mediaPlaylistOriginForwardingType - optional; type OriginForwardingType - type string with restriction - enum { 'ORIGIN_PATH', 'CONVENTIONAL', 'NONE', 'UNKNOWN' }
             The type of origin forwarding used to support Akamai authentication policies for media playlists. This setting can only be used with CDN configurations with a {@code cdnConfigurationType} of {@link CdnConfigurationType#LIVE_STREAM_SOURCE_CONTENT}, is not applicable to ingest locations, and is only applicable to delivery media locations with the {@link #securityPolicyType} set to {@link SecurityPolicyType#AKAMAI}. Valid options are {@code OriginForwardingType#NONE} or {@code OriginForwardingType#ORIGIN_PATH}.

             This setting can only be used with CDN configurations with a {@code cdnConfigurationType} of {@link CdnConfigurationType#LIVE_STREAM_SOURCE_CONTENT}.

           • mediaPlaylistOriginPathPrefix - optional; type string
             The origin path prefix provided by the publisher for the media playlists. This field is only applicable for delivery media locations with the value of {@link #mediaPlaylistOriginForwardingType} set to {@link OriginForwardingType#CONVENTIONAL}, and will be set to null otherwise.
           • keysetName - optional; type string
             The name of the EdgeCacheKeyset on the Media CDN configuration that will be used to validate signed requests from DAI to ingest content.
           • signedRequestExpirationTtlSeconds - optional; type long
             The amount of time in seconds for which a request signed with a short token will be valid. Only required if signedRequestMaximumExpirationTtl has been set in the Media CDN configuration.
         Default configuration for how DAI should deliver the non-modified media segments. At delivery time, we replace the ingest location's url prefix with the delivery location's URL prefix and use the security policy from the delivery settings to determine how DAI needs to deliver the media so that users can access it. This value is required for a valid source content configuration.
     • cdnConfigurationStatus - optional; type CdnConfigurationStatus - type string with restriction - enum { 'UNKNOWN', 'ACTIVE', 'ARCHIVED' }
       The status of the CDN configuration.
   Fault:
   ApiException (wsdlsoap:fault, use = literal)Source code
   ApiException type ApiExceptionFault

   Exception class for holding a list of service errors.

   Base class for exceptions.

   • message - optional; type string
     Error message.

   • errors - optional, unbounded; type ApiError
     The API error base class that provides details about an error that occurred while processing a service request.

     The OGNL field path is provided for parsers to identify the request data element that may have caused the error.

     • fieldPath - optional; type string
       The OGNL field path to identify cause of error.
     • fieldPathElements - optional, unbounded; type FieldPathElement
       A parsed copy of the field path. For example, the field path "operations[1].operand" corresponds to this list: {FieldPathElement(field = "operations", index = 1), FieldPathElement(field = "operand", index = null)}.
       A segment of a field path. Each dot in a field path defines a new segment.
       • field - optional; type string
         The name of a field in lower camelcase. (e.g. "biddingStrategy")
       • index - optional; type int
         For list fields, this is a 0-indexed position in the list. Null for non-list fields.
     • trigger - optional; type string
       The data that caused the error.
     • errorString - optional; type string
       A simple string representation of the error and reason.
     List of errors.

   A fault element of type ApiException.
2. getCdnConfigurationsByStatement
   Source code
   Description:
   Gets a {@link CdnConfigurationPage} of {@link CdnConfiguration} objects that satisfy the given {@link Statement#query}. Currently only CDN Configurations of type {@link CdnConfigurationType#LIVE_STREAM_SOURCE_CONTENT} will be returned. The following fields are supported for filtering:

   PQL Property	Object Property
   {@code id}	{@link CdnConfiguration#id}
   {@code name}	{@link CdnConfiguration#name}

   Operation type:
   Request-response. The endpoint receives a message, and sends a correlated message.
   Input:
   getCdnConfigurationsByStatementRequest (wsdlsoap:header, use = literal, part = RequestHeader)Source code
   parameters type getCdnConfigurationsByStatement

   Gets a {@link CdnConfigurationPage} of {@link CdnConfiguration} objects that satisfy the given {@link Statement#query}. Currently only CDN Configurations of type {@link CdnConfigurationType#LIVE_STREAM_SOURCE_CONTENT} will be returned. The following fields are supported for filtering:

   PQL Property	Object Property
   {@code id}	{@link CdnConfiguration#id}
   {@code name}	{@link CdnConfiguration#name}

   • statement - optional; type Statement
     Captures the {@code WHERE}, {@code ORDER BY} and {@code LIMIT} clauses of a PQL query. Statements are typically used to retrieve objects of a predefined domain type, which makes SELECT clause unnecessary.

     An example query text might be {@code "WHERE status = 'ACTIVE' ORDER BY id LIMIT 30"}.

     Statements support bind variables. These are substitutes for literals and can be thought of as input parameters to a PQL query.

     An example of such a query might be {@code "WHERE id = :idValue"}.

     Statements also support use of the LIKE keyword. This provides wildcard string matching.

     An example of such a query might be {@code "WHERE name LIKE '%searchString%'"}.

     The value for the variable idValue must then be set with an object of type {@link Value}, e.g., {@link NumberValue}, {@link TextValue} or {@link BooleanValue}.
     • query - optional; type string
       Holds the query in PQL syntax. The syntax is:
       [WHERE {[AND | OR] ...}]
[ORDER BY [ASC | DESC]]
[LIMIT {[,] } | { OFFSET }]
       

       
            := {< | <= | > | >= | = | != }

     := {< | <= | > | >= | = | != }
:= IN
:= IS NULL
:= LIKE
:= :
       

     • values - optional, unbounded; type String_ValueMapEntry
       Holds keys and values for bind variables and their values. The key is the name of the bind variable. The value is the literal value of the variable.

       In the example {@code "WHERE status = :bindStatus ORDER BY id LIMIT 30"}, the bind variable, represented by {@code :bindStatus} is named {@code bindStatus}, which would also be the parameter map key. The bind variable's value would be represented by a parameter map value of type {@link TextValue}. The final result, for example, would be an entry of {@code "bindStatus" => StringParam("ACTIVE")}.

       This represents an entry in a map with a key of type String and value of type Value.
       • key - optional; type string
       • value - optional; type Value
         {@code Value} represents a value.
   Output:
   getCdnConfigurationsByStatementResponse (wsdlsoap:header, use = literal, part = ResponseHeader)Source code
   parameters type getCdnConfigurationsByStatementResponse

   • rval - optional; type CdnConfigurationPage
     Captures a page of {@link CdnConfiguration} objects.
     • totalResultSetSize - optional; type int
       The size of the total result set to which this page belongs.
     • startIndex - optional; type int
       The absolute index in the total result set on which this page begins.
     • results - optional, unbounded; type CdnConfiguration
       A {@link CdnConfiguration} encapsulates information about where and how to ingest and deliver content enabled for DAI (Dynamic Ad Insertion).
       • id - optional; type long
         The unique ID of the {@link CdnConfiguration}. This value is read-only and is assigned by Google.
       • name - optional; type string
         The name of the {@link CdnConfiguration}. This value is required to create a CDN configuration and has a maximum length of 255 characters.
       • cdnConfigurationType - optional; type CdnConfigurationType - type string with restriction - enum { 'UNKNOWN', 'LIVE_STREAM_SOURCE_CONTENT' }
         The type of CDN configuration represented by this {@link CdnConfiguration}. This value is required to create a CDN configuration
       • sourceContentConfiguration - optional; type SourceContentConfiguration
         Parameters about this CDN configuration as a source of content. This facilitates fetching the original content for conditioning and delivering the original content as part of a modified stream.
         Parameters about this CDN configuration as a source of content. This facilitates fetching the original content for conditioning and delivering the original content as part of a modified stream.
         • ingestSettings - optional; type MediaLocationSettings
           Configuration that associates a media location with a security policy and the authentication credentials needed to access the content.
           • name - optional; type string
             The name of the media location. This value is read-only and is assigned by Google.
           • urlPrefix - optional; type string
             The url prefix of the media location. This value is required for a valid media location.
           • securityPolicy - optional; type SecurityPolicySettings
             The security policy and authentication credentials needed to access the content in this media location. This value is required for a valid media location.
             A set of security requirements to authenticate against in order to access video content. Different locations (e.g. different CDNs) can have different security policies.
             • securityPolicyType - optional; type SecurityPolicyType - type string with restriction - enum { 'UNKNOWN', 'NONE', 'AKAMAI', 'CLOUD_MEDIA' }
               Type of security policy. This determines which other fields should be populated. This value is required for a valid security policy.
             • tokenAuthenticationKey - optional; type string
               Shared security key used to generate the Akamai HMAC token for authenticating requests. This field is only applicable when the value of {@link #securityPolicyType} is equal to {@link SecurityPolicyType#AKAMAI} and will be set to null otherwise.

               This field is required when the {@link CdnConfiguration#cdnConfigurationType} is equal to {@link CdnConfigurationType#LIVE_STREAM_SOURCE_CONTENT} and this {@link SecurityPolicyDto} is being configured for {@link SourceContentConfiguration#ingestSettings}.

             • disableServerSideUrlSigning - optional; type boolean
               Whether the segment URLs should be signed using the {@link #tokenAuthenticationKey} on the server. This is only applicable for delivery media locations that have token authentication enabled.
             • originForwardingType - optional; type OriginForwardingType - type string with restriction - enum { 'ORIGIN_PATH', 'CONVENTIONAL', 'NONE', 'UNKNOWN' }
               The type of origin forwarding used to support Akamai authentication policies for the master playlist. This field is not applicable to ingest locations, and is only applicable to delivery media locations with the {@link #securityPolicyType} set to {@link SecurityPolicyType#AKAMAI}. If set elsewhere it will be reset to null.
             • originPathPrefix - optional; type string
               The origin path prefix provided by the publisher for the master playlist. This field is only applicable for delivery media locations with the value of {@link #originForwardingType} set to {@link OriginForwardingType#CONVENTIONAL}, and will be set to null otherwise.
             • mediaPlaylistOriginForwardingType - optional; type OriginForwardingType - type string with restriction - enum { 'ORIGIN_PATH', 'CONVENTIONAL', 'NONE', 'UNKNOWN' }
               The type of origin forwarding used to support Akamai authentication policies for media playlists. This setting can only be used with CDN configurations with a {@code cdnConfigurationType} of {@link CdnConfigurationType#LIVE_STREAM_SOURCE_CONTENT}, is not applicable to ingest locations, and is only applicable to delivery media locations with the {@link #securityPolicyType} set to {@link SecurityPolicyType#AKAMAI}. Valid options are {@code OriginForwardingType#NONE} or {@code OriginForwardingType#ORIGIN_PATH}.

               This setting can only be used with CDN configurations with a {@code cdnConfigurationType} of {@link CdnConfigurationType#LIVE_STREAM_SOURCE_CONTENT}.

             • mediaPlaylistOriginPathPrefix - optional; type string
               The origin path prefix provided by the publisher for the media playlists. This field is only applicable for delivery media locations with the value of {@link #mediaPlaylistOriginForwardingType} set to {@link OriginForwardingType#CONVENTIONAL}, and will be set to null otherwise.
             • keysetName - optional; type string
               The name of the EdgeCacheKeyset on the Media CDN configuration that will be used to validate signed requests from DAI to ingest content.
             • signedRequestExpirationTtlSeconds - optional; type long
               The amount of time in seconds for which a request signed with a short token will be valid. Only required if signedRequestMaximumExpirationTtl has been set in the Media CDN configuration.
           Configuration for how DAI should ingest media. At ingest time, we match the url prefix of media in a stream's playlist with an ingest location and use the authentication credentials from the corresponding ingest settings to download the media. This value is required for a valid source content configuration.
         • defaultDeliverySettings - optional; type MediaLocationSettings
           Configuration that associates a media location with a security policy and the authentication credentials needed to access the content.
           • name - optional; type string
             The name of the media location. This value is read-only and is assigned by Google.
           • urlPrefix - optional; type string
             The url prefix of the media location. This value is required for a valid media location.
           • securityPolicy - optional; type SecurityPolicySettings
             The security policy and authentication credentials needed to access the content in this media location. This value is required for a valid media location.
             A set of security requirements to authenticate against in order to access video content. Different locations (e.g. different CDNs) can have different security policies.
             • securityPolicyType - optional; type SecurityPolicyType - type string with restriction - enum { 'UNKNOWN', 'NONE', 'AKAMAI', 'CLOUD_MEDIA' }
               Type of security policy. This determines which other fields should be populated. This value is required for a valid security policy.
             • tokenAuthenticationKey - optional; type string
               Shared security key used to generate the Akamai HMAC token for authenticating requests. This field is only applicable when the value of {@link #securityPolicyType} is equal to {@link SecurityPolicyType#AKAMAI} and will be set to null otherwise.

               This field is required when the {@link CdnConfiguration#cdnConfigurationType} is equal to {@link CdnConfigurationType#LIVE_STREAM_SOURCE_CONTENT} and this {@link SecurityPolicyDto} is being configured for {@link SourceContentConfiguration#ingestSettings}.

             • disableServerSideUrlSigning - optional; type boolean
               Whether the segment URLs should be signed using the {@link #tokenAuthenticationKey} on the server. This is only applicable for delivery media locations that have token authentication enabled.
             • originForwardingType - optional; type OriginForwardingType - type string with restriction - enum { 'ORIGIN_PATH', 'CONVENTIONAL', 'NONE', 'UNKNOWN' }
               The type of origin forwarding used to support Akamai authentication policies for the master playlist. This field is not applicable to ingest locations, and is only applicable to delivery media locations with the {@link #securityPolicyType} set to {@link SecurityPolicyType#AKAMAI}. If set elsewhere it will be reset to null.
             • originPathPrefix - optional; type string
               The origin path prefix provided by the publisher for the master playlist. This field is only applicable for delivery media locations with the value of {@link #originForwardingType} set to {@link OriginForwardingType#CONVENTIONAL}, and will be set to null otherwise.
             • mediaPlaylistOriginForwardingType - optional; type OriginForwardingType - type string with restriction - enum { 'ORIGIN_PATH', 'CONVENTIONAL', 'NONE', 'UNKNOWN' }
               The type of origin forwarding used to support Akamai authentication policies for media playlists. This setting can only be used with CDN configurations with a {@code cdnConfigurationType} of {@link CdnConfigurationType#LIVE_STREAM_SOURCE_CONTENT}, is not applicable to ingest locations, and is only applicable to delivery media locations with the {@link #securityPolicyType} set to {@link SecurityPolicyType#AKAMAI}. Valid options are {@code OriginForwardingType#NONE} or {@code OriginForwardingType#ORIGIN_PATH}.

               This setting can only be used with CDN configurations with a {@code cdnConfigurationType} of {@link CdnConfigurationType#LIVE_STREAM_SOURCE_CONTENT}.

             • mediaPlaylistOriginPathPrefix - optional; type string
               The origin path prefix provided by the publisher for the media playlists. This field is only applicable for delivery media locations with the value of {@link #mediaPlaylistOriginForwardingType} set to {@link OriginForwardingType#CONVENTIONAL}, and will be set to null otherwise.
             • keysetName - optional; type string
               The name of the EdgeCacheKeyset on the Media CDN configuration that will be used to validate signed requests from DAI to ingest content.
             • signedRequestExpirationTtlSeconds - optional; type long
               The amount of time in seconds for which a request signed with a short token will be valid. Only required if signedRequestMaximumExpirationTtl has been set in the Media CDN configuration.
           Default configuration for how DAI should deliver the non-modified media segments. At delivery time, we replace the ingest location's url prefix with the delivery location's URL prefix and use the security policy from the delivery settings to determine how DAI needs to deliver the media so that users can access it. This value is required for a valid source content configuration.
       • cdnConfigurationStatus - optional; type CdnConfigurationStatus - type string with restriction - enum { 'UNKNOWN', 'ACTIVE', 'ARCHIVED' }
         The status of the CDN configuration.
       The collection of CDN configurations contained within this page.
   Fault:
   ApiException (wsdlsoap:fault, use = literal)Source code
   ApiException type ApiExceptionFault

   Exception class for holding a list of service errors.

   Base class for exceptions.

   • message - optional; type string
     Error message.

   • errors - optional, unbounded; type ApiError
     The API error base class that provides details about an error that occurred while processing a service request.

     The OGNL field path is provided for parsers to identify the request data element that may have caused the error.

     • fieldPath - optional; type string
       The OGNL field path to identify cause of error.
     • fieldPathElements - optional, unbounded; type FieldPathElement
       A parsed copy of the field path. For example, the field path "operations[1].operand" corresponds to this list: {FieldPathElement(field = "operations", index = 1), FieldPathElement(field = "operand", index = null)}.
       A segment of a field path. Each dot in a field path defines a new segment.
       • field - optional; type string
         The name of a field in lower camelcase. (e.g. "biddingStrategy")
       • index - optional; type int
         For list fields, this is a 0-indexed position in the list. Null for non-list fields.
     • trigger - optional; type string
       The data that caused the error.
     • errorString - optional; type string
       A simple string representation of the error and reason.
     List of errors.

   A fault element of type ApiException.
3. performCdnConfigurationAction
   Source code
   Description:
   Performs actions on {@link CdnConfiguration} objects that match the given {@link Statement#query}.
   Operation type:
   Request-response. The endpoint receives a message, and sends a correlated message.
   Input:
   performCdnConfigurationActionRequest (wsdlsoap:header, use = literal, part = RequestHeader)Source code
   parameters type performCdnConfigurationAction

   Performs actions on {@link CdnConfiguration} objects that match the given {@link Statement#query}.

   • cdnConfigurationAction - optional; type CdnConfigurationAction
     Represents the actions that can be performed on {@link CdnConfiguration} objects.
     • filterStatement - optional; type Statement
       Captures the {@code WHERE}, {@code ORDER BY} and {@code LIMIT} clauses of a PQL query. Statements are typically used to retrieve objects of a predefined domain type, which makes SELECT clause unnecessary.

       An example query text might be {@code "WHERE status = 'ACTIVE' ORDER BY id LIMIT 30"}.

       Statements support bind variables. These are substitutes for literals and can be thought of as input parameters to a PQL query.

       An example of such a query might be {@code "WHERE id = :idValue"}.

       Statements also support use of the LIKE keyword. This provides wildcard string matching.

       An example of such a query might be {@code "WHERE name LIKE '%searchString%'"}.

       The value for the variable idValue must then be set with an object of type {@link Value}, e.g., {@link NumberValue}, {@link TextValue} or {@link BooleanValue}.
       • query - optional; type string
         Holds the query in PQL syntax. The syntax is:
         [WHERE {[AND | OR] ...}]
[ORDER BY [ASC | DESC]]
[LIMIT {[,] } | { OFFSET }]
         

         
              := {< | <= | > | >= | = | != }

     := {< | <= | > | >= | = | != }
:= IN
:= IS NULL
:= LIKE
:= :
         

       • values - optional, unbounded; type String_ValueMapEntry
         Holds keys and values for bind variables and their values. The key is the name of the bind variable. The value is the literal value of the variable.

         In the example {@code "WHERE status = :bindStatus ORDER BY id LIMIT 30"}, the bind variable, represented by {@code :bindStatus} is named {@code bindStatus}, which would also be the parameter map key. The bind variable's value would be represented by a parameter map value of type {@link TextValue}. The final result, for example, would be an entry of {@code "bindStatus" => StringParam("ACTIVE")}.

         This represents an entry in a map with a key of type String and value of type Value.
         • key - optional; type string
         • value - optional; type Value
           {@code Value} represents a value.
   Output:
   performCdnConfigurationActionResponse (wsdlsoap:header, use = literal, part = ResponseHeader)Source code
   parameters type performCdnConfigurationActionResponse

   • rval - optional; type UpdateResult
     Represents the result of performing an action on objects.
     • numChanges - optional; type int
       The number of objects that were changed as a result of performing the action.
   Fault:
   ApiException (wsdlsoap:fault, use = literal)Source code
   ApiException type ApiExceptionFault

   Exception class for holding a list of service errors.

   Base class for exceptions.

   • message - optional; type string
     Error message.

   • errors - optional, unbounded; type ApiError
     The API error base class that provides details about an error that occurred while processing a service request.

     The OGNL field path is provided for parsers to identify the request data element that may have caused the error.

     • fieldPath - optional; type string
       The OGNL field path to identify cause of error.
     • fieldPathElements - optional, unbounded; type FieldPathElement
       A parsed copy of the field path. For example, the field path "operations[1].operand" corresponds to this list: {FieldPathElement(field = "operations", index = 1), FieldPathElement(field = "operand", index = null)}.
       A segment of a field path. Each dot in a field path defines a new segment.
       • field - optional; type string
         The name of a field in lower camelcase. (e.g. "biddingStrategy")
       • index - optional; type int
         For list fields, this is a 0-indexed position in the list. Null for non-list fields.
     • trigger - optional; type string
       The data that caused the error.
     • errorString - optional; type string
       A simple string representation of the error and reason.
     List of errors.

   A fault element of type ApiException.
4. updateCdnConfigurations
   Source code
   Description:
   Updates the specified {@link CdnConfiguration} objects.
   Operation type:
   Request-response. The endpoint receives a message, and sends a correlated message.
   Input:
   updateCdnConfigurationsRequest (wsdlsoap:header, use = literal, part = RequestHeader)Source code
   parameters type updateCdnConfigurations

   Updates the specified {@link CdnConfiguration} objects.

   • cdnConfigurations - optional, unbounded; type CdnConfiguration
     A {@link CdnConfiguration} encapsulates information about where and how to ingest and deliver content enabled for DAI (Dynamic Ad Insertion).
     • id - optional; type long
       The unique ID of the {@link CdnConfiguration}. This value is read-only and is assigned by Google.
     • name - optional; type string
       The name of the {@link CdnConfiguration}. This value is required to create a CDN configuration and has a maximum length of 255 characters.
     • cdnConfigurationType - optional; type CdnConfigurationType - type string with restriction - enum { 'UNKNOWN', 'LIVE_STREAM_SOURCE_CONTENT' }
       The type of CDN configuration represented by this {@link CdnConfiguration}. This value is required to create a CDN configuration
     • sourceContentConfiguration - optional; type SourceContentConfiguration
       Parameters about this CDN configuration as a source of content. This facilitates fetching the original content for conditioning and delivering the original content as part of a modified stream.
       Parameters about this CDN configuration as a source of content. This facilitates fetching the original content for conditioning and delivering the original content as part of a modified stream.
       • ingestSettings - optional; type MediaLocationSettings
         Configuration that associates a media location with a security policy and the authentication credentials needed to access the content.
         • name - optional; type string
           The name of the media location. This value is read-only and is assigned by Google.
         • urlPrefix - optional; type string
           The url prefix of the media location. This value is required for a valid media location.
         • securityPolicy - optional; type SecurityPolicySettings
           The security policy and authentication credentials needed to access the content in this media location. This value is required for a valid media location.
           A set of security requirements to authenticate against in order to access video content. Different locations (e.g. different CDNs) can have different security policies.
           • securityPolicyType - optional; type SecurityPolicyType - type string with restriction - enum { 'UNKNOWN', 'NONE', 'AKAMAI', 'CLOUD_MEDIA' }
             Type of security policy. This determines which other fields should be populated. This value is required for a valid security policy.
           • tokenAuthenticationKey - optional; type string
             Shared security key used to generate the Akamai HMAC token for authenticating requests. This field is only applicable when the value of {@link #securityPolicyType} is equal to {@link SecurityPolicyType#AKAMAI} and will be set to null otherwise.

             This field is required when the {@link CdnConfiguration#cdnConfigurationType} is equal to {@link CdnConfigurationType#LIVE_STREAM_SOURCE_CONTENT} and this {@link SecurityPolicyDto} is being configured for {@link SourceContentConfiguration#ingestSettings}.

           • disableServerSideUrlSigning - optional; type boolean
             Whether the segment URLs should be signed using the {@link #tokenAuthenticationKey} on the server. This is only applicable for delivery media locations that have token authentication enabled.
           • originForwardingType - optional; type OriginForwardingType - type string with restriction - enum { 'ORIGIN_PATH', 'CONVENTIONAL', 'NONE', 'UNKNOWN' }
             The type of origin forwarding used to support Akamai authentication policies for the master playlist. This field is not applicable to ingest locations, and is only applicable to delivery media locations with the {@link #securityPolicyType} set to {@link SecurityPolicyType#AKAMAI}. If set elsewhere it will be reset to null.
           • originPathPrefix - optional; type string
             The origin path prefix provided by the publisher for the master playlist. This field is only applicable for delivery media locations with the value of {@link #originForwardingType} set to {@link OriginForwardingType#CONVENTIONAL}, and will be set to null otherwise.
           • mediaPlaylistOriginForwardingType - optional; type OriginForwardingType - type string with restriction - enum { 'ORIGIN_PATH', 'CONVENTIONAL', 'NONE', 'UNKNOWN' }
             The type of origin forwarding used to support Akamai authentication policies for media playlists. This setting can only be used with CDN configurations with a {@code cdnConfigurationType} of {@link CdnConfigurationType#LIVE_STREAM_SOURCE_CONTENT}, is not applicable to ingest locations, and is only applicable to delivery media locations with the {@link #securityPolicyType} set to {@link SecurityPolicyType#AKAMAI}. Valid options are {@code OriginForwardingType#NONE} or {@code OriginForwardingType#ORIGIN_PATH}.

             This setting can only be used with CDN configurations with a {@code cdnConfigurationType} of {@link CdnConfigurationType#LIVE_STREAM_SOURCE_CONTENT}.

           • mediaPlaylistOriginPathPrefix - optional; type string
             The origin path prefix provided by the publisher for the media playlists. This field is only applicable for delivery media locations with the value of {@link #mediaPlaylistOriginForwardingType} set to {@link OriginForwardingType#CONVENTIONAL}, and will be set to null otherwise.
           • keysetName - optional; type string
             The name of the EdgeCacheKeyset on the Media CDN configuration that will be used to validate signed requests from DAI to ingest content.
           • signedRequestExpirationTtlSeconds - optional; type long
             The amount of time in seconds for which a request signed with a short token will be valid. Only required if signedRequestMaximumExpirationTtl has been set in the Media CDN configuration.
         Configuration for how DAI should ingest media. At ingest time, we match the url prefix of media in a stream's playlist with an ingest location and use the authentication credentials from the corresponding ingest settings to download the media. This value is required for a valid source content configuration.
       • defaultDeliverySettings - optional; type MediaLocationSettings
         Configuration that associates a media location with a security policy and the authentication credentials needed to access the content.
         • name - optional; type string
           The name of the media location. This value is read-only and is assigned by Google.
         • urlPrefix - optional; type string
           The url prefix of the media location. This value is required for a valid media location.
         • securityPolicy - optional; type SecurityPolicySettings
           The security policy and authentication credentials needed to access the content in this media location. This value is required for a valid media location.
           A set of security requirements to authenticate against in order to access video content. Different locations (e.g. different CDNs) can have different security policies.
           • securityPolicyType - optional; type SecurityPolicyType - type string with restriction - enum { 'UNKNOWN', 'NONE', 'AKAMAI', 'CLOUD_MEDIA' }
             Type of security policy. This determines which other fields should be populated. This value is required for a valid security policy.
           • tokenAuthenticationKey - optional; type string
             Shared security key used to generate the Akamai HMAC token for authenticating requests. This field is only applicable when the value of {@link #securityPolicyType} is equal to {@link SecurityPolicyType#AKAMAI} and will be set to null otherwise.

             This field is required when the {@link CdnConfiguration#cdnConfigurationType} is equal to {@link CdnConfigurationType#LIVE_STREAM_SOURCE_CONTENT} and this {@link SecurityPolicyDto} is being configured for {@link SourceContentConfiguration#ingestSettings}.

           • disableServerSideUrlSigning - optional; type boolean
             Whether the segment URLs should be signed using the {@link #tokenAuthenticationKey} on the server. This is only applicable for delivery media locations that have token authentication enabled.
           • originForwardingType - optional; type OriginForwardingType - type string with restriction - enum { 'ORIGIN_PATH', 'CONVENTIONAL', 'NONE', 'UNKNOWN' }
             The type of origin forwarding used to support Akamai authentication policies for the master playlist. This field is not applicable to ingest locations, and is only applicable to delivery media locations with the {@link #securityPolicyType} set to {@link SecurityPolicyType#AKAMAI}. If set elsewhere it will be reset to null.
           • originPathPrefix - optional; type string
             The origin path prefix provided by the publisher for the master playlist. This field is only applicable for delivery media locations with the value of {@link #originForwardingType} set to {@link OriginForwardingType#CONVENTIONAL}, and will be set to null otherwise.
           • mediaPlaylistOriginForwardingType - optional; type OriginForwardingType - type string with restriction - enum { 'ORIGIN_PATH', 'CONVENTIONAL', 'NONE', 'UNKNOWN' }
             The type of origin forwarding used to support Akamai authentication policies for media playlists. This setting can only be used with CDN configurations with a {@code cdnConfigurationType} of {@link CdnConfigurationType#LIVE_STREAM_SOURCE_CONTENT}, is not applicable to ingest locations, and is only applicable to delivery media locations with the {@link #securityPolicyType} set to {@link SecurityPolicyType#AKAMAI}. Valid options are {@code OriginForwardingType#NONE} or {@code OriginForwardingType#ORIGIN_PATH}.

             This setting can only be used with CDN configurations with a {@code cdnConfigurationType} of {@link CdnConfigurationType#LIVE_STREAM_SOURCE_CONTENT}.

           • mediaPlaylistOriginPathPrefix - optional; type string
             The origin path prefix provided by the publisher for the media playlists. This field is only applicable for delivery media locations with the value of {@link #mediaPlaylistOriginForwardingType} set to {@link OriginForwardingType#CONVENTIONAL}, and will be set to null otherwise.
           • keysetName - optional; type string
             The name of the EdgeCacheKeyset on the Media CDN configuration that will be used to validate signed requests from DAI to ingest content.
           • signedRequestExpirationTtlSeconds - optional; type long
             The amount of time in seconds for which a request signed with a short token will be valid. Only required if signedRequestMaximumExpirationTtl has been set in the Media CDN configuration.
         Default configuration for how DAI should deliver the non-modified media segments. At delivery time, we replace the ingest location's url prefix with the delivery location's URL prefix and use the security policy from the delivery settings to determine how DAI needs to deliver the media so that users can access it. This value is required for a valid source content configuration.
     • cdnConfigurationStatus - optional; type CdnConfigurationStatus - type string with restriction - enum { 'UNKNOWN', 'ACTIVE', 'ARCHIVED' }
       The status of the CDN configuration.
   Output:
   updateCdnConfigurationsResponse (wsdlsoap:header, use = literal, part = ResponseHeader)Source code
   parameters type updateCdnConfigurationsResponse

   • rval - optional, unbounded; type CdnConfiguration
     A {@link CdnConfiguration} encapsulates information about where and how to ingest and deliver content enabled for DAI (Dynamic Ad Insertion).
     • id - optional; type long
       The unique ID of the {@link CdnConfiguration}. This value is read-only and is assigned by Google.
     • name - optional; type string
       The name of the {@link CdnConfiguration}. This value is required to create a CDN configuration and has a maximum length of 255 characters.
     • cdnConfigurationType - optional; type CdnConfigurationType - type string with restriction - enum { 'UNKNOWN', 'LIVE_STREAM_SOURCE_CONTENT' }
       The type of CDN configuration represented by this {@link CdnConfiguration}. This value is required to create a CDN configuration
     • sourceContentConfiguration - optional; type SourceContentConfiguration
       Parameters about this CDN configuration as a source of content. This facilitates fetching the original content for conditioning and delivering the original content as part of a modified stream.
       Parameters about this CDN configuration as a source of content. This facilitates fetching the original content for conditioning and delivering the original content as part of a modified stream.
       • ingestSettings - optional; type MediaLocationSettings
         Configuration that associates a media location with a security policy and the authentication credentials needed to access the content.
         • name - optional; type string
           The name of the media location. This value is read-only and is assigned by Google.
         • urlPrefix - optional; type string
           The url prefix of the media location. This value is required for a valid media location.
         • securityPolicy - optional; type SecurityPolicySettings
           The security policy and authentication credentials needed to access the content in this media location. This value is required for a valid media location.
           A set of security requirements to authenticate against in order to access video content. Different locations (e.g. different CDNs) can have different security policies.
           • securityPolicyType - optional; type SecurityPolicyType - type string with restriction - enum { 'UNKNOWN', 'NONE', 'AKAMAI', 'CLOUD_MEDIA' }
             Type of security policy. This determines which other fields should be populated. This value is required for a valid security policy.
           • tokenAuthenticationKey - optional; type string
             Shared security key used to generate the Akamai HMAC token for authenticating requests. This field is only applicable when the value of {@link #securityPolicyType} is equal to {@link SecurityPolicyType#AKAMAI} and will be set to null otherwise.

             This field is required when the {@link CdnConfiguration#cdnConfigurationType} is equal to {@link CdnConfigurationType#LIVE_STREAM_SOURCE_CONTENT} and this {@link SecurityPolicyDto} is being configured for {@link SourceContentConfiguration#ingestSettings}.

           • disableServerSideUrlSigning - optional; type boolean
             Whether the segment URLs should be signed using the {@link #tokenAuthenticationKey} on the server. This is only applicable for delivery media locations that have token authentication enabled.
           • originForwardingType - optional; type OriginForwardingType - type string with restriction - enum { 'ORIGIN_PATH', 'CONVENTIONAL', 'NONE', 'UNKNOWN' }
             The type of origin forwarding used to support Akamai authentication policies for the master playlist. This field is not applicable to ingest locations, and is only applicable to delivery media locations with the {@link #securityPolicyType} set to {@link SecurityPolicyType#AKAMAI}. If set elsewhere it will be reset to null.
           • originPathPrefix - optional; type string
             The origin path prefix provided by the publisher for the master playlist. This field is only applicable for delivery media locations with the value of {@link #originForwardingType} set to {@link OriginForwardingType#CONVENTIONAL}, and will be set to null otherwise.
           • mediaPlaylistOriginForwardingType - optional; type OriginForwardingType - type string with restriction - enum { 'ORIGIN_PATH', 'CONVENTIONAL', 'NONE', 'UNKNOWN' }
             The type of origin forwarding used to support Akamai authentication policies for media playlists. This setting can only be used with CDN configurations with a {@code cdnConfigurationType} of {@link CdnConfigurationType#LIVE_STREAM_SOURCE_CONTENT}, is not applicable to ingest locations, and is only applicable to delivery media locations with the {@link #securityPolicyType} set to {@link SecurityPolicyType#AKAMAI}. Valid options are {@code OriginForwardingType#NONE} or {@code OriginForwardingType#ORIGIN_PATH}.

             This setting can only be used with CDN configurations with a {@code cdnConfigurationType} of {@link CdnConfigurationType#LIVE_STREAM_SOURCE_CONTENT}.

           • mediaPlaylistOriginPathPrefix - optional; type string
             The origin path prefix provided by the publisher for the media playlists. This field is only applicable for delivery media locations with the value of {@link #mediaPlaylistOriginForwardingType} set to {@link OriginForwardingType#CONVENTIONAL}, and will be set to null otherwise.
           • keysetName - optional; type string
             The name of the EdgeCacheKeyset on the Media CDN configuration that will be used to validate signed requests from DAI to ingest content.
           • signedRequestExpirationTtlSeconds - optional; type long
             The amount of time in seconds for which a request signed with a short token will be valid. Only required if signedRequestMaximumExpirationTtl has been set in the Media CDN configuration.
         Configuration for how DAI should ingest media. At ingest time, we match the url prefix of media in a stream's playlist with an ingest location and use the authentication credentials from the corresponding ingest settings to download the media. This value is required for a valid source content configuration.
       • defaultDeliverySettings - optional; type MediaLocationSettings
         Configuration that associates a media location with a security policy and the authentication credentials needed to access the content.
         • name - optional; type string
           The name of the media location. This value is read-only and is assigned by Google.
         • urlPrefix - optional; type string
           The url prefix of the media location. This value is required for a valid media location.
         • securityPolicy - optional; type SecurityPolicySettings
           The security policy and authentication credentials needed to access the content in this media location. This value is required for a valid media location.
           A set of security requirements to authenticate against in order to access video content. Different locations (e.g. different CDNs) can have different security policies.
           • securityPolicyType - optional; type SecurityPolicyType - type string with restriction - enum { 'UNKNOWN', 'NONE', 'AKAMAI', 'CLOUD_MEDIA' }
             Type of security policy. This determines which other fields should be populated. This value is required for a valid security policy.
           • tokenAuthenticationKey - optional; type string
             Shared security key used to generate the Akamai HMAC token for authenticating requests. This field is only applicable when the value of {@link #securityPolicyType} is equal to {@link SecurityPolicyType#AKAMAI} and will be set to null otherwise.

             This field is required when the {@link CdnConfiguration#cdnConfigurationType} is equal to {@link CdnConfigurationType#LIVE_STREAM_SOURCE_CONTENT} and this {@link SecurityPolicyDto} is being configured for {@link SourceContentConfiguration#ingestSettings}.

           • disableServerSideUrlSigning - optional; type boolean
             Whether the segment URLs should be signed using the {@link #tokenAuthenticationKey} on the server. This is only applicable for delivery media locations that have token authentication enabled.
           • originForwardingType - optional; type OriginForwardingType - type string with restriction - enum { 'ORIGIN_PATH', 'CONVENTIONAL', 'NONE', 'UNKNOWN' }
             The type of origin forwarding used to support Akamai authentication policies for the master playlist. This field is not applicable to ingest locations, and is only applicable to delivery media locations with the {@link #securityPolicyType} set to {@link SecurityPolicyType#AKAMAI}. If set elsewhere it will be reset to null.
           • originPathPrefix - optional; type string
             The origin path prefix provided by the publisher for the master playlist. This field is only applicable for delivery media locations with the value of {@link #originForwardingType} set to {@link OriginForwardingType#CONVENTIONAL}, and will be set to null otherwise.
           • mediaPlaylistOriginForwardingType - optional; type OriginForwardingType - type string with restriction - enum { 'ORIGIN_PATH', 'CONVENTIONAL', 'NONE', 'UNKNOWN' }
             The type of origin forwarding used to support Akamai authentication policies for media playlists. This setting can only be used with CDN configurations with a {@code cdnConfigurationType} of {@link CdnConfigurationType#LIVE_STREAM_SOURCE_CONTENT}, is not applicable to ingest locations, and is only applicable to delivery media locations with the {@link #securityPolicyType} set to {@link SecurityPolicyType#AKAMAI}. Valid options are {@code OriginForwardingType#NONE} or {@code OriginForwardingType#ORIGIN_PATH}.

             This setting can only be used with CDN configurations with a {@code cdnConfigurationType} of {@link CdnConfigurationType#LIVE_STREAM_SOURCE_CONTENT}.

           • mediaPlaylistOriginPathPrefix - optional; type string
             The origin path prefix provided by the publisher for the media playlists. This field is only applicable for delivery media locations with the value of {@link #mediaPlaylistOriginForwardingType} set to {@link OriginForwardingType#CONVENTIONAL}, and will be set to null otherwise.
           • keysetName - optional; type string
             The name of the EdgeCacheKeyset on the Media CDN configuration that will be used to validate signed requests from DAI to ingest content.
           • signedRequestExpirationTtlSeconds - optional; type long
             The amount of time in seconds for which a request signed with a short token will be valid. Only required if signedRequestMaximumExpirationTtl has been set in the Media CDN configuration.
         Default configuration for how DAI should deliver the non-modified media segments. At delivery time, we replace the ingest location's url prefix with the delivery location's URL prefix and use the security policy from the delivery settings to determine how DAI needs to deliver the media so that users can access it. This value is required for a valid source content configuration.
     • cdnConfigurationStatus - optional; type CdnConfigurationStatus - type string with restriction - enum { 'UNKNOWN', 'ACTIVE', 'ARCHIVED' }
       The status of the CDN configuration.
   Fault:
   ApiException (wsdlsoap:fault, use = literal)Source code
   ApiException type ApiExceptionFault

   Exception class for holding a list of service errors.

   Base class for exceptions.

   • message - optional; type string
     Error message.

   • errors - optional, unbounded; type ApiError
     The API error base class that provides details about an error that occurred while processing a service request.

     The OGNL field path is provided for parsers to identify the request data element that may have caused the error.

     • fieldPath - optional; type string
       The OGNL field path to identify cause of error.
     • fieldPathElements - optional, unbounded; type FieldPathElement
       A parsed copy of the field path. For example, the field path "operations[1].operand" corresponds to this list: {FieldPathElement(field = "operations", index = 1), FieldPathElement(field = "operand", index = null)}.
       A segment of a field path. Each dot in a field path defines a new segment.
       • field - optional; type string
         The name of a field in lower camelcase. (e.g. "biddingStrategy")
       • index - optional; type int
         For list fields, this is a 0-indexed position in the list. Null for non-list fields.
     • trigger - optional; type string
       The data that caused the error.
     • errorString - optional; type string
       A simple string representation of the error and reason.
     List of errors.

   A fault element of type ApiException.