com.oracle.bmc.loganalytics.requests

Class ListLogAnalyticsEntitiesRequest

java.lang.Object

com.oracle.bmc.requests.BmcRequest<Void>

com.oracle.bmc.loganalytics.requests.ListLogAnalyticsEntitiesRequest

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20200601")
public class ListLogAnalyticsEntitiesRequest
extends com.oracle.bmc.requests.BmcRequest<Void>

Example: Click here to see how to use ListLogAnalyticsEntitiesRequest.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ListLogAnalyticsEntitiesRequest.Builder
static class	ListLogAnalyticsEntitiesRequest.IsManagementAgentIdNull A filter to return only those log analytics entities whose managementAgentId is null or is not null.
static class	ListLogAnalyticsEntitiesRequest.SortBy The field to sort entities by.
static class	ListLogAnalyticsEntitiesRequest.SortOrder The sort order to use, either ascending (ASC) or descending (DESC).

Method Summary

Modifier and Type	Method and Description
static ListLogAnalyticsEntitiesRequest.Builder	builder()
String	getCloudResourceId() A filter to return only log analytics entities whose cloudResourceId matches the cloudResourceId given.
String	getCompartmentId() The ID of the compartment in which to list resources.
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.
String	getHostname() A filter to return only log analytics entities whose hostname matches the entire hostname given.
String	getHostnameContains() A filter to return only log analytics entities whose hostname contains the substring given.
ListLogAnalyticsEntitiesRequest.IsManagementAgentIdNull	getIsManagementAgentIdNull() A filter to return only those log analytics entities whose managementAgentId is null or is not null.
String	getLifecycleDetailsContains() A filter to return only log analytics entities whose lifecycleDetails contains the specified string.
EntityLifecycleStates	getLifecycleState() A filter to return only those log analytics entities with the specified lifecycle state.
Integer	getLimit() The maximum number of items to return.
String	getName() A filter to return only log analytics entities whose name matches the entire name given.
String	getNameContains() A filter to return only log analytics entities whose name contains the name given.
String	getNamespaceName() The Logging Analytics namespace used for the request.
String	getOpcRequestId() The client request ID for tracing.
String	getPage() The page token representing the page at which to start retrieving results.
ListLogAnalyticsEntitiesRequest.SortBy	getSortBy() The field to sort entities by.
ListLogAnalyticsEntitiesRequest.SortOrder	getSortOrder() The sort order to use, either ascending (ASC) or descending (DESC).
String	getSourceId() A filter to return only log analytics entities whose sourceId matches the sourceId given.

Methods inherited from class com.oracle.bmc.requests.BmcRequest

getBody$, getInvocationCallback, getRetryConfiguration, setInvocationCallback, setRetryConfiguration

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

builder

public static ListLogAnalyticsEntitiesRequest.Builder builder()

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.

getIsManagementAgentIdNull

public ListLogAnalyticsEntitiesRequest.IsManagementAgentIdNull getIsManagementAgentIdNull()

A filter to return only those log analytics entities whose managementAgentId is null or is not null.

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.

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.

getSortOrder

public ListLogAnalyticsEntitiesRequest.SortOrder getSortOrder()

The sort order to use, either ascending (ASC) or descending (DESC).

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.