com.oracle.bmc.cloudguard.requests

Class ListTargetsRequest

java.lang.Object

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

com.oracle.bmc.cloudguard.requests.ListTargetsRequest

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

Example: Click here to see how to use ListTargetsRequest.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ListTargetsRequest.AccessLevel Valid values are RESTRICTED and ACCESSIBLE.
static class	ListTargetsRequest.Builder
static class	ListTargetsRequest.SortBy The field to sort by.

Constructor Summary

Constructors

Constructor and Description
ListTargetsRequest()

Method Summary

Modifier and Type	Method and Description
static ListTargetsRequest.Builder	builder() Return a new builder for this request object.
boolean	equals(Object o) Uses getInvocationCallback and getRetryConfiguration to determine if passed request is equal to ‘this’.
ListTargetsRequest.AccessLevel	getAccessLevel() Valid values are RESTRICTED and ACCESSIBLE.
String	getCompartmentId() The OCID of the compartment in which to list resources.
Boolean	getCompartmentIdInSubtree() Default is false.
String	getDisplayName() A filter to return only resources that match the entire display name given.
Boolean	getIsNonSecurityZoneTargetsOnlyQuery() Default is false.
LifecycleState	getLifecycleState() The field lifecycle state.
Integer	getLimit() The maximum number of items to return
String	getOpcRequestId() The client request ID for tracing.
String	getPage() The page token representing the page at which to start retrieving results.
ListTargetsRequest.SortBy	getSortBy() The field to sort by.
SortOrders	getSortOrder() The sort order to use
int	hashCode() Uses getInvocationCallback and getRetryConfiguration to generate a hash.
ListTargetsRequest.Builder	toBuilder() Return an instance of ListTargetsRequest.Builder that allows you to modify request properties.
String	toString()

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

getBody$, getInvocationCallback, getRetryConfiguration, setInvocationCallback, setRetryConfiguration, supportsExpect100Continue

Methods inherited from class java.lang.Object

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

Constructor Detail

ListTargetsRequest

public ListTargetsRequest()

Method Detail

getCompartmentId

public String getCompartmentId()

The OCID of the compartment in which to list resources.

getDisplayName

public String getDisplayName()

A filter to return only resources that match the entire display name given.

getIsNonSecurityZoneTargetsOnlyQuery

public Boolean getIsNonSecurityZoneTargetsOnlyQuery()

Default is false. When set to true, only the targets that would be deleted as part of security zone creation will be returned.

getLifecycleState

public LifecycleState getLifecycleState()

The field lifecycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active.

getCompartmentIdInSubtree

public Boolean getCompartmentIdInSubtree()

Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned depending on the setting of accessLevel.

getAccessLevel

public ListTargetsRequest.AccessLevel getAccessLevel()

Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed.

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 SortOrders getSortOrder()

The sort order to use

getSortBy

public ListTargetsRequest.SortBy getSortBy()

The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default.

getOpcRequestId

public String getOpcRequestId()

The client request ID for tracing.

toBuilder

public ListTargetsRequest.Builder toBuilder()

Return an instance of ListTargetsRequest.Builder that allows you to modify request properties.

Returns:

instance of ListTargetsRequest.Builder that allows you to modify request properties.

builder

public static ListTargetsRequest.Builder builder()

Return a new builder for this request object.

Returns:

builder for the request object

toString

public String toString()

Overrides:

toString in class Object

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>