Class GetMessagesRequest
Implements
Inherited Members
Namespace: Oci.StreamingService.Requests
Assembly: OCI.DotNetSDK.Streaming.dll
Syntax
public class GetMessagesRequest : IOciRequestExamples
Click here to see an example of how to use GetMessages request.
Properties
Cursor
Declaration
[Required(ErrorMessage = "Cursor is required.")]
[HttpConverter(TargetEnum.Query, "cursor")]
public string Cursor { get; set; }Property Value
| Type | Description |
|---|---|
| string | The cursor used to consume the stream. |
Remarks
Required
Limit
Declaration
[HttpConverter(TargetEnum.Query, "limit")]
public int? Limit { get; set; }Property Value
| Type | Description |
|---|---|
| int? | The maximum number of messages to return. You can specify any value up to 10000. By default, the service returns as many messages as possible. Consider your average message size to help avoid exceeding throughput on the stream. |
OpcRequestId
Declaration
[HttpConverter(TargetEnum.Header, "opc-request-id")]
public string OpcRequestId { get; set; }Property Value
| Type | Description |
|---|---|
| string | The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. |
StreamId
Declaration
[Required(ErrorMessage = "StreamId is required.")]
[HttpConverter(TargetEnum.Path, "streamId")]
public string StreamId { get; set; }Property Value
| Type | Description |
|---|---|
| string | The OCID of the stream. |
Remarks
Required