func GetActionTypeEnumStringValues() []string
GetActionTypeEnumStringValues Enumerates the set of values in String for ActionTypeEnum
func GetConsumerGroupLifecycleStateEnumStringValues() []string
GetConsumerGroupLifecycleStateEnumStringValues Enumerates the set of values in String for ConsumerGroupLifecycleStateEnum
func GetListConsumerGroupsSortByEnumStringValues() []string
GetListConsumerGroupsSortByEnumStringValues Enumerates the set of values in String for ListConsumerGroupsSortByEnum
func GetListConsumerGroupsSortOrderEnumStringValues() []string
GetListConsumerGroupsSortOrderEnumStringValues Enumerates the set of values in String for ListConsumerGroupsSortOrderEnum
func GetListQueuesSortByEnumStringValues() []string
GetListQueuesSortByEnumStringValues Enumerates the set of values in String for ListQueuesSortByEnum
func GetListQueuesSortOrderEnumStringValues() []string
GetListQueuesSortOrderEnumStringValues Enumerates the set of values in String for ListQueuesSortOrderEnum
func GetOperationStatusEnumStringValues() []string
GetOperationStatusEnumStringValues Enumerates the set of values in String for OperationStatusEnum
func GetOperationTypeEnumStringValues() []string
GetOperationTypeEnumStringValues Enumerates the set of values in String for OperationTypeEnum
func GetPurgeQueueDetailsPurgeTypeEnumStringValues() []string
GetPurgeQueueDetailsPurgeTypeEnumStringValues Enumerates the set of values in String for PurgeQueueDetailsPurgeTypeEnum
func GetQueueCapabilityEnumStringValues() []string
GetQueueCapabilityEnumStringValues Enumerates the set of values in String for QueueCapabilityEnum
func GetQueueLifecycleStateEnumStringValues() []string
GetQueueLifecycleStateEnumStringValues Enumerates the set of values in String for QueueLifecycleStateEnum
func GetSortOrderEnumStringValues() []string
GetSortOrderEnumStringValues Enumerates the set of values in String for SortOrderEnum
ActionTypeEnum Enum with underlying type: string
type ActionTypeEnum string
Set of constants representing the allowable values for ActionTypeEnum
const (
ActionTypeCreated ActionTypeEnum = "CREATED"
ActionTypeUpdated ActionTypeEnum = "UPDATED"
ActionTypeDeleted ActionTypeEnum = "DELETED"
ActionTypeInProgress ActionTypeEnum = "IN_PROGRESS"
ActionTypeRelated ActionTypeEnum = "RELATED"
)
func GetActionTypeEnumValues() []ActionTypeEnum
GetActionTypeEnumValues Enumerates the set of values for ActionTypeEnum
func GetMappingActionTypeEnum(val string) (ActionTypeEnum, bool)
GetMappingActionTypeEnum performs case Insensitive comparison on enum value and return the desired enum
CapabilityDetails Base object for capabilities
type CapabilityDetails interface {
}
ChangeQueueCompartmentDetails The information to be updated.
type ChangeQueueCompartmentDetails 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 ChangeQueueCompartmentDetails) String() string
func (m ChangeQueueCompartmentDetails) 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
ChangeQueueCompartmentRequest wrapper for the ChangeQueueCompartment operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/queue/ChangeQueueCompartment.go.html to see an example of how to use ChangeQueueCompartmentRequest.
type ChangeQueueCompartmentRequest struct {
// The unique queue identifier.
QueueId *string `mandatory:"true" contributesTo:"path" name:"queueId"`
// The information to be updated.
ChangeQueueCompartmentDetails `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"`
// 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 ChangeQueueCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ChangeQueueCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ChangeQueueCompartmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ChangeQueueCompartmentRequest) String() string
func (request ChangeQueueCompartmentRequest) 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
ChangeQueueCompartmentResponse wrapper for the ChangeQueueCompartment operation
type ChangeQueueCompartmentResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// 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 ChangeQueueCompartmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ChangeQueueCompartmentResponse) String() string
ChannelCollection List of IDs of non-empty channels.
type ChannelCollection struct {
// The approximate list of IDs of non-empty channels.
Items []string `mandatory:"true" json:"items"`
}
func (m ChannelCollection) String() string
func (m ChannelCollection) 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
ConsumerGroup A detailed representation of a consumer group.
type ConsumerGroup struct {
// A unique identifier for the consumer group that is immutable on creation.
Id *string `mandatory:"true" json:"id"`
// A user-friendly name for the consumer group. It has to be unique within the same queue in a case-insensitive manner. It's changeable. Avoid entering confidential information.
DisplayName *string `mandatory:"true" json:"displayName"`
// The time that the consumer group 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 time that the consumer group was updated, expressed in RFC 3339 (https://tools.ietf.org/rfc/rfc3339) timestamp format.
// Example: `2018-04-20T00:00:07.405Z`
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// The current state of the consumer group.
LifecycleState ConsumerGroupLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The filter used by the consumer group. Only messages matching the filter will be available by consumers of the group.
// An empty value means that all messages will be available in the group.
Filter *string `mandatory:"true" json:"filter"`
// The OCID of the associated queue.
QueueId *string `mandatory:"true" json:"queueId"`
// Any additional details about the current state of the consumer group.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// The number of times a message can be delivered to a consumer before being moved to the dead letter queue.
// A value of 0 indicates that the DLQ is not used.
// If the value isn't set, it will be using the value defined at the queue level.
DeadLetterQueueDeliveryCount *int `mandatory:"false" json:"deadLetterQueueDeliveryCount"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// Usage of system tag keys. These predefined keys are scoped to namespaces.
// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}
func (m ConsumerGroup) String() string
func (m ConsumerGroup) 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
ConsumerGroupCollection Results of a consumer group search. Contains both ConsumerGroupSummary items and other information, such as metadata.
type ConsumerGroupCollection struct {
// List of consumer groups.
Items []ConsumerGroupSummary `mandatory:"true" json:"items"`
}
func (m ConsumerGroupCollection) String() string
func (m ConsumerGroupCollection) 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
ConsumerGroupLifecycleStateEnum Enum with underlying type: string
type ConsumerGroupLifecycleStateEnum string
Set of constants representing the allowable values for ConsumerGroupLifecycleStateEnum
const (
ConsumerGroupLifecycleStateCreating ConsumerGroupLifecycleStateEnum = "CREATING"
ConsumerGroupLifecycleStateUpdating ConsumerGroupLifecycleStateEnum = "UPDATING"
ConsumerGroupLifecycleStateActive ConsumerGroupLifecycleStateEnum = "ACTIVE"
ConsumerGroupLifecycleStateDeleting ConsumerGroupLifecycleStateEnum = "DELETING"
ConsumerGroupLifecycleStateDeleted ConsumerGroupLifecycleStateEnum = "DELETED"
ConsumerGroupLifecycleStateFailed ConsumerGroupLifecycleStateEnum = "FAILED"
ConsumerGroupLifecycleStateInactive ConsumerGroupLifecycleStateEnum = "INACTIVE"
)
func GetConsumerGroupLifecycleStateEnumValues() []ConsumerGroupLifecycleStateEnum
GetConsumerGroupLifecycleStateEnumValues Enumerates the set of values for ConsumerGroupLifecycleStateEnum
func GetMappingConsumerGroupLifecycleStateEnum(val string) (ConsumerGroupLifecycleStateEnum, bool)
GetMappingConsumerGroupLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
ConsumerGroupSummary Summary of the consumer group.
type ConsumerGroupSummary struct {
// A unique identifier for the consumer group that is immutable on creation.
Id *string `mandatory:"true" json:"id"`
// A user-friendly name for the consumer group. It has to be unique within the same queue in a case-insensitive manner. It's changeable. Avoid entering confidential information.
DisplayName *string `mandatory:"true" json:"displayName"`
// The time that the consumer group 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 time that the consumer group was updated, expressed in RFC 3339 (https://tools.ietf.org/rfc/rfc3339) timestamp format.
// Example: `2018-04-20T00:00:07.405Z`
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// The current state of the consumer group.
LifecycleState ConsumerGroupLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The filter used by the consumer group. Only messages matching the filter will be available by consumers of the group.
Filter *string `mandatory:"true" json:"filter"`
// The OCID of the associated queue.
QueueId *string `mandatory:"true" json:"queueId"`
// Any additional details about the current state of the consumer group.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// Usage of system tag keys. These predefined keys are scoped to namespaces.
// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}
func (m ConsumerGroupSummary) String() string
func (m ConsumerGroupSummary) 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
ConsumerGroupsCapabilityDetails Specifies the details for the consumer group capability. All fields are optional and are only used when the capability is added. Fields will be `null` when the capability is returned as part of the GetQueue API.
type ConsumerGroupsCapabilityDetails struct {
// Specifies if the primary consumer group should be automatically enabled after adding the capability.
IsPrimaryConsumerGroupEnabled *bool `mandatory:"false" json:"isPrimaryConsumerGroupEnabled"`
// Name of the primary consumer group. If omitted, it will be named "Primary Consumer Group".
PrimaryConsumerGroupDisplayName *string `mandatory:"false" json:"primaryConsumerGroupDisplayName"`
// The filter used by the primary consumer group. Only messages matching the filter will be available by consumers of the group.
// An empty value means that all messages will be available in the group.
PrimaryConsumerGroupFilter *string `mandatory:"false" json:"primaryConsumerGroupFilter"`
// The number of times a message can be delivered to a consumer before being moved to the dead letter queue.
// A value of 0 indicates that the DLQ is not used.
// If the value isn't set, it will be using the value defined at the queue level.
PrimaryConsumerGroupDeadLetterQueueDeliveryCount *int `mandatory:"false" json:"primaryConsumerGroupDeadLetterQueueDeliveryCount"`
}
func (m ConsumerGroupsCapabilityDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m ConsumerGroupsCapabilityDetails) String() string
func (m ConsumerGroupsCapabilityDetails) 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
CreateConsumerGroupDetails The information about a new consumer group.
type CreateConsumerGroupDetails struct {
// The user-friendly name of the consumer group.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID of the associated queue.
QueueId *string `mandatory:"true" json:"queueId"`
// The filter used by the consumer group. Only messages matching the filter will be available by consumers of the group.
Filter *string `mandatory:"false" json:"filter"`
// Used to enable or disable the consumer group.
// An enabled consumer group will have a lifecycle state of ACTIVE, while a disabled will have its state as INACTIVE.
IsEnabled *bool `mandatory:"false" json:"isEnabled"`
// The number of times a message can be delivered to a consumer before being moved to the dead letter queue.
// A value of 0 indicates that the DLQ is not used.
// If the value isn't specified, it will be using the value defined at the queue level.
DeadLetterQueueDeliveryCount *int `mandatory:"false" json:"deadLetterQueueDeliveryCount"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m CreateConsumerGroupDetails) String() string
func (m CreateConsumerGroupDetails) 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
CreateConsumerGroupRequest wrapper for the CreateConsumerGroup operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/queue/CreateConsumerGroup.go.html to see an example of how to use CreateConsumerGroupRequest.
type CreateConsumerGroupRequest struct {
// Details for the new consumer group.
CreateConsumerGroupDetails `contributesTo:"body"`
// 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
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// 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 CreateConsumerGroupRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateConsumerGroupRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateConsumerGroupRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateConsumerGroupRequest) String() string
func (request CreateConsumerGroupRequest) 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
CreateConsumerGroupResponse wrapper for the CreateConsumerGroup operation
type CreateConsumerGroupResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// 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 CreateConsumerGroupResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateConsumerGroupResponse) String() string
CreateQueueDetails The information about a new queue.
type CreateQueueDetails struct {
// The user-friendly name of the queue.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the queue.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The retention period of messages in the queue, in seconds.
RetentionInSeconds *int `mandatory:"false" json:"retentionInSeconds"`
// The default visibility timeout of the messages consumed from the queue, in seconds.
VisibilityInSeconds *int `mandatory:"false" json:"visibilityInSeconds"`
// The default polling timeout of the messages in the queue, in seconds.
TimeoutInSeconds *int `mandatory:"false" json:"timeoutInSeconds"`
// The percentage of allocated queue resources that can be consumed by a single channel. For example, if a queue has a storage limit of 2Gb, and a single channel consumption limit is 0.1 (10%), that means data size of a single channel can't exceed 200Mb. Consumption limit of 100% (default) means that a single channel can consume up-to all allocated queue's resources.
ChannelConsumptionLimit *int `mandatory:"false" json:"channelConsumptionLimit"`
// The number of times a message can be delivered to a consumer before being moved to the dead letter queue. A value of 0 indicates that the DLQ is not used.
DeadLetterQueueDeliveryCount *int `mandatory:"false" json:"deadLetterQueueDeliveryCount"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the custom encryption key to be used to encrypt messages content.
CustomEncryptionKeyId *string `mandatory:"false" json:"customEncryptionKeyId"`
// The capability to add on the queue
Capabilities []CapabilityDetails `mandatory:"false" json:"capabilities"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m CreateQueueDetails) String() string
func (m *CreateQueueDetails) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m CreateQueueDetails) 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
CreateQueueRequest wrapper for the CreateQueue operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/queue/CreateQueue.go.html to see an example of how to use CreateQueueRequest.
type CreateQueueRequest struct {
// Details for the new Queue.
CreateQueueDetails `contributesTo:"body"`
// 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
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// 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 CreateQueueRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateQueueRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateQueueRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateQueueRequest) String() string
func (request CreateQueueRequest) 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
CreateQueueResponse wrapper for the CreateQueue operation
type CreateQueueResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// 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 CreateQueueResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateQueueResponse) String() string
DeleteConsumerGroupRequest wrapper for the DeleteConsumerGroup operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/queue/DeleteConsumerGroup.go.html to see an example of how to use DeleteConsumerGroupRequest.
type DeleteConsumerGroupRequest struct {
// The unique consumer group identifier.
ConsumerGroupId *string `mandatory:"true" contributesTo:"path" name:"consumerGroupId"`
// 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"`
// 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 DeleteConsumerGroupRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteConsumerGroupRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteConsumerGroupRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteConsumerGroupRequest) String() string
func (request DeleteConsumerGroupRequest) 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
DeleteConsumerGroupResponse wrapper for the DeleteConsumerGroup operation
type DeleteConsumerGroupResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// 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 DeleteConsumerGroupResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteConsumerGroupResponse) String() string
DeleteMessageRequest wrapper for the DeleteMessage operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/queue/DeleteMessage.go.html to see an example of how to use DeleteMessageRequest.
type DeleteMessageRequest struct {
// The unique queue identifier.
QueueId *string `mandatory:"true" contributesTo:"path" name:"queueId"`
// The receipt of the message retrieved from a GetMessages call.
MessageReceipt *string `mandatory:"true" contributesTo:"path" name:"messageReceipt"`
// 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"`
// Optional parameter to specify a consumer group.
ConsumerGroupId *string `mandatory:"false" contributesTo:"query" name:"consumerGroupId"`
// 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 DeleteMessageRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteMessageRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteMessageRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteMessageRequest) String() string
func (request DeleteMessageRequest) 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
DeleteMessageResponse wrapper for the DeleteMessage operation
type DeleteMessageResponse 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 DeleteMessageResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteMessageResponse) String() string
DeleteMessagesDetails The details of a DeleteMessages request.
type DeleteMessagesDetails struct {
// The array of messages to delete from a queue.
Entries []DeleteMessagesDetailsEntry `mandatory:"true" json:"entries"`
}
func (m DeleteMessagesDetails) String() string
func (m DeleteMessagesDetails) 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
DeleteMessagesDetailsEntry Object that represents a message to delete from a queue.
type DeleteMessagesDetailsEntry struct {
// The receipt of the message to delete.
Receipt *string `mandatory:"true" json:"receipt"`
}
func (m DeleteMessagesDetailsEntry) String() string
func (m DeleteMessagesDetailsEntry) 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
DeleteMessagesRequest wrapper for the DeleteMessages operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/queue/DeleteMessages.go.html to see an example of how to use DeleteMessagesRequest.
type DeleteMessagesRequest struct {
// The unique queue identifier.
QueueId *string `mandatory:"true" contributesTo:"path" name:"queueId"`
// Details for the messages to delete.
DeleteMessagesDetails `contributesTo:"body"`
// Optional parameter to specify a consumer group.
ConsumerGroupId *string `mandatory:"false" contributesTo:"query" name:"consumerGroupId"`
// 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 DeleteMessagesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteMessagesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteMessagesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteMessagesRequest) String() string
func (request DeleteMessagesRequest) 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
DeleteMessagesResponse wrapper for the DeleteMessages operation
type DeleteMessagesResponse struct {
// The underlying http response
RawResponse *http.Response
// The DeleteMessagesResult instance
DeleteMessagesResult `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 DeleteMessagesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteMessagesResponse) String() string
DeleteMessagesResult The response to a DeleteMessages request. It indicates the number of server and client failures as well as an array of entries for successful and failed actions.
type DeleteMessagesResult struct {
// The number of messages that failed to be deleted from the queue because of a server failure.
ServerFailures *int `mandatory:"true" json:"serverFailures"`
// The number of messages that failed to be deleted from the queue because of a client failure such as an invalid receipt.
ClientFailures *int `mandatory:"true" json:"clientFailures"`
// An array of items representing the result of each action.
// The order is guaranteed to be the same as in the `DeleteMessagesDetails` object.
// If a message was successfully deleted from the queue, the entry does not contain any fields.
// If a message failed to be deleted from the queue, the entry includes the `errorCode` and `errorMessage` fields.
Entries []DeleteMessagesResultEntry `mandatory:"true" json:"entries"`
}
func (m DeleteMessagesResult) String() string
func (m DeleteMessagesResult) 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
DeleteMessagesResultEntry Represents the result of a DeleteMessages request, whether it was successful or not. If a message was successfully deleted from the queue, the entry does not contain any fields. If a message failed to be deleted from the queue, the entry includes the `errorCode` and `errorMessage` fields.
type DeleteMessagesResultEntry struct {
// The error code, in case the message was not successfully deleted from the queue.
ErrorCode *int `mandatory:"false" json:"errorCode"`
// A human-readable error message associated with the error code.
ErrorMessage *string `mandatory:"false" json:"errorMessage"`
}
func (m DeleteMessagesResultEntry) String() string
func (m DeleteMessagesResultEntry) 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
DeleteQueueRequest wrapper for the DeleteQueue operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/queue/DeleteQueue.go.html to see an example of how to use DeleteQueueRequest.
type DeleteQueueRequest struct {
// The unique queue identifier.
QueueId *string `mandatory:"true" contributesTo:"path" name:"queueId"`
// 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"`
// 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 DeleteQueueRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteQueueRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteQueueRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteQueueRequest) String() string
func (request DeleteQueueRequest) 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
DeleteQueueResponse wrapper for the DeleteQueue operation
type DeleteQueueResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// 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 DeleteQueueResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteQueueResponse) String() string
GetConsumerGroupRequest wrapper for the GetConsumerGroup operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/queue/GetConsumerGroup.go.html to see an example of how to use GetConsumerGroupRequest.
type GetConsumerGroupRequest struct {
// The unique consumer group identifier.
ConsumerGroupId *string `mandatory:"true" contributesTo:"path" name:"consumerGroupId"`
// 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 GetConsumerGroupRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetConsumerGroupRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetConsumerGroupRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetConsumerGroupRequest) String() string
func (request GetConsumerGroupRequest) 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
GetConsumerGroupResponse wrapper for the GetConsumerGroup operation
type GetConsumerGroupResponse struct {
// The underlying http response
RawResponse *http.Response
// The ConsumerGroup instance
ConsumerGroup `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response GetConsumerGroupResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetConsumerGroupResponse) String() string
GetMessage A message consumed from a queue.
type GetMessage struct {
// The ID of the message. This ID is only used for tracing and debugging purposes and isn't used as a parameter in any request.
Id *int64 `mandatory:"true" json:"id"`
// The content of the message.
Content *string `mandatory:"true" json:"content"`
// A receipt is a base64urlencode opaque token, uniquely representing a message.
// The receipt can be used to delete a message or update its visibility.
Receipt *string `mandatory:"true" json:"receipt"`
// The number of times that the message has been delivered to a consumer.
DeliveryCount *int `mandatory:"true" json:"deliveryCount"`
// The time after which the message will be visible to other consumers, expressed in RFC 3339 (https://tools.ietf.org/rfc/rfc3339) timestamp format.
// Example: `2018-04-20T00:00:07.405Z`
VisibleAfter *common.SDKTime `mandatory:"true" json:"visibleAfter"`
// The time after which the message will be automatically deleted, expressed in RFC 3339 (https://tools.ietf.org/rfc/rfc3339) timestamp format.
// Example: `2018-04-20T00:00:07.405Z`
ExpireAfter *common.SDKTime `mandatory:"true" json:"expireAfter"`
// The time when message was created in queue.
// Example: `2018-04-20T00:00:07.405Z`
CreatedAt *common.SDKTime `mandatory:"true" json:"createdAt"`
Metadata *MessageMetadata `mandatory:"false" json:"metadata"`
}
func (m GetMessage) String() string
func (m GetMessage) 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
GetMessages A list of messages from a queue.
type GetMessages struct {
// List of messages from a queue.
Messages []GetMessage `mandatory:"true" json:"messages"`
}
func (m GetMessages) String() string
func (m GetMessages) 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
GetMessagesRequest wrapper for the GetMessages operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/queue/GetMessages.go.html to see an example of how to use GetMessagesRequest.
type GetMessagesRequest struct {
// The unique queue identifier.
QueueId *string `mandatory:"true" contributesTo:"path" name:"queueId"`
// If the `visibilityInSeconds` parameter is set, messages will be hidden for `visibilityInSeconds` seconds and won't be consumable by other consumers during that time.
// If it isn't set it defaults to the value set at the queue level.
// Using a `visibilityInSeconds` value of 0 effectively acts as a peek functionality.
// Messages retrieved that way aren't meant to be deleted because they will most likely be delivered to another consumer as their visibility won't change, but will still increase the delivery count by one.
VisibilityInSeconds *int `mandatory:"false" contributesTo:"query" name:"visibilityInSeconds"`
// If the `timeoutInSeconds parameter` isn't set or it is set to a value greater than 0, the request is using the long-polling mode and will only return when a message is available for consumption (it does not wait for limit messages but still only returns at-most limit messages) or after `timeoutInSeconds` seconds (in which case it will return an empty response), whichever comes first.
// If the parameter is set to 0, the request is using the short-polling mode and immediately returns whether messages have been retrieved or not.
// In same rare-cases a long-polling request could be interrupted (returned with empty response) before the end of the timeout.
TimeoutInSeconds *int `mandatory:"false" contributesTo:"query" name:"timeoutInSeconds"`
// The limit parameter controls how many messages is returned at-most.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// 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"`
// Optional parameter to filter the channels.
ChannelFilter *string `mandatory:"false" contributesTo:"query" name:"channelFilter"`
// Optional parameter to specify a consumer group.
ConsumerGroupId *string `mandatory:"false" contributesTo:"query" name:"consumerGroupId"`
// 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 GetMessages instance
GetMessages `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 GetMessagesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetMessagesResponse) String() string
GetQueueRequest wrapper for the GetQueue operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/queue/GetQueue.go.html to see an example of how to use GetQueueRequest.
type GetQueueRequest struct {
// The unique queue identifier.
QueueId *string `mandatory:"true" contributesTo:"path" name:"queueId"`
// 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 GetQueueRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetQueueRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetQueueRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetQueueRequest) String() string
func (request GetQueueRequest) 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
GetQueueResponse wrapper for the GetQueue operation
type GetQueueResponse struct {
// The underlying http response
RawResponse *http.Response
// The Queue instance
Queue `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response GetQueueResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetQueueResponse) String() string
GetStatsRequest wrapper for the GetStats operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/queue/GetStats.go.html to see an example of how to use GetStatsRequest.
type GetStatsRequest struct {
// The unique queue identifier.
QueueId *string `mandatory:"true" contributesTo:"path" name:"queueId"`
// 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"`
// Id to specify channel.
ChannelId *string `mandatory:"false" contributesTo:"query" name:"channelId"`
// Optional parameter to specify a consumer group.
ConsumerGroupId *string `mandatory:"false" contributesTo:"query" name:"consumerGroupId"`
// 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 GetStatsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetStatsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetStatsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetStatsRequest) String() string
func (request GetStatsRequest) 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
GetStatsResponse wrapper for the GetStats operation
type GetStatsResponse struct {
// The underlying http response
RawResponse *http.Response
// The QueueStats instance
QueueStats `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 GetStatsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetStatsResponse) String() string
GetWorkRequestRequest wrapper for the GetWorkRequest operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/queue/GetWorkRequest.go.html to see an example of how to use GetWorkRequestRequest.
type GetWorkRequestRequest struct {
// The ID of the asynchronous request.
WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`
// 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 GetWorkRequestRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetWorkRequestRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetWorkRequestRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetWorkRequestRequest) String() string
func (request GetWorkRequestRequest) 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
GetWorkRequestResponse wrapper for the GetWorkRequest operation
type GetWorkRequestResponse struct {
// The underlying http response
RawResponse *http.Response
// The WorkRequest instance
WorkRequest `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"`
// A decimal number representing the number of seconds the client should wait before polling this endpoint again.
RetryAfter *int `presentIn:"header" name:"retry-after"`
}
func (response GetWorkRequestResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetWorkRequestResponse) String() string
LargeMessagesCapabilityDetails Specifies the details for the large messages capability.
type LargeMessagesCapabilityDetails struct {
}
func (m LargeMessagesCapabilityDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m LargeMessagesCapabilityDetails) String() string
func (m LargeMessagesCapabilityDetails) 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
ListChannelsRequest wrapper for the ListChannels operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/queue/ListChannels.go.html to see an example of how to use ListChannelsRequest.
type ListChannelsRequest struct {
// The unique queue identifier.
QueueId *string `mandatory:"true" contributesTo:"path" name:"queueId"`
// Optional parameter to specify a consumer group.
ConsumerGroupId *string `mandatory:"false" contributesTo:"query" name:"consumerGroupId"`
// 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 list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// Optional parameter to filter the channels.
ChannelFilter *string `mandatory:"false" contributesTo:"query" name:"channelFilter"`
// 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 ListChannelsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListChannelsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListChannelsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListChannelsRequest) String() string
func (request ListChannelsRequest) 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
ListChannelsResponse wrapper for the ListChannels operation
type ListChannelsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of ChannelCollection instances
ChannelCollection `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 pagination of a list of items. When paging through a list, if this header appears in the response,
// then a partial list might have been returned. Include this value as the `page` parameter for the
// subsequent GET request to get the next batch of items.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListChannelsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListChannelsResponse) String() string
ListConsumerGroupsRequest wrapper for the ListConsumerGroups operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/queue/ListConsumerGroups.go.html to see an example of how to use ListConsumerGroupsRequest.
type ListConsumerGroupsRequest struct {
// A filter to return only resources their lifecycleState matches the given lifecycleState.
LifecycleState ConsumerGroupLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// A filter to return only resources that match the entire display name given.
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// The unique consumer group identifier.
Id *string `mandatory:"false" contributesTo:"query" name:"id"`
// The unique queue identifier.
QueueId *string `mandatory:"false" contributesTo:"query" name:"queueId"`
// For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The sort order to use, either 'asc' or 'desc'.
SortOrder ListConsumerGroupsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default.
SortBy ListConsumerGroupsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// 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 ListConsumerGroupsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListConsumerGroupsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListConsumerGroupsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListConsumerGroupsRequest) String() string
func (request ListConsumerGroupsRequest) 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
ListConsumerGroupsResponse wrapper for the ListConsumerGroups operation
type ListConsumerGroupsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of ConsumerGroupCollection instances
ConsumerGroupCollection `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 pagination of a list of items. When paging through a list, if this header appears in the response,
// then a partial list might have been returned. Include this value as the `page` parameter for the
// subsequent GET request to get the next batch of items.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListConsumerGroupsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListConsumerGroupsResponse) String() string
ListConsumerGroupsSortByEnum Enum with underlying type: string
type ListConsumerGroupsSortByEnum string
Set of constants representing the allowable values for ListConsumerGroupsSortByEnum
const (
ListConsumerGroupsSortByTimecreated ListConsumerGroupsSortByEnum = "timeCreated"
ListConsumerGroupsSortByDisplayname ListConsumerGroupsSortByEnum = "displayName"
)
func GetListConsumerGroupsSortByEnumValues() []ListConsumerGroupsSortByEnum
GetListConsumerGroupsSortByEnumValues Enumerates the set of values for ListConsumerGroupsSortByEnum
func GetMappingListConsumerGroupsSortByEnum(val string) (ListConsumerGroupsSortByEnum, bool)
GetMappingListConsumerGroupsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListConsumerGroupsSortOrderEnum Enum with underlying type: string
type ListConsumerGroupsSortOrderEnum string
Set of constants representing the allowable values for ListConsumerGroupsSortOrderEnum
const (
ListConsumerGroupsSortOrderAsc ListConsumerGroupsSortOrderEnum = "ASC"
ListConsumerGroupsSortOrderDesc ListConsumerGroupsSortOrderEnum = "DESC"
)
func GetListConsumerGroupsSortOrderEnumValues() []ListConsumerGroupsSortOrderEnum
GetListConsumerGroupsSortOrderEnumValues Enumerates the set of values for ListConsumerGroupsSortOrderEnum
func GetMappingListConsumerGroupsSortOrderEnum(val string) (ListConsumerGroupsSortOrderEnum, bool)
GetMappingListConsumerGroupsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListQueuesRequest wrapper for the ListQueues operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/queue/ListQueues.go.html to see an example of how to use ListQueuesRequest.
type ListQueuesRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources.
CompartmentId *string `mandatory:"false" contributesTo:"query" name:"compartmentId"`
// A filter to return only resources their lifecycleState matches the given lifecycleState.
LifecycleState QueueLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// A filter to return only resources that match the entire display name given.
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// The unique queue identifier.
Id *string `mandatory:"false" contributesTo:"query" name:"id"`
// For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The sort order to use, either 'asc' or 'desc'.
SortOrder ListQueuesSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default.
SortBy ListQueuesSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// 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 ListQueuesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListQueuesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListQueuesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListQueuesRequest) String() string
func (request ListQueuesRequest) 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
ListQueuesResponse wrapper for the ListQueues operation
type ListQueuesResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of QueueCollection instances
QueueCollection `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 pagination of a list of items. When paging through a list, if this header appears in the response,
// then a partial list might have been returned. Include this value as the `page` parameter for the
// subsequent GET request to get the next batch of items.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListQueuesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListQueuesResponse) String() string
ListQueuesSortByEnum Enum with underlying type: string
type ListQueuesSortByEnum string
Set of constants representing the allowable values for ListQueuesSortByEnum
const (
ListQueuesSortByTimecreated ListQueuesSortByEnum = "timeCreated"
ListQueuesSortByDisplayname ListQueuesSortByEnum = "displayName"
)
func GetListQueuesSortByEnumValues() []ListQueuesSortByEnum
GetListQueuesSortByEnumValues Enumerates the set of values for ListQueuesSortByEnum
func GetMappingListQueuesSortByEnum(val string) (ListQueuesSortByEnum, bool)
GetMappingListQueuesSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListQueuesSortOrderEnum Enum with underlying type: string
type ListQueuesSortOrderEnum string
Set of constants representing the allowable values for ListQueuesSortOrderEnum
const (
ListQueuesSortOrderAsc ListQueuesSortOrderEnum = "ASC"
ListQueuesSortOrderDesc ListQueuesSortOrderEnum = "DESC"
)
func GetListQueuesSortOrderEnumValues() []ListQueuesSortOrderEnum
GetListQueuesSortOrderEnumValues Enumerates the set of values for ListQueuesSortOrderEnum
func GetMappingListQueuesSortOrderEnum(val string) (ListQueuesSortOrderEnum, bool)
GetMappingListQueuesSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestErrorsRequest wrapper for the ListWorkRequestErrors operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/queue/ListWorkRequestErrors.go.html to see an example of how to use ListWorkRequestErrorsRequest.
type ListWorkRequestErrorsRequest struct {
// The ID of the asynchronous request.
WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`
// 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 list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// 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 ListWorkRequestErrorsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListWorkRequestErrorsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListWorkRequestErrorsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListWorkRequestErrorsRequest) String() string
func (request ListWorkRequestErrorsRequest) 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
ListWorkRequestErrorsResponse wrapper for the ListWorkRequestErrors operation
type ListWorkRequestErrorsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of WorkRequestErrorCollection instances
WorkRequestErrorCollection `presentIn:"body"`
// For pagination of a list of items. When paging through a list, if this header appears in the response,
// then a partial list might have been returned. Include this value as the `page` parameter for the
// subsequent GET request to get the next batch of items.
OpcNextPage *string `presentIn:"header" name:"opc-next-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 ListWorkRequestErrorsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListWorkRequestErrorsResponse) String() string
ListWorkRequestLogsRequest wrapper for the ListWorkRequestLogs operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/queue/ListWorkRequestLogs.go.html to see an example of how to use ListWorkRequestLogsRequest.
type ListWorkRequestLogsRequest struct {
// The ID of the asynchronous request.
WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`
// 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 list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// 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 ListWorkRequestLogsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListWorkRequestLogsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListWorkRequestLogsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListWorkRequestLogsRequest) String() string
func (request ListWorkRequestLogsRequest) 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
ListWorkRequestLogsResponse wrapper for the ListWorkRequestLogs operation
type ListWorkRequestLogsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of WorkRequestLogEntryCollection instances
WorkRequestLogEntryCollection `presentIn:"body"`
// For pagination of a list of items. When paging through a list, if this header appears in the response,
// then a partial list might have been returned. Include this value as the `page` parameter for the
// subsequent GET request to get the next batch of items.
OpcNextPage *string `presentIn:"header" name:"opc-next-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 ListWorkRequestLogsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListWorkRequestLogsResponse) String() string
ListWorkRequestsRequest wrapper for the ListWorkRequests operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/queue/ListWorkRequests.go.html to see an example of how to use ListWorkRequestsRequest.
type ListWorkRequestsRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources.
CompartmentId *string `mandatory:"false" contributesTo:"query" name:"compartmentId"`
// The ID of the asynchronous work request.
WorkRequestId *string `mandatory:"false" contributesTo:"query" name:"workRequestId"`
// 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 list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// 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 ListWorkRequestsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListWorkRequestsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListWorkRequestsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListWorkRequestsRequest) String() string
func (request ListWorkRequestsRequest) 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
ListWorkRequestsResponse wrapper for the ListWorkRequests operation
type ListWorkRequestsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of WorkRequestSummaryCollection instances
WorkRequestSummaryCollection `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 pagination of a list of items. When paging through a list, if this header appears in the response,
// then a partial list might have been returned. Include this value as the `page` parameter for the
// subsequent GET request to get the next batch of items.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListWorkRequestsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListWorkRequestsResponse) String() string
MessageMetadata Object that represents metadata for message.
type MessageMetadata struct {
// The channel ID which specifies the channel to publish or retrieve messages.
ChannelId *string `mandatory:"true" json:"channelId"`
// Additional message properties
CustomProperties map[string]string `mandatory:"false" json:"customProperties"`
}
func (m MessageMetadata) String() string
func (m MessageMetadata) 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
OperationStatusEnum Enum with underlying type: string
type OperationStatusEnum string
Set of constants representing the allowable values for OperationStatusEnum
const (
OperationStatusAccepted OperationStatusEnum = "ACCEPTED"
OperationStatusInProgress OperationStatusEnum = "IN_PROGRESS"
OperationStatusFailed OperationStatusEnum = "FAILED"
OperationStatusSucceeded OperationStatusEnum = "SUCCEEDED"
OperationStatusCanceling OperationStatusEnum = "CANCELING"
OperationStatusCanceled OperationStatusEnum = "CANCELED"
)
func GetMappingOperationStatusEnum(val string) (OperationStatusEnum, bool)
GetMappingOperationStatusEnum performs case Insensitive comparison on enum value and return the desired enum
func GetOperationStatusEnumValues() []OperationStatusEnum
GetOperationStatusEnumValues Enumerates the set of values for OperationStatusEnum
OperationTypeEnum Enum with underlying type: string
type OperationTypeEnum string
Set of constants representing the allowable values for OperationTypeEnum
const (
OperationTypeCreateQueue OperationTypeEnum = "CREATE_QUEUE"
OperationTypeUpdateQueue OperationTypeEnum = "UPDATE_QUEUE"
OperationTypeDeleteQueue OperationTypeEnum = "DELETE_QUEUE"
OperationTypeMoveQueue OperationTypeEnum = "MOVE_QUEUE"
OperationTypePurgeQueue OperationTypeEnum = "PURGE_QUEUE"
OperationTypeCreateConsumerGroup OperationTypeEnum = "CREATE_CONSUMER_GROUP"
OperationTypeUpdateConsumerGroup OperationTypeEnum = "UPDATE_CONSUMER_GROUP"
OperationTypeDeleteConsumerGroup OperationTypeEnum = "DELETE_CONSUMER_GROUP"
)
func GetMappingOperationTypeEnum(val string) (OperationTypeEnum, bool)
GetMappingOperationTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetOperationTypeEnumValues() []OperationTypeEnum
GetOperationTypeEnumValues Enumerates the set of values for OperationTypeEnum
PurgeQueueDetails Purge parameters.
type PurgeQueueDetails struct {
// Type of the purge to perform:
// - NORMAL - purge only the normal queue
// - DLQ - purge only the dead letter queue
// - BOTH - purge both the normal queue and the dead letter queue
PurgeType PurgeQueueDetailsPurgeTypeEnum `mandatory:"true" json:"purgeType"`
// Optional parameter to specify the destination of purge operation.
// If the channel ID is specified, the purge operation will delete all the messages in the specific channels.
// If the channel ID is not specified, the purge operation will delete all the messages in the queue and in the child channels.
ChannelIds []string `mandatory:"false" json:"channelIds"`
// The consumer group ID to purge. If the CONSUMER_GROUPS capability is enabled on the queue, omitting that field
// will purge the "Primary Consumer Group", otherwise it will purge the queue.
// If you wish to purge all consumer groups in the queue, you can pass the special value 'all'.
ConsumerGroupId *string `mandatory:"false" json:"consumerGroupId"`
}
func (m PurgeQueueDetails) String() string
func (m PurgeQueueDetails) 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
PurgeQueueDetailsPurgeTypeEnum Enum with underlying type: string
type PurgeQueueDetailsPurgeTypeEnum string
Set of constants representing the allowable values for PurgeQueueDetailsPurgeTypeEnum
const (
PurgeQueueDetailsPurgeTypeNormal PurgeQueueDetailsPurgeTypeEnum = "NORMAL"
PurgeQueueDetailsPurgeTypeDlq PurgeQueueDetailsPurgeTypeEnum = "DLQ"
PurgeQueueDetailsPurgeTypeBoth PurgeQueueDetailsPurgeTypeEnum = "BOTH"
)
func GetMappingPurgeQueueDetailsPurgeTypeEnum(val string) (PurgeQueueDetailsPurgeTypeEnum, bool)
GetMappingPurgeQueueDetailsPurgeTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetPurgeQueueDetailsPurgeTypeEnumValues() []PurgeQueueDetailsPurgeTypeEnum
GetPurgeQueueDetailsPurgeTypeEnumValues Enumerates the set of values for PurgeQueueDetailsPurgeTypeEnum
PurgeQueueRequest wrapper for the PurgeQueue operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/queue/PurgeQueue.go.html to see an example of how to use PurgeQueueRequest.
type PurgeQueueRequest struct {
// The unique queue identifier.
QueueId *string `mandatory:"true" contributesTo:"path" name:"queueId"`
// The information to be updated.
PurgeQueueDetails `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"`
// 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 PurgeQueueRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request PurgeQueueRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request PurgeQueueRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request PurgeQueueRequest) String() string
func (request PurgeQueueRequest) 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
PurgeQueueResponse wrapper for the PurgeQueue operation
type PurgeQueueResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// 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 PurgeQueueResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response PurgeQueueResponse) String() string
PutMessage A message that has been published to a queue.
type PutMessage struct {
// The ID of the message.
Id *int64 `mandatory:"true" json:"id"`
// The time after which the message will be automatically deleted, expressed in RFC 3339 (https://tools.ietf.org/rfc/rfc3339) timestamp format.
// Example: `2018-04-20T00:00:07.405Z`
ExpireAfter *common.SDKTime `mandatory:"false" json:"expireAfter"`
}
func (m PutMessage) String() string
func (m PutMessage) 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
PutMessages A list of the messages published to a queue.
type PutMessages struct {
// The messages that have been published to a queue.
Messages []PutMessage `mandatory:"true" json:"messages"`
}
func (m PutMessages) String() string
func (m PutMessages) 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 The details of a PutMessages request.
type PutMessagesDetails struct {
// The array of messages to put into a queue.
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 publish into a queue.
type PutMessagesDetailsEntry struct {
// The content of the message
Content *string `mandatory:"true" json:"content"`
Metadata *MessageMetadata `mandatory:"false" json:"metadata"`
}
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/queue/PutMessages.go.html to see an example of how to use PutMessagesRequest.
type PutMessagesRequest struct {
// The unique queue identifier.
QueueId *string `mandatory:"true" contributesTo:"path" name:"queueId"`
// Details for the messages to publish.
PutMessagesDetails `contributesTo:"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 `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 PutMessages instance
PutMessages `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
Queue A detailed representation of a queue and its configuration.
type Queue struct {
// A unique identifier for the queue that is immutable on creation.
Id *string `mandatory:"true" json:"id"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the queue.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The time that the queue 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 time that the queue was updated, expressed in RFC 3339 (https://tools.ietf.org/rfc/rfc3339) timestamp format.
// Example: `2018-04-20T00:00:07.405Z`
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// The current state of the queue.
LifecycleState QueueLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The endpoint to use to consume or publish messages in the queue.
MessagesEndpoint *string `mandatory:"true" json:"messagesEndpoint"`
// The retention period of the messages in the queue, in seconds.
RetentionInSeconds *int `mandatory:"true" json:"retentionInSeconds"`
// The default visibility timeout of the messages consumed from the queue, in seconds.
VisibilityInSeconds *int `mandatory:"true" json:"visibilityInSeconds"`
// The default polling timeout of the messages in the queue, in seconds.
TimeoutInSeconds *int `mandatory:"true" json:"timeoutInSeconds"`
// The number of times a message can be delivered to a consumer before being moved to the dead letter queue. A value of 0 indicates that the DLQ is not used.
DeadLetterQueueDeliveryCount *int `mandatory:"true" json:"deadLetterQueueDeliveryCount"`
// A user-friendly name for the queue. Does not have to be unique, and it's changeable. Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// Any additional details about the current state of the queue.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the custom encryption key to be used to encrypt messages content.
CustomEncryptionKeyId *string `mandatory:"false" json:"customEncryptionKeyId"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// Usage of system tag keys. These predefined keys are scoped to namespaces.
// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
// The percentage of allocated queue resources that can be consumed by a single channel. For example, if a queue has a storage limit of 2Gb, and a single channel consumption limit is 0.1 (10%), that means data size of a single channel can't exceed 200Mb. Consumption limit of 100% (default) means that a single channel can consume up-to all allocated queue's resources.
ChannelConsumptionLimit *int `mandatory:"false" json:"channelConsumptionLimit"`
// The list of capabilities enabled on the queue
Capabilities []CapabilityDetails `mandatory:"false" json:"capabilities"`
}
func (m Queue) String() string
func (m *Queue) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m Queue) 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
QueueAdminClient a client for QueueAdmin
type QueueAdminClient struct {
common.BaseClient
// contains filtered or unexported fields
}
func NewQueueAdminClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client QueueAdminClient, err error)
NewQueueAdminClientWithConfigurationProvider Creates a new default QueueAdmin client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region
func NewQueueAdminClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client QueueAdminClient, err error)
NewQueueAdminClientWithOboToken Creates a new default QueueAdmin 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 QueueAdminClient) ChangeQueueCompartment(ctx context.Context, request ChangeQueueCompartmentRequest) (response ChangeQueueCompartmentResponse, err error)
ChangeQueueCompartment Moves a queue from one compartment to another. 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/queue/ChangeQueueCompartment.go.html to see an example of how to use ChangeQueueCompartment API. A default retry strategy applies to this operation ChangeQueueCompartment()
func (client *QueueAdminClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client QueueAdminClient) CreateConsumerGroup(ctx context.Context, request CreateConsumerGroupRequest) (response CreateConsumerGroupResponse, err error)
CreateConsumerGroup Creates a new consumer group.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/queue/CreateConsumerGroup.go.html to see an example of how to use CreateConsumerGroup API. A default retry strategy applies to this operation CreateConsumerGroup()
func (client QueueAdminClient) CreateQueue(ctx context.Context, request CreateQueueRequest) (response CreateQueueResponse, err error)
CreateQueue Creates a new queue.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/queue/CreateQueue.go.html to see an example of how to use CreateQueue API. A default retry strategy applies to this operation CreateQueue()
func (client QueueAdminClient) DeleteConsumerGroup(ctx context.Context, request DeleteConsumerGroupRequest) (response DeleteConsumerGroupResponse, err error)
DeleteConsumerGroup Deletes a consumer group resource by identifier.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/queue/DeleteConsumerGroup.go.html to see an example of how to use DeleteConsumerGroup API. A default retry strategy applies to this operation DeleteConsumerGroup()
func (client QueueAdminClient) DeleteQueue(ctx context.Context, request DeleteQueueRequest) (response DeleteQueueResponse, err error)
DeleteQueue Deletes a queue resource by identifier.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/queue/DeleteQueue.go.html to see an example of how to use DeleteQueue API. A default retry strategy applies to this operation DeleteQueue()
func (client QueueAdminClient) GetConsumerGroup(ctx context.Context, request GetConsumerGroupRequest) (response GetConsumerGroupResponse, err error)
GetConsumerGroup Gets a consumer group by identifier.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/queue/GetConsumerGroup.go.html to see an example of how to use GetConsumerGroup API. A default retry strategy applies to this operation GetConsumerGroup()
func (client QueueAdminClient) GetQueue(ctx context.Context, request GetQueueRequest) (response GetQueueResponse, err error)
GetQueue Gets a queue by identifier.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/queue/GetQueue.go.html to see an example of how to use GetQueue API. A default retry strategy applies to this operation GetQueue()
func (client QueueAdminClient) GetWorkRequest(ctx context.Context, request GetWorkRequestRequest) (response GetWorkRequestResponse, err error)
GetWorkRequest Gets the status of the work request with the given ID.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/queue/GetWorkRequest.go.html to see an example of how to use GetWorkRequest API. A default retry strategy applies to this operation GetWorkRequest()
func (client QueueAdminClient) ListConsumerGroups(ctx context.Context, request ListConsumerGroupsRequest) (response ListConsumerGroupsResponse, err error)
ListConsumerGroups Returns a list of consumer groups.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/queue/ListConsumerGroups.go.html to see an example of how to use ListConsumerGroups API. A default retry strategy applies to this operation ListConsumerGroups()
func (client QueueAdminClient) ListQueues(ctx context.Context, request ListQueuesRequest) (response ListQueuesResponse, err error)
ListQueues Returns a list of queues.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/queue/ListQueues.go.html to see an example of how to use ListQueues API. A default retry strategy applies to this operation ListQueues()
func (client QueueAdminClient) ListWorkRequestErrors(ctx context.Context, request ListWorkRequestErrorsRequest) (response ListWorkRequestErrorsResponse, err error)
ListWorkRequestErrors Return a (paginated) list of errors for a given work request.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/queue/ListWorkRequestErrors.go.html to see an example of how to use ListWorkRequestErrors API. A default retry strategy applies to this operation ListWorkRequestErrors()
func (client QueueAdminClient) ListWorkRequestLogs(ctx context.Context, request ListWorkRequestLogsRequest) (response ListWorkRequestLogsResponse, err error)
ListWorkRequestLogs Return a (paginated) list of logs for a given work request.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/queue/ListWorkRequestLogs.go.html to see an example of how to use ListWorkRequestLogs API. A default retry strategy applies to this operation ListWorkRequestLogs()
func (client QueueAdminClient) ListWorkRequests(ctx context.Context, request ListWorkRequestsRequest) (response ListWorkRequestsResponse, err error)
ListWorkRequests Lists the work requests in a compartment.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/queue/ListWorkRequests.go.html to see an example of how to use ListWorkRequests API. A default retry strategy applies to this operation ListWorkRequests()
func (client QueueAdminClient) PurgeQueue(ctx context.Context, request PurgeQueueRequest) (response PurgeQueueResponse, err error)
PurgeQueue Deletes all messages present in the queue or in the specified consumer group, or deletes all the messages in the specific channel at the time of invocation. Only one concurrent purge operation is supported for any given queue. However multiple concurrent purge operations are supported for different queues. Purge request without specification of target channels will clean up all messages in the queue and in the child channels. Purge request without specification of consumer group will either clean up all messages in the queue or in the primary consumer group, depending on the presence of the CONSUMER_GROUPS capability on the queue. To purge all consumer groups, the special value 'all' can be used.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/queue/PurgeQueue.go.html to see an example of how to use PurgeQueue API. A default retry strategy applies to this operation PurgeQueue()
func (client *QueueAdminClient) SetRegion(region string)
SetRegion overrides the region of this client.
func (client QueueAdminClient) UpdateConsumerGroup(ctx context.Context, request UpdateConsumerGroupRequest) (response UpdateConsumerGroupResponse, err error)
UpdateConsumerGroup Updates the specified consumer group.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/queue/UpdateConsumerGroup.go.html to see an example of how to use UpdateConsumerGroup API. A default retry strategy applies to this operation UpdateConsumerGroup()
func (client QueueAdminClient) UpdateQueue(ctx context.Context, request UpdateQueueRequest) (response UpdateQueueResponse, err error)
UpdateQueue Updates the specified queue.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/queue/UpdateQueue.go.html to see an example of how to use UpdateQueue API. A default retry strategy applies to this operation UpdateQueue()
QueueCapabilityEnum Enum with underlying type: string
type QueueCapabilityEnum string
Set of constants representing the allowable values for QueueCapabilityEnum
const (
QueueCapabilityConsumerGroups QueueCapabilityEnum = "CONSUMER_GROUPS"
QueueCapabilityLargeMessages QueueCapabilityEnum = "LARGE_MESSAGES"
)
func GetMappingQueueCapabilityEnum(val string) (QueueCapabilityEnum, bool)
GetMappingQueueCapabilityEnum performs case Insensitive comparison on enum value and return the desired enum
func GetQueueCapabilityEnumValues() []QueueCapabilityEnum
GetQueueCapabilityEnumValues Enumerates the set of values for QueueCapabilityEnum
QueueClient a client for Queue
type QueueClient struct {
common.BaseClient
// contains filtered or unexported fields
}
func NewQueueClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client QueueClient, err error)
NewQueueClientWithConfigurationProvider Creates a new default Queue client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region
func NewQueueClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client QueueClient, err error)
NewQueueClientWithOboToken Creates a new default Queue 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 *QueueClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client QueueClient) DeleteMessage(ctx context.Context, request DeleteMessageRequest) (response DeleteMessageResponse, err error)
DeleteMessage Deletes the message represented by the receipt from the queue. You must use the messages endpoint (https://docs.oracle.com/iaas/Content/queue/messages.htm#messages__messages-endpoint) to delete messages. The messages endpoint may be different for different queues. Use GetQueue to find the queue's `messagesEndpoint`.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/queue/DeleteMessage.go.html to see an example of how to use DeleteMessage API. A default retry strategy applies to this operation DeleteMessage()
func (client QueueClient) DeleteMessages(ctx context.Context, request DeleteMessagesRequest) (response DeleteMessagesResponse, err error)
DeleteMessages Deletes multiple messages from the queue or the consumer group. Only messages from the same queue/consumer group can be deleted at once. You must use the messages endpoint (https://docs.oracle.com/iaas/Content/queue/messages.htm#messages__messages-endpoint) to delete messages. The messages endpoint may be different for different queues. Use GetQueue to find the queue's `messagesEndpoint`.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/queue/DeleteMessages.go.html to see an example of how to use DeleteMessages API. A default retry strategy applies to this operation DeleteMessages()
func (client QueueClient) GetMessages(ctx context.Context, request GetMessagesRequest) (response GetMessagesResponse, err error)
GetMessages Consumes messages from the queue. You must use the messages endpoint (https://docs.oracle.com/iaas/Content/queue/messages.htm#messages__messages-endpoint) to consume messages. The messages endpoint may be different for different queues. Use GetQueue to find the queue's `messagesEndpoint`. GetMessages accepts optional channelFilter query parameter that can filter source channels of the messages. When channelFilter is present, service will return available messages from the channel which ID exactly matched the filter. When filter is not specified, messages will be returned from a random non-empty channel within a queue.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/queue/GetMessages.go.html to see an example of how to use GetMessages API.
func (client QueueClient) GetStats(ctx context.Context, request GetStatsRequest) (response GetStatsResponse, err error)
GetStats Gets the statistics for the queue and its dead letter queue. You must use the messages endpoint (https://docs.oracle.com/iaas/Content/queue/messages.htm#messages__messages-endpoint) to get a queue's statistics. The messages endpoint may be different for different queues. Use GetQueue to find the queue's `messagesEndpoint`.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/queue/GetStats.go.html to see an example of how to use GetStats API. A default retry strategy applies to this operation GetStats()
func (client QueueClient) ListChannels(ctx context.Context, request ListChannelsRequest) (response ListChannelsResponse, err error)
ListChannels Gets the list of IDs of non-empty channels. It will return an approximate list of IDs of non-empty channels. That information is based on the queue level statistics. API supports optional channelFilter parameter which will filter the returned results according to the specified filter. List of channel IDs is approximate, because statistics is refreshed once per-second, and that list represents a snapshot of the past information. API is paginated.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/queue/ListChannels.go.html to see an example of how to use ListChannels API. A default retry strategy applies to this operation ListChannels()
func (client QueueClient) PutMessages(ctx context.Context, request PutMessagesRequest) (response PutMessagesResponse, err error)
PutMessages Puts messages into the queue. You must use the messages endpoint (https://docs.oracle.com/iaas/Content/queue/messages.htm#messages__messages-endpoint) to produce messages. The messages endpoint may be different for different queues. Use GetQueue to find the queue's `messagesEndpoint`.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/queue/PutMessages.go.html to see an example of how to use PutMessages API.
func (client *QueueClient) SetRegion(region string)
SetRegion overrides the region of this client.
func (client QueueClient) UpdateMessage(ctx context.Context, request UpdateMessageRequest) (response UpdateMessageResponse, err error)
UpdateMessage Updates the visibility of the message represented by the receipt. You must use the messages endpoint (https://docs.oracle.com/iaas/Content/queue/messages.htm#messages__messages-endpoint) to update messages. The messages endpoint may be different for different queues. Use GetQueue to find the queue's `messagesEndpoint`.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/queue/UpdateMessage.go.html to see an example of how to use UpdateMessage API. A default retry strategy applies to this operation UpdateMessage()
func (client QueueClient) UpdateMessages(ctx context.Context, request UpdateMessagesRequest) (response UpdateMessagesResponse, err error)
UpdateMessages Updates multiple messages in the queue or the consumer group. Only messages from the same queue/consumer group can be updated at once. You must use the messages endpoint (https://docs.oracle.com/iaas/Content/queue/messages.htm#messages__messages-endpoint) to update messages. The messages endpoint may be different for different queues. Use GetQueue to find the queue's `messagesEndpoint`.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/queue/UpdateMessages.go.html to see an example of how to use UpdateMessages API. A default retry strategy applies to this operation UpdateMessages()
QueueCollection Results of a queue search. Contains both QueueSummary items and other information, such as metadata.
type QueueCollection struct {
// List of queues.
Items []QueueSummary `mandatory:"true" json:"items"`
}
func (m QueueCollection) String() string
func (m QueueCollection) 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
QueueLifecycleStateEnum Enum with underlying type: string
type QueueLifecycleStateEnum string
Set of constants representing the allowable values for QueueLifecycleStateEnum
const (
QueueLifecycleStateCreating QueueLifecycleStateEnum = "CREATING"
QueueLifecycleStateUpdating QueueLifecycleStateEnum = "UPDATING"
QueueLifecycleStateActive QueueLifecycleStateEnum = "ACTIVE"
QueueLifecycleStateDeleting QueueLifecycleStateEnum = "DELETING"
QueueLifecycleStateDeleted QueueLifecycleStateEnum = "DELETED"
QueueLifecycleStateFailed QueueLifecycleStateEnum = "FAILED"
QueueLifecycleStateInactive QueueLifecycleStateEnum = "INACTIVE"
)
func GetMappingQueueLifecycleStateEnum(val string) (QueueLifecycleStateEnum, bool)
GetMappingQueueLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetQueueLifecycleStateEnumValues() []QueueLifecycleStateEnum
GetQueueLifecycleStateEnumValues Enumerates the set of values for QueueLifecycleStateEnum
QueueStats The stats for a queue and its dead letter queue. If channelId is specified in request field, it will return channel specific stats response.
type QueueStats struct {
Queue *Stats `mandatory:"true" json:"queue"`
Dlq *Stats `mandatory:"true" json:"dlq"`
// If channelId is present in GetStats call, the channel id will be returned in the GetStats response.
ChannelId *string `mandatory:"false" json:"channelId"`
// If consumerGroupId is present in GetStats call, the consumer group id will be returned in the GetStats response.
ConsumerGroupId *string `mandatory:"false" json:"consumerGroupId"`
}
func (m QueueStats) String() string
func (m QueueStats) 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
QueueSummary Summary of the queue.
type QueueSummary struct {
// A unique identifier for the queue that is immutable on creation.
Id *string `mandatory:"true" json:"id"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the queue.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The time that the queue 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 time that the queue was updated, expressed in RFC 3339 (https://tools.ietf.org/rfc/rfc3339) timestamp format.
// Example: `2018-04-20T00:00:07.405Z`
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// The current state of the queue.
LifecycleState QueueLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The endpoint to use to consume or publish messages in the queue.
MessagesEndpoint *string `mandatory:"true" json:"messagesEndpoint"`
// A user-friendly name for the queue. Does not have to be unique, and it's changeable. Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// Any additional details about the current state of the queue.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// Usage of system tag keys. These predefined keys are scoped to namespaces.
// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
// The list of capabilities enabled on the queue
Capabilities []QueueCapabilityEnum `mandatory:"false" json:"capabilities,omitempty"`
}
func (m QueueSummary) String() string
func (m QueueSummary) 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
SortOrderEnum Enum with underlying type: string
type SortOrderEnum string
Set of constants representing the allowable values for SortOrderEnum
const (
SortOrderAsc SortOrderEnum = "ASC"
SortOrderDesc SortOrderEnum = "DESC"
)
func GetMappingSortOrderEnum(val string) (SortOrderEnum, bool)
GetMappingSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
func GetSortOrderEnumValues() []SortOrderEnum
GetSortOrderEnumValues Enumerates the set of values for SortOrderEnum
Stats The stats for a queue or a dead letter queue.
type Stats struct {
// The approximate number of visible messages (available for delivery) currently in the queue.
VisibleMessages *int64 `mandatory:"true" json:"visibleMessages"`
// The approximate number of messages delivered to a consumer but not yet deleted and so unavailable for re-delivery.
InFlightMessages *int64 `mandatory:"true" json:"inFlightMessages"`
// The approximate size of the queue in bytes. Sum of the size of visible and in-flight messages.
SizeInBytes *int64 `mandatory:"true" json:"sizeInBytes"`
}
func (m Stats) String() string
func (m Stats) 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
UpdateConsumerGroupDetails The information to be updated.
type UpdateConsumerGroupDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the consumer group.
DisplayName *string `mandatory:"false" json:"displayName"`
// The filter used by the consumer group. Only messages matching the filter will be available by consumers of the group.
Filter *string `mandatory:"false" json:"filter"`
// Used to enable or disable the consumer group.
// An enabled consumer group will have a lifecycle state of ACTIVE, while a disabled will have its state as INACTIVE.
IsEnabled *bool `mandatory:"false" json:"isEnabled"`
// The number of times a message can be delivered to a consumer before being moved to the dead letter queue.
// A value of 0 indicates that the DLQ is not used.
// Changing that value to a lower threshold does not retroactively move in-flight messages in the dead letter queue.
// A value of -1 unsets the delivery count for the consumer group (i.e. it will now be using the value set at the queue level).
DeadLetterQueueDeliveryCount *int `mandatory:"false" json:"deadLetterQueueDeliveryCount"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m UpdateConsumerGroupDetails) String() string
func (m UpdateConsumerGroupDetails) 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
UpdateConsumerGroupRequest wrapper for the UpdateConsumerGroup operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/queue/UpdateConsumerGroup.go.html to see an example of how to use UpdateConsumerGroupRequest.
type UpdateConsumerGroupRequest struct {
// The unique consumer group identifier.
ConsumerGroupId *string `mandatory:"true" contributesTo:"path" name:"consumerGroupId"`
// The information to be updated.
UpdateConsumerGroupDetails `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"`
// 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 UpdateConsumerGroupRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateConsumerGroupRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateConsumerGroupRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateConsumerGroupRequest) String() string
func (request UpdateConsumerGroupRequest) 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
UpdateConsumerGroupResponse wrapper for the UpdateConsumerGroup operation
type UpdateConsumerGroupResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// 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 UpdateConsumerGroupResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateConsumerGroupResponse) String() string
UpdateMessageDetails Updates the visibility of a message
type UpdateMessageDetails struct {
// The new visibility of the message relative to the current time (as-per the clock of the server receiving the request).
VisibilityInSeconds *int `mandatory:"true" json:"visibilityInSeconds"`
}
func (m UpdateMessageDetails) String() string
func (m UpdateMessageDetails) 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
UpdateMessageRequest wrapper for the UpdateMessage operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/queue/UpdateMessage.go.html to see an example of how to use UpdateMessageRequest.
type UpdateMessageRequest struct {
// The unique queue identifier.
QueueId *string `mandatory:"true" contributesTo:"path" name:"queueId"`
// The receipt of the message retrieved from a GetMessages call.
MessageReceipt *string `mandatory:"true" contributesTo:"path" name:"messageReceipt"`
// Details for the message to update.
UpdateMessageDetails `contributesTo:"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 `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Optional parameter to specify a consumer group.
ConsumerGroupId *string `mandatory:"false" contributesTo:"query" name:"consumerGroupId"`
// 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 UpdateMessageRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateMessageRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateMessageRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateMessageRequest) String() string
func (request UpdateMessageRequest) 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
UpdateMessageResponse wrapper for the UpdateMessage operation
type UpdateMessageResponse struct {
// The underlying http response
RawResponse *http.Response
// The UpdatedMessage instance
UpdatedMessage `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 UpdateMessageResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateMessageResponse) String() string
UpdateMessagesDetails The details of an UpdateMessages request.
type UpdateMessagesDetails struct {
// The array of messages to update in a queue.
Entries []UpdateMessagesDetailsEntry `mandatory:"true" json:"entries"`
}
func (m UpdateMessagesDetails) String() string
func (m UpdateMessagesDetails) 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
UpdateMessagesDetailsEntry Object that represents a message to update in a queue.
type UpdateMessagesDetailsEntry struct {
// The receipt of the message to update.
Receipt *string `mandatory:"true" json:"receipt"`
// The new visibility of the message relative to the current time (as-per the clock of the server receiving the request).
VisibilityInSeconds *int `mandatory:"true" json:"visibilityInSeconds"`
}
func (m UpdateMessagesDetailsEntry) String() string
func (m UpdateMessagesDetailsEntry) 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
UpdateMessagesRequest wrapper for the UpdateMessages operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/queue/UpdateMessages.go.html to see an example of how to use UpdateMessagesRequest.
type UpdateMessagesRequest struct {
// The unique queue identifier.
QueueId *string `mandatory:"true" contributesTo:"path" name:"queueId"`
// Details for the messages to update.
UpdateMessagesDetails `contributesTo:"body"`
// Optional parameter to specify a consumer group.
ConsumerGroupId *string `mandatory:"false" contributesTo:"query" name:"consumerGroupId"`
// 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 UpdateMessagesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateMessagesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateMessagesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateMessagesRequest) String() string
func (request UpdateMessagesRequest) 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
UpdateMessagesResponse wrapper for the UpdateMessages operation
type UpdateMessagesResponse struct {
// The underlying http response
RawResponse *http.Response
// The UpdateMessagesResult instance
UpdateMessagesResult `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 UpdateMessagesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateMessagesResponse) String() string
UpdateMessagesResult The response to a UpdateMessages request. It indicates the number of server and client failures as well as an array of entries for successful and failed actions.
type UpdateMessagesResult struct {
// The number of messages that failed to be updated in the queue because of a server failure.
ServerFailures *int `mandatory:"true" json:"serverFailures"`
// The number of messages that failed to be updated in the queue because of a client failure such as an invalid receipt or invalid `visibilityInSeconds`.
ClientFailures *int `mandatory:"true" json:"clientFailures"`
// An array of items representing the result of each action.
// The order is guaranteed to be the same as in the `UpdateMessagesDetails` object.
// If a message was successfully updated in the queue, the entry includes the `id` and `visibleAfter` fields.
// If a message failed to be updated in the queue, the entry includes the `errorCode` and `errorMessage` fields.
Entries []UpdateMessagesResultEntry `mandatory:"true" json:"entries"`
}
func (m UpdateMessagesResult) String() string
func (m UpdateMessagesResult) 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
UpdateMessagesResultEntry Represents the result of a UpdateMessages request, whether it was successful or not. If a message was successfully updated in the queue, the entry includes the `id` and `visibleAfter` fields. If a message failed to be updated in the queue, the entry includes the `errorCode` and `errorMessage` fields.
type UpdateMessagesResultEntry struct {
// The ID of the message that's been updated.
Id *int64 `mandatory:"false" json:"id"`
// The time after which the message will be visible to other consumers, expressed in RFC 3339 (https://tools.ietf.org/rfc/rfc3339) timestamp format.
// Example: `2018-04-20T00:00:07.405Z`
VisibleAfter *common.SDKTime `mandatory:"false" json:"visibleAfter"`
// The error code, in case the message was not successfully updated in the queue.
ErrorCode *int `mandatory:"false" json:"errorCode"`
// A human-readable error message associated with the error code.
ErrorMessage *string `mandatory:"false" json:"errorMessage"`
}
func (m UpdateMessagesResultEntry) String() string
func (m UpdateMessagesResultEntry) 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
UpdateQueueDetails The information to be updated.
type UpdateQueueDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the queue.
DisplayName *string `mandatory:"false" json:"displayName"`
// The default visibility timeout of the messages consumed from the queue, in seconds.
VisibilityInSeconds *int `mandatory:"false" json:"visibilityInSeconds"`
// The default polling timeout of the messages in the queue, in seconds.
TimeoutInSeconds *int `mandatory:"false" json:"timeoutInSeconds"`
// The percentage of allocated queue resources that can be consumed by a single channel. For example, if a queue has a storage limit of 2Gb, and a single channel consumption limit is 0.1 (10%), that means data size of a single channel can't exceed 200Mb. Consumption limit of 100% (default) means that a single channel can consume up-to all allocated queue's resources.
ChannelConsumptionLimit *int `mandatory:"false" json:"channelConsumptionLimit"`
// The number of times a message can be delivered to a consumer before being moved to the dead letter queue.
// A value of 0 indicates that the DLQ is not used.
// Changing that value to a lower threshold does not retroactively move in-flight messages in the dead letter queue.
DeadLetterQueueDeliveryCount *int `mandatory:"false" json:"deadLetterQueueDeliveryCount"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the custom encryption key to be used to encrypt messages content. A string with a length of 0 means the custom key should be removed from queue.
CustomEncryptionKeyId *string `mandatory:"false" json:"customEncryptionKeyId"`
// The list of capabilities enabled on the queue
Capabilities []CapabilityDetails `mandatory:"false" json:"capabilities"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m UpdateQueueDetails) String() string
func (m *UpdateQueueDetails) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m UpdateQueueDetails) 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
UpdateQueueRequest wrapper for the UpdateQueue operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/queue/UpdateQueue.go.html to see an example of how to use UpdateQueueRequest.
type UpdateQueueRequest struct {
// The unique queue identifier.
QueueId *string `mandatory:"true" contributesTo:"path" name:"queueId"`
// The information to be updated.
UpdateQueueDetails `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"`
// 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 UpdateQueueRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateQueueRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateQueueRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateQueueRequest) String() string
func (request UpdateQueueRequest) 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
UpdateQueueResponse wrapper for the UpdateQueue operation
type UpdateQueueResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// 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 UpdateQueueResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateQueueResponse) String() string
UpdatedMessage An updated message with the new visibility.
type UpdatedMessage struct {
// The ID of the message that's been updated.
Id *int64 `mandatory:"true" json:"id"`
// The time after which the message will be visible to other consumers, expressed in RFC 3339 (https://tools.ietf.org/rfc/rfc3339) timestamp format.
// Example: `2018-04-20T00:00:07.405Z`
VisibleAfter *common.SDKTime `mandatory:"true" json:"visibleAfter"`
}
func (m UpdatedMessage) String() string
func (m UpdatedMessage) 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
WorkRequest A description of workrequest status
type WorkRequest struct {
// Type of the work request
OperationType OperationTypeEnum `mandatory:"true" json:"operationType"`
// Status of current work request.
Status OperationStatusEnum `mandatory:"true" json:"status"`
// The id of the work request.
Id *string `mandatory:"true" json:"id"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the work request. Work requests should be scoped to
// the same compartment as the resource the work request affects. If the work request affects multiple resources,
// and those resources are not in the same compartment, it is up to the service team to pick the primary
// resource whose compartment should be used
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The resources affected by this work request.
Resources []WorkRequestResource `mandatory:"true" json:"resources"`
// Percentage of the request completed.
PercentComplete *float32 `mandatory:"true" json:"percentComplete"`
// The date and time the request was created, as described in
// RFC 3339 (https://tools.ietf.org/rfc/rfc3339), section 14.29.
TimeAccepted *common.SDKTime `mandatory:"true" json:"timeAccepted"`
// The date and time the request was started, as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339),
// section 14.29.
TimeStarted *common.SDKTime `mandatory:"false" json:"timeStarted"`
// The date and time the object was finished, as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339).
TimeFinished *common.SDKTime `mandatory:"false" json:"timeFinished"`
}
func (m WorkRequest) String() string
func (m WorkRequest) 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
WorkRequestError An error encountered while executing a work request.
type WorkRequestError struct {
// A machine-usable code for the error that occured. Error codes are listed on
// (https://docs.oracle.com/iaas/Content/API/References/apierrors.htm)
Code *string `mandatory:"true" json:"code"`
// A human readable description of the issue encountered.
Message *string `mandatory:"true" json:"message"`
// The time the error occured. An RFC 3339 (https://tools.ietf.org/rfc/rfc3339) formatted datetime string.
Timestamp *common.SDKTime `mandatory:"true" json:"timestamp"`
}
func (m WorkRequestError) String() string
func (m WorkRequestError) 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
WorkRequestErrorCollection Results of a workRequestError search. Contains both WorkRequestError items and other information, such as metadata.
type WorkRequestErrorCollection struct {
// List of workRequestError objects.
Items []WorkRequestError `mandatory:"true" json:"items"`
}
func (m WorkRequestErrorCollection) String() string
func (m WorkRequestErrorCollection) 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
WorkRequestLogEntry A log message from the execution of a work request.
type WorkRequestLogEntry struct {
// Human-readable log message.
Message *string `mandatory:"true" json:"message"`
// The time the log message was written. An RFC 3339 (https://tools.ietf.org/rfc/rfc3339) formatted datetime string
Timestamp *common.SDKTime `mandatory:"true" json:"timestamp"`
}
func (m WorkRequestLogEntry) String() string
func (m WorkRequestLogEntry) 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
WorkRequestLogEntryCollection Results of a workRequestLog search. Contains both workRequestLog items and other information, such as metadata.
type WorkRequestLogEntryCollection struct {
// List of workRequestLogEntries.
Items []WorkRequestLogEntry `mandatory:"true" json:"items"`
}
func (m WorkRequestLogEntryCollection) String() string
func (m WorkRequestLogEntryCollection) 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
WorkRequestResource A resource created or operated on by a work request.
type WorkRequestResource struct {
// The resource type the work request affects.
EntityType *string `mandatory:"true" json:"entityType"`
// The way in which this resource is affected by the work tracked in the work request.
// A resource being created, updated, or deleted will remain in the IN_PROGRESS state until
// work is complete for that resource at which point it will transition to CREATED, UPDATED,
// or DELETED, respectively.
ActionType ActionTypeEnum `mandatory:"true" json:"actionType"`
// The identifier of the resource the work request affects.
Identifier *string `mandatory:"true" json:"identifier"`
// The URI path that the user can do a GET on to access the resource metadata
EntityUri *string `mandatory:"false" json:"entityUri"`
}
func (m WorkRequestResource) String() string
func (m WorkRequestResource) 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
WorkRequestSummary A summary of the status of a work request.
type WorkRequestSummary struct {
// Type of the work request
OperationType OperationTypeEnum `mandatory:"true" json:"operationType"`
// Status of current work request.
Status OperationStatusEnum `mandatory:"true" json:"status"`
// The ID of the work request.
Id *string `mandatory:"true" json:"id"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the work request. Work requests should be scoped to
// the same compartment as the resource the work request affects. If the work request affects multiple resources,
// and those resources are not in the same compartment, it is up to the service team to pick the primary
// resource whose compartment should be used
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The resources affected by this work request.
Resources []WorkRequestResource `mandatory:"true" json:"resources"`
// Percentage of the request completed.
PercentComplete *float32 `mandatory:"true" json:"percentComplete"`
// The date and time the request was created, as described in
// RFC 3339 (https://tools.ietf.org/rfc/rfc3339), section 14.29.
TimeAccepted *common.SDKTime `mandatory:"true" json:"timeAccepted"`
// The date and time the request was started, as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339),
// section 14.29.
TimeStarted *common.SDKTime `mandatory:"false" json:"timeStarted"`
// The date and time the object was finished, as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339).
TimeFinished *common.SDKTime `mandatory:"false" json:"timeFinished"`
}
func (m WorkRequestSummary) String() string
func (m WorkRequestSummary) 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
WorkRequestSummaryCollection Results of a workRequest search. Contains both WorkRequest items and other information, such as metadata.
type WorkRequestSummaryCollection struct {
// List of workRequestSummary objects.
Items []WorkRequestSummary `mandatory:"true" json:"items"`
}
func (m WorkRequestSummaryCollection) String() string
func (m WorkRequestSummaryCollection) 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