Class ResourceFilters


  • @Generated(value="OracleSDKGenerator",
               comments="API Version: 20200630")
    public final class ResourceFilters
    extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    Information to filter the actual target resources in an operation.

    e.g: While querying a DATABASE_INSIGHTS_DATA_OBJECT using /opsiDataObjects/actions/queryData API, if resourceFilters is set with valid value for definedTagEquals field, only data of the database insights resources for which the specified freeform tags exist will be considered for the actual query scope.
    Note: Objects should always be created or deserialized using the ResourceFilters.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the ResourceFilters.Builder, which maintain a set of all explicitly set fields called ResourceFilters.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

    • Method Detail

      • getDefinedTagEquals

        public List<String> getDefinedTagEquals()
        A list of tag filters to apply.

        Only resources with a defined tag matching the value will be considered. Each item in the list has the format “{namespace}.{tagName}.{value}”. All inputs are case-insensitive. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as “OR”. Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as “AND”.

        Returns:
        the value
      • getFreeformTagEquals

        public List<String> getFreeformTagEquals()
        A list of tag filters to apply.

        Only resources with a freeform tag matching the value will be considered. The key for each tag is “{tagName}.{value}”. All inputs are case-insensitive. Multiple values for the same tag name are interpreted as “OR”. Values for different tag names are interpreted as “AND”.

        Returns:
        the value
      • getDefinedTagExists

        public List<String> getDefinedTagExists()
        A list of tag existence filters to apply.

        Only resources for which the specified defined tags exist will be considered. Each item in the list has the format “{namespace}.{tagName}.true” (for checking existence of a defined tag) or “{namespace}.true”. All inputs are case-insensitive. Currently, only existence (“true” at the end) is supported. Absence (“false” at the end) is not supported. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as “OR”. Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as “AND”.

        Returns:
        the value
      • getFreeformTagExists

        public List<String> getFreeformTagExists()
        A list of tag existence filters to apply.

        Only resources for which the specified freeform tags exist will be considered. The key for each tag is “{tagName}.true”. All inputs are case-insensitive. Currently, only existence (“true” at the end) is supported. Absence (“false” at the end) is not supported. Multiple values for different tag names are interpreted as “AND”.

        Returns:
        the value
      • getCompartmentIdInSubtree

        public Boolean getCompartmentIdInSubtree()
        A flag to consider all resources within a given compartment and all sub-compartments.
        Returns:
        the value
      • getResourceStatus

        public List<ResourceStatus> getResourceStatus()
        Filter resources by status, multiple options could be chosen to show authorized resources even if those are disabled or deleted.
        Returns:
        the value
      • toString

        public String toString()
        Overrides:
        toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
      • toString

        public String toString​(boolean includeByteArrayContents)
        Return a string representation of the object.
        Parameters:
        includeByteArrayContents - true to include the full contents of byte arrays
        Returns:
        string representation
      • equals

        public boolean equals​(Object o)
        Overrides:
        equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel