Class ListOccCustomerGroupsRequest
- java.lang.Object
-
- com.oracle.bmc.requests.BmcRequest<Void>
-
- com.oracle.bmc.capacitymanagement.requests.ListOccCustomerGroupsRequest
-
@Generated(value="OracleSDKGenerator", comments="API Version: 20231107") public class ListOccCustomerGroupsRequest extends BmcRequest<Void>Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/capacitymanagement/ListOccCustomerGroupsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListOccCustomerGroupsRequest.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classListOccCustomerGroupsRequest.Builderstatic classListOccCustomerGroupsRequest.SortByThe field to sort by.
-
Constructor Summary
Constructors Constructor Description ListOccCustomerGroupsRequest()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static ListOccCustomerGroupsRequest.Builderbuilder()Return a new builder for this request object.booleanequals(Object o)Uses getInvocationCallback and getRetryConfiguration to determine if passed request is equal to ‘this’.StringgetCompartmentId()The ocid of the compartment or tenancy in which resources are to be listed.StringgetDisplayName()A filter to return only the resources that match the entire display name.StringgetId()A query filter to return the list result based on the customer group OCID.IntegergetLimit()The maximum number of items to return.StringgetOpcRequestId()The client request ID for tracing.StringgetPage()A token representing the position at which to start retrieving results.ListOccCustomerGroupsRequest.SortBygetSortBy()The field to sort by.SortOrdergetSortOrder()The sort order to use, either ‘ASC’ or ‘DESC’.OccCustomerGroup.StatusgetStatus()A query filter to return the list result based on status.inthashCode()Uses getInvocationCallback and getRetryConfiguration to generate a hash.ListOccCustomerGroupsRequest.BuildertoBuilder()Return an instance ofListOccCustomerGroupsRequest.Builderthat allows you to modify request properties.StringtoString()-
Methods inherited from class com.oracle.bmc.requests.BmcRequest
getBody$, getInvocationCallback, getRetryConfiguration, setInvocationCallback, setRetryConfiguration, supportsExpect100Continue
-
-
-
-
Method Detail
-
getCompartmentId
public String getCompartmentId()
The ocid of the compartment or tenancy in which resources are to be listed.This will also be used for authorization purposes.
-
getStatus
public OccCustomerGroup.Status getStatus()
A query filter to return the list result based on status.
-
getDisplayName
public String getDisplayName()
A filter to return only the resources that match the entire display name.The match is not case sensitive.
-
getId
public String getId()
A query filter to return the list result based on the customer group OCID.This is done for users who have INSPECT permission but do not have READ permission.
-
getLimit
public Integer getLimit()
The maximum number of items to return.
-
getPage
public String getPage()
A token representing the position at which to start retrieving results.This must come from opc-next-page header field of a previous response.
-
getOpcRequestId
public String getOpcRequestId()
The client request ID for tracing.The only valid characters for request IDs are letters, numbers, underscore, and dash.
-
getSortOrder
public SortOrder getSortOrder()
The sort order to use, either ‘ASC’ or ‘DESC’.
-
getSortBy
public ListOccCustomerGroupsRequest.SortBy getSortBy()
The field to sort by.Only one sort order may be provided. Default order for name and compartment ID is ascending. Default order for time created is descending.
-
toBuilder
public ListOccCustomerGroupsRequest.Builder toBuilder()
Return an instance ofListOccCustomerGroupsRequest.Builderthat allows you to modify request properties.- Returns:
- instance of
ListOccCustomerGroupsRequest.Builderthat allows you to modify request properties.
-
builder
public static ListOccCustomerGroupsRequest.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:BmcRequestUses getInvocationCallback and getRetryConfiguration to determine if passed request is equal to ‘this’.- Overrides:
equalsin classBmcRequest<Void>
-
hashCode
public int hashCode()
Description copied from class:BmcRequestUses getInvocationCallback and getRetryConfiguration to generate a hash.- Overrides:
hashCodein classBmcRequest<Void>
-
-