@Generated(value="OracleSDKGenerator",
comments="API Version: 20180418")
public final class Stream
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
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 Stream.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set
fields into account. The constructor, on the other hand, does not take the explicitly set fields
into account (since the constructor cannot distinguish explicit null from unset null).
| Modifier and Type | Class and Description |
|---|---|
static class |
Stream.Builder |
static class |
Stream.LifecycleState
The current state of the stream.
|
EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME| 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.
|
| Modifier and Type | Method and Description |
|---|---|
static Stream.Builder |
builder()
Create a new builder.
|
boolean |
equals(Object o) |
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() |
String |
toString(boolean includeByteArrayContents)
Return a string representation of the object.
|
markPropertyAsExplicitlySet, wasPropertyExplicitlySet@Deprecated @ConstructorProperties(value={"name","id","partitions","retentionInHours","compartmentId","streamPoolId","lifecycleState","lifecycleStateDetails","timeCreated","messagesEndpoint","freeformTags","definedTags"}) 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)
public static Stream.Builder builder()
Create a new builder.
public Stream.Builder toBuilder()
public String getName()
The name of the stream. Avoid entering confidential information.
Example: TelemetryEvents
public String getId()
The OCID of the stream.
public Integer getPartitions()
The number of partitions in the stream.
public Integer getRetentionInHours()
The retention period of the stream, in hours. This property is read-only.
public String getCompartmentId()
The OCID of the stream.
public String getStreamPoolId()
The OCID of the stream pool that contains the stream.
public Stream.LifecycleState getLifecycleState()
The current state of the stream.
public String getLifecycleStateDetails()
Any additional details about the current state of the stream.
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
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.
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"}
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"}}'
public String toString()
toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelpublic String toString(boolean includeByteArrayContents)
Return a string representation of the object.
includeByteArrayContents - true to include the full contents of byte arrayspublic boolean equals(Object o)
equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelpublic int hashCode()
hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelCopyright © 2016–2024. All rights reserved.