com.oracle.bmc.osubsubscription.requests

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 here to see how to use ListCommitmentsRequest.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ListCommitmentsRequest.Builder
static class	ListCommitmentsRequest.SortBy The field to sort by.
static class	ListCommitmentsRequest.SortOrder The sort order to use, either ascending (ASC) or descending (DESC).

Constructor Summary

Constructors

Constructor and Description
ListCommitmentsRequest()

Method Summary

Modifier and Type	Method and Description
static ListCommitmentsRequest.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’.
String	getCompartmentId() The OCID of the compartment.
Integer	getLimit() The maximum number of items to return in a paginated “List” call.
String	getOpcRequestId() Unique Oracle-assigned identifier for the request.
String	getPage() The value of the opc-next-page response header from the previous “List” call.
ListCommitmentsRequest.SortBy	getSortBy() The field to sort by.
ListCommitmentsRequest.SortOrder	getSortOrder() The sort order to use, either ascending (ASC) or descending (DESC).
String	getSubscribedServiceId() This param is used to get the commitments for a particular subscribed service
String	getXOneGatewaySubscriptionId() This header is meant to be used only for internal purposes and will be ignored on any public request.
String	getXOneOriginRegion() The OCI home region name in case home region is not us-ashburn-1 (IAD), e.g.
int	hashCode() Uses getInvocationCallback and getRetryConfiguration to generate a hash.
ListCommitmentsRequest.Builder	toBuilder() Return an instance of ListCommitmentsRequest.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

ListCommitmentsRequest

public ListCommitmentsRequest()

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 of ListCommitmentsRequest.Builder that allows you to modify request properties.

Returns:

instance of ListCommitmentsRequest.Builder that 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

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>