Class ListCommitmentsRequest
- java.lang.Object
-
- com.oracle.bmc.requests.BmcRequest<Void>
-
- com.oracle.bmc.osubsubscription.requests.ListCommitmentsRequest
-
@Generated(value="OracleSDKGenerator", comments="API Version: 20210501") public class ListCommitmentsRequest extends BmcRequest<Void>Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/osubsubscription/ListCommitmentsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListCommitmentsRequest.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classListCommitmentsRequest.Builderstatic classListCommitmentsRequest.SortByThe field to sort by.static classListCommitmentsRequest.SortOrderThe sort order to use, either ascending (ASC) or descending (DESC).
-
Constructor Summary
Constructors Constructor Description ListCommitmentsRequest()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static ListCommitmentsRequest.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.IntegergetLimit()The maximum number of items to return in a paginated “List” call.StringgetOpcRequestId()Unique Oracle-assigned identifier for the request.StringgetPage()The value of the opc-next-page response header from the previous “List” call.ListCommitmentsRequest.SortBygetSortBy()The field to sort by.ListCommitmentsRequest.SortOrdergetSortOrder()The sort order to use, either ascending (ASC) or descending (DESC).StringgetSubscribedServiceId()This param is used to get the commitments for a particular subscribed serviceStringgetXOneGatewaySubscriptionId()This header is meant to be used only for internal purposes and will be ignored on any public request.StringgetXOneOriginRegion()The OCI home region name in case home region is not us-ashburn-1 (IAD), e.g.inthashCode()Uses getInvocationCallback and getRetryConfiguration to generate a hash.ListCommitmentsRequest.BuildertoBuilder()Return an instance ofListCommitmentsRequest.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
-
getSubscribedServiceId
public String getSubscribedServiceId()
This param is used to get the commitments for a particular subscribed service
-
getCompartmentId
public String getCompartmentId()
The OCID of the compartment.
-
getLimit
public Integer getLimit()
The maximum number of items to return in a paginated “List” call.Default: (50)
Example: 500
-
getPage
public String getPage()
The value of the opc-next-page response header from the previous “List” call.
-
getSortOrder
public ListCommitmentsRequest.SortOrder getSortOrder()
The sort order to use, either ascending (ASC) or descending (DESC).
-
getSortBy
public ListCommitmentsRequest.SortBy getSortBy()
The field to sort by.You can provide one sort order (sortOrder).
-
getOpcRequestId
public String getOpcRequestId()
Unique Oracle-assigned identifier for the request.If you need to contact Oracle about a particular request, please provide the request ID.
-
getXOneGatewaySubscriptionId
public String getXOneGatewaySubscriptionId()
This header is meant to be used only for internal purposes and will be ignored on any public request.The purpose of this header is to help on Gateway to API calls identification.
-
getXOneOriginRegion
public String getXOneOriginRegion()
The OCI home region name in case home region is not us-ashburn-1 (IAD), e.g.ap-mumbai-1, us-phoenix-1 etc.
-
toBuilder
public ListCommitmentsRequest.Builder toBuilder()
Return an instance ofListCommitmentsRequest.Builderthat allows you to modify request properties.- Returns:
- instance of
ListCommitmentsRequest.Builderthat allows you to modify request properties.
-
builder
public static ListCommitmentsRequest.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>
-
-