Class UpdateDecoderManifestRequest

    • Method Detail

      • name

        public final String name()

        The name of the decoder manifest to update.

        Returns:
        The name of the decoder manifest to update.
      • description

        public final String description()

        A brief description of the decoder manifest to update.

        Returns:
        A brief description of the decoder manifest to update.
      • hasSignalDecodersToAdd

        public final boolean hasSignalDecodersToAdd()
        For responses, this returns true if the service returned a value for the SignalDecodersToAdd property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
      • signalDecodersToAdd

        public final List<SignalDecoder> signalDecodersToAdd()

        A list of information about decoding additional signals to add to the decoder manifest.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSignalDecodersToAdd() method.

        Returns:
        A list of information about decoding additional signals to add to the decoder manifest.
      • hasSignalDecodersToUpdate

        public final boolean hasSignalDecodersToUpdate()
        For responses, this returns true if the service returned a value for the SignalDecodersToUpdate property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
      • signalDecodersToUpdate

        public final List<SignalDecoder> signalDecodersToUpdate()

        A list of updated information about decoding signals to update in the decoder manifest.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSignalDecodersToUpdate() method.

        Returns:
        A list of updated information about decoding signals to update in the decoder manifest.
      • hasSignalDecodersToRemove

        public final boolean hasSignalDecodersToRemove()
        For responses, this returns true if the service returned a value for the SignalDecodersToRemove property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
      • signalDecodersToRemove

        public final List<String> signalDecodersToRemove()

        A list of signal decoders to remove from the decoder manifest.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSignalDecodersToRemove() method.

        Returns:
        A list of signal decoders to remove from the decoder manifest.
      • hasNetworkInterfacesToAdd

        public final boolean hasNetworkInterfacesToAdd()
        For responses, this returns true if the service returned a value for the NetworkInterfacesToAdd property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
      • networkInterfacesToAdd

        public final List<NetworkInterface> networkInterfacesToAdd()

        A list of information about the network interfaces to add to the decoder manifest.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasNetworkInterfacesToAdd() method.

        Returns:
        A list of information about the network interfaces to add to the decoder manifest.
      • hasNetworkInterfacesToUpdate

        public final boolean hasNetworkInterfacesToUpdate()
        For responses, this returns true if the service returned a value for the NetworkInterfacesToUpdate property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
      • networkInterfacesToUpdate

        public final List<NetworkInterface> networkInterfacesToUpdate()

        A list of information about the network interfaces to update in the decoder manifest.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasNetworkInterfacesToUpdate() method.

        Returns:
        A list of information about the network interfaces to update in the decoder manifest.
      • hasNetworkInterfacesToRemove

        public final boolean hasNetworkInterfacesToRemove()
        For responses, this returns true if the service returned a value for the NetworkInterfacesToRemove property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
      • networkInterfacesToRemove

        public final List<String> networkInterfacesToRemove()

        A list of network interfaces to remove from the decoder manifest.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasNetworkInterfacesToRemove() method.

        Returns:
        A list of network interfaces to remove from the decoder manifest.
      • status

        public final ManifestStatus status()

        The state of the decoder manifest. If the status is ACTIVE, the decoder manifest can't be edited. If the status is DRAFT, you can edit the decoder manifest.

        If the service returns an enum value that is not available in the current SDK version, status will return ManifestStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

        Returns:
        The state of the decoder manifest. If the status is ACTIVE, the decoder manifest can't be edited. If the status is DRAFT, you can edit the decoder manifest.
        See Also:
        ManifestStatus
      • statusAsString

        public final String statusAsString()

        The state of the decoder manifest. If the status is ACTIVE, the decoder manifest can't be edited. If the status is DRAFT, you can edit the decoder manifest.

        If the service returns an enum value that is not available in the current SDK version, status will return ManifestStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

        Returns:
        The state of the decoder manifest. If the status is ACTIVE, the decoder manifest can't be edited. If the status is DRAFT, you can edit the decoder manifest.
        See Also:
        ManifestStatus
      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object