Package com.oracle.bmc.ons.requests

Class ListSubscriptionsRequest

java.lang.Object

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

com.oracle.bmc.ons.requests.ListSubscriptionsRequest

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

Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/ons/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

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	getCompartmentId()	The OCID of the compartment.
Integer	getLimit()	For list pagination.
String	getOpcRequestId()	The unique Oracle-assigned identifier for the request.
String	getPage()	For list pagination.
String	getTopicId()	Return all subscriptions that are subscribed to the given topic OCID.
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.

getTopicId

public String getTopicId()

Return all subscriptions that are subscribed to the given topic OCID.

Either this query parameter or the compartmentId query parameter must be set.

getPage

public String getPage()

For list pagination.

The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination.

getLimit

public Integer getLimit()

For list pagination.

The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination.

getOpcRequestId

public String getOpcRequestId()

The unique Oracle-assigned identifier for the request.

If you need to contact Oracle about a particular request, please provide the request ID.

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>