Class ListOnPremConnectorsRequest
- java.lang.Object
-
- com.oracle.bmc.requests.BmcRequest<Void>
-
- com.oracle.bmc.datasafe.requests.ListOnPremConnectorsRequest
-
@Generated(value="OracleSDKGenerator", comments="API Version: 20181201") public class ListOnPremConnectorsRequest extends BmcRequest<Void>
Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/datasafe/ListOnPremConnectorsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListOnPremConnectorsRequest.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
ListOnPremConnectorsRequest.AccessLevel
Valid values are RESTRICTED and ACCESSIBLE.static class
ListOnPremConnectorsRequest.Builder
static class
ListOnPremConnectorsRequest.SortBy
The field used for sorting.static class
ListOnPremConnectorsRequest.SortOrder
The sort order to use, either ascending (ASC) or descending (DESC).
-
Constructor Summary
Constructors Constructor Description ListOnPremConnectorsRequest()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static ListOnPremConnectorsRequest.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’.ListOnPremConnectorsRequest.AccessLevel
getAccessLevel()
Valid values are RESTRICTED and ACCESSIBLE.String
getCompartmentId()
A filter to return only resources that match the specified compartment OCID.Boolean
getCompartmentIdInSubtree()
Default is false.String
getDisplayName()
A filter to return only resources that match the specified display name.Integer
getLimit()
For list pagination.String
getOnPremConnectorId()
A filter to return only the on-premises connector that matches the specified id.OnPremConnectorLifecycleState
getOnPremConnectorLifecycleState()
A filter to return only on-premises connector resources that match the specified lifecycle state.String
getOpcRequestId()
Unique identifier for the request.String
getPage()
For list pagination.ListOnPremConnectorsRequest.SortBy
getSortBy()
The field used for sorting.ListOnPremConnectorsRequest.SortOrder
getSortOrder()
The sort order to use, either ascending (ASC) or descending (DESC).int
hashCode()
Uses getInvocationCallback and getRetryConfiguration to generate a hash.ListOnPremConnectorsRequest.Builder
toBuilder()
Return an instance ofListOnPremConnectorsRequest.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
-
-
-
-
Method Detail
-
getCompartmentId
public String getCompartmentId()
A filter to return only resources that match the specified compartment OCID.
-
getOnPremConnectorId
public String getOnPremConnectorId()
A filter to return only the on-premises connector that matches the specified id.
-
getDisplayName
public String getDisplayName()
A filter to return only resources that match the specified display name.
-
getOnPremConnectorLifecycleState
public OnPremConnectorLifecycleState getOnPremConnectorLifecycleState()
A filter to return only on-premises connector resources that match the specified lifecycle state.
-
getLimit
public Integer getLimit()
For list pagination.The maximum number of items to return per page in a paginated “List” call. For details about how pagination works, see List Pagination.
-
getPage
public String getPage()
For list pagination.The page token representing the page at which to start retrieving results. It is usually retrieved from a previous “List” call. For details about how pagination works, see List Pagination.
-
getSortOrder
public ListOnPremConnectorsRequest.SortOrder getSortOrder()
The sort order to use, either ascending (ASC) or descending (DESC).
-
getSortBy
public ListOnPremConnectorsRequest.SortBy getSortBy()
The field used for sorting.Only one sorting order (sortOrder) can be specified. The default order for TIMECREATED is descending. The default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.
-
getOpcRequestId
public String getOpcRequestId()
Unique identifier for the request.
-
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. Depends on the ‘accessLevel’ setting.
-
getAccessLevel
public ListOnPremConnectorsRequest.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.
-
toBuilder
public ListOnPremConnectorsRequest.Builder toBuilder()
Return an instance ofListOnPremConnectorsRequest.Builder
that allows you to modify request properties.- Returns:
- instance of
ListOnPremConnectorsRequest.Builder
that allows you to modify request properties.
-
builder
public static ListOnPremConnectorsRequest.Builder builder()
Return a new builder for this request object.- Returns:
- builder for the request 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 classBmcRequest<Void>
-
hashCode
public int hashCode()
Description copied from class:BmcRequest
Uses getInvocationCallback and getRetryConfiguration to generate a hash.- Overrides:
hashCode
in classBmcRequest<Void>
-
-