Class ControlOperationFilter

    • Method Detail

      • hasControlIdentifiers

        public final boolean hasControlIdentifiers()
        For responses, this returns true if the service returned a value for the ControlIdentifiers 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.
      • controlIdentifiers

        public final List<String> controlIdentifiers()

        The set of controlIdentifier returned by the filter.

        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 hasControlIdentifiers() method.

        Returns:
        The set of controlIdentifier returned by the filter.
      • controlOperationTypes

        public final List<ControlOperationType> controlOperationTypes()

        The set of ControlOperation objects returned by the filter.

        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 hasControlOperationTypes() method.

        Returns:
        The set of ControlOperation objects returned by the filter.
      • hasControlOperationTypes

        public final boolean hasControlOperationTypes()
        For responses, this returns true if the service returned a value for the ControlOperationTypes 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.
      • controlOperationTypesAsStrings

        public final List<String> controlOperationTypesAsStrings()

        The set of ControlOperation objects returned by the filter.

        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 hasControlOperationTypes() method.

        Returns:
        The set of ControlOperation objects returned by the filter.
      • hasEnabledControlIdentifiers

        public final boolean hasEnabledControlIdentifiers()
        For responses, this returns true if the service returned a value for the EnabledControlIdentifiers 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.
      • enabledControlIdentifiers

        public final List<String> enabledControlIdentifiers()

        The set controlIdentifier of enabled controls selected by the filter.

        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 hasEnabledControlIdentifiers() method.

        Returns:
        The set controlIdentifier of enabled controls selected by the filter.
      • statuses

        public final List<ControlOperationStatus> statuses()

        Lists the status of control operations.

        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 hasStatuses() method.

        Returns:
        Lists the status of control operations.
      • hasStatuses

        public final boolean hasStatuses()
        For responses, this returns true if the service returned a value for the Statuses 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.
      • statusesAsStrings

        public final List<String> statusesAsStrings()

        Lists the status of control operations.

        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 hasStatuses() method.

        Returns:
        Lists the status of control operations.
      • hasTargetIdentifiers

        public final boolean hasTargetIdentifiers()
        For responses, this returns true if the service returned a value for the TargetIdentifiers 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.
      • targetIdentifiers

        public final List<String> targetIdentifiers()

        The set of targetIdentifier objects returned by the filter.

        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 hasTargetIdentifiers() method.

        Returns:
        The set of targetIdentifier objects returned by the filter.
      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object
      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object
      • 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
      • getValueForField

        public final <T> Optional<T> getValueForField​(String fieldName,
                                                      Class<T> clazz)