streaming

package
v12.4.0+incompatible Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 13, 2019 License: Apache-2.0, UPL-1.0 Imports: 4 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var GetCreateArchiverDetailsStartPositionEnumValues = GetArchiverStartPositionEnumValues

GetCreateArchiverDetailsStartPositionEnumValues Enumerates the set of values for ArchiverStartPositionEnum Consider using GetArchiverStartPositionEnumValue Deprecated

View Source 
var GetUpdateArchiverDetailsStartPositionEnumValues = GetArchiverStartPositionEnumValues

GetUpdateArchiverDetailsStartPositionEnumValues Enumerates the set of values for ArchiverStartPositionEnum Consider using GetArchiverStartPositionEnumValue Deprecated

Functions

This section is empty.

Types

type Archiver 

type Archiver struct {

	// Time when the resource was created.
	TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`

	// The state of the stream archiver.
	LifecycleState ArchiverLifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`

	// The name of the bucket.
	BucketName *string `mandatory:"false" json:"bucketName"`

	// The flag to create a new bucket or use existing one.
	UseExistingBucket *bool `mandatory:"false" json:"useExistingBucket"`

	// The start message.
	StartPosition ArchiverStartPositionEnum `mandatory:"false" json:"startPosition,omitempty"`

	// The batch rollover size in megabytes.
	BatchRolloverSizeInMBs *int `mandatory:"false" json:"batchRolloverSizeInMBs"`

	// The rollover time in seconds.
	BatchRolloverTimeInSeconds *int `mandatory:"false" json:"batchRolloverTimeInSeconds"`

	// If an operation failed this property contained the last error occurred.
	Error *ArchiverError `mandatory:"false" json:"error"`
}

Archiver Represents the current state of the stream archiver.

func (Archiver) String 

func (m Archiver) String() string

type ArchiverError 

type ArchiverError struct {

	// A short error code that defines the error, meant for programmatic parsing.
	Code *string `mandatory:"false" json:"code"`

	// A human-readable error string.
	Message *string `mandatory:"false" json:"message"`
}

ArchiverError An error related to a stream archiver.

func (ArchiverError) String 

func (m ArchiverError) String() string

type ArchiverLifecycleStateEnum 

type ArchiverLifecycleStateEnum string

ArchiverLifecycleStateEnum Enum with underlying type: string 

const (
	ArchiverLifecycleStateCreating ArchiverLifecycleStateEnum = "CREATING"
	ArchiverLifecycleStateStopped  ArchiverLifecycleStateEnum = "STOPPED"
	ArchiverLifecycleStateStarting ArchiverLifecycleStateEnum = "STARTING"
	ArchiverLifecycleStateRunning  ArchiverLifecycleStateEnum = "RUNNING"
	ArchiverLifecycleStateStopping ArchiverLifecycleStateEnum = "STOPPING"
	ArchiverLifecycleStateUpdating ArchiverLifecycleStateEnum = "UPDATING"
)

Set of constants representing the allowable values for ArchiverLifecycleStateEnum

func GetArchiverLifecycleStateEnumValues 

func GetArchiverLifecycleStateEnumValues() []ArchiverLifecycleStateEnum

GetArchiverLifecycleStateEnumValues Enumerates the set of values for ArchiverLifecycleStateEnum

type ArchiverStartPositionEnum 

type ArchiverStartPositionEnum string

ArchiverStartPositionEnum Enum with underlying type: string 

const (
	ArchiverStartPositionLatest      ArchiverStartPositionEnum = "LATEST"
	ArchiverStartPositionTrimHorizon ArchiverStartPositionEnum = "TRIM_HORIZON"
)

Set of constants representing the allowable values for ArchiverStartPositionEnum 

const (
	CreateArchiverDetailsStartPositionLatest      ArchiverStartPositionEnum = "LATEST"
	CreateArchiverDetailsStartPositionTrimHorizon ArchiverStartPositionEnum = "TRIM_HORIZON"
)

Set of constants representing the allowable values for ArchiverStartPositionEnum Deprecated 

const (
	UpdateArchiverDetailsStartPositionLatest      ArchiverStartPositionEnum = "LATEST"
	UpdateArchiverDetailsStartPositionTrimHorizon ArchiverStartPositionEnum = "TRIM_HORIZON"
)

Set of constants representing the allowable values for ArchiverStartPositionEnum Deprecated

func GetArchiverStartPositionEnumValues 

func GetArchiverStartPositionEnumValues() []ArchiverStartPositionEnum

GetArchiverStartPositionEnumValues Enumerates the set of values for ArchiverStartPositionEnum

type ChangeStreamCompartmentDetails 

type ChangeStreamCompartmentDetails struct {

	// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment
	// into which the resource should be moved.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`
}

ChangeStreamCompartmentDetails Detailed representation of a change stream compartment operation.

func (ChangeStreamCompartmentDetails) String 

func (m ChangeStreamCompartmentDetails) String() string

type ChangeStreamCompartmentRequest 

