Package com.oracle.bmc.streaming.requests

Class ListStreamsRequest

java.lang.Object

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

com.oracle.bmc.streaming.requests.ListStreamsRequest

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

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ListStreamsRequest.Builder
static class	ListStreamsRequest.SortBy	The field to sort by.
static class	ListStreamsRequest.SortOrder	The sort order to use, either ‘asc’ or ‘desc’.

Constructor Summary

Constructors

Constructor	Description
ListStreamsRequest()

Method Summary

Modifier and Type	Method	Description
static ListStreamsRequest.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.
String	getId()	A filter to return only resources that match the given ID exactly.
Stream.LifecycleState	getLifecycleState()	A filter to only return resources that match the given lifecycle state.
Integer	getLimit()	The maximum number of items to return.
String	getName()	A filter to return only resources that match the given name exactly.
String	getOpcRequestId()	The unique Oracle-assigned identifier for the request.
String	getPage()	The page at which to start retrieving results.
ListStreamsRequest.SortBy	getSortBy()	The field to sort by.
ListStreamsRequest.SortOrder	getSortOrder()	The sort order to use, either ‘asc’ or ‘desc’.
String	getStreamPoolId()	The OCID of the stream pool.
int	hashCode()	Uses getInvocationCallback and getRetryConfiguration to generate a hash.
ListStreamsRequest.Builder	toBuilder()	Return an instance of ListStreamsRequest.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

ListStreamsRequest

public ListStreamsRequest()

Method Detail

getCompartmentId

public String getCompartmentId()

The OCID of the compartment.

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

getStreamPoolId

public String getStreamPoolId()

The OCID of the stream pool.

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

getId

public String getId()

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

getName

public String getName()

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

getLimit

public Integer getLimit()

The maximum number of items to return.

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

getPage

public String getPage()

The page at which to start retrieving results.

getSortBy

public ListStreamsRequest.SortBy getSortBy()

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.

getSortOrder

public ListStreamsRequest.SortOrder getSortOrder()

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

getLifecycleState

public Stream.LifecycleState getLifecycleState()

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

The state value is case-insensitive.

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

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

Returns:

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

builder

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