com.oracle.bmc.opsi.model

Class ResourceFilters

java.lang.Object

com.oracle.bmc.http.internal.ExplicitlySetBmcModel

com.oracle.bmc.opsi.model.ResourceFilters

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20200630")
public final class ResourceFilters
extends ExplicitlySetBmcModel

Information to filter the actual target resources in an operation. e.g: While quering a DATABASE_INSIGHTS_DATA_OBJECT using /opsiDataObjects/{opsiDataObjectidentifier}/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 ExplicitlySetBmcModel.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take ExplicitlySetBmcModel.__explicitlySet__ into account. The constructor, on the other hand, does not set ExplicitlySetBmcModel.__explicitlySet__ (since the constructor cannot distinguish explicit null from unset null).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ResourceFilters.Builder

Constructor Summary

Constructors

Constructor and Description
ResourceFilters(List<String> definedTagEquals, List<String> freeformTagEquals, List<String> definedTagExists, List<String> freeformTagExists, Boolean compartmentIdInSubtree) Deprecated.

Method Summary

Modifier and Type	Method and Description
static ResourceFilters.Builder	builder() Create a new builder.
boolean	equals(Object o)
Boolean	getCompartmentIdInSubtree() A flag to consider all resources within a given compartment and all sub-compartments.
List<String>	getDefinedTagEquals() A list of tag filters to apply.
List<String>	getDefinedTagExists() A list of tag existence filters to apply.
List<String>	getFreeformTagEquals() A list of tag filters to apply.
List<String>	getFreeformTagExists() A list of tag existence filters to apply.
int	hashCode()
ResourceFilters.Builder	toBuilder()
String	toString()
String	toString(boolean includeByteArrayContents) Return a string representation of the object.

Methods inherited from class com.oracle.bmc.http.internal.ExplicitlySetBmcModel

markPropertyAsExplicitlySet, wasPropertyExplicitlySet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ResourceFilters

@Deprecated
 @ConstructorProperties(value={"definedTagEquals","freeformTagEquals","definedTagExists","freeformTagExists","compartmentIdInSubtree"})
public ResourceFilters(List<String> definedTagEquals,
                                                                                                                                                                           List<String> freeformTagEquals,
                                                                                                                                                                           List<String> definedTagExists,
                                                                                                                                                                           List<String> freeformTagExists,
                                                                                                                                                                           Boolean compartmentIdInSubtree)

Deprecated.

Method Detail

builder

public static ResourceFilters.Builder builder()

Create a new builder.

toBuilder

public ResourceFilters.Builder toBuilder()

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

toString

public String toString()

Overrides:

toString in class 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 ExplicitlySetBmcModel

hashCode

public int hashCode()

Overrides:

hashCode in class ExplicitlySetBmcModel