Package com.oracle.bmc.ons.requests

Class ListSubscriptionsRequest.Builder

java.lang.Object

com.oracle.bmc.ons.requests.ListSubscriptionsRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<ListSubscriptionsRequest,Void>

Enclosing class:

ListSubscriptionsRequest

public static class ListSubscriptionsRequest.Builder
extends Object
implements BmcRequest.Builder<ListSubscriptionsRequest,Void>

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ListSubscriptionsRequest	build()	Build the instance of ListSubscriptionsRequest as configured by this builder
ListSubscriptionsRequest	buildWithoutInvocationCallback()	Build the instance of ListSubscriptionsRequest as configured by this builder
ListSubscriptionsRequest.Builder	compartmentId(String compartmentId)	The OCID of the compartment.
ListSubscriptionsRequest.Builder	copy(ListSubscriptionsRequest o)	Copy method to populate the builder with values from the given instance.
ListSubscriptionsRequest.Builder	invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)	Set the invocation callback for the request to be built.
ListSubscriptionsRequest.Builder	limit(Integer limit)	For list pagination.
ListSubscriptionsRequest.Builder	opcRequestId(String opcRequestId)	The unique Oracle-assigned identifier for the request.
ListSubscriptionsRequest.Builder	page(String page)	For list pagination.
ListSubscriptionsRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration)	Set the retry configuration for the request to be built.
ListSubscriptionsRequest.Builder	topicId(String topicId)	Return all subscriptions that are subscribed to the given topic OCID.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.oracle.bmc.requests.BmcRequest.Builder

body$

Constructor Detail

Builder

public Builder()

Method Detail

compartmentId

public ListSubscriptionsRequest.Builder compartmentId(String compartmentId)

The OCID of the compartment.

Parameters:

compartmentId - the value to set

Returns:

this builder instance

topicId

public ListSubscriptionsRequest.Builder topicId(String topicId)

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

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

Parameters:

topicId - the value to set

Returns:

this builder instance

page

public ListSubscriptionsRequest.Builder page(String page)

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.

Parameters:

page - the value to set

Returns:

this builder instance

limit

public ListSubscriptionsRequest.Builder limit(Integer limit)

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.

Parameters:

limit - the value to set

Returns:

this builder instance

opcRequestId

public ListSubscriptionsRequest.Builder opcRequestId(String opcRequestId)

The unique Oracle-assigned identifier for the request.

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

Parameters:

opcRequestId - the value to set

Returns:

this builder instance

invocationCallback

public ListSubscriptionsRequest.Builder invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)

Set the invocation callback for the request to be built.

Parameters:

invocationCallback - the invocation callback to be set for the request

Returns:

this builder instance

retryConfiguration

public ListSubscriptionsRequest.Builder retryConfiguration(RetryConfiguration retryConfiguration)

Set the retry configuration for the request to be built.

Parameters:

retryConfiguration - the retry configuration to be used for the request

Returns:

this builder instance

copy

public ListSubscriptionsRequest.Builder copy(ListSubscriptionsRequest o)

Copy method to populate the builder with values from the given instance.

Specified by:

copy in interface BmcRequest.Builder<ListSubscriptionsRequest,Void>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public ListSubscriptionsRequest build()

Build the instance of ListSubscriptionsRequest as configured by this builder

Note that this method takes calls to invocationCallback(com.oracle.bmc.http.client.RequestInterceptor) into account, while the method buildWithoutInvocationCallback() does not.

This is the preferred method to build an instance.

Specified by:

build in interface BmcRequest.Builder<ListSubscriptionsRequest,Void>

Returns:

instance of ListSubscriptionsRequest

buildWithoutInvocationCallback

public ListSubscriptionsRequest buildWithoutInvocationCallback()

Build the instance of ListSubscriptionsRequest as configured by this builder

Note that this method does not take calls to invocationCallback(com.oracle.bmc.http.client.RequestInterceptor) into account, while the method build() does

Returns:

instance of ListSubscriptionsRequest