Package com.oracle.bmc.loganalytics.requests

Class ListLogAnalyticsEntitiesRequest

  • @Generated(value="OracleSDKGenerator",
           comments="API Version: 20200601")
public class ListLogAnalyticsEntitiesRequest
extends BmcRequest<Void>

    Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/loganalytics/ListLogAnalyticsEntitiesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListLogAnalyticsEntitiesRequest.

    • Constructor Detail

      • ListLogAnalyticsEntitiesRequest

        public ListLogAnalyticsEntitiesRequest()

    • Method Detail

      • getNamespaceName

        public String getNamespaceName()
        The Logging Analytics namespace used for the request.

      • getCompartmentId

        public String getCompartmentId()
        The ID of the compartment in which to list resources.

      • getName

        public String getName()
        A filter to return only log analytics entities whose name matches the entire name given.

        The match is case-insensitive.

      • getNameContains

        public String getNameContains()
        A filter to return only log analytics entities whose name contains the name given.

        The match is case-insensitive.

      • getEntityTypeName

        public List<String> getEntityTypeName()
        A filter to return only log analytics entities whose entityTypeName matches the entire log analytics entity type name of one of the entityTypeNames given in the list.

        The match is case-insensitive.

      • getCloudResourceId

        public String getCloudResourceId()
        A filter to return only log analytics entities whose cloudResourceId matches the cloudResourceId given.

      • getLifecycleState

        public EntityLifecycleStates getLifecycleState()
        A filter to return only those log analytics entities with the specified lifecycle state.

        The state value is case-insensitive.

      • getLifecycleDetailsContains

        public String getLifecycleDetailsContains()
        A filter to return only log analytics entities whose lifecycleDetails contains the specified string.

      • getHostname

        public String getHostname()
        A filter to return only log analytics entities whose hostname matches the entire hostname given.

      • getHostnameContains

        public String getHostnameContains()
        A filter to return only log analytics entities whose hostname contains the substring given.

        The match is case-insensitive.

      • getSourceId

        public String getSourceId()
        A filter to return only log analytics entities whose sourceId matches the sourceId given.

      • getCreationSourceType

        public List<CreationSourceType> getCreationSourceType()
        A filter to return only those log analytics entities with the specified auto-creation source.

      • getCreationSourceDetails

        public String getCreationSourceDetails()
        A filter to return only log analytics entities whose auto-creation source details contains the specified string.

      • getLimit

        public Integer getLimit()
        The maximum number of items to return.

      • getPage

        public String getPage()
        The page token representing the page at which to start retrieving results.

        This is usually retrieved from a previous list call.

      • getSortBy

        public ListLogAnalyticsEntitiesRequest.SortBy getSortBy()
        The field to sort entities by.

        Only one sort order may be provided. Default order for timeCreated and timeUpdated is descending. Default order for entity name is ascending. If no value is specified timeCreated is default.

      • getOpcRequestId

        public String getOpcRequestId()
        The client request ID for tracing.

      • getMetadataEquals

        public List<String> getMetadataEquals()
        A filter to return only log analytics entities whose metadata name, value and type matches the specified string.

        Each item in the array has the format “{name}:{value}:{type}”. All inputs are case-insensitive.

      • getDefinedTagEquals

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

        Only entities with a defined tag matching the value will be returned. 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”.

      • getFreeformTagEquals

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

        Only entities with a freeform tag matching the value will be returned. 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”.

      • getDefinedTagExists

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

        Only entities for which the specified defined tags exist will be returned. 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”.

      • getFreeformTagExists

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

        Only entities for which the specified freeform tags exist the value will be returned. 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”.

      • getIsShowAssociatedSourcesCount

        public Boolean getIsShowAssociatedSourcesCount()
        Option to return count of associated log sources for log analytics entity(s).

      • equals

        public boolean equals​(Object o)
        Description copied from class: BmcRequest
        Uses getInvocationCallback and getRetryConfiguration to determine if passed request is equal to ‘this’.
        Overrides:
        equals in class BmcRequest<Void>

      • hashCode

        public int hashCode()
        Description copied from class: BmcRequest
        Uses getInvocationCallback and getRetryConfiguration to generate a hash.
        Overrides:
        hashCode in class BmcRequest<Void>