Web Service: DaiAuthenticationKeyService

Port type DaiAuthenticationKeyServiceInterfaceSource code

1. createDaiAuthenticationKeys
   Source code
   Description:
   Creates new {@link DaiAuthenticationKey} objects.

   The following fields are required:

   • {@link DaiAuthenticationKey#name}
   Operation type:
   Request-response. The endpoint receives a message, and sends a correlated message.
   Input:
   createDaiAuthenticationKeysRequest (wsdlsoap:header, use = literal, part = RequestHeader)Source code
   parameters type createDaiAuthenticationKeys

   Creates new {@link DaiAuthenticationKey} objects.

   The following fields are required:

   • {@link DaiAuthenticationKey#name}

   • daiAuthenticationKeys - optional, unbounded; type DaiAuthenticationKey
     A {@code DaiAuthenticationKey} is used to authenticate stream requests to the IMA SDK API.
     • id - optional; type long
       The unique ID of the {@link DaiAuthenticationKey}. This value is read-only and is assigned by Google.
     • key - optional; type string
       The value of the secure key. This value is read-only and is assigned by Google.
     • creationDateTime - optional; type DateTime
       The date and time this {@link DaiAuthenticationKey} was created. This value is read-only and is assigned by Google.
       Represents a date combined with the time of day.
       • date - optional; type Date
         Represents a date.
         • year - optional; type int
           Year (e.g., 2009)
         • month - optional; type int
           Month (1..12)
         • day - optional; type int
           Day (1..31)
       • hour - optional; type int
       • minute - optional; type int
       • second - optional; type int
       • timeZoneId - optional; type string
     • status - optional; type DaiAuthenticationKeyStatus - type string with restriction - enum { 'UNKNOWN', 'ACTIVE', 'INACTIVE' }
       The status of this {@link DaiAuthenticationKey}. This value is read-only and is assigned by Google.

       DAI authentication keys are created in the {@link DaiAuthenticationKeyStatus#ACTIVE} state. The status can only be modified through the {@link DaiAuthenticationKeyService#performDaiAuthenticationKeyAction} method.

       Only active keys will be accepted by the IMA SDK API as valid.

     • name - optional; type string
       The name for this {@link DaiAuthenticationKey}.
     • keyType - optional; type DaiAuthenticationKeyType - type string with restriction - enum { 'UNKNOWN', 'API', 'HMAC' }
       The type of this key, which determines how it should be used on stream create requests.
   Output:
   createDaiAuthenticationKeysResponse (wsdlsoap:header, use = literal, part = ResponseHeader)Source code
   parameters type createDaiAuthenticationKeysResponse

   • rval - optional, unbounded; type DaiAuthenticationKey
     A {@code DaiAuthenticationKey} is used to authenticate stream requests to the IMA SDK API.
     • id - optional; type long
       The unique ID of the {@link DaiAuthenticationKey}. This value is read-only and is assigned by Google.
     • key - optional; type string
       The value of the secure key. This value is read-only and is assigned by Google.
     • creationDateTime - optional; type DateTime
       The date and time this {@link DaiAuthenticationKey} was created. This value is read-only and is assigned by Google.
       Represents a date combined with the time of day.
       • date - optional; type Date
         Represents a date.
         • year - optional; type int
           Year (e.g., 2009)
         • month - optional; type int
           Month (1..12)
         • day - optional; type int
           Day (1..31)
       • hour - optional; type int
       • minute - optional; type int
       • second - optional; type int
       • timeZoneId - optional; type string
     • status - optional; type DaiAuthenticationKeyStatus - type string with restriction - enum { 'UNKNOWN', 'ACTIVE', 'INACTIVE' }
       The status of this {@link DaiAuthenticationKey}. This value is read-only and is assigned by Google.

       DAI authentication keys are created in the {@link DaiAuthenticationKeyStatus#ACTIVE} state. The status can only be modified through the {@link DaiAuthenticationKeyService#performDaiAuthenticationKeyAction} method.

       Only active keys will be accepted by the IMA SDK API as valid.

     • name - optional; type string
       The name for this {@link DaiAuthenticationKey}.
     • keyType - optional; type DaiAuthenticationKeyType - type string with restriction - enum { 'UNKNOWN', 'API', 'HMAC' }
       The type of this key, which determines how it should be used on stream create requests.
   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. getDaiAuthenticationKeysByStatement
   Source code
   Description:
   Gets a {@link DaiAuthenticationKeyPage} of {@link DaiAuthenticationKey} objects that satisfy the given {@link Statement#query}. The following fields are supported for filtering:

   PQL Property	Object Property
   {@code id}	{@link DaiAuthenticationKey#id}
   {@code status}	{@link DaiAuthenticationKey#status}
   {@code name}	{@link DaiAuthenticationKey#name}

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

   Gets a {@link DaiAuthenticationKeyPage} of {@link DaiAuthenticationKey} objects that satisfy the given {@link Statement#query}. The following fields are supported for filtering:

   PQL Property	Object Property
   {@code id}	{@link DaiAuthenticationKey#id}
   {@code status}	{@link DaiAuthenticationKey#status}
   {@code name}	{@link DaiAuthenticationKey#name}

   • 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:
   getDaiAuthenticationKeysByStatementResponse (wsdlsoap:header, use = literal, part = ResponseHeader)Source code
   parameters type getDaiAuthenticationKeysByStatementResponse

   • rval - optional; type DaiAuthenticationKeyPage
     Captures a page of {@link DaiAuthenticationKey} 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 DaiAuthenticationKey
       A {@code DaiAuthenticationKey} is used to authenticate stream requests to the IMA SDK API.
       • id - optional; type long
         The unique ID of the {@link DaiAuthenticationKey}. This value is read-only and is assigned by Google.
       • key - optional; type string
         The value of the secure key. This value is read-only and is assigned by Google.
       • creationDateTime - optional; type DateTime
         The date and time this {@link DaiAuthenticationKey} was created. This value is read-only and is assigned by Google.
         Represents a date combined with the time of day.
         • date - optional; type Date
           Represents a date.
           • year - optional; type int
             Year (e.g., 2009)
           • month - optional; type int
             Month (1..12)
           • day - optional; type int
             Day (1..31)
         • hour - optional; type int
         • minute - optional; type int
         • second - optional; type int
         • timeZoneId - optional; type string
       • status - optional; type DaiAuthenticationKeyStatus - type string with restriction - enum { 'UNKNOWN', 'ACTIVE', 'INACTIVE' }
         The status of this {@link DaiAuthenticationKey}. This value is read-only and is assigned by Google.

         DAI authentication keys are created in the {@link DaiAuthenticationKeyStatus#ACTIVE} state. The status can only be modified through the {@link DaiAuthenticationKeyService#performDaiAuthenticationKeyAction} method.

         Only active keys will be accepted by the IMA SDK API as valid.

       • name - optional; type string
         The name for this {@link DaiAuthenticationKey}.
       • keyType - optional; type DaiAuthenticationKeyType - type string with restriction - enum { 'UNKNOWN', 'API', 'HMAC' }
         The type of this key, which determines how it should be used on stream create requests.
       The collection of live stream events 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. performDaiAuthenticationKeyAction
   Source code
   Description:
   Performs actions on {@link DaiAuthenticationKey} objects that match the given {@link Statement#query}.

   DAI authentication keys cannot be deactivated if there are active {@link LiveStreamEvent}s or Content Sources that are using them.

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

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

   DAI authentication keys cannot be deactivated if there are active {@link LiveStreamEvent}s or Content Sources that are using them.

   • daiAuthenticationKeyAction - optional; type DaiAuthenticationKeyAction
     Represents the actions that can be performed on {@link DaiAuthenticationKey} 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:
   performDaiAuthenticationKeyActionResponse (wsdlsoap:header, use = literal, part = ResponseHeader)Source code
   parameters type performDaiAuthenticationKeyActionResponse

   • 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. updateDaiAuthenticationKeys
   Source code
   Description:
   Updates the specified {@link DaiAuthenticationKey} objects.
   Operation type:
   Request-response. The endpoint receives a message, and sends a correlated message.
   Input:
   updateDaiAuthenticationKeysRequest (wsdlsoap:header, use = literal, part = RequestHeader)Source code
   parameters type updateDaiAuthenticationKeys

   Updates the specified {@link DaiAuthenticationKey} objects.

   • daiAuthenticationKeys - optional, unbounded; type DaiAuthenticationKey
     A {@code DaiAuthenticationKey} is used to authenticate stream requests to the IMA SDK API.
     • id - optional; type long
       The unique ID of the {@link DaiAuthenticationKey}. This value is read-only and is assigned by Google.
     • key - optional; type string
       The value of the secure key. This value is read-only and is assigned by Google.
     • creationDateTime - optional; type DateTime
       The date and time this {@link DaiAuthenticationKey} was created. This value is read-only and is assigned by Google.
       Represents a date combined with the time of day.
       • date - optional; type Date
         Represents a date.
         • year - optional; type int
           Year (e.g., 2009)
         • month - optional; type int
           Month (1..12)
         • day - optional; type int
           Day (1..31)
       • hour - optional; type int
       • minute - optional; type int
       • second - optional; type int
       • timeZoneId - optional; type string
     • status - optional; type DaiAuthenticationKeyStatus - type string with restriction - enum { 'UNKNOWN', 'ACTIVE', 'INACTIVE' }
       The status of this {@link DaiAuthenticationKey}. This value is read-only and is assigned by Google.

       DAI authentication keys are created in the {@link DaiAuthenticationKeyStatus#ACTIVE} state. The status can only be modified through the {@link DaiAuthenticationKeyService#performDaiAuthenticationKeyAction} method.

       Only active keys will be accepted by the IMA SDK API as valid.

     • name - optional; type string
       The name for this {@link DaiAuthenticationKey}.
     • keyType - optional; type DaiAuthenticationKeyType - type string with restriction - enum { 'UNKNOWN', 'API', 'HMAC' }
       The type of this key, which determines how it should be used on stream create requests.
   Output:
   updateDaiAuthenticationKeysResponse (wsdlsoap:header, use = literal, part = ResponseHeader)Source code
   parameters type updateDaiAuthenticationKeysResponse

   • rval - optional, unbounded; type DaiAuthenticationKey
     A {@code DaiAuthenticationKey} is used to authenticate stream requests to the IMA SDK API.
     • id - optional; type long
       The unique ID of the {@link DaiAuthenticationKey}. This value is read-only and is assigned by Google.
     • key - optional; type string
       The value of the secure key. This value is read-only and is assigned by Google.
     • creationDateTime - optional; type DateTime
       The date and time this {@link DaiAuthenticationKey} was created. This value is read-only and is assigned by Google.
       Represents a date combined with the time of day.
       • date - optional; type Date
         Represents a date.
         • year - optional; type int
           Year (e.g., 2009)
         • month - optional; type int
           Month (1..12)
         • day - optional; type int
           Day (1..31)
       • hour - optional; type int
       • minute - optional; type int
       • second - optional; type int
       • timeZoneId - optional; type string
     • status - optional; type DaiAuthenticationKeyStatus - type string with restriction - enum { 'UNKNOWN', 'ACTIVE', 'INACTIVE' }
       The status of this {@link DaiAuthenticationKey}. This value is read-only and is assigned by Google.

       DAI authentication keys are created in the {@link DaiAuthenticationKeyStatus#ACTIVE} state. The status can only be modified through the {@link DaiAuthenticationKeyService#performDaiAuthenticationKeyAction} method.

       Only active keys will be accepted by the IMA SDK API as valid.

     • name - optional; type string
       The name for this {@link DaiAuthenticationKey}.
     • keyType - optional; type DaiAuthenticationKeyType - type string with restriction - enum { 'UNKNOWN', 'API', 'HMAC' }
       The type of this key, which determines how it should be used on stream create requests.
   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.