Package com.oracle.bmc.osubsubscription.requests

Class ListSubscriptionsRequest

java.lang.Object

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

com.oracle.bmc.osubsubscription.requests.ListSubscriptionsRequest

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

Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/osubsubscription/ListSubscriptionsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListSubscriptionsRequest.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor	Description
ListSubscriptionsRequest()

Method Summary

Modifier and Type	Method	Description
static ListSubscriptionsRequest.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	getBuyerEmail()	Buyer Email Id
String	getCompartmentId()	The OCID of the compartment.
Boolean	getIsCommitInfoRequired()	Boolean value to decide whether commitment services will be shown
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.
String	getPlanNumber()	The Plan Number
ListSubscriptionsRequest.SortBy	getSortBy()	The field to sort by.
ListSubscriptionsRequest.SortOrder	getSortOrder()	The sort order to use, either ascending (ASC) or descending (DESC).
String	getSubscriptionId()	Line level Subscription Id
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.
ListSubscriptionsRequest.Builder	toBuilder()	Return an instance of ListSubscriptionsRequest.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

ListSubscriptionsRequest

public ListSubscriptionsRequest()

Method Detail

getCompartmentId

public String getCompartmentId()

The OCID of the compartment.

getPlanNumber

public String getPlanNumber()

The Plan Number

getSubscriptionId

public String getSubscriptionId()

Line level Subscription Id

getBuyerEmail

public String getBuyerEmail()

Buyer Email Id

getIsCommitInfoRequired

public Boolean getIsCommitInfoRequired()

Boolean value to decide whether commitment services will be shown

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 ListSubscriptionsRequest.SortOrder getSortOrder()

The sort order to use, either ascending (ASC) or descending (DESC).

getSortBy

public ListSubscriptionsRequest.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 ListSubscriptionsRequest.Builder toBuilder()

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

Returns:

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

builder

public static ListSubscriptionsRequest.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>