com.oracle.bmc.streaming.model

Class Stream

java.lang.Object

com.oracle.bmc.streaming.model.Stream

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20180418")
public final class Stream
extends Object

Detailed representation of a stream, including all its partitions.
Note: Objects should always be created or deserialized using the Stream.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the Stream.Builder, which maintain a set of all explicitly set fields called __explicitlySet__. The hashCode() and equals(Object) methods are implemented to take __explicitlySet__ into account. The constructor, on the other hand, does not set __explicitlySet__ (since the constructor cannot distinguish explicit null from unset null).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Stream.Builder
static class	Stream.LifecycleState The current state of the stream.

Constructor Summary

Constructors

Constructor and Description
Stream(String name, String id, Integer partitions, Integer retentionInHours, String compartmentId, String streamPoolId, Stream.LifecycleState lifecycleState, String lifecycleStateDetails, Date timeCreated, String messagesEndpoint, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags) Deprecated.

Method Summary

Modifier and Type	Method and Description
static Stream.Builder	builder() Create a new builder.
boolean	equals(Object o)
Set<String>	get__explicitlySet__()
String	getCompartmentId() The OCID of the stream.
Map<String,Map<String,Object>>	getDefinedTags() Defined tags for this resource.
Map<String,String>	getFreeformTags() Free-form tags for this resource.
String	getId() The OCID of the stream.
Stream.LifecycleState	getLifecycleState() The current state of the stream.
String	getLifecycleStateDetails() Any additional details about the current state of the stream.
String	getMessagesEndpoint() The endpoint to use when creating the StreamClient to consume or publish messages in the stream.
String	getName() The name of the stream.
Integer	getPartitions() The number of partitions in the stream.
Integer	getRetentionInHours() The retention period of the stream, in hours.
String	getStreamPoolId() The OCID of the stream pool that contains the stream.
Date	getTimeCreated() The date and time the stream was created, expressed in in RFC 3339 timestamp format.
int	hashCode()
Stream.Builder	toBuilder()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Stream

@ConstructorProperties(value={"name","id","partitions","retentionInHours","compartmentId","streamPoolId","lifecycleState","lifecycleStateDetails","timeCreated","messagesEndpoint","freeformTags","definedTags"})
 @Deprecated
public Stream(String name,
                                                                                                                                                                                                                                             String id,
                                                                                                                                                                                                                                             Integer partitions,
                                                                                                                                                                                                                                             Integer retentionInHours,
                                                                                                                                                                                                                                             String compartmentId,
                                                                                                                                                                                                                                             String streamPoolId,
                                                                                                                                                                                                                                             Stream.LifecycleState lifecycleState,
                                                                                                                                                                                                                                             String lifecycleStateDetails,
                                                                                                                                                                                                                                             Date timeCreated,
                                                                                                                                                                                                                                             String messagesEndpoint,
                                                                                                                                                                                                                                             Map<String,String> freeformTags,
                                                                                                                                                                                                                                             Map<String,Map<String,Object>> definedTags)

Deprecated.

Method Detail

builder

public static Stream.Builder builder()

Create a new builder.

toBuilder

public Stream.Builder toBuilder()

getName

public String getName()

The name of the stream. Avoid entering confidential information.

Example: TelemetryEvents

getId

public String getId()

The OCID of the stream.

getPartitions

public Integer getPartitions()

The number of partitions in the stream.

getRetentionInHours

public Integer getRetentionInHours()

The retention period of the stream, in hours. This property is read-only.

getCompartmentId

public String getCompartmentId()

The OCID of the stream.

getStreamPoolId

public String getStreamPoolId()

The OCID of the stream pool that contains the stream.

getLifecycleState

public Stream.LifecycleState getLifecycleState()

The current state of the stream.

getLifecycleStateDetails

public String getLifecycleStateDetails()

Any additional details about the current state of the stream.

getTimeCreated

public Date getTimeCreated()

The date and time the stream was created, expressed in in RFC 3339 timestamp format.

Example: 2018-04-20T00:00:07.405Z

getMessagesEndpoint

public String getMessagesEndpoint()

The endpoint to use when creating the StreamClient to consume or publish messages in the stream. If the associated stream pool is private, the endpoint is also private and can only be accessed from inside the stream pool’s associated subnet.

getFreeformTags

public Map<String,String> getFreeformTags()

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Exists for cross-compatibility only. For more information, see Resource Tags.

Example: {"Department": "Finance"}

getDefinedTags

public Map<String,Map<String,Object>> getDefinedTags()

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Example: {"Operations": {"CostCenter": "42"}}'

get__explicitlySet__

public Set<String> get__explicitlySet__()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object