func GetConnectHarnessLifecycleStateEnumStringValues() []string
GetConnectHarnessLifecycleStateEnumStringValues Enumerates the set of values in String for ConnectHarnessLifecycleStateEnum
func GetConnectHarnessSummaryLifecycleStateEnumStringValues() []string
GetConnectHarnessSummaryLifecycleStateEnumStringValues Enumerates the set of values in String for ConnectHarnessSummaryLifecycleStateEnum
func GetCreateCursorDetailsTypeEnumStringValues() []string
GetCreateCursorDetailsTypeEnumStringValues Enumerates the set of values in String for CreateCursorDetailsTypeEnum
func GetCreateGroupCursorDetailsTypeEnumStringValues() []string
GetCreateGroupCursorDetailsTypeEnumStringValues Enumerates the set of values in String for CreateGroupCursorDetailsTypeEnum
func GetCustomEncryptionKeyKeyStateEnumStringValues() []string
GetCustomEncryptionKeyKeyStateEnumStringValues Enumerates the set of values in String for CustomEncryptionKeyKeyStateEnum
func GetListConnectHarnessesSortByEnumStringValues() []string
GetListConnectHarnessesSortByEnumStringValues Enumerates the set of values in String for ListConnectHarnessesSortByEnum
func GetListConnectHarnessesSortOrderEnumStringValues() []string
GetListConnectHarnessesSortOrderEnumStringValues Enumerates the set of values in String for ListConnectHarnessesSortOrderEnum
func GetListStreamPoolsSortByEnumStringValues() []string
GetListStreamPoolsSortByEnumStringValues Enumerates the set of values in String for ListStreamPoolsSortByEnum
func GetListStreamPoolsSortOrderEnumStringValues() []string
GetListStreamPoolsSortOrderEnumStringValues Enumerates the set of values in String for ListStreamPoolsSortOrderEnum
func GetListStreamsSortByEnumStringValues() []string
GetListStreamsSortByEnumStringValues Enumerates the set of values in String for ListStreamsSortByEnum
func GetListStreamsSortOrderEnumStringValues() []string
GetListStreamsSortOrderEnumStringValues Enumerates the set of values in String for ListStreamsSortOrderEnum
func GetStreamLifecycleStateEnumStringValues() []string
GetStreamLifecycleStateEnumStringValues Enumerates the set of values in String for StreamLifecycleStateEnum
func GetStreamPoolLifecycleStateEnumStringValues() []string
GetStreamPoolLifecycleStateEnumStringValues Enumerates the set of values in String for StreamPoolLifecycleStateEnum
func GetStreamPoolSummaryLifecycleStateEnumStringValues() []string
GetStreamPoolSummaryLifecycleStateEnumStringValues Enumerates the set of values in String for StreamPoolSummaryLifecycleStateEnum
func GetStreamSummaryLifecycleStateEnumStringValues() []string
GetStreamSummaryLifecycleStateEnumStringValues Enumerates the set of values in String for StreamSummaryLifecycleStateEnum
func GetUpdateGroupDetailsTypeEnumStringValues() []string
GetUpdateGroupDetailsTypeEnumStringValues Enumerates the set of values in String for UpdateGroupDetailsTypeEnum
ChangeConnectHarnessCompartmentDetails Detailed representation of a change connect harness compartment operation.
type ChangeConnectHarnessCompartmentDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment
// into which the resource should be moved.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
}
func (m ChangeConnectHarnessCompartmentDetails) String() string
func (m ChangeConnectHarnessCompartmentDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ChangeConnectHarnessCompartmentRequest wrapper for the ChangeConnectHarnessCompartment operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/streaming/ChangeConnectHarnessCompartment.go.html to see an example of how to use 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
}
func (request ChangeConnectHarnessCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ChangeConnectHarnessCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ChangeConnectHarnessCompartmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ChangeConnectHarnessCompartmentRequest) String() string
func (request ChangeConnectHarnessCompartmentRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ChangeConnectHarnessCompartmentResponse wrapper for the ChangeConnectHarnessCompartment operation
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"`
}
func (response ChangeConnectHarnessCompartmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ChangeConnectHarnessCompartmentResponse) String() string
ChangeStreamCompartmentDetails Detailed representation of a change stream compartment operation.
type ChangeStreamCompartmentDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment
// into which the resource should be moved.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
}
func (m ChangeStreamCompartmentDetails) String() string
func (m ChangeStreamCompartmentDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ChangeStreamCompartmentRequest wrapper for the ChangeStreamCompartment operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/streaming/ChangeStreamCompartment.go.html to see an example of how to use 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
}
func (request ChangeStreamCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ChangeStreamCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ChangeStreamCompartmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ChangeStreamCompartmentRequest) String() string
func (request ChangeStreamCompartmentRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ChangeStreamCompartmentResponse wrapper for the ChangeStreamCompartment operation
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"`
}
func (response ChangeStreamCompartmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ChangeStreamCompartmentResponse) String() string
ChangeStreamPoolCompartmentDetails Detailed representation of a change stream pool compartment operation.
type ChangeStreamPoolCompartmentDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment
// into which the resource should be moved.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
}
func (m ChangeStreamPoolCompartmentDetails) String() string
func (m ChangeStreamPoolCompartmentDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ChangeStreamPoolCompartmentRequest wrapper for the ChangeStreamPoolCompartment operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/streaming/ChangeStreamPoolCompartment.go.html to see an example of how to use 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
}
func (request ChangeStreamPoolCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ChangeStreamPoolCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ChangeStreamPoolCompartmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ChangeStreamPoolCompartmentRequest) String() string
func (request ChangeStreamPoolCompartmentRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ChangeStreamPoolCompartmentResponse wrapper for the ChangeStreamPoolCompartment operation
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"`
}
func (response ChangeStreamPoolCompartmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ChangeStreamPoolCompartmentResponse) String() string
ConnectHarness Detailed representation of a connect harness.
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.oracle.com/iaas/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.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}'
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m ConnectHarness) String() string
func (m ConnectHarness) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ConnectHarnessLifecycleStateEnum Enum with underlying type: string
type ConnectHarnessLifecycleStateEnum string
Set of constants representing the allowable values for ConnectHarnessLifecycleStateEnum
const (
ConnectHarnessLifecycleStateCreating ConnectHarnessLifecycleStateEnum = "CREATING"
ConnectHarnessLifecycleStateActive ConnectHarnessLifecycleStateEnum = "ACTIVE"
ConnectHarnessLifecycleStateDeleting ConnectHarnessLifecycleStateEnum = "DELETING"
ConnectHarnessLifecycleStateDeleted ConnectHarnessLifecycleStateEnum = "DELETED"
ConnectHarnessLifecycleStateFailed ConnectHarnessLifecycleStateEnum = "FAILED"
ConnectHarnessLifecycleStateUpdating ConnectHarnessLifecycleStateEnum = "UPDATING"
)
func GetConnectHarnessLifecycleStateEnumValues() []ConnectHarnessLifecycleStateEnum
GetConnectHarnessLifecycleStateEnumValues Enumerates the set of values for ConnectHarnessLifecycleStateEnum
func GetMappingConnectHarnessLifecycleStateEnum(val string) (ConnectHarnessLifecycleStateEnum, bool)
GetMappingConnectHarnessLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
ConnectHarnessSummary Summary representation of a ConnectHarness.
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.oracle.com/iaas/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.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m ConnectHarnessSummary) String() string
func (m ConnectHarnessSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ConnectHarnessSummaryLifecycleStateEnum Enum with underlying type: string
type ConnectHarnessSummaryLifecycleStateEnum string
Set of constants representing the allowable values for ConnectHarnessSummaryLifecycleStateEnum
const (
ConnectHarnessSummaryLifecycleStateCreating ConnectHarnessSummaryLifecycleStateEnum = "CREATING"
ConnectHarnessSummaryLifecycleStateActive ConnectHarnessSummaryLifecycleStateEnum = "ACTIVE"
ConnectHarnessSummaryLifecycleStateDeleting ConnectHarnessSummaryLifecycleStateEnum = "DELETING"
ConnectHarnessSummaryLifecycleStateDeleted ConnectHarnessSummaryLifecycleStateEnum = "DELETED"
ConnectHarnessSummaryLifecycleStateFailed ConnectHarnessSummaryLifecycleStateEnum = "FAILED"
ConnectHarnessSummaryLifecycleStateUpdating ConnectHarnessSummaryLifecycleStateEnum = "UPDATING"
)
func GetConnectHarnessSummaryLifecycleStateEnumValues() []ConnectHarnessSummaryLifecycleStateEnum
GetConnectHarnessSummaryLifecycleStateEnumValues Enumerates the set of values for ConnectHarnessSummaryLifecycleStateEnum
func GetMappingConnectHarnessSummaryLifecycleStateEnum(val string) (ConnectHarnessSummaryLifecycleStateEnum, bool)
GetMappingConnectHarnessSummaryLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
ConsumerCommitRequest wrapper for the ConsumerCommit operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/streaming/ConsumerCommit.go.html to see an example of how to use 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
}
func (request ConsumerCommitRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ConsumerCommitRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ConsumerCommitRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ConsumerCommitRequest) String() string
func (request ConsumerCommitRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ConsumerCommitResponse wrapper for the ConsumerCommit operation
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"`
}
func (response ConsumerCommitResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ConsumerCommitResponse) String() string
ConsumerHeartbeatRequest wrapper for the ConsumerHeartbeat operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/streaming/ConsumerHeartbeat.go.html to see an example of how to use 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
}
func (request ConsumerHeartbeatRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ConsumerHeartbeatRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ConsumerHeartbeatRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ConsumerHeartbeatRequest) String() string
func (request ConsumerHeartbeatRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ConsumerHeartbeatResponse wrapper for the ConsumerHeartbeat operation
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"`
}
func (response ConsumerHeartbeatResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ConsumerHeartbeatResponse) String() string
CreateConnectHarnessDetails Object used to create a connect harness.
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.oracle.com/iaas/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.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m CreateConnectHarnessDetails) String() string
func (m CreateConnectHarnessDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateConnectHarnessRequest wrapper for the CreateConnectHarness operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/streaming/CreateConnectHarness.go.html to see an example of how to use 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
}
func (request CreateConnectHarnessRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateConnectHarnessRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateConnectHarnessRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateConnectHarnessRequest) String() string
func (request CreateConnectHarnessRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateConnectHarnessResponse wrapper for the CreateConnectHarness operation
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"`
}
func (response CreateConnectHarnessResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateConnectHarnessResponse) String() string
CreateCursorDetails Object used to create a cursor to consume messages in a stream.
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"`
}
func (m CreateCursorDetails) String() string
func (m CreateCursorDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateCursorDetailsTypeEnum Enum with underlying type: string
type CreateCursorDetailsTypeEnum string
Set of constants representing the allowable values for CreateCursorDetailsTypeEnum
const (
CreateCursorDetailsTypeAfterOffset CreateCursorDetailsTypeEnum = "AFTER_OFFSET"
CreateCursorDetailsTypeAtOffset CreateCursorDetailsTypeEnum = "AT_OFFSET"
CreateCursorDetailsTypeAtTime CreateCursorDetailsTypeEnum = "AT_TIME"
CreateCursorDetailsTypeLatest CreateCursorDetailsTypeEnum = "LATEST"
CreateCursorDetailsTypeTrimHorizon CreateCursorDetailsTypeEnum = "TRIM_HORIZON"
)
func GetCreateCursorDetailsTypeEnumValues() []CreateCursorDetailsTypeEnum
GetCreateCursorDetailsTypeEnumValues Enumerates the set of values for CreateCursorDetailsTypeEnum
func GetMappingCreateCursorDetailsTypeEnum(val string) (CreateCursorDetailsTypeEnum, bool)
GetMappingCreateCursorDetailsTypeEnum performs case Insensitive comparison on enum value and return the desired enum
CreateCursorRequest wrapper for the CreateCursor operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/streaming/CreateCursor.go.html to see an example of how to use 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
}
func (request CreateCursorRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateCursorRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateCursorRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateCursorRequest) String() string
func (request CreateCursorRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateCursorResponse wrapper for the CreateCursor operation
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"`
}
func (response CreateCursorResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateCursorResponse) String() string
CreateGroupCursorDetails Object used to create a group cursor.
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"`
}
func (m CreateGroupCursorDetails) String() string
func (m CreateGroupCursorDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateGroupCursorDetailsTypeEnum Enum with underlying type: string
type CreateGroupCursorDetailsTypeEnum string
Set of constants representing the allowable values for CreateGroupCursorDetailsTypeEnum
const (
CreateGroupCursorDetailsTypeAtTime CreateGroupCursorDetailsTypeEnum = "AT_TIME"
CreateGroupCursorDetailsTypeLatest CreateGroupCursorDetailsTypeEnum = "LATEST"
CreateGroupCursorDetailsTypeTrimHorizon CreateGroupCursorDetailsTypeEnum = "TRIM_HORIZON"
)
func GetCreateGroupCursorDetailsTypeEnumValues() []CreateGroupCursorDetailsTypeEnum
GetCreateGroupCursorDetailsTypeEnumValues Enumerates the set of values for CreateGroupCursorDetailsTypeEnum
func GetMappingCreateGroupCursorDetailsTypeEnum(val string) (CreateGroupCursorDetailsTypeEnum, bool)
GetMappingCreateGroupCursorDetailsTypeEnum performs case Insensitive comparison on enum value and return the desired enum
CreateGroupCursorRequest wrapper for the CreateGroupCursor operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/streaming/CreateGroupCursor.go.html to see an example of how to use 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
}
func (request CreateGroupCursorRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateGroupCursorRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateGroupCursorRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateGroupCursorRequest) String() string
func (request CreateGroupCursorRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateGroupCursorResponse wrapper for the CreateGroupCursor operation
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"`
}
func (response CreateGroupCursorResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateGroupCursorResponse) String() string
CreateStreamDetails Object used to create a stream.
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.oracle.com/iaas/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.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m CreateStreamDetails) String() string
func (m CreateStreamDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateStreamPoolDetails Object used to create a stream pool.
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.oracle.com/iaas/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.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m CreateStreamPoolDetails) String() string
func (m CreateStreamPoolDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateStreamPoolRequest wrapper for the CreateStreamPool operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/streaming/CreateStreamPool.go.html to see an example of how to use 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
}
func (request CreateStreamPoolRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateStreamPoolRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateStreamPoolRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateStreamPoolRequest) String() string
func (request CreateStreamPoolRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateStreamPoolResponse wrapper for the CreateStreamPool operation
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"`
}
func (response CreateStreamPoolResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateStreamPoolResponse) String() string
CreateStreamRequest wrapper for the CreateStream operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/streaming/CreateStream.go.html to see an example of how to use 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
}
func (request CreateStreamRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateStreamRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateStreamRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateStreamRequest) String() string
func (request CreateStreamRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateStreamResponse wrapper for the CreateStream operation
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"`
}
func (response CreateStreamResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateStreamResponse) String() string
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.
type Cursor struct {
// The cursor to pass to the `GetMessages` operation.
Value *string `mandatory:"true" json:"value"`
}
func (m Cursor) String() string
func (m Cursor) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CustomEncryptionKey Custom Encryption Key which will be used for encryption by all the streams in the pool.
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"`
}
func (m CustomEncryptionKey) String() string
func (m CustomEncryptionKey) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CustomEncryptionKeyDetails The OCID of the custom encryption key to be used or deleted if currently being used.
type CustomEncryptionKeyDetails struct {
// Custom Encryption Key (Master Key) ocid.
KmsKeyId *string `mandatory:"true" json:"kmsKeyId"`
}
func (m CustomEncryptionKeyDetails) String() string
func (m CustomEncryptionKeyDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CustomEncryptionKeyKeyStateEnum Enum with underlying type: string
type CustomEncryptionKeyKeyStateEnum string
Set of constants representing the allowable values for CustomEncryptionKeyKeyStateEnum
const (
CustomEncryptionKeyKeyStateActive CustomEncryptionKeyKeyStateEnum = "ACTIVE"
CustomEncryptionKeyKeyStateCreating CustomEncryptionKeyKeyStateEnum = "CREATING"
CustomEncryptionKeyKeyStateDeleting CustomEncryptionKeyKeyStateEnum = "DELETING"
CustomEncryptionKeyKeyStateNone CustomEncryptionKeyKeyStateEnum = "NONE"
CustomEncryptionKeyKeyStateFailed CustomEncryptionKeyKeyStateEnum = "FAILED"
CustomEncryptionKeyKeyStateUpdating CustomEncryptionKeyKeyStateEnum = "UPDATING"
)
func GetCustomEncryptionKeyKeyStateEnumValues() []CustomEncryptionKeyKeyStateEnum
GetCustomEncryptionKeyKeyStateEnumValues Enumerates the set of values for CustomEncryptionKeyKeyStateEnum
func GetMappingCustomEncryptionKeyKeyStateEnum(val string) (CustomEncryptionKeyKeyStateEnum, bool)
GetMappingCustomEncryptionKeyKeyStateEnum performs case Insensitive comparison on enum value and return the desired enum
DeleteConnectHarnessRequest wrapper for the DeleteConnectHarness operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/streaming/DeleteConnectHarness.go.html to see an example of how to use 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
}
func (request DeleteConnectHarnessRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteConnectHarnessRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteConnectHarnessRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteConnectHarnessRequest) String() string
func (request DeleteConnectHarnessRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DeleteConnectHarnessResponse wrapper for the DeleteConnectHarness operation
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"`
}
func (response DeleteConnectHarnessResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteConnectHarnessResponse) String() string
DeleteStreamPoolRequest wrapper for the DeleteStreamPool operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/streaming/DeleteStreamPool.go.html to see an example of how to use 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
}
func (request DeleteStreamPoolRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteStreamPoolRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteStreamPoolRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteStreamPoolRequest) String() string
func (request DeleteStreamPoolRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DeleteStreamPoolResponse wrapper for the DeleteStreamPool operation
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"`
}
func (response DeleteStreamPoolResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteStreamPoolResponse) String() string
DeleteStreamRequest wrapper for the DeleteStream operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/streaming/DeleteStream.go.html to see an example of how to use 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
}
func (request DeleteStreamRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteStreamRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteStreamRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteStreamRequest) String() string
func (request DeleteStreamRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DeleteStreamResponse wrapper for the DeleteStream operation
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"`
}
func (response DeleteStreamResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteStreamResponse) String() string
GetConnectHarnessRequest wrapper for the GetConnectHarness operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/streaming/GetConnectHarness.go.html to see an example of how to use 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
}
func (request GetConnectHarnessRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetConnectHarnessRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetConnectHarnessRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetConnectHarnessRequest) String() string
func (request GetConnectHarnessRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GetConnectHarnessResponse wrapper for the GetConnectHarness operation
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"`
}
func (response GetConnectHarnessResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetConnectHarnessResponse) String() string
GetGroupRequest wrapper for the GetGroup operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/streaming/GetGroup.go.html to see an example of how to use 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
}
func (request GetGroupRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetGroupRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetGroupRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetGroupRequest) String() string
func (request GetGroupRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GetGroupResponse wrapper for the GetGroup operation
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"`
}
func (response GetGroupResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetGroupResponse) String() string
GetMessagesRequest wrapper for the GetMessages operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/streaming/GetMessages.go.html to see an example of how to use 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
}
func (request GetMessagesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetMessagesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetMessagesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetMessagesRequest) String() string
func (request GetMessagesRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GetMessagesResponse wrapper for the GetMessages operation
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"`
}
func (response GetMessagesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetMessagesResponse) String() string
GetStreamPoolRequest wrapper for the GetStreamPool operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/streaming/GetStreamPool.go.html to see an example of how to use 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
}
func (request GetStreamPoolRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetStreamPoolRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetStreamPoolRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetStreamPoolRequest) String() string
func (request GetStreamPoolRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GetStreamPoolResponse wrapper for the GetStreamPool operation
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"`
}
func (response GetStreamPoolResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetStreamPoolResponse) String() string
GetStreamRequest wrapper for the GetStream operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/streaming/GetStream.go.html to see an example of how to use 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
}
func (request GetStreamRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetStreamRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetStreamRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetStreamRequest) String() string
func (request GetStreamRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GetStreamResponse wrapper for the GetStream operation
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"`
}
func (response GetStreamResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetStreamResponse) String() string
Group Represents the current state of a consumer group, including partition reservations and committed offsets.
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"`
}
func (m Group) String() string
func (m Group) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
KafkaSettings Settings for the Kafka compatibility layer.
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"`
}
func (m KafkaSettings) String() string
func (m KafkaSettings) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListConnectHarnessesRequest wrapper for the ListConnectHarnesses operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/streaming/ListConnectHarnesses.go.html to see an example of how to use 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
}
func (request ListConnectHarnessesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListConnectHarnessesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListConnectHarnessesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListConnectHarnessesRequest) String() string
func (request ListConnectHarnessesRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListConnectHarnessesResponse wrapper for the ListConnectHarnesses operation
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.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.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"`
}
func (response ListConnectHarnessesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListConnectHarnessesResponse) String() string
ListConnectHarnessesSortByEnum Enum with underlying type: string
type ListConnectHarnessesSortByEnum string
Set of constants representing the allowable values for ListConnectHarnessesSortByEnum
const (
ListConnectHarnessesSortByName ListConnectHarnessesSortByEnum = "NAME"
ListConnectHarnessesSortByTimecreated ListConnectHarnessesSortByEnum = "TIMECREATED"
)
func GetListConnectHarnessesSortByEnumValues() []ListConnectHarnessesSortByEnum
GetListConnectHarnessesSortByEnumValues Enumerates the set of values for ListConnectHarnessesSortByEnum
func GetMappingListConnectHarnessesSortByEnum(val string) (ListConnectHarnessesSortByEnum, bool)
GetMappingListConnectHarnessesSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListConnectHarnessesSortOrderEnum Enum with underlying type: string
type ListConnectHarnessesSortOrderEnum string
Set of constants representing the allowable values for ListConnectHarnessesSortOrderEnum
const (
ListConnectHarnessesSortOrderAsc ListConnectHarnessesSortOrderEnum = "ASC"
ListConnectHarnessesSortOrderDesc ListConnectHarnessesSortOrderEnum = "DESC"
)
func GetListConnectHarnessesSortOrderEnumValues() []ListConnectHarnessesSortOrderEnum
GetListConnectHarnessesSortOrderEnumValues Enumerates the set of values for ListConnectHarnessesSortOrderEnum
func GetMappingListConnectHarnessesSortOrderEnum(val string) (ListConnectHarnessesSortOrderEnum, bool)
GetMappingListConnectHarnessesSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListStreamPoolsRequest wrapper for the ListStreamPools operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/streaming/ListStreamPools.go.html to see an example of how to use 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
}
func (request ListStreamPoolsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListStreamPoolsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListStreamPoolsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListStreamPoolsRequest) String() string
func (request ListStreamPoolsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListStreamPoolsResponse wrapper for the ListStreamPools operation
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.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.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"`
}
func (response ListStreamPoolsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListStreamPoolsResponse) String() string
ListStreamPoolsSortByEnum Enum with underlying type: string
type ListStreamPoolsSortByEnum string
Set of constants representing the allowable values for ListStreamPoolsSortByEnum
const (
ListStreamPoolsSortByName ListStreamPoolsSortByEnum = "NAME"
ListStreamPoolsSortByTimecreated ListStreamPoolsSortByEnum = "TIMECREATED"
)
func GetListStreamPoolsSortByEnumValues() []ListStreamPoolsSortByEnum
GetListStreamPoolsSortByEnumValues Enumerates the set of values for ListStreamPoolsSortByEnum
func GetMappingListStreamPoolsSortByEnum(val string) (ListStreamPoolsSortByEnum, bool)
GetMappingListStreamPoolsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListStreamPoolsSortOrderEnum Enum with underlying type: string
type ListStreamPoolsSortOrderEnum string
Set of constants representing the allowable values for ListStreamPoolsSortOrderEnum
const (
ListStreamPoolsSortOrderAsc ListStreamPoolsSortOrderEnum = "ASC"
ListStreamPoolsSortOrderDesc ListStreamPoolsSortOrderEnum = "DESC"
)
func GetListStreamPoolsSortOrderEnumValues() []ListStreamPoolsSortOrderEnum
GetListStreamPoolsSortOrderEnumValues Enumerates the set of values for ListStreamPoolsSortOrderEnum
func GetMappingListStreamPoolsSortOrderEnum(val string) (ListStreamPoolsSortOrderEnum, bool)
GetMappingListStreamPoolsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListStreamsRequest wrapper for the ListStreams operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/streaming/ListStreams.go.html to see an example of how to use 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
}
func (request ListStreamsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListStreamsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListStreamsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListStreamsRequest) String() string
func (request ListStreamsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListStreamsResponse wrapper for the ListStreams operation
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.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.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"`
}
func (response ListStreamsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListStreamsResponse) String() string
ListStreamsSortByEnum Enum with underlying type: string
type ListStreamsSortByEnum string
Set of constants representing the allowable values for ListStreamsSortByEnum
const (
ListStreamsSortByName ListStreamsSortByEnum = "NAME"
ListStreamsSortByTimecreated ListStreamsSortByEnum = "TIMECREATED"
)
func GetListStreamsSortByEnumValues() []ListStreamsSortByEnum
GetListStreamsSortByEnumValues Enumerates the set of values for ListStreamsSortByEnum
func GetMappingListStreamsSortByEnum(val string) (ListStreamsSortByEnum, bool)
GetMappingListStreamsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListStreamsSortOrderEnum Enum with underlying type: string
type ListStreamsSortOrderEnum string
Set of constants representing the allowable values for ListStreamsSortOrderEnum
const (
ListStreamsSortOrderAsc ListStreamsSortOrderEnum = "ASC"
ListStreamsSortOrderDesc ListStreamsSortOrderEnum = "DESC"
)
func GetListStreamsSortOrderEnumValues() []ListStreamsSortOrderEnum
GetListStreamsSortOrderEnumValues Enumerates the set of values for ListStreamsSortOrderEnum
func GetMappingListStreamsSortOrderEnum(val string) (ListStreamsSortOrderEnum, bool)
GetMappingListStreamsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
Message A message in a stream.
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"`
}
func (m Message) String() string
func (m Message) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
PartitionReservation Represents the state of a single partition reservation.
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"`
}
func (m PartitionReservation) String() string
func (m PartitionReservation) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
PrivateEndpointDetails Optional parameters if a private stream pool is requested.
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"`
}
func (m PrivateEndpointDetails) String() string
func (m PrivateEndpointDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
PrivateEndpointSettings Optional settings if the stream pool is private.
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"`
}
func (m PrivateEndpointSettings) String() string
func (m PrivateEndpointSettings) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
PutMessagesDetails Object that represents an array of messages to emit to a stream.
type PutMessagesDetails struct {
// The array of messages to put into a stream.
Messages []PutMessagesDetailsEntry `mandatory:"true" json:"messages"`
}
func (m PutMessagesDetails) String() string
func (m PutMessagesDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
PutMessagesDetailsEntry Object that represents a message to emit to a stream.
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"`
}
func (m PutMessagesDetailsEntry) String() string
func (m PutMessagesDetailsEntry) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
PutMessagesRequest wrapper for the PutMessages operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/streaming/PutMessages.go.html to see an example of how to use 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
}
func (request PutMessagesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request PutMessagesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request PutMessagesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request PutMessagesRequest) String() string
func (request PutMessagesRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
PutMessagesResponse wrapper for the PutMessages operation
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"`
}
func (response PutMessagesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response PutMessagesResponse) String() string
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.
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"`
}
func (m PutMessagesResult) String() string
func (m PutMessagesResult) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
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`.
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"`
}
func (m PutMessagesResultEntry) String() string
func (m PutMessagesResultEntry) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
Stream Detailed representation of a stream, including all its partitions.
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.oracle.com/iaas/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.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}'
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m Stream) String() string
func (m Stream) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
StreamAdminClient a client for StreamAdmin
type StreamAdminClient struct {
common.BaseClient
// contains filtered or unexported fields
}
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(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 (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.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/streaming/ChangeConnectHarnessCompartment.go.html to see an example of how to use ChangeConnectHarnessCompartment API. A default retry strategy applies to this operation ChangeConnectHarnessCompartment()
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.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/streaming/ChangeStreamCompartment.go.html to see an example of how to use ChangeStreamCompartment API. A default retry strategy applies to this operation ChangeStreamCompartment()
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.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/streaming/ChangeStreamPoolCompartment.go.html to see an example of how to use ChangeStreamPoolCompartment API. A default retry strategy applies to this operation ChangeStreamPoolCompartment()
func (client *StreamAdminClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
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.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/streaming/CreateConnectHarness.go.html to see an example of how to use CreateConnectHarness API. A default retry strategy applies to this operation CreateConnectHarness()
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.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/streaming/CreateStream.go.html to see an example of how to use CreateStream API. A default retry strategy applies to this operation CreateStream()
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.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/streaming/CreateStreamPool.go.html to see an example of how to use CreateStreamPool API. A default retry strategy applies to this operation CreateStreamPool()
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.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/streaming/DeleteConnectHarness.go.html to see an example of how to use DeleteConnectHarness API. A default retry strategy applies to this operation DeleteConnectHarness()
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.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/streaming/DeleteStream.go.html to see an example of how to use DeleteStream API. A default retry strategy applies to this operation DeleteStream()
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.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/streaming/DeleteStreamPool.go.html to see an example of how to use DeleteStreamPool API. A default retry strategy applies to this operation DeleteStreamPool()
func (client StreamAdminClient) GetConnectHarness(ctx context.Context, request GetConnectHarnessRequest) (response GetConnectHarnessResponse, err error)
GetConnectHarness Gets detailed information about a connect harness.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/streaming/GetConnectHarness.go.html to see an example of how to use GetConnectHarness API. A default retry strategy applies to this operation GetConnectHarness()
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.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/streaming/GetStream.go.html to see an example of how to use GetStream API. A default retry strategy applies to this operation GetStream()
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.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/streaming/GetStreamPool.go.html to see an example of how to use GetStreamPool API. A default retry strategy applies to this operation GetStreamPool()
func (client StreamAdminClient) ListConnectHarnesses(ctx context.Context, request ListConnectHarnessesRequest) (response ListConnectHarnessesResponse, err error)
ListConnectHarnesses Lists the connectharness.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/streaming/ListConnectHarnesses.go.html to see an example of how to use ListConnectHarnesses API. A default retry strategy applies to this operation ListConnectHarnesses()
func (client StreamAdminClient) ListStreamPools(ctx context.Context, request ListStreamPoolsRequest) (response ListStreamPoolsResponse, err error)
ListStreamPools List the stream pools for a given compartment ID.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/streaming/ListStreamPools.go.html to see an example of how to use ListStreamPools API. A default retry strategy applies to this operation ListStreamPools()
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.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/streaming/ListStreams.go.html to see an example of how to use ListStreams API. A default retry strategy applies to this operation ListStreams()
func (client *StreamAdminClient) SetRegion(region string)
SetRegion overrides the region of this client.
func (client StreamAdminClient) UpdateConnectHarness(ctx context.Context, request UpdateConnectHarnessRequest) (response UpdateConnectHarnessResponse, err error)
UpdateConnectHarness Updates the tags applied to the connect harness.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/streaming/UpdateConnectHarness.go.html to see an example of how to use UpdateConnectHarness API. A default retry strategy applies to this operation UpdateConnectHarness()
func (client StreamAdminClient) UpdateStream(ctx context.Context, request UpdateStreamRequest) (response UpdateStreamResponse, err error)
UpdateStream Updates the stream. Only specified values will be updated.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/streaming/UpdateStream.go.html to see an example of how to use UpdateStream API. A default retry strategy applies to this operation UpdateStream()
func (client StreamAdminClient) UpdateStreamPool(ctx context.Context, request UpdateStreamPoolRequest) (response UpdateStreamPoolResponse, err error)
UpdateStreamPool Updates the specified stream pool.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/streaming/UpdateStreamPool.go.html to see an example of how to use UpdateStreamPool API. A default retry strategy applies to this operation UpdateStreamPool()
StreamClient a client for Stream
type StreamClient struct {
common.BaseClient
// contains filtered or unexported fields
}
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(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 (client *StreamClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
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.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/streaming/ConsumerCommit.go.html to see an example of how to use ConsumerCommit API. A default retry strategy applies to this operation ConsumerCommit()
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.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/streaming/ConsumerHeartbeat.go.html to see an example of how to use ConsumerHeartbeat API. A default retry strategy applies to this operation ConsumerHeartbeat()
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.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/streaming/CreateCursor.go.html to see an example of how to use CreateCursor API. A default retry strategy applies to this operation CreateCursor()
func (client StreamClient) CreateGroupCursor(ctx context.Context, request CreateGroupCursorRequest) (response CreateGroupCursorResponse, err error)
CreateGroupCursor Creates a group-cursor.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/streaming/CreateGroupCursor.go.html to see an example of how to use CreateGroupCursor API. A default retry strategy applies to this operation CreateGroupCursor()
func (client StreamClient) GetGroup(ctx context.Context, request GetGroupRequest) (response GetGroupResponse, err error)
GetGroup Returns the current state of a consumer group.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/streaming/GetGroup.go.html to see an example of how to use GetGroup API. A default retry strategy applies to this operation GetGroup()
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.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/streaming/GetMessages.go.html to see an example of how to use GetMessages API. A default retry strategy applies to this operation GetMessages()
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.
Click https://docs.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 (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.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/streaming/UpdateGroup.go.html to see an example of how to use UpdateGroup API. A default retry strategy applies to this operation UpdateGroup()
StreamLifecycleStateEnum Enum with underlying type: string
type StreamLifecycleStateEnum string
Set of constants representing the allowable values for StreamLifecycleStateEnum
const (
StreamLifecycleStateCreating StreamLifecycleStateEnum = "CREATING"
StreamLifecycleStateActive StreamLifecycleStateEnum = "ACTIVE"
StreamLifecycleStateDeleting StreamLifecycleStateEnum = "DELETING"
StreamLifecycleStateDeleted StreamLifecycleStateEnum = "DELETED"
StreamLifecycleStateFailed StreamLifecycleStateEnum = "FAILED"
StreamLifecycleStateUpdating StreamLifecycleStateEnum = "UPDATING"
)
func GetMappingStreamLifecycleStateEnum(val string) (StreamLifecycleStateEnum, bool)
GetMappingStreamLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetStreamLifecycleStateEnumValues() []StreamLifecycleStateEnum
GetStreamLifecycleStateEnumValues Enumerates the set of values for StreamLifecycleStateEnum
StreamPool The details of a stream pool.
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.oracle.com/iaas/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.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}'
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m StreamPool) String() string
func (m StreamPool) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
StreamPoolLifecycleStateEnum Enum with underlying type: string
type StreamPoolLifecycleStateEnum string
Set of constants representing the allowable values for StreamPoolLifecycleStateEnum
const (
StreamPoolLifecycleStateCreating StreamPoolLifecycleStateEnum = "CREATING"
StreamPoolLifecycleStateActive StreamPoolLifecycleStateEnum = "ACTIVE"
StreamPoolLifecycleStateDeleting StreamPoolLifecycleStateEnum = "DELETING"
StreamPoolLifecycleStateDeleted StreamPoolLifecycleStateEnum = "DELETED"
StreamPoolLifecycleStateFailed StreamPoolLifecycleStateEnum = "FAILED"
StreamPoolLifecycleStateUpdating StreamPoolLifecycleStateEnum = "UPDATING"
)
func GetMappingStreamPoolLifecycleStateEnum(val string) (StreamPoolLifecycleStateEnum, bool)
GetMappingStreamPoolLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetStreamPoolLifecycleStateEnumValues() []StreamPoolLifecycleStateEnum
GetStreamPoolLifecycleStateEnumValues Enumerates the set of values for StreamPoolLifecycleStateEnum
StreamPoolSummary The summary representation of a stream pool.
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.oracle.com/iaas/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.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m StreamPoolSummary) String() string
func (m StreamPoolSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
StreamPoolSummaryLifecycleStateEnum Enum with underlying type: string
type StreamPoolSummaryLifecycleStateEnum string
Set of constants representing the allowable values for StreamPoolSummaryLifecycleStateEnum
const (
StreamPoolSummaryLifecycleStateCreating StreamPoolSummaryLifecycleStateEnum = "CREATING"
StreamPoolSummaryLifecycleStateActive StreamPoolSummaryLifecycleStateEnum = "ACTIVE"
StreamPoolSummaryLifecycleStateDeleting StreamPoolSummaryLifecycleStateEnum = "DELETING"
StreamPoolSummaryLifecycleStateDeleted StreamPoolSummaryLifecycleStateEnum = "DELETED"
StreamPoolSummaryLifecycleStateFailed StreamPoolSummaryLifecycleStateEnum = "FAILED"
StreamPoolSummaryLifecycleStateUpdating StreamPoolSummaryLifecycleStateEnum = "UPDATING"
)
func GetMappingStreamPoolSummaryLifecycleStateEnum(val string) (StreamPoolSummaryLifecycleStateEnum, bool)
GetMappingStreamPoolSummaryLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetStreamPoolSummaryLifecycleStateEnumValues() []StreamPoolSummaryLifecycleStateEnum
GetStreamPoolSummaryLifecycleStateEnumValues Enumerates the set of values for StreamPoolSummaryLifecycleStateEnum
StreamSummary Summary representation of a stream.
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.oracle.com/iaas/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.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m StreamSummary) String() string
func (m StreamSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
StreamSummaryLifecycleStateEnum Enum with underlying type: string
type StreamSummaryLifecycleStateEnum string
Set of constants representing the allowable values for StreamSummaryLifecycleStateEnum
const (
StreamSummaryLifecycleStateCreating StreamSummaryLifecycleStateEnum = "CREATING"
StreamSummaryLifecycleStateActive StreamSummaryLifecycleStateEnum = "ACTIVE"
StreamSummaryLifecycleStateDeleting StreamSummaryLifecycleStateEnum = "DELETING"
StreamSummaryLifecycleStateDeleted StreamSummaryLifecycleStateEnum = "DELETED"
StreamSummaryLifecycleStateFailed StreamSummaryLifecycleStateEnum = "FAILED"
StreamSummaryLifecycleStateUpdating StreamSummaryLifecycleStateEnum = "UPDATING"
)
func GetMappingStreamSummaryLifecycleStateEnum(val string) (StreamSummaryLifecycleStateEnum, bool)
GetMappingStreamSummaryLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetStreamSummaryLifecycleStateEnumValues() []StreamSummaryLifecycleStateEnum
GetStreamSummaryLifecycleStateEnumValues Enumerates the set of values for StreamSummaryLifecycleStateEnum
UpdateConnectHarnessDetails Object used to update a connect harness.
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.oracle.com/iaas/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.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m UpdateConnectHarnessDetails) String() string
func (m UpdateConnectHarnessDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateConnectHarnessRequest wrapper for the UpdateConnectHarness operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/streaming/UpdateConnectHarness.go.html to see an example of how to use 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
}
func (request UpdateConnectHarnessRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateConnectHarnessRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateConnectHarnessRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateConnectHarnessRequest) String() string
func (request UpdateConnectHarnessRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateConnectHarnessResponse wrapper for the UpdateConnectHarness operation
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"`
}
func (response UpdateConnectHarnessResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateConnectHarnessResponse) String() string
UpdateGroupDetails Request body for operationally managing a group.
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"`
}
func (m UpdateGroupDetails) String() string
func (m UpdateGroupDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateGroupDetailsTypeEnum Enum with underlying type: string
type UpdateGroupDetailsTypeEnum string
Set of constants representing the allowable values for UpdateGroupDetailsTypeEnum
const (
UpdateGroupDetailsTypeAtTime UpdateGroupDetailsTypeEnum = "AT_TIME"
UpdateGroupDetailsTypeLatest UpdateGroupDetailsTypeEnum = "LATEST"
UpdateGroupDetailsTypeTrimHorizon UpdateGroupDetailsTypeEnum = "TRIM_HORIZON"
)
func GetMappingUpdateGroupDetailsTypeEnum(val string) (UpdateGroupDetailsTypeEnum, bool)
GetMappingUpdateGroupDetailsTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetUpdateGroupDetailsTypeEnumValues() []UpdateGroupDetailsTypeEnum
GetUpdateGroupDetailsTypeEnumValues Enumerates the set of values for UpdateGroupDetailsTypeEnum
UpdateGroupRequest wrapper for the UpdateGroup operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/streaming/UpdateGroup.go.html to see an example of how to use 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
}
func (request UpdateGroupRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateGroupRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateGroupRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateGroupRequest) String() string
func (request UpdateGroupRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateGroupResponse wrapper for the UpdateGroup operation
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"`
}
func (response UpdateGroupResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateGroupResponse) String() string
UpdateStreamDetails Object used to update a stream.
type UpdateStreamDetails struct {
// The OCID (https://docs.oracle.com/iaas/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.oracle.com/iaas/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.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m UpdateStreamDetails) String() string
func (m UpdateStreamDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateStreamPoolDetails Object used to update the stream pool's details.
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.oracle.com/iaas/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.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m UpdateStreamPoolDetails) String() string
func (m UpdateStreamPoolDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateStreamPoolRequest wrapper for the UpdateStreamPool operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/streaming/UpdateStreamPool.go.html to see an example of how to use 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
}
func (request UpdateStreamPoolRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateStreamPoolRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateStreamPoolRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateStreamPoolRequest) String() string
func (request UpdateStreamPoolRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateStreamPoolResponse wrapper for the UpdateStreamPool operation
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"`
}
func (response UpdateStreamPoolResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateStreamPoolResponse) String() string
UpdateStreamRequest wrapper for the UpdateStream operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/streaming/UpdateStream.go.html to see an example of how to use 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
}
func (request UpdateStreamRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateStreamRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateStreamRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateStreamRequest) String() string
func (request UpdateStreamRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateStreamResponse wrapper for the UpdateStream operation
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"`
}
func (response UpdateStreamResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateStreamResponse) String() string