type ChangeStreamCompartmentRequest struct {

	// The OCID of the stream to change compatment for.
	StreamId *string `mandatory:"true" contributesTo:"path" name:"streamId"`

	// The stream will be moved into the compartment specified within this entity.
	ChangeStreamCompartmentDetails `contributesTo:"body"`

	// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
	// particular request, please provide the request ID.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

ChangeStreamCompartmentRequest wrapper for the ChangeStreamCompartment operation

func (ChangeStreamCompartmentRequest) HTTPRequest 

func (request ChangeStreamCompartmentRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ChangeStreamCompartmentRequest) RetryPolicy 

func (request ChangeStreamCompartmentRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ChangeStreamCompartmentRequest) String 

func (request ChangeStreamCompartmentRequest) String() string

type ChangeStreamCompartmentResponse 

type ChangeStreamCompartmentResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
	// a particular request, please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

ChangeStreamCompartmentResponse wrapper for the ChangeStreamCompartment operation

func (ChangeStreamCompartmentResponse) HTTPResponse 

func (response ChangeStreamCompartmentResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ChangeStreamCompartmentResponse) String 

func (response ChangeStreamCompartmentResponse) String() string

type ConsumerCommitRequest 

type ConsumerCommitRequest struct {

	// The OCID of the stream for which the group is committing offsets.
	StreamId *string `mandatory:"true" contributesTo:"path" name:"streamId"`

	// The group-cursor representing the offsets of the group. This cursor is retrieved from the CreateGroupCursor API call.
	Cursor *string `mandatory:"true" contributesTo:"query" name:"cursor"`

	// The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
	// particular request, please provide the request ID.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

ConsumerCommitRequest wrapper for the ConsumerCommit operation

func (ConsumerCommitRequest) HTTPRequest 

func (request ConsumerCommitRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ConsumerCommitRequest) RetryPolicy 

func (request ConsumerCommitRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ConsumerCommitRequest) String 

func (request ConsumerCommitRequest) String() string

type ConsumerCommitResponse 

type ConsumerCommitResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The Cursor instance
	Cursor `presentIn:"body"`

	// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
	// a particular request, please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

ConsumerCommitResponse wrapper for the ConsumerCommit operation

func (ConsumerCommitResponse) HTTPResponse 

func (response ConsumerCommitResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ConsumerCommitResponse) String 

func (response ConsumerCommitResponse) String() string

type ConsumerHeartbeatRequest 

type ConsumerHeartbeatRequest struct {

	// The OCID of the stream for which the group is committing offsets.
	StreamId *string `mandatory:"true" contributesTo:"path" name:"streamId"`

	// The group-cursor representing the offsets of the group. This cursor is retrieved from the CreateGroupCursor API call.
	Cursor *string `mandatory:"true" contributesTo:"query" name:"cursor"`

	// The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
	// particular request, please provide the request ID.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

ConsumerHeartbeatRequest wrapper for the ConsumerHeartbeat operation

func (ConsumerHeartbeatRequest) HTTPRequest 

func (request ConsumerHeartbeatRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ConsumerHeartbeatRequest) RetryPolicy 

func (request ConsumerHeartbeatRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ConsumerHeartbeatRequest) String 

func (request ConsumerHeartbeatRequest) String() string

type ConsumerHeartbeatResponse 

type ConsumerHeartbeatResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The Cursor instance
	Cursor `presentIn:"body"`

	// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
	// a particular request, please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

ConsumerHeartbeatResponse wrapper for the ConsumerHeartbeat operation

func (ConsumerHeartbeatResponse) HTTPResponse 

func (response ConsumerHeartbeatResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ConsumerHeartbeatResponse) String 

func (response ConsumerHeartbeatResponse) String() string

type CreateArchiverDetails 

type CreateArchiverDetails struct {

	// The name of the bucket.
	BucketName *string `mandatory:"true" json:"bucketName"`

	// The flag to create a new bucket or use existing one.
	UseExistingBucket *bool `mandatory:"true" json:"useExistingBucket"`

	// The start message.
	StartPosition ArchiverStartPositionEnum `mandatory:"true" json:"startPosition"`

	// The batch rollover size in megabytes.
	BatchRolloverSizeInMBs *int `mandatory:"true" json:"batchRolloverSizeInMBs"`

	// The rollover time in seconds.
	BatchRolloverTimeInSeconds *int `mandatory:"true" json:"batchRolloverTimeInSeconds"`
}

CreateArchiverDetails Represents the parameters of the stream archiver.

func (CreateArchiverDetails) String 

func (m CreateArchiverDetails) String() string

type CreateArchiverDetailsStartPositionEnum 

type CreateArchiverDetailsStartPositionEnum = ArchiverStartPositionEnum

CreateArchiverDetailsStartPositionEnum is an alias to type: ArchiverStartPositionEnum Consider using ArchiverStartPositionEnum instead Deprecated

type CreateArchiverRequest 

type CreateArchiverRequest struct {

	// The OCID of the stream.
	StreamId *string `mandatory:"true" contributesTo:"path" name:"streamId"`

	// A stream archiver parameters to create.
	CreateArchiverDetails `contributesTo:"body"`

	// The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
	// particular request, please provide the request ID.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
	OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

CreateArchiverRequest wrapper for the CreateArchiver operation

func (CreateArchiverRequest) HTTPRequest 

func (request CreateArchiverRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateArchiverRequest) RetryPolicy 

func (request CreateArchiverRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (CreateArchiverRequest) String 

func (request CreateArchiverRequest) String() string

type CreateArchiverResponse 

type CreateArchiverResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The Archiver instance
	Archiver `presentIn:"body"`

	// For optimistic concurrency control. See `if-match`.
	Etag *string `presentIn:"header" name:"etag"`

	// Unique Oracle-assigned identifier for the request. If you need to contact Oracle
	// about a particular request, please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

CreateArchiverResponse wrapper for the CreateArchiver operation

func (CreateArchiverResponse) HTTPResponse 

func (response CreateArchiverResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (CreateArchiverResponse) String 

func (response CreateArchiverResponse) String() string

type CreateCursorDetails 

type CreateCursorDetails struct {

	// The partition to get messages from.
	Partition *string `mandatory:"true" json:"partition"`

	// The type of cursor, which determines the starting point from which the stream will be consumed:
	// - `AFTER_OFFSET:` The partition position immediately following the offset you specify. (Offsets are assigned when you successfully append a message to a partition in a stream.)
	// - `AT_OFFSET:` The exact partition position indicated by the offset you specify.
	// - `AT_TIME:` A specific point in time.
	// - `LATEST:` The most recent message in the partition that was added after the cursor was created.
	// - `TRIM_HORIZON:` The oldest message in the partition that is within the retention period window.
	Type CreateCursorDetailsTypeEnum `mandatory:"true" json:"type"`

	// The offset to consume from if the cursor type is `AT_OFFSET` or `AFTER_OFFSET`.
	Offset *int64 `mandatory:"false" json:"offset"`

	// The time to consume from if the cursor type is `AT_TIME`, expressed in RFC 3339 (https://tools.ietf.org/rfc/rfc3339) timestamp format.
	Time *common.SDKTime `mandatory:"false" json:"time"`
}

CreateCursorDetails Object used to create a cursor to consume messages in a stream.

func (CreateCursorDetails) String 

func (m CreateCursorDetails) String() string

type CreateCursorDetailsTypeEnum 

type CreateCursorDetailsTypeEnum string

CreateCursorDetailsTypeEnum Enum with underlying type: string 

const (
	CreateCursorDetailsTypeAfterOffset CreateCursorDetailsTypeEnum = "AFTER_OFFSET"
	CreateCursorDetailsTypeAtOffset    CreateCursorDetailsTypeEnum = "AT_OFFSET"
	CreateCursorDetailsTypeAtTime      CreateCursorDetailsTypeEnum = "AT_TIME"
	CreateCursorDetailsTypeLatest      CreateCursorDetailsTypeEnum = "LATEST"
	CreateCursorDetailsTypeTrimHorizon CreateCursorDetailsTypeEnum = "TRIM_HORIZON"
)

Set of constants representing the allowable values for CreateCursorDetailsTypeEnum

func GetCreateCursorDetailsTypeEnumValues 

func GetCreateCursorDetailsTypeEnumValues() []CreateCursorDetailsTypeEnum

GetCreateCursorDetailsTypeEnumValues Enumerates the set of values for CreateCursorDetailsTypeEnum

type CreateCursorRequest 

type CreateCursorRequest struct {

	// The OCID of the stream to create a cursor for.
	StreamId *string `mandatory:"true" contributesTo:"path" name:"streamId"`

	// The information used to create the cursor.
	CreateCursorDetails `contributesTo:"body"`

	// The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
	// particular request, please provide the request ID.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

CreateCursorRequest wrapper for the CreateCursor operation

func (CreateCursorRequest) HTTPRequest 

func (request CreateCursorRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateCursorRequest) RetryPolicy 

func (request CreateCursorRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (CreateCursorRequest) String 

func (request CreateCursorRequest) String() string

type CreateCursorResponse 

type CreateCursorResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The Cursor instance
	Cursor `presentIn:"body"`

	// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
	// a particular request, please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

CreateCursorResponse wrapper for the CreateCursor operation

func (CreateCursorResponse) HTTPResponse 

func (response CreateCursorResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (CreateCursorResponse) String 

func (response CreateCursorResponse) String() string

type CreateGroupCursorDetails 

type CreateGroupCursorDetails struct {

	// The type of the cursor. This value is only used when the group is created.
	Type CreateGroupCursorDetailsTypeEnum `mandatory:"true" json:"type"`

	// Name of the consumer group.
	GroupName *string `mandatory:"true" json:"groupName"`

	// The time to consume from if type is AT_TIME.
	Time *common.SDKTime `mandatory:"false" json:"time"`

	// A unique identifier for the instance joining the consumer group. If an instanceName is not provided, a UUID will be generated and used.
	InstanceName *string `mandatory:"false" json:"instanceName"`

	// The amount of a consumer instance inactivity time, before partition reservations are released.
	TimeoutInMs *int `mandatory:"false" json:"timeoutInMs"`

	// When using consumer-groups, the default commit-on-get behaviour can be overriden by setting this value to false.
	// If disabled, a consumer must manually commit their cursors.
	CommitOnGet *bool `mandatory:"false" json:"commitOnGet"`
}

CreateGroupCursorDetails Object used to create a group cursor.

func (CreateGroupCursorDetails) String 

func (m CreateGroupCursorDetails) String() string

type CreateGroupCursorDetailsTypeEnum 

type CreateGroupCursorDetailsTypeEnum string

CreateGroupCursorDetailsTypeEnum Enum with underlying type: string 

const (
	CreateGroupCursorDetailsTypeAtTime      CreateGroupCursorDetailsTypeEnum = "AT_TIME"
	CreateGroupCursorDetailsTypeLatest      CreateGroupCursorDetailsTypeEnum = "LATEST"
	CreateGroupCursorDetailsTypeTrimHorizon CreateGroupCursorDetailsTypeEnum = "TRIM_HORIZON"
)

Set of constants representing the allowable values for CreateGroupCursorDetailsTypeEnum

func GetCreateGroupCursorDetailsTypeEnumValues 

func GetCreateGroupCursorDetailsTypeEnumValues() []CreateGroupCursorDetailsTypeEnum

GetCreateGroupCursorDetailsTypeEnumValues Enumerates the set of values for CreateGroupCursorDetailsTypeEnum

type CreateGroupCursorRequest 

type CreateGroupCursorRequest struct {

	// The OCID of the stream to create a cursor for.
	StreamId *string `mandatory:"true" contributesTo:"path" name:"streamId"`

	// The information used to create the cursor.
	CreateGroupCursorDetails `contributesTo:"body"`

	// The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
	// particular request, please provide the request ID.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

CreateGroupCursorRequest wrapper for the CreateGroupCursor operation

func (CreateGroupCursorRequest) HTTPRequest 

func (request CreateGroupCursorRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateGroupCursorRequest) RetryPolicy 

func (request CreateGroupCursorRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (CreateGroupCursorRequest) String 

func (request CreateGroupCursorRequest) String() string

type CreateGroupCursorResponse 

type CreateGroupCursorResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The Cursor instance
	Cursor `presentIn:"body"`

	// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
	// a particular request, please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

CreateGroupCursorResponse wrapper for the CreateGroupCursor operation

func (CreateGroupCursorResponse) HTTPResponse 

func (response CreateGroupCursorResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (CreateGroupCursorResponse) String 

func (response CreateGroupCursorResponse) String() string

type CreateStreamDetails 

type CreateStreamDetails struct {

	// The name of the stream. Avoid entering confidential information.
	// Example: `TelemetryEvents`
	Name *string `mandatory:"true" json:"name"`

	// The number of partitions in the stream.
	Partitions *int `mandatory:"true" json:"partitions"`

	// The OCID of the compartment that contains the stream.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// The retention period of the stream, in hours. Accepted values are between 24 and 168 (7 days).
	// If not specified, the stream will have a retention period of 24 hours.
	RetentionInHours *int `mandatory:"false" json:"retentionInHours"`

	// Free-form tags for this resource. Each tag is a simple key-value pair that is applied with no predefined name, type, or namespace. Exists for cross-compatibility only.
	// For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

CreateStreamDetails Object used to create a stream.

func (CreateStreamDetails) String 

func (m CreateStreamDetails) String() string

type CreateStreamRequest 

type CreateStreamRequest struct {

	// The stream to create.
	CreateStreamDetails `contributesTo:"body"`

	// The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
	// particular request, please provide the request ID.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

CreateStreamRequest wrapper for the CreateStream operation

func (CreateStreamRequest) HTTPRequest 

func (request CreateStreamRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateStreamRequest) RetryPolicy 

func (request CreateStreamRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (CreateStreamRequest) String 

func (request CreateStreamRequest) String() string

type CreateStreamResponse 

type CreateStreamResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The Stream instance
	Stream `presentIn:"body"`

	// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
	// a particular request, please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`

	// For optimistic concurrency control. See `if-match`.
	Etag *string `presentIn:"header" name:"etag"`
}

CreateStreamResponse wrapper for the CreateStream operation

func (CreateStreamResponse) HTTPResponse 

func (response CreateStreamResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (CreateStreamResponse) String 

func (response CreateStreamResponse) String() string

type Cursor 

type Cursor struct {

	// The cursor to pass to the `GetMessages` operation.
	Value *string `mandatory:"true" json:"value"`
}

Cursor A cursor that indicates the position in the stream from which you want to begin consuming messages and which is required by the GetMessages operation.

func (Cursor) String 

func (m Cursor) String() string

type DeleteStreamRequest 

type DeleteStreamRequest struct {

	// The OCID of the stream to delete.
	StreamId *string `mandatory:"true" contributesTo:"path" name:"streamId"`

	// The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
	// particular request, please provide the request ID.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

DeleteStreamRequest wrapper for the DeleteStream operation

func (DeleteStreamRequest) HTTPRequest 

func (request DeleteStreamRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteStreamRequest) RetryPolicy 

func (request DeleteStreamRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (DeleteStreamRequest) String 

func (request DeleteStreamRequest) String() string

type DeleteStreamResponse 

type DeleteStreamResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
	// a particular request, please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

DeleteStreamResponse wrapper for the DeleteStream operation

func (DeleteStreamResponse) HTTPResponse 

func (response DeleteStreamResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (DeleteStreamResponse) String 

func (response DeleteStreamResponse) String() string

type GetArchiverRequest 

type GetArchiverRequest struct {

	// The OCID of the stream.
	StreamId *string `mandatory:"true" contributesTo:"path" name:"streamId"`

	// The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
	// particular request, please provide the request ID.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

GetArchiverRequest wrapper for the GetArchiver operation

func (GetArchiverRequest) HTTPRequest 

func (request GetArchiverRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetArchiverRequest) RetryPolicy 

func (request GetArchiverRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetArchiverRequest) String 

func (request GetArchiverRequest) String() string

type GetArchiverResponse 

type GetArchiverResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The Archiver instance
	Archiver `presentIn:"body"`

	// For optimistic concurrency control. See `if-match`.
	Etag *string `presentIn:"header" name:"etag"`

	// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
	// a particular request, please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

GetArchiverResponse wrapper for the GetArchiver operation

func (GetArchiverResponse) HTTPResponse 

func (response GetArchiverResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetArchiverResponse) String 

func (response GetArchiverResponse) String() string

type GetGroupRequest 

type GetGroupRequest struct {

	// The OCID of the stream, on which the group is operating.
	StreamId *string `mandatory:"true" contributesTo:"path" name:"streamId"`

	// The name of the consumer group.
	GroupName *string `mandatory:"true" contributesTo:"path" name:"groupName"`

	// The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
	// particular request, please provide the request ID.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

GetGroupRequest wrapper for the GetGroup operation

func (GetGroupRequest) HTTPRequest 

func (request GetGroupRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetGroupRequest) RetryPolicy 

func (request GetGroupRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetGroupRequest) String 

func (request GetGroupRequest) String() string

type GetGroupResponse 

type GetGroupResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The Group instance
	Group `presentIn:"body"`

	// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
	// a particular request, please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

GetGroupResponse wrapper for the GetGroup operation

func (GetGroupResponse) HTTPResponse 

func (response GetGroupResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetGroupResponse) String 

func (response GetGroupResponse) String() string

type GetMessagesRequest 

type GetMessagesRequest struct {

	// The OCID of the stream to get messages from.
	StreamId *string `mandatory:"true" contributesTo:"path" name:"streamId"`

	// The cursor used to consume the stream.
	Cursor *string `mandatory:"true" contributesTo:"query" name:"cursor"`

	// 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.
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
	// particular request, please provide the request ID.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

GetMessagesRequest wrapper for the GetMessages operation

func (GetMessagesRequest) HTTPRequest 

func (request GetMessagesRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetMessagesRequest) RetryPolicy 

func (request GetMessagesRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetMessagesRequest) String 

func (request GetMessagesRequest) String() string

type GetMessagesResponse 

type GetMessagesResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The []Message instance
	Items []Message `presentIn:"body"`

	// The cursor to use to get the next batch of messages.
	OpcNextCursor *string `presentIn:"header" name:"opc-next-cursor"`

	// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
	// a particular request, please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

GetMessagesResponse wrapper for the GetMessages operation

func (GetMessagesResponse) HTTPResponse 

func (response GetMessagesResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetMessagesResponse) String 

func (response GetMessagesResponse) String() string

type GetStreamRequest 

type GetStreamRequest struct {

	// The OCID of the stream to retrieve.
	StreamId *string `mandatory:"true" contributesTo:"path" name:"streamId"`

	// The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
	// particular request, please provide the request ID.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

GetStreamRequest wrapper for the GetStream operation

func (GetStreamRequest) HTTPRequest 

func (request GetStreamRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetStreamRequest) RetryPolicy 

func (request GetStreamRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetStreamRequest) String 

func (request GetStreamRequest) String() string

type GetStreamResponse 

type GetStreamResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The Stream instance
	Stream `presentIn:"body"`

	// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
	// a particular request, please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`

	// For optimistic concurrency control. See `if-match`.
	Etag *string `presentIn:"header" name:"etag"`
}

GetStreamResponse wrapper for the GetStream operation

func (GetStreamResponse) HTTPResponse 

func (response GetStreamResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetStreamResponse) String 

func (response GetStreamResponse) String() string

type Group 

type Group struct {

	// The streamId for which the group exists.
	StreamId *string `mandatory:"false" json:"streamId"`

	// The name of the consumer group.
	GroupName *string `mandatory:"false" json:"groupName"`

	// An array of the partition reservations of a group.
	Reservations []PartitionReservation `mandatory:"false" json:"reservations"`
}

Group Represents the current state of a consumer group, including partition reservations and committed offsets.

func (Group) String 

func (m Group) String() string

type ListStreamsRequest 

type ListStreamsRequest struct {

	// The OCID of the compartment.
	CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`

	// A filter to return only resources that match the given ID exactly.
	Id *string `mandatory:"false" contributesTo:"query" name:"id"`

	// A filter to return only resources that match the given name exactly.
	Name *string `mandatory:"false" contributesTo:"query" name:"name"`

	// The maximum number of items to return. The value must be between 1 and 50. The default is 10.
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// The page at which to start retrieving results.
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// 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.
	SortBy ListStreamsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`

	// The sort order to use, either 'asc' or 'desc'.
	SortOrder ListStreamsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`

	// A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
	LifecycleState StreamLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`

	// The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
	// particular request, please provide the request ID.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

ListStreamsRequest wrapper for the ListStreams operation

func (ListStreamsRequest) HTTPRequest 

func (request ListStreamsRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListStreamsRequest) RetryPolicy 

func (request ListStreamsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListStreamsRequest) String 

func (request ListStreamsRequest) String() string

type ListStreamsResponse 

type ListStreamsResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of []StreamSummary instances
	Items []StreamSummary `presentIn:"body"`

	// For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	OpcNextPage *string `presentIn:"header" name:"opc-next-page"`

	// For list pagination. When this header appears in the response, previous pages of results exist. For important details about how pagination works, see List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	OpcPrevPage *string `presentIn:"header" name:"opc-prev-page"`

	// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
	// a particular request, please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

ListStreamsResponse wrapper for the ListStreams operation

func (ListStreamsResponse) HTTPResponse 

func (response ListStreamsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListStreamsResponse) String 

func (response ListStreamsResponse) String() string

type ListStreamsSortByEnum 

type ListStreamsSortByEnum string

ListStreamsSortByEnum Enum with underlying type: string 

const (
	ListStreamsSortByName        ListStreamsSortByEnum = "NAME"
	ListStreamsSortByTimecreated ListStreamsSortByEnum = "TIMECREATED"
)

Set of constants representing the allowable values for ListStreamsSortByEnum

func GetListStreamsSortByEnumValues 

func GetListStreamsSortByEnumValues() []ListStreamsSortByEnum

GetListStreamsSortByEnumValues Enumerates the set of values for ListStreamsSortByEnum

type ListStreamsSortOrderEnum 

type ListStreamsSortOrderEnum string

ListStreamsSortOrderEnum Enum with underlying type: string 

const (
	ListStreamsSortOrderAsc  ListStreamsSortOrderEnum = "ASC"
	ListStreamsSortOrderDesc ListStreamsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListStreamsSortOrderEnum

func GetListStreamsSortOrderEnumValues 

func GetListStreamsSortOrderEnumValues() []ListStreamsSortOrderEnum

GetListStreamsSortOrderEnumValues Enumerates the set of values for ListStreamsSortOrderEnum

type Message 

type Message struct {

	// The name of the stream that the message belongs to.
	Stream *string `mandatory:"true" json:"stream"`

	// The ID of the partition where the message is stored.
	Partition *string `mandatory:"true" json:"partition"`

	// The key associated with the message, expressed as a byte array.
	Key []byte `mandatory:"true" json:"key"`

	// The value associated with the message, expressed as a byte array.
	Value []byte `mandatory:"true" json:"value"`

	// The offset of the message, which uniquely identifies it within the partition.
	Offset *int64 `mandatory:"true" json:"offset"`

	// The timestamp indicating when the server appended the message to the stream.
	Timestamp *common.SDKTime `mandatory:"true" json:"timestamp"`
}

Message A message in a stream.

func (Message) String 

func (m Message) String() string

type PartitionReservation 

type PartitionReservation struct {

	// The partition for which the reservation applies.
	Partition *string `mandatory:"false" json:"partition"`

	// The latest offset which has been committed for this partition.
	CommittedOffset *int64 `mandatory:"false" json:"committedOffset"`

	// The consumer instance which currently has the partition reserved.
	ReservedInstance *string `mandatory:"false" json:"reservedInstance"`

	// A timestamp when the current reservation expires.
	TimeReservedUntil *common.SDKTime `mandatory:"false" json:"timeReservedUntil"`
}

PartitionReservation Represents the state of a single partition reservation.

func (PartitionReservation) String 

func (m PartitionReservation) String() string

type PutMessagesDetails 

type PutMessagesDetails struct {

	// The array of messages to put into a stream.
	Messages []PutMessagesDetailsEntry `mandatory:"true" json:"messages"`
}

PutMessagesDetails Object that represents an array of messages to emit to a stream.

func (PutMessagesDetails) String 

func (m PutMessagesDetails) String() string

type PutMessagesDetailsEntry 

type PutMessagesDetailsEntry struct {

	// The message, expressed as a byte array up to 1 MiB in size.
	Value []byte `mandatory:"true" json:"value"`

	// The key of the message, expressed as a byte array up to 256 bytes in size. Messages with the same key are stored in the same partition.
	Key []byte `mandatory:"false" json:"key"`
}

PutMessagesDetailsEntry Object that represents a message to emit to a stream.

func (PutMessagesDetailsEntry) String 

func (m PutMessagesDetailsEntry) String() string

type PutMessagesRequest 

type PutMessagesRequest struct {

	// The OCID of the stream where you want to put messages.
	StreamId *string `mandatory:"true" contributesTo:"path" name:"streamId"`

	// Array of messages to put into the stream.
	PutMessagesDetails `contributesTo:"body"`

	// The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
	// particular request, please provide the request ID.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

PutMessagesRequest wrapper for the PutMessages operation

func (PutMessagesRequest) HTTPRequest 

func (request PutMessagesRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (PutMessagesRequest) RetryPolicy 

func (request PutMessagesRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (PutMessagesRequest) String 

func (request PutMessagesRequest) String() string

type PutMessagesResponse 

type PutMessagesResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The PutMessagesResult instance
	PutMessagesResult `presentIn:"body"`

	// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
	// a particular request, please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

PutMessagesResponse wrapper for the PutMessages operation

func (PutMessagesResponse) HTTPResponse 

func (response PutMessagesResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (PutMessagesResponse) String 

func (response PutMessagesResponse) String() string

type PutMessagesResult 

type PutMessagesResult struct {

	// The number of messages that failed to be added to the stream.
	Failures *int `mandatory:"true" json:"failures"`

	// An array of items representing the result of each message.
	// The order is guaranteed to be the same as in the `PutMessagesDetails` object.
	// If a message was successfully appended to the stream, the entry includes the `offset`, `partition`, and `timestamp`.
	// If a message failed to be appended to the stream, the entry includes the `error` and `errorMessage`.
	Entries []PutMessagesResultEntry `mandatory:"false" json:"entries"`
}

PutMessagesResult The response to a PutMessages request. It indicates the number of failed messages as well as an array of results for successful and failed messages.

func (PutMessagesResult) String 

func (m PutMessagesResult) String() string

type PutMessagesResultEntry 

type PutMessagesResultEntry struct {

	// The ID of the partition where the message was stored.
	Partition *string `mandatory:"false" json:"partition"`

	// The offset of the message in the partition.
	Offset *int64 `mandatory:"false" json:"offset"`

	// The timestamp indicating when the server appended the message to the stream.
	Timestamp *common.SDKTime `mandatory:"false" json:"timestamp"`

	// The error code, in case the message was not successfully appended to the stream.
	Error *string `mandatory:"false" json:"error"`

	// A human-readable error message associated with the error code.
	ErrorMessage *string `mandatory:"false" json:"errorMessage"`
}

PutMessagesResultEntry Represents the result of a PutMessages request, whether it was successful or not. If a message was successfully appended to the stream, the entry includes the `offset`, `partition`, and `timestamp`. If the message failed to be appended to the stream, the entry includes the `error` and `errorMessage`.

func (PutMessagesResultEntry) String 

func (m PutMessagesResultEntry) String() string

type StartArchiverRequest 

type StartArchiverRequest struct {

	// The OCID of the stream.
	StreamId *string `mandatory:"true" contributesTo:"path" name:"streamId"`

	// The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
	// particular request, please provide the request ID.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

StartArchiverRequest wrapper for the StartArchiver operation

func (StartArchiverRequest) HTTPRequest 

func (request StartArchiverRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (StartArchiverRequest) RetryPolicy 

func (request StartArchiverRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (StartArchiverRequest) String 

func (request StartArchiverRequest) String() string

type StartArchiverResponse 

type StartArchiverResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The Archiver instance
	Archiver `presentIn:"body"`

	// For optimistic concurrency control. See `if-match`.
	Etag *string `presentIn:"header" name:"etag"`

	// Unique Oracle-assigned identifier for the request. If you need to contact Oracle
	// about a particular request, please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

StartArchiverResponse wrapper for the StartArchiver operation

func (StartArchiverResponse) HTTPResponse 

func (response StartArchiverResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (StartArchiverResponse) String 

func (response StartArchiverResponse) String() string

type StopArchiverRequest 

type StopArchiverRequest struct {

	// The OCID of the stream.
	StreamId *string `mandatory:"true" contributesTo:"path" name:"streamId"`

	// The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
	// particular request, please provide the request ID.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

StopArchiverRequest wrapper for the StopArchiver operation

func (StopArchiverRequest) HTTPRequest 

func (request StopArchiverRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (StopArchiverRequest) RetryPolicy 

func (request StopArchiverRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (StopArchiverRequest) String 

func (request StopArchiverRequest) String() string

type StopArchiverResponse 

type StopArchiverResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The Archiver instance
	Archiver `presentIn:"body"`

	// For optimistic concurrency control. See `if-match`.
	Etag *string `presentIn:"header" name:"etag"`

	// Unique Oracle-assigned identifier for the request. If you need to contact Oracle
	// about a particular request, please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

StopArchiverResponse wrapper for the StopArchiver operation

func (StopArchiverResponse) HTTPResponse 

func (response StopArchiverResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (StopArchiverResponse) String 

func (response StopArchiverResponse) String() string

type Stream 

type Stream struct {

	// The name of the stream. Avoid entering confidential information.
	// Example: `TelemetryEvents`
	Name *string `mandatory:"true" json:"name"`

	// The OCID of the stream.
	Id *string `mandatory:"true" json:"id"`

	// The number of partitions in the stream.
	Partitions *int `mandatory:"true" json:"partitions"`

	// The retention period of the stream, in hours. This property is read-only.
	RetentionInHours *int `mandatory:"true" json:"retentionInHours"`

	// The OCID of the stream.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// The current state of the stream.
	LifecycleState StreamLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`

	// The date and time the stream was created, expressed in in RFC 3339 (https://tools.ietf.org/rfc/rfc3339) timestamp format.
	// Example: `2018-04-20T00:00:07.405Z`
	TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`

	// The endpoint to use when creating the StreamClient to consume or publish messages in the stream.
	MessagesEndpoint *string `mandatory:"true" json:"messagesEndpoint"`

	// Any additional details about the current state of the stream.
	LifecycleStateDetails *string `mandatory:"false" json:"lifecycleStateDetails"`

	// 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 (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}'
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

Stream Detailed representation of a stream, including all its partitions.

func (Stream) String 

func (m Stream) String() string

type StreamAdminClient 

type StreamAdminClient struct {
	common.BaseClient
	// contains filtered or unexported fields
}

StreamAdminClient a client for StreamAdmin

func NewStreamAdminClientWithConfigurationProvider 

func NewStreamAdminClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client StreamAdminClient, err error)

NewStreamAdminClientWithConfigurationProvider Creates a new default StreamAdmin client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region

func (StreamAdminClient) ChangeStreamCompartment 

func (client StreamAdminClient) ChangeStreamCompartment(ctx context.Context, request ChangeStreamCompartmentRequest) (response ChangeStreamCompartmentResponse, err error)

ChangeStreamCompartment Moves a resource into a different compartment. When provided, If-Match is checked against ETag values of the resource.

func (*StreamAdminClient) ConfigurationProvider 

func (client *StreamAdminClient) ConfigurationProvider() *common.ConfigurationProvider

ConfigurationProvider the ConfigurationProvider used in this client, or null if none set

func (StreamAdminClient) CreateArchiver 

func (client StreamAdminClient) CreateArchiver(ctx context.Context, request CreateArchiverRequest) (response CreateArchiverResponse, err error)

CreateArchiver Starts the provisioning of a new stream archiver. To track the progress of the provisioning, you can periodically call GetArchiver. In the response, the `lifecycleState` parameter of the Archiver object tells you its current state.

func (StreamAdminClient) CreateStream 

func (client StreamAdminClient) CreateStream(ctx context.Context, request CreateStreamRequest) (response CreateStreamResponse, err error)

CreateStream Starts the provisioning of a new stream. To track the progress of the provisioning, you can periodically call GetStream. In the response, the `lifecycleState` parameter of the Stream object tells you its current state.

func (StreamAdminClient) DeleteStream 

func (client StreamAdminClient) DeleteStream(ctx context.Context, request DeleteStreamRequest) (response DeleteStreamResponse, err error)

DeleteStream Deletes a stream and its content. Stream contents are deleted immediately. The service retains records of the stream itself for 90 days after deletion. The `lifecycleState` parameter of the `Stream` object changes to `DELETING` and the stream becomes inaccessible for read or write operations. To verify that a stream has been deleted, make a GetStream request. If the call returns the stream's lifecycle state as `DELETED`, then the stream has been deleted. If the call returns a "404 Not Found" error, that means all records of the stream have been deleted.

func (StreamAdminClient) GetArchiver 

func (client StreamAdminClient) GetArchiver(ctx context.Context, request GetArchiverRequest) (response GetArchiverResponse, err error)

GetArchiver Returns the current state of the stream archiver.

func (StreamAdminClient) GetStream 

func (client StreamAdminClient) GetStream(ctx context.Context, request GetStreamRequest) (response GetStreamResponse, err error)

GetStream Gets detailed information about a stream, including the number of partitions.

func (StreamAdminClient) ListStreams 

func (client StreamAdminClient) ListStreams(ctx context.Context, request ListStreamsRequest) (response ListStreamsResponse, err error)

ListStreams Lists the streams.

func (*StreamAdminClient) SetRegion 

func (client *StreamAdminClient) SetRegion(region string)

SetRegion overrides the region of this client.

func (StreamAdminClient) StartArchiver 

func (client StreamAdminClient) StartArchiver(ctx context.Context, request StartArchiverRequest) (response StartArchiverResponse, err error)

StartArchiver Start the archiver for the specified stream.

func (StreamAdminClient) StopArchiver 

func (client StreamAdminClient) StopArchiver(ctx context.Context, request StopArchiverRequest) (response StopArchiverResponse, err error)

StopArchiver Stop the archiver for the specified stream.

func (StreamAdminClient) UpdateArchiver 

func (client StreamAdminClient) UpdateArchiver(ctx context.Context, request UpdateArchiverRequest) (response UpdateArchiverResponse, err error)

UpdateArchiver Update the stream archiver parameters.

func (StreamAdminClient) UpdateStream 

func (client StreamAdminClient) UpdateStream(ctx context.Context, request UpdateStreamRequest) (response UpdateStreamResponse, err error)

UpdateStream Updates the tags applied to the stream.

type StreamClient 

type StreamClient struct {
	common.BaseClient
	// contains filtered or unexported fields
}

StreamClient a client for Stream

func NewStreamClientWithConfigurationProvider 

func NewStreamClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client StreamClient, err error)

NewStreamClientWithConfigurationProvider Creates a new default Stream client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region

func (*StreamClient) ConfigurationProvider 

func (client *StreamClient) ConfigurationProvider() *common.ConfigurationProvider

ConfigurationProvider the ConfigurationProvider used in this client, or null if none set

func (StreamClient) ConsumerCommit 

func (client StreamClient) ConsumerCommit(ctx context.Context, request ConsumerCommitRequest) (response ConsumerCommitResponse, err error)

ConsumerCommit Provides a mechanism to manually commit offsets, if not using commit-on-get consumer semantics. This commits offsets assicated with the provided cursor, extends the timeout on each of the affected partitions, and returns an updated cursor.

func (StreamClient) ConsumerHeartbeat 

func (client StreamClient) ConsumerHeartbeat(ctx context.Context, request ConsumerHeartbeatRequest) (response ConsumerHeartbeatResponse, err error)

ConsumerHeartbeat Allows long-running processes to extend the timeout on partitions reserved by a consumer instance.

func (StreamClient) CreateCursor 

func (client StreamClient) CreateCursor(ctx context.Context, request CreateCursorRequest) (response CreateCursorResponse, err error)

CreateCursor Creates a cursor. Cursors are used to consume a stream, starting from a specific point in the partition and going forward from there. You can create a cursor based on an offset, a time, the trim horizon, or the most recent message in the stream. As the oldest message inside the retention period boundary, using the trim horizon effectively lets you consume all messages in the stream. A cursor based on the most recent message allows consumption of only messages that are added to the stream after you create the cursor. Cursors expire five minutes after you receive them from the service.

func (StreamClient) CreateGroupCursor 

func (client StreamClient) CreateGroupCursor(ctx context.Context, request CreateGroupCursorRequest) (response CreateGroupCursorResponse, err error)

CreateGroupCursor Creates a group-cursor.

func (StreamClient) GetGroup 

func (client StreamClient) GetGroup(ctx context.Context, request GetGroupRequest) (response GetGroupResponse, err error)

GetGroup Returns the current state of a consumer group.

func (StreamClient) GetMessages 

func (client StreamClient) GetMessages(ctx context.Context, request GetMessagesRequest) (response GetMessagesResponse, err error)

GetMessages Returns messages from the specified stream using the specified cursor as the starting point for consumption. By default, the number of messages returned is undefined, but the service returns as many as possible. To get messages, you must first obtain a cursor using the CreateCursor operation. In the response, retrieve the value of the 'opc-next-cursor' header to pass as a parameter to get the next batch of messages in the stream.

func (StreamClient) PutMessages 

func (client StreamClient) PutMessages(ctx context.Context, request PutMessagesRequest) (response PutMessagesResponse, err error)

PutMessages Emits messages to a stream. There's no limit to the number of messages in a request, but the total size of a message or request must be 1 MiB or less. The service calculates the partition ID from the message key and stores messages that share a key on the same partition. If a message does not contain a key or if the key is null, the service generates a message key for you. The partition ID cannot be passed as a parameter.

func (*StreamClient) SetRegion 

func (client *StreamClient) SetRegion(region string)

SetRegion overrides the region of this client.

func (StreamClient) UpdateGroup 

func (client StreamClient) UpdateGroup(ctx context.Context, request UpdateGroupRequest) (response UpdateGroupResponse, err error)

UpdateGroup Forcefully changes the current location of a group as a whole; reseting processing location of all consumers to a particular location in the stream.

type StreamLifecycleStateEnum 

type StreamLifecycleStateEnum string

StreamLifecycleStateEnum Enum with underlying type: string 

const (
	StreamLifecycleStateCreating StreamLifecycleStateEnum = "CREATING"
	StreamLifecycleStateActive   StreamLifecycleStateEnum = "ACTIVE"
	StreamLifecycleStateDeleting StreamLifecycleStateEnum = "DELETING"
	StreamLifecycleStateDeleted  StreamLifecycleStateEnum = "DELETED"
	StreamLifecycleStateFailed   StreamLifecycleStateEnum = "FAILED"
)

Set of constants representing the allowable values for StreamLifecycleStateEnum

func GetStreamLifecycleStateEnumValues 

func GetStreamLifecycleStateEnumValues() []StreamLifecycleStateEnum

GetStreamLifecycleStateEnumValues Enumerates the set of values for StreamLifecycleStateEnum

type StreamSummary 

type StreamSummary struct {

	// The name of the stream.
	// Example: `TelemetryEvents`
	Name *string `mandatory:"true" json:"name"`

	// The OCID of the stream.
	Id *string `mandatory:"true" json:"id"`

	// The number of partitions in the stream.
	Partitions *int `mandatory:"true" json:"partitions"`

	// The OCID of the compartment that contains the stream.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// The current state of the stream.
	LifecycleState StreamSummaryLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`

	// The date and time the stream was created, expressed in RFC 3339 (https://tools.ietf.org/rfc/rfc3339) timestamp format.
	// Example: `2018-04-20T00:00:07.405Z`
	TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`

	// The endpoint to use when creating the StreamClient to consume or publish messages in the stream.
	MessagesEndpoint *string `mandatory:"true" json:"messagesEndpoint"`

	// Free-form tags for this resource. Each tag is a simple key-value pair that is applied with no predefined name, type, or namespace. Exists for cross-compatibility only.
	// For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

StreamSummary Summary representation of a stream.

func (StreamSummary) String 

func (m StreamSummary) String() string

type StreamSummaryLifecycleStateEnum 

type StreamSummaryLifecycleStateEnum string

StreamSummaryLifecycleStateEnum Enum with underlying type: string 

const (
	StreamSummaryLifecycleStateCreating StreamSummaryLifecycleStateEnum = "CREATING"
	StreamSummaryLifecycleStateActive   StreamSummaryLifecycleStateEnum = "ACTIVE"
	StreamSummaryLifecycleStateDeleting StreamSummaryLifecycleStateEnum = "DELETING"
	StreamSummaryLifecycleStateDeleted  StreamSummaryLifecycleStateEnum = "DELETED"
	StreamSummaryLifecycleStateFailed   StreamSummaryLifecycleStateEnum = "FAILED"
)

Set of constants representing the allowable values for StreamSummaryLifecycleStateEnum

func GetStreamSummaryLifecycleStateEnumValues 

func GetStreamSummaryLifecycleStateEnumValues() []StreamSummaryLifecycleStateEnum

GetStreamSummaryLifecycleStateEnumValues Enumerates the set of values for StreamSummaryLifecycleStateEnum

type UpdateArchiverDetails 

type UpdateArchiverDetails struct {

	// The name of the bucket.
	BucketName *string `mandatory:"false" json:"bucketName"`

	// The flag to create a new bucket or use existing one.
	UseExistingBucket *bool `mandatory:"false" json:"useExistingBucket"`

	// The start message.
	StartPosition ArchiverStartPositionEnum `mandatory:"false" json:"startPosition,omitempty"`

	// The batch rollover size in megabytes.
	BatchRolloverSizeInMBs *int `mandatory:"false" json:"batchRolloverSizeInMBs"`

	// The rollover time in seconds.
	BatchRolloverTimeInSeconds *int `mandatory:"false" json:"batchRolloverTimeInSeconds"`
}

UpdateArchiverDetails The update stream archiver parameters.

func (UpdateArchiverDetails) String 

func (m UpdateArchiverDetails) String() string

type UpdateArchiverDetailsStartPositionEnum 

type UpdateArchiverDetailsStartPositionEnum = ArchiverStartPositionEnum

UpdateArchiverDetailsStartPositionEnum is an alias to type: ArchiverStartPositionEnum Consider using ArchiverStartPositionEnum instead Deprecated

type UpdateArchiverRequest 

type UpdateArchiverRequest struct {

	// The OCID of the stream.
	StreamId *string `mandatory:"true" contributesTo:"path" name:"streamId"`

	// The new parameters of the stream archiver.
	UpdateArchiverDetails `contributesTo:"body"`

	// The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
	// particular request, please provide the request ID.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

UpdateArchiverRequest wrapper for the UpdateArchiver operation

func (UpdateArchiverRequest) HTTPRequest 

func (request UpdateArchiverRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateArchiverRequest) RetryPolicy 

func (request UpdateArchiverRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (UpdateArchiverRequest) String 

func (request UpdateArchiverRequest) String() string

type UpdateArchiverResponse 

type UpdateArchiverResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The Archiver instance
	Archiver `presentIn:"body"`

	// For optimistic concurrency control. See `if-match`.
	Etag *string `presentIn:"header" name:"etag"`

	// Unique Oracle-assigned identifier for the request. If you need to contact Oracle
	// about a particular request, please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

UpdateArchiverResponse wrapper for the UpdateArchiver operation

func (UpdateArchiverResponse) HTTPResponse 

func (response UpdateArchiverResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (UpdateArchiverResponse) String 

func (response UpdateArchiverResponse) String() string

type UpdateGroupDetails 

type UpdateGroupDetails struct {

	// The type of the cursor.
	Type UpdateGroupDetailsTypeEnum `mandatory:"false" json:"type,omitempty"`

	// The time to consume from if type is AT_TIME.
	Time *common.SDKTime `mandatory:"false" json:"time"`
}

UpdateGroupDetails Request body for operationally managing a group.

func (UpdateGroupDetails) String 

func (m UpdateGroupDetails) String() string

type UpdateGroupDetailsTypeEnum 

type UpdateGroupDetailsTypeEnum string

UpdateGroupDetailsTypeEnum Enum with underlying type: string 

const (
	UpdateGroupDetailsTypeAtTime      UpdateGroupDetailsTypeEnum = "AT_TIME"
	UpdateGroupDetailsTypeLatest      UpdateGroupDetailsTypeEnum = "LATEST"
	UpdateGroupDetailsTypeTrimHorizon UpdateGroupDetailsTypeEnum = "TRIM_HORIZON"
)

Set of constants representing the allowable values for UpdateGroupDetailsTypeEnum

func GetUpdateGroupDetailsTypeEnumValues 

func GetUpdateGroupDetailsTypeEnumValues() []UpdateGroupDetailsTypeEnum

GetUpdateGroupDetailsTypeEnumValues Enumerates the set of values for UpdateGroupDetailsTypeEnum

type UpdateGroupRequest 

type UpdateGroupRequest struct {

	// The OCID of the stream, on which the group is operating.
	StreamId *string `mandatory:"true" contributesTo:"path" name:"streamId"`

	// The name of the consumer group.
	GroupName *string `mandatory:"true" contributesTo:"path" name:"groupName"`

	// The information used to modify the group.
	UpdateGroupDetails `contributesTo:"body"`

	// The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
	// particular request, please provide the request ID.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

UpdateGroupRequest wrapper for the UpdateGroup operation

func (UpdateGroupRequest) HTTPRequest 

func (request UpdateGroupRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateGroupRequest) RetryPolicy 

func (request UpdateGroupRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (UpdateGroupRequest) String 

func (request UpdateGroupRequest) String() string

type UpdateGroupResponse 

type UpdateGroupResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
	// a particular request, please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

UpdateGroupResponse wrapper for the UpdateGroup operation

func (UpdateGroupResponse) HTTPResponse 

func (response UpdateGroupResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (UpdateGroupResponse) String 

func (response UpdateGroupResponse) String() string

type UpdateStreamDetails 

type UpdateStreamDetails struct {

	// Free-form tags for this resource. Each tag is a simple key-value pair that is applied with no predefined name, type, or namespace. Exists for cross-compatibility only.
	// For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

UpdateStreamDetails Object used to update a stream.

func (UpdateStreamDetails) String 

func (m UpdateStreamDetails) String() string

type UpdateStreamRequest 

type UpdateStreamRequest struct {

	// The OCID of the stream to update.
	StreamId *string `mandatory:"true" contributesTo:"path" name:"streamId"`

	// The stream is updated with the tags provided.
	UpdateStreamDetails `contributesTo:"body"`

	// The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
	// particular request, please provide the request ID.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

UpdateStreamRequest wrapper for the UpdateStream operation

func (UpdateStreamRequest) HTTPRequest 

func (request UpdateStreamRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateStreamRequest) RetryPolicy 

func (request UpdateStreamRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (UpdateStreamRequest) String 

func (request UpdateStreamRequest) String() string

type UpdateStreamResponse 

type UpdateStreamResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The Stream instance
	Stream `presentIn:"body"`

	// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
	// a particular request, please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`

	// For optimistic concurrency control. See `if-match`.
	Etag *string `presentIn:"header" name:"etag"`
}

UpdateStreamResponse wrapper for the UpdateStream operation

func (UpdateStreamResponse) HTTPResponse 

func (response UpdateStreamResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (UpdateStreamResponse) String 

func (response UpdateStreamResponse) String() string

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.