streaming

package
v31.0.0 Latest Latest
Warning

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

 Go to latest Published: Dec 15, 2020 License: Apache-2.0, UPL-1.0 Imports: 5 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ChangeConnectHarnessCompartmentDetails 

type ChangeConnectHarnessCompartmentDetails 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"`
}

ChangeConnectHarnessCompartmentDetails Detailed representation of a change connect harness compartment operation.

func (ChangeConnectHarnessCompartmentDetails) String 

func (m ChangeConnectHarnessCompartmentDetails) String() string

type ChangeConnectHarnessCompartmentRequest 

type ChangeConnectHarnessCompartmentRequest struct {

	// The OCID of the connect harness.
	ConnectHarnessId *string `mandatory:"true" contributesTo:"path" name:"connectHarnessId"`

	// The connect harness will be moved into the compartment specified within this entity.
	ChangeConnectHarnessCompartmentDetails `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
}

ChangeConnectHarnessCompartmentRequest wrapper for the ChangeConnectHarnessCompartment operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/streaming/ChangeConnectHarnessCompartment.go.html to see an example of how to use ChangeConnectHarnessCompartmentRequest.

func (ChangeConnectHarnessCompartmentRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (ChangeConnectHarnessCompartmentRequest) RetryPolicy 

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

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

func (ChangeConnectHarnessCompartmentRequest) String 

func (request ChangeConnectHarnessCompartmentRequest) String() string

type ChangeConnectHarnessCompartmentResponse 

type ChangeConnectHarnessCompartmentResponse 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"`
}

ChangeConnectHarnessCompartmentResponse wrapper for the ChangeConnectHarnessCompartment operation

func (ChangeConnectHarnessCompartmentResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (ChangeConnectHarnessCompartmentResponse) String 

func (response ChangeConnectHarnessCompartmentResponse) String() string

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.
	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

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/streaming/ChangeStreamCompartment.go.html to see an example of how to use ChangeStreamCompartmentRequest.

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 ChangeStreamPoolCompartmentDetails 

type ChangeStreamPoolCompartmentDetails 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"`
}

ChangeStreamPoolCompartmentDetails Detailed representation of a change stream pool compartment operation.

func (ChangeStreamPoolCompartmentDetails) String 

func (m ChangeStreamPoolCompartmentDetails) String() string

type ChangeStreamPoolCompartmentRequest 

type ChangeStreamPoolCompartmentRequest struct {

	// The OCID of the stream pool.
	StreamPoolId *string `mandatory:"true" contributesTo:"path" name:"streamPoolId"`

	// The stream pool will be moved into the compartment specified within this entity.
	ChangeStreamPoolCompartmentDetails `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
}

ChangeStreamPoolCompartmentRequest wrapper for the ChangeStreamPoolCompartment operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/streaming/ChangeStreamPoolCompartment.go.html to see an example of how to use ChangeStreamPoolCompartmentRequest.

func (ChangeStreamPoolCompartmentRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (ChangeStreamPoolCompartmentRequest) RetryPolicy 

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

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

func (ChangeStreamPoolCompartmentRequest) String 

func (request ChangeStreamPoolCompartmentRequest) String() string

type ChangeStreamPoolCompartmentResponse 

type ChangeStreamPoolCompartmentResponse 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"`
}

ChangeStreamPoolCompartmentResponse wrapper for the ChangeStreamPoolCompartment operation

func (ChangeStreamPoolCompartmentResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (ChangeStreamPoolCompartmentResponse) String 

func (response ChangeStreamPoolCompartmentResponse) String() string

type ConnectHarness 

type ConnectHarness struct {

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

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

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

	// The current state of the connect harness.
	LifecycleState ConnectHarnessLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`

	// The date and time the connect harness 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"`

	// Any additional details about the current state of the connect harness.
	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"`
}

ConnectHarness Detailed representation of a connect harness.

func (ConnectHarness) String 

func (m ConnectHarness) String() string

type ConnectHarnessLifecycleStateEnum 

type ConnectHarnessLifecycleStateEnum string

ConnectHarnessLifecycleStateEnum Enum with underlying type: string 

const (
	ConnectHarnessLifecycleStateCreating ConnectHarnessLifecycleStateEnum = "CREATING"
	ConnectHarnessLifecycleStateActive   ConnectHarnessLifecycleStateEnum = "ACTIVE"
	ConnectHarnessLifecycleStateDeleting ConnectHarnessLifecycleStateEnum = "DELETING"
	ConnectHarnessLifecycleStateDeleted  ConnectHarnessLifecycleStateEnum = "DELETED"
	ConnectHarnessLifecycleStateFailed   ConnectHarnessLifecycleStateEnum = "FAILED"
	ConnectHarnessLifecycleStateUpdating ConnectHarnessLifecycleStateEnum = "UPDATING"
)

Set of constants representing the allowable values for ConnectHarnessLifecycleStateEnum

func GetConnectHarnessLifecycleStateEnumValues 

func GetConnectHarnessLifecycleStateEnumValues() []ConnectHarnessLifecycleStateEnum

GetConnectHarnessLifecycleStateEnumValues Enumerates the set of values for ConnectHarnessLifecycleStateEnum

type ConnectHarnessSummary 

type ConnectHarnessSummary struct {

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

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

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

	// The current state of the connect harness.
	LifecycleState ConnectHarnessSummaryLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`

	// The date and time the connect harness 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"`

	// 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"`
}

ConnectHarnessSummary Summary representation of a ConnectHarness.

func (ConnectHarnessSummary) String 

func (m ConnectHarnessSummary) String() string

type ConnectHarnessSummaryLifecycleStateEnum 

type ConnectHarnessSummaryLifecycleStateEnum string

ConnectHarnessSummaryLifecycleStateEnum Enum with underlying type: string 

const (
	ConnectHarnessSummaryLifecycleStateCreating ConnectHarnessSummaryLifecycleStateEnum = "CREATING"
	ConnectHarnessSummaryLifecycleStateActive   ConnectHarnessSummaryLifecycleStateEnum = "ACTIVE"
	ConnectHarnessSummaryLifecycleStateDeleting ConnectHarnessSummaryLifecycleStateEnum = "DELETING"
	ConnectHarnessSummaryLifecycleStateDeleted  ConnectHarnessSummaryLifecycleStateEnum = "DELETED"
	ConnectHarnessSummaryLifecycleStateFailed   ConnectHarnessSummaryLifecycleStateEnum = "FAILED"
	ConnectHarnessSummaryLifecycleStateUpdating ConnectHarnessSummaryLifecycleStateEnum = "UPDATING"
)

Set of constants representing the allowable values for ConnectHarnessSummaryLifecycleStateEnum

func GetConnectHarnessSummaryLifecycleStateEnumValues 

func GetConnectHarnessSummaryLifecycleStateEnumValues() []ConnectHarnessSummaryLifecycleStateEnum

GetConnectHarnessSummaryLifecycleStateEnumValues Enumerates the set of values for ConnectHarnessSummaryLifecycleStateEnum

type ConsumerCommitRequest 

type ConsumerCommitRequest struct {

	// The OCID of the stream.
	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

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/streaming/ConsumerCommit.go.html to see an example of how to use ConsumerCommitRequest.

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.
	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

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/streaming/ConsumerHeartbeat.go.html to see an example of how to use ConsumerHeartbeatRequest.

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 CreateConnectHarnessDetails 

type CreateConnectHarnessDetails struct {

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

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

	// 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"`
}

CreateConnectHarnessDetails Object used to create a connect harness.

func (CreateConnectHarnessDetails) String 

func (m CreateConnectHarnessDetails) String() string

type CreateConnectHarnessRequest 

type CreateConnectHarnessRequest struct {

	// The connect harness to create.
	CreateConnectHarnessDetails `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
}

CreateConnectHarnessRequest wrapper for the CreateConnectHarness operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/streaming/CreateConnectHarness.go.html to see an example of how to use CreateConnectHarnessRequest.

func (CreateConnectHarnessRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (CreateConnectHarnessRequest) RetryPolicy 

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

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

func (CreateConnectHarnessRequest) String 

func (request CreateConnectHarnessRequest) String() string

type CreateConnectHarnessResponse 

type CreateConnectHarnessResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The ConnectHarness instance
	ConnectHarness `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"`
}

CreateConnectHarnessResponse wrapper for the CreateConnectHarness operation

func (CreateConnectHarnessResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (CreateConnectHarnessResponse) String 

func (response CreateConnectHarnessResponse) 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.
	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

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/streaming/CreateCursor.go.html to see an example of how to use CreateCursorRequest.

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.
	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

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/streaming/CreateGroupCursor.go.html to see an example of how to use CreateGroupCursorRequest.

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:"false" json:"compartmentId"`

	// The OCID of the stream pool that contains the stream.
	StreamPoolId *string `mandatory:"false" json:"streamPoolId"`

	// 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 CreateStreamPoolDetails 

type CreateStreamPoolDetails struct {

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

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

	KafkaSettings *KafkaSettings `mandatory:"false" json:"kafkaSettings"`

	CustomEncryptionKeyDetails *CustomEncryptionKeyDetails `mandatory:"false" json:"customEncryptionKeyDetails"`

	PrivateEndpointDetails *PrivateEndpointDetails `mandatory:"false" json:"privateEndpointDetails"`

	// 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"`
}

CreateStreamPoolDetails Object used to create a stream pool.

func (CreateStreamPoolDetails) String 

func (m CreateStreamPoolDetails) String() string

type CreateStreamPoolRequest 

type CreateStreamPoolRequest struct {

	// The stream pool to create.
	CreateStreamPoolDetails `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
}

CreateStreamPoolRequest wrapper for the CreateStreamPool operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/streaming/CreateStreamPool.go.html to see an example of how to use CreateStreamPoolRequest.

func (CreateStreamPoolRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (CreateStreamPoolRequest) RetryPolicy 

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

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

func (CreateStreamPoolRequest) String 

func (request CreateStreamPoolRequest) String() string

type CreateStreamPoolResponse 

type CreateStreamPoolResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The StreamPool instance
	StreamPool `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"`
}

CreateStreamPoolResponse wrapper for the CreateStreamPool operation

func (CreateStreamPoolResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (CreateStreamPoolResponse) String 

func (response CreateStreamPoolResponse) 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

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/streaming/CreateStream.go.html to see an example of how to use CreateStreamRequest.

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 CustomEncryptionKey 

type CustomEncryptionKey struct {

	// Custom Encryption Key (Master Key) ocid.
	KmsKeyId *string `mandatory:"false" json:"kmsKeyId"`

	// Life cycle State of the custom key
	KeyState CustomEncryptionKeyKeyStateEnum `mandatory:"false" json:"keyState,omitempty"`
}

CustomEncryptionKey Custom Encryption Key which will be used for encryption by all the streams in the pool.

func (CustomEncryptionKey) String 

func (m CustomEncryptionKey) String() string

type CustomEncryptionKeyDetails 

type CustomEncryptionKeyDetails struct {

	// Custom Encryption Key (Master Key) ocid.
	KmsKeyId *string `mandatory:"true" json:"kmsKeyId"`
}

CustomEncryptionKeyDetails The OCID of the custom encryption key to be used or deleted if currently being used.

func (CustomEncryptionKeyDetails) String 

func (m CustomEncryptionKeyDetails) String() string

type CustomEncryptionKeyKeyStateEnum 

type CustomEncryptionKeyKeyStateEnum string

CustomEncryptionKeyKeyStateEnum Enum with underlying type: string 

const (
	CustomEncryptionKeyKeyStateActive   CustomEncryptionKeyKeyStateEnum = "ACTIVE"
	CustomEncryptionKeyKeyStateCreating CustomEncryptionKeyKeyStateEnum = "CREATING"
	CustomEncryptionKeyKeyStateDeleting CustomEncryptionKeyKeyStateEnum = "DELETING"
	CustomEncryptionKeyKeyStateNone     CustomEncryptionKeyKeyStateEnum = "NONE"
	CustomEncryptionKeyKeyStateFailed   CustomEncryptionKeyKeyStateEnum = "FAILED"
	CustomEncryptionKeyKeyStateUpdating CustomEncryptionKeyKeyStateEnum = "UPDATING"
)

Set of constants representing the allowable values for CustomEncryptionKeyKeyStateEnum

func GetCustomEncryptionKeyKeyStateEnumValues 

func GetCustomEncryptionKeyKeyStateEnumValues() []CustomEncryptionKeyKeyStateEnum

GetCustomEncryptionKeyKeyStateEnumValues Enumerates the set of values for CustomEncryptionKeyKeyStateEnum

type DeleteConnectHarnessRequest 

type DeleteConnectHarnessRequest struct {

	// The OCID of the connect harness.
	ConnectHarnessId *string `mandatory:"true" contributesTo:"path" name:"connectHarnessId"`

	// 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
}

DeleteConnectHarnessRequest wrapper for the DeleteConnectHarness operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/streaming/DeleteConnectHarness.go.html to see an example of how to use DeleteConnectHarnessRequest.

func (DeleteConnectHarnessRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (DeleteConnectHarnessRequest) RetryPolicy 

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

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

func (DeleteConnectHarnessRequest) String 

func (request DeleteConnectHarnessRequest) String() string

type DeleteConnectHarnessResponse 

type DeleteConnectHarnessResponse 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"`
}

DeleteConnectHarnessResponse wrapper for the DeleteConnectHarness operation

func (DeleteConnectHarnessResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (DeleteConnectHarnessResponse) String 

func (response DeleteConnectHarnessResponse) String() string

type DeleteStreamPoolRequest 

type DeleteStreamPoolRequest struct {

	// The OCID of the stream pool.
	StreamPoolId *string `mandatory:"true" contributesTo:"path" name:"streamPoolId"`

	// 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
}

DeleteStreamPoolRequest wrapper for the DeleteStreamPool operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/streaming/DeleteStreamPool.go.html to see an example of how to use DeleteStreamPoolRequest.

func (DeleteStreamPoolRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (DeleteStreamPoolRequest) RetryPolicy 

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

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

func (DeleteStreamPoolRequest) String 

func (request DeleteStreamPoolRequest) String() string

type DeleteStreamPoolResponse 

type DeleteStreamPoolResponse 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"`
}

DeleteStreamPoolResponse wrapper for the DeleteStreamPool operation

func (DeleteStreamPoolResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (DeleteStreamPoolResponse) String 

func (response DeleteStreamPoolResponse) String() string

type DeleteStreamRequest 

type DeleteStreamRequest 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
}

DeleteStreamRequest wrapper for the DeleteStream operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/streaming/DeleteStream.go.html to see an example of how to use DeleteStreamRequest.

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 GetConnectHarnessRequest 

type GetConnectHarnessRequest struct {

	// The OCID of the connect harness.
	ConnectHarnessId *string `mandatory:"true" contributesTo:"path" name:"connectHarnessId"`

	// 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
}

GetConnectHarnessRequest wrapper for the GetConnectHarness operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/streaming/GetConnectHarness.go.html to see an example of how to use GetConnectHarnessRequest.

func (GetConnectHarnessRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (GetConnectHarnessRequest) RetryPolicy 

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

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

func (GetConnectHarnessRequest) String 

func (request GetConnectHarnessRequest) String() string

type GetConnectHarnessResponse 

type GetConnectHarnessResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The ConnectHarness instance
	ConnectHarness `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"`
}

GetConnectHarnessResponse wrapper for the GetConnectHarness operation

func (GetConnectHarnessResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (GetConnectHarnessResponse) String 

func (response GetConnectHarnessResponse) String() string

type GetGroupRequest 

type GetGroupRequest struct {

	// The OCID of the stream.
	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

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/streaming/GetGroup.go.html to see an example of how to use GetGroupRequest.

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.
	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

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/streaming/GetMessages.go.html to see an example of how to use GetMessagesRequest.

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 GetStreamPoolRequest 

type GetStreamPoolRequest struct {

	// The OCID of the stream pool.
	StreamPoolId *string `mandatory:"true" contributesTo:"path" name:"streamPoolId"`

	// 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
}

GetStreamPoolRequest wrapper for the GetStreamPool operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/streaming/GetStreamPool.go.html to see an example of how to use GetStreamPoolRequest.

func (GetStreamPoolRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (GetStreamPoolRequest) RetryPolicy 

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

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

func (GetStreamPoolRequest) String 

func (request GetStreamPoolRequest) String() string

type GetStreamPoolResponse 

type GetStreamPoolResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The StreamPool instance
	StreamPool `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"`
}

GetStreamPoolResponse wrapper for the GetStreamPool operation

func (GetStreamPoolResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (GetStreamPoolResponse) String 

func (response GetStreamPoolResponse) String() string

type GetStreamRequest 

type GetStreamRequest 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
}

GetStreamRequest wrapper for the GetStream operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/streaming/GetStream.go.html to see an example of how to use GetStreamRequest.

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:"true" json:"streamId"`

	// The name of the consumer group.
	GroupName *string `mandatory:"true" 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 KafkaSettings 

type KafkaSettings struct {

	// Bootstrap servers.
	BootstrapServers *string `mandatory:"false" json:"bootstrapServers"`

	// Enable auto creation of topic on the server.
	AutoCreateTopicsEnable *bool `mandatory:"false" json:"autoCreateTopicsEnable"`

	// The number of hours to keep a log file before deleting it (in hours).
	LogRetentionHours *int `mandatory:"false" json:"logRetentionHours"`

	// The default number of log partitions per topic.
	NumPartitions *int `mandatory:"false" json:"numPartitions"`
}

KafkaSettings Settings for the Kafka compatibility layer.

func (KafkaSettings) String 

func (m KafkaSettings) String() string

type ListConnectHarnessesRequest 

type ListConnectHarnessesRequest 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 ListConnectHarnessesSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`

	// The sort order to use, either 'asc' or 'desc'.
	SortOrder ListConnectHarnessesSortOrderEnum `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 ConnectHarnessSummaryLifecycleStateEnum `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
}

ListConnectHarnessesRequest wrapper for the ListConnectHarnesses operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/streaming/ListConnectHarnesses.go.html to see an example of how to use ListConnectHarnessesRequest.

func (ListConnectHarnessesRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (ListConnectHarnessesRequest) RetryPolicy 

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

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

func (ListConnectHarnessesRequest) String 

func (request ListConnectHarnessesRequest) String() string

type ListConnectHarnessesResponse 

type ListConnectHarnessesResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of []ConnectHarnessSummary instances
	Items []ConnectHarnessSummary `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"`
}

ListConnectHarnessesResponse wrapper for the ListConnectHarnesses operation

func (ListConnectHarnessesResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (ListConnectHarnessesResponse) String 

func (response ListConnectHarnessesResponse) String() string

type ListConnectHarnessesSortByEnum 

type ListConnectHarnessesSortByEnum string

ListConnectHarnessesSortByEnum Enum with underlying type: string 

const (
	ListConnectHarnessesSortByName        ListConnectHarnessesSortByEnum = "NAME"
	ListConnectHarnessesSortByTimecreated ListConnectHarnessesSortByEnum = "TIMECREATED"
)

Set of constants representing the allowable values for ListConnectHarnessesSortByEnum

func GetListConnectHarnessesSortByEnumValues 

func GetListConnectHarnessesSortByEnumValues() []ListConnectHarnessesSortByEnum

GetListConnectHarnessesSortByEnumValues Enumerates the set of values for ListConnectHarnessesSortByEnum

type ListConnectHarnessesSortOrderEnum 

type ListConnectHarnessesSortOrderEnum string

ListConnectHarnessesSortOrderEnum Enum with underlying type: string 

const (
	ListConnectHarnessesSortOrderAsc  ListConnectHarnessesSortOrderEnum = "ASC"
	ListConnectHarnessesSortOrderDesc ListConnectHarnessesSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListConnectHarnessesSortOrderEnum

func GetListConnectHarnessesSortOrderEnumValues 

func GetListConnectHarnessesSortOrderEnumValues() []ListConnectHarnessesSortOrderEnum

GetListConnectHarnessesSortOrderEnumValues Enumerates the set of values for ListConnectHarnessesSortOrderEnum

type ListStreamPoolsRequest 

type ListStreamPoolsRequest 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 ListStreamPoolsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`

	// The sort order to use, either 'asc' or 'desc'.
	SortOrder ListStreamPoolsSortOrderEnum `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 StreamPoolSummaryLifecycleStateEnum `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
}

ListStreamPoolsRequest wrapper for the ListStreamPools operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/streaming/ListStreamPools.go.html to see an example of how to use ListStreamPoolsRequest.

func (ListStreamPoolsRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (ListStreamPoolsRequest) RetryPolicy 

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

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

func (ListStreamPoolsRequest) String 

func (request ListStreamPoolsRequest) String() string

type ListStreamPoolsResponse 

type ListStreamPoolsResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of []StreamPoolSummary instances
	Items []StreamPoolSummary `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"`
}

ListStreamPoolsResponse wrapper for the ListStreamPools operation

func (ListStreamPoolsResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (ListStreamPoolsResponse) String 

func (response ListStreamPoolsResponse) String() string

type ListStreamPoolsSortByEnum 

type ListStreamPoolsSortByEnum string

ListStreamPoolsSortByEnum Enum with underlying type: string 

const (
	ListStreamPoolsSortByName        ListStreamPoolsSortByEnum = "NAME"
	ListStreamPoolsSortByTimecreated ListStreamPoolsSortByEnum = "TIMECREATED"
)

Set of constants representing the allowable values for ListStreamPoolsSortByEnum

func GetListStreamPoolsSortByEnumValues 

func GetListStreamPoolsSortByEnumValues() []ListStreamPoolsSortByEnum

GetListStreamPoolsSortByEnumValues Enumerates the set of values for ListStreamPoolsSortByEnum

type ListStreamPoolsSortOrderEnum 

type ListStreamPoolsSortOrderEnum string

ListStreamPoolsSortOrderEnum Enum with underlying type: string 

const (
	ListStreamPoolsSortOrderAsc  ListStreamPoolsSortOrderEnum = "ASC"
	ListStreamPoolsSortOrderDesc ListStreamPoolsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListStreamPoolsSortOrderEnum

func GetListStreamPoolsSortOrderEnumValues 

func GetListStreamPoolsSortOrderEnumValues() []ListStreamPoolsSortOrderEnum

GetListStreamPoolsSortOrderEnumValues Enumerates the set of values for ListStreamPoolsSortOrderEnum

type ListStreamsRequest 

type ListStreamsRequest struct {

	// The OCID of the compartment. Is exclusive with the `streamPoolId` parameter. One of them is required.
	CompartmentId *string `mandatory:"false" contributesTo:"query" name:"compartmentId"`

	// The OCID of the stream pool. Is exclusive with the `compartmentId` parameter. One of them is required.
	StreamPoolId *string `mandatory:"false" contributesTo:"query" name:"streamPoolId"`

	// 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

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/streaming/ListStreams.go.html to see an example of how to use ListStreamsRequest.

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 PrivateEndpointDetails 

type PrivateEndpointDetails struct {

	// If specified, the stream pool will be private and only accessible from inside that subnet.
	// Producing-to and consuming-from a stream inside a private stream pool can also only be done from inside the subnet.
	// That value cannot be changed.
	SubnetId *string `mandatory:"false" json:"subnetId"`

	// The optional private IP you want to be associated with your private stream pool.
	// That parameter can only be specified when the subnetId parameter is set. It cannot be changed.
	// The private IP needs to be part of the CIDR range of the specified subnetId or the creation will fail.
	// If not specified a random IP inside the subnet will be chosen.
	// After the stream pool is created, a custom FQDN, pointing to this private IP, is created.
	// The FQDN is then used to access the service instead of the private IP.
	PrivateEndpointIp *string `mandatory:"false" json:"privateEndpointIp"`

	// The optional list of network security groups to be used with the private endpoint of the stream pool.
	// That value cannot be changed.
	NsgIds []string `mandatory:"false" json:"nsgIds"`
}

PrivateEndpointDetails Optional parameters if a private stream pool is requested.

func (PrivateEndpointDetails) String 

func (m PrivateEndpointDetails) String() string

type PrivateEndpointSettings 

type PrivateEndpointSettings struct {

	// The subnet id from which the private stream pool can be accessed.
	// Trying to access the streams from another network location will result in an error.
	SubnetId *string `mandatory:"false" json:"subnetId"`

	// The private IP associated with the stream pool in the associated subnetId.
	// The stream pool's FQDN resolves to that IP and should be used - instead of the private IP - in order to not trigger any TLS issues.
	PrivateEndpointIp *string `mandatory:"false" json:"privateEndpointIp"`

	// The optional list of network security groups that are associated with the private endpoint of the stream pool.
	NsgIds []string `mandatory:"false" json:"nsgIds"`
}

PrivateEndpointSettings Optional settings if the stream pool is private.

func (PrivateEndpointSettings) String 

func (m PrivateEndpointSettings) 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.
	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

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/streaming/PutMessages.go.html to see an example of how to use PutMessagesRequest.

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:"true" 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 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 OCID of the stream pool that contains the stream.
	StreamPoolId *string `mandatory:"true" json:"streamPoolId"`

	// 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.
	// 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.
	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 NewStreamAdminClientWithOboToken 

func NewStreamAdminClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client StreamAdminClient, err error)

NewStreamAdminClientWithOboToken Creates a new default StreamAdmin client with the given configuration provider. The obotoken will be added to default headers and signed; the configuration provider will be used for the signer 

as well as reading the region

func (StreamAdminClient) ChangeConnectHarnessCompartment 

func (client StreamAdminClient) ChangeConnectHarnessCompartment(ctx context.Context, request ChangeConnectHarnessCompartmentRequest) (response ChangeConnectHarnessCompartmentResponse, err error)

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

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/streaming/ChangeConnectHarnessCompartment.go.html to see an example of how to use ChangeConnectHarnessCompartment API.

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. The stream will also be moved into the default stream pool in the destination compartment.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/streaming/ChangeStreamCompartment.go.html to see an example of how to use ChangeStreamCompartment API.

func (StreamAdminClient) ChangeStreamPoolCompartment 

func (client StreamAdminClient) ChangeStreamPoolCompartment(ctx context.Context, request ChangeStreamPoolCompartmentRequest) (response ChangeStreamPoolCompartmentResponse, err error)

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

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/streaming/ChangeStreamPoolCompartment.go.html to see an example of how to use ChangeStreamPoolCompartment API.

func (*StreamAdminClient) ConfigurationProvider 

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

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

func (StreamAdminClient) CreateConnectHarness 

func (client StreamAdminClient) CreateConnectHarness(ctx context.Context, request CreateConnectHarnessRequest) (response CreateConnectHarnessResponse, err error)

CreateConnectHarness Starts the provisioning of a new connect harness. To track the progress of the provisioning, you can periodically call ConnectHarness object tells you its current state.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/streaming/CreateConnectHarness.go.html to see an example of how to use CreateConnectHarness API.

func (StreamAdminClient) CreateStream 

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

CreateStream Starts the provisioning of a new stream. The stream will be created in the given compartment id or stream pool id, depending on which parameter is specified. Compartment id and stream pool id cannot be specified at the same time. 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.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/streaming/CreateStream.go.html to see an example of how to use CreateStream API.

func (StreamAdminClient) CreateStreamPool 

func (client StreamAdminClient) CreateStreamPool(ctx context.Context, request CreateStreamPoolRequest) (response CreateStreamPoolResponse, err error)

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

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/streaming/CreateStreamPool.go.html to see an example of how to use CreateStreamPool API.

func (StreamAdminClient) DeleteConnectHarness 

func (client StreamAdminClient) DeleteConnectHarness(ctx context.Context, request DeleteConnectHarnessRequest) (response DeleteConnectHarnessResponse, err error)

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

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/streaming/DeleteConnectHarness.go.html to see an example of how to use DeleteConnectHarness API.

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.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/streaming/DeleteStream.go.html to see an example of how to use DeleteStream API.

func (StreamAdminClient) DeleteStreamPool 

func (client StreamAdminClient) DeleteStreamPool(ctx context.Context, request DeleteStreamPoolRequest) (response DeleteStreamPoolResponse, err error)

DeleteStreamPool Deletes a stream pool. All containing streams will also be deleted. The default stream pool of a compartment cannot be deleted.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/streaming/DeleteStreamPool.go.html to see an example of how to use DeleteStreamPool API.

func (StreamAdminClient) GetConnectHarness 

func (client StreamAdminClient) GetConnectHarness(ctx context.Context, request GetConnectHarnessRequest) (response GetConnectHarnessResponse, err error)

GetConnectHarness Gets detailed information about a connect harness.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/streaming/GetConnectHarness.go.html to see an example of how to use GetConnectHarness API.

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.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/streaming/GetStream.go.html to see an example of how to use GetStream API.

func (StreamAdminClient) GetStreamPool 

func (client StreamAdminClient) GetStreamPool(ctx context.Context, request GetStreamPoolRequest) (response GetStreamPoolResponse, err error)

GetStreamPool Gets detailed information about the stream pool, such as Kafka settings.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/streaming/GetStreamPool.go.html to see an example of how to use GetStreamPool API.

func (StreamAdminClient) ListConnectHarnesses 

func (client StreamAdminClient) ListConnectHarnesses(ctx context.Context, request ListConnectHarnessesRequest) (response ListConnectHarnessesResponse, err error)

ListConnectHarnesses Lists the connectharness.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/streaming/ListConnectHarnesses.go.html to see an example of how to use ListConnectHarnesses API.

func (StreamAdminClient) ListStreamPools 

func (client StreamAdminClient) ListStreamPools(ctx context.Context, request ListStreamPoolsRequest) (response ListStreamPoolsResponse, err error)

ListStreamPools List the stream pools for a given compartment ID.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/streaming/ListStreamPools.go.html to see an example of how to use ListStreamPools API.

func (StreamAdminClient) ListStreams 

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

ListStreams Lists the streams in the given compartment id. If the compartment id is specified, it will list streams in the compartment, regardless of their stream pool. If the stream pool id is specified, the action will be scoped to that stream pool. The compartment id and stream pool id cannot be specified at the same time.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/streaming/ListStreams.go.html to see an example of how to use ListStreams API.

func (*StreamAdminClient) SetRegion 

func (client *StreamAdminClient) SetRegion(region string)

SetRegion overrides the region of this client.

func (StreamAdminClient) UpdateConnectHarness 

func (client StreamAdminClient) UpdateConnectHarness(ctx context.Context, request UpdateConnectHarnessRequest) (response UpdateConnectHarnessResponse, err error)

UpdateConnectHarness Updates the tags applied to the connect harness.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/streaming/UpdateConnectHarness.go.html to see an example of how to use UpdateConnectHarness API.

func (StreamAdminClient) UpdateStream 

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

UpdateStream Updates the stream. Only specified values will be updated.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/streaming/UpdateStream.go.html to see an example of how to use UpdateStream API.

func (StreamAdminClient) UpdateStreamPool 

func (client StreamAdminClient) UpdateStreamPool(ctx context.Context, request UpdateStreamPoolRequest) (response UpdateStreamPoolResponse, err error)

UpdateStreamPool Updates the specified stream pool.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/streaming/UpdateStreamPool.go.html to see an example of how to use UpdateStreamPool API.

type StreamClient 

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

StreamClient a client for Stream

func NewStreamClientWithConfigurationProvider 

func NewStreamClientWithConfigurationProvider(configProvider common.ConfigurationProvider, endpoint string) (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

func NewStreamClientWithOboToken 

func NewStreamClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string, endpoint string) (client StreamClient, err error)

NewStreamClientWithOboToken Creates a new default Stream client with the given configuration provider. The obotoken will be added to default headers and signed; the configuration provider will be used for the signer

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.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/streaming/ConsumerCommit.go.html to see an example of how to use ConsumerCommit API.

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.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/streaming/ConsumerHeartbeat.go.html to see an example of how to use ConsumerHeartbeat API.

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.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/streaming/CreateCursor.go.html to see an example of how to use CreateCursor API.

func (StreamClient) CreateGroupCursor 

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

CreateGroupCursor Creates a group-cursor.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/streaming/CreateGroupCursor.go.html to see an example of how to use CreateGroupCursor API.

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.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/streaming/GetGroup.go.html to see an example of how to use GetGroup API.

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.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/streaming/GetMessages.go.html to see an example of how to use GetMessages API.

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.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/streaming/PutMessages.go.html to see an example of how to use PutMessages API.

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.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/streaming/UpdateGroup.go.html to see an example of how to use UpdateGroup API.

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"
	StreamLifecycleStateUpdating StreamLifecycleStateEnum = "UPDATING"
)

Set of constants representing the allowable values for StreamLifecycleStateEnum

func GetStreamLifecycleStateEnumValues 

func GetStreamLifecycleStateEnumValues() []StreamLifecycleStateEnum

GetStreamLifecycleStateEnumValues Enumerates the set of values for StreamLifecycleStateEnum

type StreamPool 

type StreamPool struct {

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

	// Compartment OCID that the pool belongs to.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

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

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

	// The date and time the stream pool 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"`

	KafkaSettings *KafkaSettings `mandatory:"true" json:"kafkaSettings"`

	CustomEncryptionKey *CustomEncryptionKey `mandatory:"true" json:"customEncryptionKey"`

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

	// True if the stream pool is private, false otherwise.
	// If the stream pool is private, the streams inside the stream pool can only be accessed from inside the associated subnetId.
	IsPrivate *bool `mandatory:"false" json:"isPrivate"`

	// The FQDN used to access the streams inside the stream pool (same FQDN as the messagesEndpoint attribute of a Stream object).
	// If the stream pool is private, the FQDN is customized and can only be accessed from inside the associated subnetId, otherwise the FQDN is publicly resolvable.
	// Depending on which protocol you attempt to use, you need to either prepend https or append the Kafka port.
	EndpointFqdn *string `mandatory:"false" json:"endpointFqdn"`

	PrivateEndpointSettings *PrivateEndpointSettings `mandatory:"false" json:"privateEndpointSettings"`

	// 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"`
}

StreamPool The details of a stream pool.

func (StreamPool) String 

func (m StreamPool) String() string

type StreamPoolLifecycleStateEnum 

type StreamPoolLifecycleStateEnum string

StreamPoolLifecycleStateEnum Enum with underlying type: string 

const (
	StreamPoolLifecycleStateCreating StreamPoolLifecycleStateEnum = "CREATING"
	StreamPoolLifecycleStateActive   StreamPoolLifecycleStateEnum = "ACTIVE"
	StreamPoolLifecycleStateDeleting StreamPoolLifecycleStateEnum = "DELETING"
	StreamPoolLifecycleStateDeleted  StreamPoolLifecycleStateEnum = "DELETED"
	StreamPoolLifecycleStateFailed   StreamPoolLifecycleStateEnum = "FAILED"
	StreamPoolLifecycleStateUpdating StreamPoolLifecycleStateEnum = "UPDATING"
)

Set of constants representing the allowable values for StreamPoolLifecycleStateEnum

func GetStreamPoolLifecycleStateEnumValues 

func GetStreamPoolLifecycleStateEnumValues() []StreamPoolLifecycleStateEnum

GetStreamPoolLifecycleStateEnumValues Enumerates the set of values for StreamPoolLifecycleStateEnum

type StreamPoolSummary 

type StreamPoolSummary struct {

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

	// Compartment OCID that the pool belongs to.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

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

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

	// The date and time the stream pool 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"`

	// True if the stream pool is private, false otherwise.
	// The associated endpoint and subnetId of a private stream pool can be retrieved through the GetStreamPool API.
	IsPrivate *bool `mandatory:"false" json:"isPrivate"`

	// 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"`
}

StreamPoolSummary The summary representation of a stream pool.

func (StreamPoolSummary) String 

func (m StreamPoolSummary) String() string

type StreamPoolSummaryLifecycleStateEnum 

type StreamPoolSummaryLifecycleStateEnum string

StreamPoolSummaryLifecycleStateEnum Enum with underlying type: string 

const (
	StreamPoolSummaryLifecycleStateCreating StreamPoolSummaryLifecycleStateEnum = "CREATING"
	StreamPoolSummaryLifecycleStateActive   StreamPoolSummaryLifecycleStateEnum = "ACTIVE"
	StreamPoolSummaryLifecycleStateDeleting StreamPoolSummaryLifecycleStateEnum = "DELETING"
	StreamPoolSummaryLifecycleStateDeleted  StreamPoolSummaryLifecycleStateEnum = "DELETED"
	StreamPoolSummaryLifecycleStateFailed   StreamPoolSummaryLifecycleStateEnum = "FAILED"
	StreamPoolSummaryLifecycleStateUpdating StreamPoolSummaryLifecycleStateEnum = "UPDATING"
)

Set of constants representing the allowable values for StreamPoolSummaryLifecycleStateEnum

func GetStreamPoolSummaryLifecycleStateEnumValues 

func GetStreamPoolSummaryLifecycleStateEnumValues() []StreamPoolSummaryLifecycleStateEnum

GetStreamPoolSummaryLifecycleStateEnumValues Enumerates the set of values for StreamPoolSummaryLifecycleStateEnum

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 OCID of the stream pool that contains the stream.
	StreamPoolId *string `mandatory:"true" json:"streamPoolId"`

	// 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.
	// 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.
	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"
	StreamSummaryLifecycleStateUpdating StreamSummaryLifecycleStateEnum = "UPDATING"
)

Set of constants representing the allowable values for StreamSummaryLifecycleStateEnum

func GetStreamSummaryLifecycleStateEnumValues 

func GetStreamSummaryLifecycleStateEnumValues() []StreamSummaryLifecycleStateEnum

GetStreamSummaryLifecycleStateEnumValues Enumerates the set of values for StreamSummaryLifecycleStateEnum

type UpdateConnectHarnessDetails 

type UpdateConnectHarnessDetails 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"`
}

UpdateConnectHarnessDetails Object used to update a connect harness.

func (UpdateConnectHarnessDetails) String 

func (m UpdateConnectHarnessDetails) String() string

type UpdateConnectHarnessRequest 

type UpdateConnectHarnessRequest struct {

	// The OCID of the connect harness.
	ConnectHarnessId *string `mandatory:"true" contributesTo:"path" name:"connectHarnessId"`

	// The connect harness is updated with the tags provided.
	UpdateConnectHarnessDetails `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
}

UpdateConnectHarnessRequest wrapper for the UpdateConnectHarness operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/streaming/UpdateConnectHarness.go.html to see an example of how to use UpdateConnectHarnessRequest.

func (UpdateConnectHarnessRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (UpdateConnectHarnessRequest) RetryPolicy 

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

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

func (UpdateConnectHarnessRequest) String 

func (request UpdateConnectHarnessRequest) String() string

type UpdateConnectHarnessResponse 

type UpdateConnectHarnessResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The ConnectHarness instance
	ConnectHarness `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"`
}

UpdateConnectHarnessResponse wrapper for the UpdateConnectHarness operation

func (UpdateConnectHarnessResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (UpdateConnectHarnessResponse) String 

func (response UpdateConnectHarnessResponse) 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.
	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

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/streaming/UpdateGroup.go.html to see an example of how to use UpdateGroupRequest.

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 {

	// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the stream pool where the stream should be moved.
	StreamPoolId *string `mandatory:"false" json:"streamPoolId"`

	// 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 UpdateStreamPoolDetails 

type UpdateStreamPoolDetails struct {
	Name *string `mandatory:"false" json:"name"`

	KafkaSettings *KafkaSettings `mandatory:"false" json:"kafkaSettings"`

	CustomEncryptionKeyDetails *CustomEncryptionKeyDetails `mandatory:"false" json:"customEncryptionKeyDetails"`

	// 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"`
}

UpdateStreamPoolDetails Object used to update the stream pool's details.

func (UpdateStreamPoolDetails) String 

func (m UpdateStreamPoolDetails) String() string

type UpdateStreamPoolRequest 

type UpdateStreamPoolRequest struct {

	// The OCID of the stream pool.
	StreamPoolId *string `mandatory:"true" contributesTo:"path" name:"streamPoolId"`

	// The pool is updated with the provided fields.
	UpdateStreamPoolDetails `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
}

UpdateStreamPoolRequest wrapper for the UpdateStreamPool operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/streaming/UpdateStreamPool.go.html to see an example of how to use UpdateStreamPoolRequest.

func (UpdateStreamPoolRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (UpdateStreamPoolRequest) RetryPolicy 

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

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

func (UpdateStreamPoolRequest) String 

func (request UpdateStreamPoolRequest) String() string

type UpdateStreamPoolResponse 

type UpdateStreamPoolResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The StreamPool instance
	StreamPool `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"`
}

UpdateStreamPoolResponse wrapper for the UpdateStreamPool operation

func (UpdateStreamPoolResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (UpdateStreamPoolResponse) String 

func (response UpdateStreamPoolResponse) String() string

type UpdateStreamRequest 

type UpdateStreamRequest struct {

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

	// The stream is updated with the values 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

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/streaming/UpdateStream.go.html to see an example of how to use UpdateStreamRequest.

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.