Package com.oracle.bmc.streaming.requests

Class ListStreamsRequest.Builder

java.lang.Object

com.oracle.bmc.streaming.requests.ListStreamsRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<ListStreamsRequest,Void>

Enclosing class:

ListStreamsRequest

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

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ListStreamsRequest	build()	Build the instance of ListStreamsRequest as configured by this builder
ListStreamsRequest	buildWithoutInvocationCallback()	Build the instance of ListStreamsRequest as configured by this builder
ListStreamsRequest.Builder	compartmentId(String compartmentId)	The OCID of the compartment.
ListStreamsRequest.Builder	copy(ListStreamsRequest o)	Copy method to populate the builder with values from the given instance.
ListStreamsRequest.Builder	id(String id)	A filter to return only resources that match the given ID exactly.
ListStreamsRequest.Builder	invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)	Set the invocation callback for the request to be built.
ListStreamsRequest.Builder	lifecycleState(Stream.LifecycleState lifecycleState)	A filter to only return resources that match the given lifecycle state.
ListStreamsRequest.Builder	limit(Integer limit)	The maximum number of items to return.
ListStreamsRequest.Builder	name(String name)	A filter to return only resources that match the given name exactly.
ListStreamsRequest.Builder	opcRequestId(String opcRequestId)	The unique Oracle-assigned identifier for the request.
ListStreamsRequest.Builder	page(String page)	The page at which to start retrieving results.
ListStreamsRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration)	Set the retry configuration for the request to be built.
ListStreamsRequest.Builder	sortBy(ListStreamsRequest.SortBy sortBy)	The field to sort by.
ListStreamsRequest.Builder	sortOrder(ListStreamsRequest.SortOrder sortOrder)	The sort order to use, either ‘asc’ or ‘desc’.
ListStreamsRequest.Builder	streamPoolId(String streamPoolId)	The OCID of the stream pool.

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 ListStreamsRequest.Builder compartmentId(String compartmentId)

The OCID of the compartment.

Is exclusive with the streamPoolId parameter. One of them is required.

Parameters:

compartmentId - the value to set

Returns:

this builder instance

streamPoolId

public ListStreamsRequest.Builder streamPoolId(String streamPoolId)

The OCID of the stream pool.

Is exclusive with the compartmentId parameter. One of them is required.

Parameters:

streamPoolId - the value to set

Returns:

this builder instance

id

public ListStreamsRequest.Builder id(String id)

A filter to return only resources that match the given ID exactly.

Parameters:

id - the value to set

Returns:

this builder instance

name

public ListStreamsRequest.Builder name(String name)

A filter to return only resources that match the given name exactly.

Parameters:

name - the value to set

Returns:

this builder instance

limit

public ListStreamsRequest.Builder limit(Integer limit)

The maximum number of items to return.

The value must be between 1 and 50. The default is 10.

Parameters:

limit - the value to set

Returns:

this builder instance

page

public ListStreamsRequest.Builder page(String page)

The page at which to start retrieving results.

Parameters:

page - the value to set

Returns:

this builder instance

sortBy

public ListStreamsRequest.Builder sortBy(ListStreamsRequest.SortBy sortBy)

The field to sort by.

You can provide no more than one sort order. By default, TIMECREATED sorts results in descending order and NAME sorts results in ascending order.

Parameters:

sortBy - the value to set

Returns:

this builder instance

sortOrder

public ListStreamsRequest.Builder sortOrder(ListStreamsRequest.SortOrder sortOrder)

The sort order to use, either ‘asc’ or ‘desc’.

Parameters:

sortOrder - the value to set

Returns:

this builder instance

lifecycleState

public ListStreamsRequest.Builder lifecycleState(Stream.LifecycleState lifecycleState)

A filter to only return resources that match the given lifecycle state.

The state value is case-insensitive.

Parameters:

lifecycleState - the value to set

Returns:

this builder instance

opcRequestId

public ListStreamsRequest.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 ListStreamsRequest.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 ListStreamsRequest.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 ListStreamsRequest.Builder copy(ListStreamsRequest o)

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

Specified by:

copy in interface BmcRequest.Builder<ListStreamsRequest,Void>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public ListStreamsRequest build()

Build the instance of ListStreamsRequest 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<ListStreamsRequest,Void>

Returns:

instance of ListStreamsRequest

buildWithoutInvocationCallback

public ListStreamsRequest buildWithoutInvocationCallback()

Build the instance of ListStreamsRequest 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 ListStreamsRequest