func GetBackoffRetryPolicyPolicyTypeEnumStringValues() []string
GetBackoffRetryPolicyPolicyTypeEnumStringValues Enumerates the set of values in String for BackoffRetryPolicyPolicyTypeEnum
func GetListTopicsSortByEnumStringValues() []string
GetListTopicsSortByEnumStringValues Enumerates the set of values in String for ListTopicsSortByEnum
func GetListTopicsSortOrderEnumStringValues() []string
GetListTopicsSortOrderEnumStringValues Enumerates the set of values in String for ListTopicsSortOrderEnum
func GetNotificationTopicLifecycleStateEnumStringValues() []string
GetNotificationTopicLifecycleStateEnumStringValues Enumerates the set of values in String for NotificationTopicLifecycleStateEnum
func GetNotificationTopicSummaryLifecycleStateEnumStringValues() []string
GetNotificationTopicSummaryLifecycleStateEnumStringValues Enumerates the set of values in String for NotificationTopicSummaryLifecycleStateEnum
func GetPublishMessageMessageTypeEnumStringValues() []string
GetPublishMessageMessageTypeEnumStringValues Enumerates the set of values in String for PublishMessageMessageTypeEnum
func GetSubscriptionLifecycleStateEnumStringValues() []string
GetSubscriptionLifecycleStateEnumStringValues Enumerates the set of values in String for SubscriptionLifecycleStateEnum
func GetSubscriptionSummaryLifecycleStateEnumStringValues() []string
GetSubscriptionSummaryLifecycleStateEnumStringValues Enumerates the set of values in String for SubscriptionSummaryLifecycleStateEnum
BackoffRetryPolicy The backoff retry portion of the subscription delivery policy. For information about retry durations for subscriptions, see How Notifications Works (https://docs.oracle.com/iaas/Content/Notification/Concepts/notificationoverview.htm#how).
type BackoffRetryPolicy struct {
// The maximum retry duration in milliseconds. Default value is `7200000` (2 hours).
MaxRetryDuration *int `mandatory:"true" json:"maxRetryDuration"`
// The type of delivery policy.
PolicyType BackoffRetryPolicyPolicyTypeEnum `mandatory:"true" json:"policyType"`
}
func (m BackoffRetryPolicy) String() string
func (m BackoffRetryPolicy) 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
BackoffRetryPolicyPolicyTypeEnum Enum with underlying type: string
type BackoffRetryPolicyPolicyTypeEnum string
Set of constants representing the allowable values for BackoffRetryPolicyPolicyTypeEnum
const (
BackoffRetryPolicyPolicyTypeExponential BackoffRetryPolicyPolicyTypeEnum = "EXPONENTIAL"
)
func GetBackoffRetryPolicyPolicyTypeEnumValues() []BackoffRetryPolicyPolicyTypeEnum
GetBackoffRetryPolicyPolicyTypeEnumValues Enumerates the set of values for BackoffRetryPolicyPolicyTypeEnum
func GetMappingBackoffRetryPolicyPolicyTypeEnum(val string) (BackoffRetryPolicyPolicyTypeEnum, bool)
GetMappingBackoffRetryPolicyPolicyTypeEnum performs case Insensitive comparison on enum value and return the desired enum
ChangeCompartmentDetails The configuration details for the move operation.
type ChangeCompartmentDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the specified topic
// or subscription to.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
}
func (m ChangeCompartmentDetails) String() string
func (m ChangeCompartmentDetails) 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
ChangeSubscriptionCompartmentRequest wrapper for the ChangeSubscriptionCompartment operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ons/ChangeSubscriptionCompartment.go.html to see an example of how to use ChangeSubscriptionCompartmentRequest.
type ChangeSubscriptionCompartmentRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subscription to move.
SubscriptionId *string `mandatory:"true" contributesTo:"path" name:"subscriptionId"`
// The configuration details for the move operation.
ChangeSubscriptionCompartmentDetails ChangeCompartmentDetails `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 that due to conflicting operations (for example, if a resource
// has been deleted and purged from the system, then a retry of the original creation request
// may be rejected).
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Used for optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
// parameter to the value of the etag from a previous GET or POST response for that resource. The resource
// will be updated or deleted only if the etag you provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ChangeSubscriptionCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ChangeSubscriptionCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ChangeSubscriptionCompartmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ChangeSubscriptionCompartmentRequest) String() string
func (request ChangeSubscriptionCompartmentRequest) 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
ChangeSubscriptionCompartmentResponse wrapper for the ChangeSubscriptionCompartment operation
type ChangeSubscriptionCompartmentResponse 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 ChangeSubscriptionCompartmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ChangeSubscriptionCompartmentResponse) String() string
ChangeTopicCompartmentRequest wrapper for the ChangeTopicCompartment operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ons/ChangeTopicCompartment.go.html to see an example of how to use ChangeTopicCompartmentRequest.
type ChangeTopicCompartmentRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the topic to move.
TopicId *string `mandatory:"true" contributesTo:"path" name:"topicId"`
// The configuration details for the move operation.
ChangeTopicCompartmentDetails ChangeCompartmentDetails `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 that due to conflicting operations (for example, if a resource
// has been deleted and purged from the system, then a retry of the original creation request
// may be rejected).
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Used for optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
// parameter to the value of the etag from a previous GET or POST response for that resource. The resource
// will be updated or deleted only if the etag you provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ChangeTopicCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ChangeTopicCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ChangeTopicCompartmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ChangeTopicCompartmentRequest) String() string
func (request ChangeTopicCompartmentRequest) 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
ChangeTopicCompartmentResponse wrapper for the ChangeTopicCompartment operation
type ChangeTopicCompartmentResponse 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 ChangeTopicCompartmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ChangeTopicCompartmentResponse) String() string
ConfirmationResult The confirmation details for the specified subscription. For information about confirming subscriptions, see To confirm a subscription (https://docs.oracle.com/iaas/Content/Notification/Tasks/managingtopicsandsubscriptions.htm#confirmSub).
type ConfirmationResult struct {
// The name of the subscribed topic.
TopicName *string `mandatory:"true" json:"topicName"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the topic associated with the specified subscription.
TopicId *string `mandatory:"true" json:"topicId"`
// A locator that corresponds to the subscription protocol.
// For example, an email address for a subscription that uses the `EMAIL` protocol, or a URL for a subscription that uses an HTTP-based protocol.
Endpoint *string `mandatory:"true" json:"endpoint"`
// The URL for unsubscribing from the topic.
UnsubscribeUrl *string `mandatory:"true" json:"unsubscribeUrl"`
// A human-readable string indicating the status of the subscription confirmation.
Message *string `mandatory:"true" json:"message"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subscription specified in the request.
SubscriptionId *string `mandatory:"true" json:"subscriptionId"`
}
func (m ConfirmationResult) String() string
func (m ConfirmationResult) 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
CreateSubscriptionDetails The configuration details for creating the subscription.
type CreateSubscriptionDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the topic for the subscription.
TopicId *string `mandatory:"true" json:"topicId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment for the subscription.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The protocol used for the subscription.
// Allowed values:
// * `CUSTOM_HTTPS`
// * `EMAIL`
// * `HTTPS` (deprecated; for PagerDuty endpoints, use `PAGERDUTY`)
// * `ORACLE_FUNCTIONS`
// * `PAGERDUTY`
// * `SLACK`
// * `SMS`
// For information about subscription protocols, see
// To create a subscription (https://docs.oracle.com/iaas/Content/Notification/Tasks/managingtopicsandsubscriptions.htm#createSub).
Protocol *string `mandatory:"true" json:"protocol"`
// A locator that corresponds to the subscription protocol.
// For example, an email address for a subscription that uses the `EMAIL` protocol, or a URL for a subscription that uses an HTTP-based protocol.
// HTTP-based protocols use URL endpoints that begin with "http:" or "https:".
// A URL cannot exceed 512 characters.
// Avoid entering confidential information.
// For protocol-specific endpoint formats and steps to get or create endpoints, see
// To create a subscription (https://docs.oracle.com/iaas/Content/Notification/Tasks/managingtopicsandsubscriptions.htm#createSub).
Endpoint *string `mandatory:"true" json:"endpoint"`
// Metadata for the subscription.
Metadata *string `mandatory:"false" json:"metadata"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m CreateSubscriptionDetails) String() string
func (m CreateSubscriptionDetails) 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
CreateSubscriptionRequest wrapper for the CreateSubscription operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ons/CreateSubscription.go.html to see an example of how to use CreateSubscriptionRequest.
type CreateSubscriptionRequest struct {
// The subscription to create.
CreateSubscriptionDetails `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 that due to conflicting operations (for example, if a resource
// has been deleted and purged from the system, then a retry of the original creation request
// may be rejected).
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request CreateSubscriptionRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateSubscriptionRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateSubscriptionRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateSubscriptionRequest) String() string
func (request CreateSubscriptionRequest) 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
CreateSubscriptionResponse wrapper for the CreateSubscription operation
type CreateSubscriptionResponse struct {
// The underlying http response
RawResponse *http.Response
// The Subscription instance
Subscription `presentIn:"body"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
}
func (response CreateSubscriptionResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateSubscriptionResponse) String() string
CreateTopicDetails The configuration details for creating the topic.
type CreateTopicDetails struct {
// The name of the topic being created. The topic name must be unique across the tenancy. Avoid entering confidential information.
Name *string `mandatory:"true" json:"name"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment to create the topic in.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The description of the topic being created. Avoid entering confidential information.
Description *string `mandatory:"false" json:"description"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m CreateTopicDetails) String() string
func (m CreateTopicDetails) 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
CreateTopicRequest wrapper for the CreateTopic operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ons/CreateTopic.go.html to see an example of how to use CreateTopicRequest.
type CreateTopicRequest struct {
// The topic to create.
CreateTopicDetails `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 that due to conflicting operations (for example, if a resource
// has been deleted and purged from the system, then a retry of the original creation request
// may be rejected).
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request CreateTopicRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateTopicRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateTopicRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateTopicRequest) String() string
func (request CreateTopicRequest) 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
CreateTopicResponse wrapper for the CreateTopic operation
type CreateTopicResponse struct {
// The underlying http response
RawResponse *http.Response
// The NotificationTopic instance
NotificationTopic `presentIn:"body"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
}
func (response CreateTopicResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateTopicResponse) String() string
DeleteSubscriptionRequest wrapper for the DeleteSubscription operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ons/DeleteSubscription.go.html to see an example of how to use DeleteSubscriptionRequest.
type DeleteSubscriptionRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subscription to delete.
SubscriptionId *string `mandatory:"true" contributesTo:"path" name:"subscriptionId"`
// The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Used for optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
// parameter to the value of the etag from a previous GET or POST response for that resource. The resource
// will be updated or deleted only if the etag you provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request DeleteSubscriptionRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteSubscriptionRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteSubscriptionRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteSubscriptionRequest) String() string
func (request DeleteSubscriptionRequest) 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
DeleteSubscriptionResponse wrapper for the DeleteSubscription operation
type DeleteSubscriptionResponse 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 DeleteSubscriptionResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteSubscriptionResponse) String() string
DeleteTopicRequest wrapper for the DeleteTopic operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ons/DeleteTopic.go.html to see an example of how to use DeleteTopicRequest.
type DeleteTopicRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the topic to delete.
TopicId *string `mandatory:"true" contributesTo:"path" name:"topicId"`
// The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Used for optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
// parameter to the value of the etag from a previous GET or POST response for that resource. The resource
// will be updated or deleted only if the etag you provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request DeleteTopicRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteTopicRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteTopicRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteTopicRequest) String() string
func (request DeleteTopicRequest) 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
DeleteTopicResponse wrapper for the DeleteTopic operation
type DeleteTopicResponse 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 DeleteTopicResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteTopicResponse) String() string
DeliveryPolicy The subscription delivery policy.
type DeliveryPolicy struct {
BackoffRetryPolicy *BackoffRetryPolicy `mandatory:"false" json:"backoffRetryPolicy"`
}
func (m DeliveryPolicy) String() string
func (m DeliveryPolicy) 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
GetConfirmSubscriptionRequest wrapper for the GetConfirmSubscription operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ons/GetConfirmSubscription.go.html to see an example of how to use GetConfirmSubscriptionRequest.
type GetConfirmSubscriptionRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subscription to get the confirmation details for.
Id *string `mandatory:"true" contributesTo:"path" name:"id"`
// The subscription confirmation token.
Token *string `mandatory:"true" contributesTo:"query" name:"token"`
// The protocol used for the subscription.
// Allowed values:
// * `CUSTOM_HTTPS`
// * `EMAIL`
// * `HTTPS` (deprecated; for PagerDuty endpoints, use `PAGERDUTY`)
// * `ORACLE_FUNCTIONS`
// * `PAGERDUTY`
// * `SLACK`
// * `SMS`
// For information about subscription protocols, see
// To create a subscription (https://docs.oracle.com/iaas/Content/Notification/Tasks/managingtopicsandsubscriptions.htm#createSub).
Protocol *string `mandatory:"true" contributesTo:"query" name:"protocol"`
// The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetConfirmSubscriptionRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetConfirmSubscriptionRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetConfirmSubscriptionRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetConfirmSubscriptionRequest) String() string
func (request GetConfirmSubscriptionRequest) 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
GetConfirmSubscriptionResponse wrapper for the GetConfirmSubscription operation
type GetConfirmSubscriptionResponse struct {
// The underlying http response
RawResponse *http.Response
// The ConfirmationResult instance
ConfirmationResult `presentIn:"body"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
}
func (response GetConfirmSubscriptionResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetConfirmSubscriptionResponse) String() string
GetSubscriptionRequest wrapper for the GetSubscription operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ons/GetSubscription.go.html to see an example of how to use GetSubscriptionRequest.
type GetSubscriptionRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subscription to retrieve.
SubscriptionId *string `mandatory:"true" contributesTo:"path" name:"subscriptionId"`
// The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetSubscriptionRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetSubscriptionRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetSubscriptionRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetSubscriptionRequest) String() string
func (request GetSubscriptionRequest) 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
GetSubscriptionResponse wrapper for the GetSubscription operation
type GetSubscriptionResponse struct {
// The underlying http response
RawResponse *http.Response
// The Subscription instance
Subscription `presentIn:"body"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
}
func (response GetSubscriptionResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetSubscriptionResponse) String() string
GetTopicRequest wrapper for the GetTopic operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ons/GetTopic.go.html to see an example of how to use GetTopicRequest.
type GetTopicRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the topic to retrieve.
// Transactions Per Minute (TPM) per-tenancy limit for this operation: 120.
TopicId *string `mandatory:"true" contributesTo:"path" name:"topicId"`
// The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetTopicRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetTopicRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetTopicRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetTopicRequest) String() string
func (request GetTopicRequest) 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
GetTopicResponse wrapper for the GetTopic operation
type GetTopicResponse struct {
// The underlying http response
RawResponse *http.Response
// The NotificationTopic instance
NotificationTopic `presentIn:"body"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
}
func (response GetTopicResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetTopicResponse) String() string
GetUnsubscriptionRequest wrapper for the GetUnsubscription operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ons/GetUnsubscription.go.html to see an example of how to use GetUnsubscriptionRequest.
type GetUnsubscriptionRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subscription to unsubscribe from.
Id *string `mandatory:"true" contributesTo:"path" name:"id"`
// The subscription confirmation token.
Token *string `mandatory:"true" contributesTo:"query" name:"token"`
// The protocol used for the subscription.
// Allowed values:
// * `CUSTOM_HTTPS`
// * `EMAIL`
// * `HTTPS` (deprecated; for PagerDuty endpoints, use `PAGERDUTY`)
// * `ORACLE_FUNCTIONS`
// * `PAGERDUTY`
// * `SLACK`
// * `SMS`
// For information about subscription protocols, see
// To create a subscription (https://docs.oracle.com/iaas/Content/Notification/Tasks/managingtopicsandsubscriptions.htm#createSub).
Protocol *string `mandatory:"true" contributesTo:"query" name:"protocol"`
// The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetUnsubscriptionRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetUnsubscriptionRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetUnsubscriptionRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetUnsubscriptionRequest) String() string
func (request GetUnsubscriptionRequest) 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
GetUnsubscriptionResponse wrapper for the GetUnsubscription operation
type GetUnsubscriptionResponse struct {
// The underlying http response
RawResponse *http.Response
// The string instance
Value *string `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 GetUnsubscriptionResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetUnsubscriptionResponse) String() string
ListSubscriptionsRequest wrapper for the ListSubscriptions operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ons/ListSubscriptions.go.html to see an example of how to use ListSubscriptionsRequest.
type ListSubscriptionsRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// Return all subscriptions that are subscribed to the given topic OCID. Either this query parameter or the compartmentId query parameter must be set.
TopicId *string `mandatory:"false" contributesTo:"query" name:"topicId"`
// 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"`
// The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListSubscriptionsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListSubscriptionsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListSubscriptionsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListSubscriptionsRequest) String() string
func (request ListSubscriptionsRequest) 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
ListSubscriptionsResponse wrapper for the ListSubscriptions operation
type ListSubscriptionsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []SubscriptionSummary instances
Items []SubscriptionSummary `presentIn:"body"`
// For list pagination. When this header appears in the response, additional pages of results remain.
// For important details about how pagination works, see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// 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 ListSubscriptionsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListSubscriptionsResponse) String() string
ListTopicsRequest wrapper for the ListTopics operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ons/ListTopics.go.html to see an example of how to use ListTopicsRequest.
type ListTopicsRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// A filter to only return resources that match the given id exactly.
Id *string `mandatory:"false" contributesTo:"query" name:"id"`
// A filter to only return resources that match the given name exactly.
Name *string `mandatory:"false" contributesTo:"query" name:"name"`
// 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"`
// The field to sort by. Only one field can be selected for sorting.
SortBy ListTopicsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The sort order to use (ascending or descending).
SortOrder ListTopicsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// Filter returned list by specified lifecycle state. This parameter is case-insensitive.
LifecycleState NotificationTopicSummaryLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListTopicsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListTopicsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListTopicsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListTopicsRequest) String() string
func (request ListTopicsRequest) 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
ListTopicsResponse wrapper for the ListTopics operation
type ListTopicsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []NotificationTopicSummary instances
Items []NotificationTopicSummary `presentIn:"body"`
// For list pagination. When this header appears in the response, additional pages of results remain.
// For important details about how pagination works, see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// For list pagination. When this header appears in the response, previous pages of results remain.
// For important details about how pagination works, see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcPreviousPage *string `presentIn:"header" name:"opc-previous-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 ListTopicsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListTopicsResponse) String() string
ListTopicsSortByEnum Enum with underlying type: string
type ListTopicsSortByEnum string
Set of constants representing the allowable values for ListTopicsSortByEnum
const (
ListTopicsSortByTimecreated ListTopicsSortByEnum = "TIMECREATED"
ListTopicsSortByLifecyclestate ListTopicsSortByEnum = "LIFECYCLESTATE"
)
func GetListTopicsSortByEnumValues() []ListTopicsSortByEnum
GetListTopicsSortByEnumValues Enumerates the set of values for ListTopicsSortByEnum
func GetMappingListTopicsSortByEnum(val string) (ListTopicsSortByEnum, bool)
GetMappingListTopicsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListTopicsSortOrderEnum Enum with underlying type: string
type ListTopicsSortOrderEnum string
Set of constants representing the allowable values for ListTopicsSortOrderEnum
const (
ListTopicsSortOrderAsc ListTopicsSortOrderEnum = "ASC"
ListTopicsSortOrderDesc ListTopicsSortOrderEnum = "DESC"
)
func GetListTopicsSortOrderEnumValues() []ListTopicsSortOrderEnum
GetListTopicsSortOrderEnumValues Enumerates the set of values for ListTopicsSortOrderEnum
func GetMappingListTopicsSortOrderEnum(val string) (ListTopicsSortOrderEnum, bool)
GetMappingListTopicsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
MessageDetails The content of the message to be published.
type MessageDetails struct {
// The body of the message to be published.
// Avoid entering confidential information.
Body *string `mandatory:"true" json:"body"`
// The title of the message to be published. Avoid entering confidential information.
Title *string `mandatory:"false" json:"title"`
}
func (m MessageDetails) String() string
func (m MessageDetails) 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
NotificationControlPlaneClient a client for NotificationControlPlane
type NotificationControlPlaneClient struct {
common.BaseClient
// contains filtered or unexported fields
}
func NewNotificationControlPlaneClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client NotificationControlPlaneClient, err error)
NewNotificationControlPlaneClientWithConfigurationProvider Creates a new default NotificationControlPlane client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region
func NewNotificationControlPlaneClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client NotificationControlPlaneClient, err error)
NewNotificationControlPlaneClientWithOboToken Creates a new default NotificationControlPlane 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 NotificationControlPlaneClient) ChangeTopicCompartment(ctx context.Context, request ChangeTopicCompartmentRequest) (response ChangeTopicCompartmentResponse, err error)
ChangeTopicCompartment Moves a topic into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment (https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). Transactions Per Minute (TPM) per-tenancy limit for this operation: 60.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ons/ChangeTopicCompartment.go.html to see an example of how to use ChangeTopicCompartment API.
func (client *NotificationControlPlaneClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client NotificationControlPlaneClient) CreateTopic(ctx context.Context, request CreateTopicRequest) (response CreateTopicResponse, err error)
CreateTopic Creates a topic in the specified compartment. For general information about topics, see Managing Topics and Subscriptions (https://docs.oracle.com/iaas/Content/Notification/Tasks/managingtopicsandsubscriptions.htm). For the purposes of access control, you must provide the OCID of the compartment where you want the topic to reside. For information about access control and compartments, see Overview of the IAM Service (https://docs.oracle.com/iaas/Content/Identity/Concepts/overview.htm). You must specify a display name for the topic. All Oracle Cloud Infrastructure resources, including topics, get an Oracle-assigned, unique ID called an Oracle Cloud Identifier (OCID). When you create a resource, you can find its OCID in the response. You can also retrieve a resource's OCID by using a List API operation on that resource type, or by viewing the resource in the Console. For more information, see Resource Identifiers (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm). Transactions Per Minute (TPM) per-tenancy limit for this operation: 60.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ons/CreateTopic.go.html to see an example of how to use CreateTopic API.
func (client NotificationControlPlaneClient) DeleteTopic(ctx context.Context, request DeleteTopicRequest) (response DeleteTopicResponse, err error)
DeleteTopic Deletes the specified topic. Transactions Per Minute (TPM) per-tenancy limit for this operation: 60.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ons/DeleteTopic.go.html to see an example of how to use DeleteTopic API.
func (client NotificationControlPlaneClient) GetTopic(ctx context.Context, request GetTopicRequest) (response GetTopicResponse, err error)
GetTopic Gets the specified topic's configuration information.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ons/GetTopic.go.html to see an example of how to use GetTopic API.
func (client NotificationControlPlaneClient) ListTopics(ctx context.Context, request ListTopicsRequest) (response ListTopicsResponse, err error)
ListTopics Lists topics in the specified compartment. Transactions Per Minute (TPM) per-tenancy limit for this operation: 120.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ons/ListTopics.go.html to see an example of how to use ListTopics API.
func (client *NotificationControlPlaneClient) SetRegion(region string)
SetRegion overrides the region of this client.
func (client NotificationControlPlaneClient) UpdateTopic(ctx context.Context, request UpdateTopicRequest) (response UpdateTopicResponse, err error)
UpdateTopic Updates the specified topic's configuration. Transactions Per Minute (TPM) per-tenancy limit for this operation: 60.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ons/UpdateTopic.go.html to see an example of how to use UpdateTopic API.
NotificationDataPlaneClient a client for NotificationDataPlane
type NotificationDataPlaneClient struct {
common.BaseClient
// contains filtered or unexported fields
}
func NewNotificationDataPlaneClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client NotificationDataPlaneClient, err error)
NewNotificationDataPlaneClientWithConfigurationProvider Creates a new default NotificationDataPlane client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region
func NewNotificationDataPlaneClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client NotificationDataPlaneClient, err error)
NewNotificationDataPlaneClientWithOboToken Creates a new default NotificationDataPlane 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 NotificationDataPlaneClient) ChangeSubscriptionCompartment(ctx context.Context, request ChangeSubscriptionCompartmentRequest) (response ChangeSubscriptionCompartmentResponse, err error)
ChangeSubscriptionCompartment Moves a subscription into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment (https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). Transactions Per Minute (TPM) per-tenancy limit for this operation: 60.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ons/ChangeSubscriptionCompartment.go.html to see an example of how to use ChangeSubscriptionCompartment API.
func (client *NotificationDataPlaneClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client NotificationDataPlaneClient) CreateSubscription(ctx context.Context, request CreateSubscriptionRequest) (response CreateSubscriptionResponse, err error)
CreateSubscription Creates a subscription for the specified topic and sends a subscription confirmation URL to the endpoint. The subscription remains in "Pending" status until it has been confirmed. For information about confirming subscriptions, see To confirm a subscription (https://docs.oracle.com/iaas/Content/Notification/Tasks/managingtopicsandsubscriptions.htm#confirmSub). Transactions Per Minute (TPM) per-tenancy limit for this operation: 60.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ons/CreateSubscription.go.html to see an example of how to use CreateSubscription API.
func (client NotificationDataPlaneClient) DeleteSubscription(ctx context.Context, request DeleteSubscriptionRequest) (response DeleteSubscriptionResponse, err error)
DeleteSubscription Deletes the specified subscription. Transactions Per Minute (TPM) per-tenancy limit for this operation: 60.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ons/DeleteSubscription.go.html to see an example of how to use DeleteSubscription API.
func (client NotificationDataPlaneClient) GetConfirmSubscription(ctx context.Context, request GetConfirmSubscriptionRequest) (response GetConfirmSubscriptionResponse, err error)
GetConfirmSubscription Gets the confirmation details for the specified subscription. Transactions Per Minute (TPM) per-tenancy limit for this operation: 60.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ons/GetConfirmSubscription.go.html to see an example of how to use GetConfirmSubscription API.
func (client NotificationDataPlaneClient) GetSubscription(ctx context.Context, request GetSubscriptionRequest) (response GetSubscriptionResponse, err error)
GetSubscription Gets the specified subscription's configuration information. Transactions Per Minute (TPM) per-tenancy limit for this operation: 60.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ons/GetSubscription.go.html to see an example of how to use GetSubscription API.
func (client NotificationDataPlaneClient) GetUnsubscription(ctx context.Context, request GetUnsubscriptionRequest) (response GetUnsubscriptionResponse, err error)
GetUnsubscription Unsubscribes the subscription from the topic. Transactions Per Minute (TPM) per-tenancy limit for this operation: 60.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ons/GetUnsubscription.go.html to see an example of how to use GetUnsubscription API.
func (client NotificationDataPlaneClient) ListSubscriptions(ctx context.Context, request ListSubscriptionsRequest) (response ListSubscriptionsResponse, err error)
ListSubscriptions Lists the subscriptions in the specified compartment or topic. Transactions Per Minute (TPM) per-tenancy limit for this operation: 60.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ons/ListSubscriptions.go.html to see an example of how to use ListSubscriptions API.
func (client NotificationDataPlaneClient) PublishMessage(ctx context.Context, request PublishMessageRequest) (response PublishMessageResponse, err error)
PublishMessage Publishes a message to the specified topic. The topic endpoint is required for this operation. To get the topic endpoint, use GetTopic and review the `apiEndpoint` value in the response (NotificationTopic). Limits information follows. Message size limit per request: 64KB. Message delivery rate limit per endpoint: 60 messages per minute for HTTP-based protocols, 10 messages per minute for the `EMAIL` protocol. HTTP-based protocols use URL endpoints that begin with "http:" or "https:". Transactions Per Minute (TPM) per-tenancy limit for this operation: 60 per topic. (This TPM limit represents messages per minute.) For more information about publishing messages, see Publishing Messages (https://docs.oracle.com/iaas/Content/Notification/Tasks/publishingmessages.htm). For steps to request a limit increase, see Requesting a Service Limit Increase (https://docs.oracle.com/iaas/Content/General/Concepts/servicelimits.htm#three).
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ons/PublishMessage.go.html to see an example of how to use PublishMessage API.
func (client NotificationDataPlaneClient) ResendSubscriptionConfirmation(ctx context.Context, request ResendSubscriptionConfirmationRequest) (response ResendSubscriptionConfirmationResponse, err error)
ResendSubscriptionConfirmation Resends the confirmation details for the specified subscription. Transactions Per Minute (TPM) per-tenancy limit for this operation: 60.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ons/ResendSubscriptionConfirmation.go.html to see an example of how to use ResendSubscriptionConfirmation API.
func (client *NotificationDataPlaneClient) SetRegion(region string)
SetRegion overrides the region of this client.
func (client NotificationDataPlaneClient) UpdateSubscription(ctx context.Context, request UpdateSubscriptionRequest) (response UpdateSubscriptionResponse, err error)
UpdateSubscription Updates the specified subscription's configuration. Transactions Per Minute (TPM) per-tenancy limit for this operation: 60.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ons/UpdateSubscription.go.html to see an example of how to use UpdateSubscription API.
NotificationTopic The properties that define a topic. For general information about topics, see Notifications Overview (https://docs.oracle.com/iaas/Content/Notification/Concepts/notificationoverview.htm).
type NotificationTopic struct {
// The name of the topic.
Name *string `mandatory:"true" json:"name"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the topic.
TopicId *string `mandatory:"true" json:"topicId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment for the topic.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The lifecycle state of the topic.
LifecycleState NotificationTopicLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The time the topic was created.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The endpoint for managing subscriptions or publishing messages to the topic.
ApiEndpoint *string `mandatory:"true" json:"apiEndpoint"`
// A unique short topic Id. This is used only for SMS subscriptions.
ShortTopicId *string `mandatory:"false" json:"shortTopicId"`
// The description of the topic.
Description *string `mandatory:"false" json:"description"`
// For optimistic concurrency control. See `if-match`.
Etag *string `mandatory:"false" json:"etag"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m NotificationTopic) String() string
func (m NotificationTopic) 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
NotificationTopicLifecycleStateEnum Enum with underlying type: string
type NotificationTopicLifecycleStateEnum string
Set of constants representing the allowable values for NotificationTopicLifecycleStateEnum
const (
NotificationTopicLifecycleStateActive NotificationTopicLifecycleStateEnum = "ACTIVE"
NotificationTopicLifecycleStateDeleting NotificationTopicLifecycleStateEnum = "DELETING"
NotificationTopicLifecycleStateCreating NotificationTopicLifecycleStateEnum = "CREATING"
)
func GetMappingNotificationTopicLifecycleStateEnum(val string) (NotificationTopicLifecycleStateEnum, bool)
GetMappingNotificationTopicLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetNotificationTopicLifecycleStateEnumValues() []NotificationTopicLifecycleStateEnum
GetNotificationTopicLifecycleStateEnumValues Enumerates the set of values for NotificationTopicLifecycleStateEnum
NotificationTopicSummary A summary of the properties that define a topic.
type NotificationTopicSummary struct {
// The name of the topic.
Name *string `mandatory:"true" json:"name"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the topic.
TopicId *string `mandatory:"true" json:"topicId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment for the topic.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The lifecycle state of the topic.
LifecycleState NotificationTopicSummaryLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The time the topic was created.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The endpoint for managing subscriptions or publishing messages to the topic.
ApiEndpoint *string `mandatory:"true" json:"apiEndpoint"`
// A unique short topic Id. This is used only for SMS subscriptions.
ShortTopicId *string `mandatory:"false" json:"shortTopicId"`
// The description of the topic.
Description *string `mandatory:"false" json:"description"`
// For optimistic concurrency control. See `if-match`.
Etag *string `mandatory:"false" json:"etag"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m NotificationTopicSummary) String() string
func (m NotificationTopicSummary) 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
NotificationTopicSummaryLifecycleStateEnum Enum with underlying type: string
type NotificationTopicSummaryLifecycleStateEnum string
Set of constants representing the allowable values for NotificationTopicSummaryLifecycleStateEnum
const (
NotificationTopicSummaryLifecycleStateActive NotificationTopicSummaryLifecycleStateEnum = "ACTIVE"
NotificationTopicSummaryLifecycleStateDeleting NotificationTopicSummaryLifecycleStateEnum = "DELETING"
NotificationTopicSummaryLifecycleStateCreating NotificationTopicSummaryLifecycleStateEnum = "CREATING"
)
func GetMappingNotificationTopicSummaryLifecycleStateEnum(val string) (NotificationTopicSummaryLifecycleStateEnum, bool)
GetMappingNotificationTopicSummaryLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetNotificationTopicSummaryLifecycleStateEnumValues() []NotificationTopicSummaryLifecycleStateEnum
GetNotificationTopicSummaryLifecycleStateEnumValues Enumerates the set of values for NotificationTopicSummaryLifecycleStateEnum
PublishMessageMessageTypeEnum Enum with underlying type: string
type PublishMessageMessageTypeEnum string
Set of constants representing the allowable values for PublishMessageMessageTypeEnum
const (
PublishMessageMessageTypeJson PublishMessageMessageTypeEnum = "JSON"
PublishMessageMessageTypeRawText PublishMessageMessageTypeEnum = "RAW_TEXT"
)
func GetMappingPublishMessageMessageTypeEnum(val string) (PublishMessageMessageTypeEnum, bool)
GetMappingPublishMessageMessageTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetPublishMessageMessageTypeEnumValues() []PublishMessageMessageTypeEnum
GetPublishMessageMessageTypeEnumValues Enumerates the set of values for PublishMessageMessageTypeEnum
PublishMessageRequest wrapper for the PublishMessage operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ons/PublishMessage.go.html to see an example of how to use PublishMessageRequest.
type PublishMessageRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the topic.
TopicId *string `mandatory:"true" contributesTo:"path" name:"topicId"`
// The message to publish.
MessageDetails `contributesTo:"body"`
// The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// **Deprecated.**
// Support for JSON is deprecated.
// You can send a JSON payload even when transmitting the payload as a raw string.
// Configure your receiving system to read the raw payload as JSON format.
// Type of message body in the request.
// For `messageType` of JSON, a default key-value pair is required. Example: `{"default": "Alarm breached", "Email": "Alarm breached: <url>"}.`
MessageType PublishMessageMessageTypeEnum `mandatory:"false" contributesTo:"header" name:"messageType"`
// 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 PublishMessageRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request PublishMessageRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request PublishMessageRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request PublishMessageRequest) String() string
func (request PublishMessageRequest) 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
PublishMessageResponse wrapper for the PublishMessage operation
type PublishMessageResponse struct {
// The underlying http response
RawResponse *http.Response
// The PublishResult instance
PublishResult `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 PublishMessageResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response PublishMessageResponse) String() string
PublishResult The response to a PublishMessage call.
type PublishResult struct {
// The UUID of the message.
MessageId *string `mandatory:"true" json:"messageId"`
// The time that the service received the message.
TimeStamp *common.SDKTime `mandatory:"false" json:"timeStamp"`
}
func (m PublishResult) String() string
func (m PublishResult) 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
ResendSubscriptionConfirmationRequest wrapper for the ResendSubscriptionConfirmation operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ons/ResendSubscriptionConfirmation.go.html to see an example of how to use ResendSubscriptionConfirmationRequest.
type ResendSubscriptionConfirmationRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subscription to resend the confirmation for.
Id *string `mandatory:"true" contributesTo:"path" name:"id"`
// The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ResendSubscriptionConfirmationRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ResendSubscriptionConfirmationRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ResendSubscriptionConfirmationRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ResendSubscriptionConfirmationRequest) String() string
func (request ResendSubscriptionConfirmationRequest) 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
ResendSubscriptionConfirmationResponse wrapper for the ResendSubscriptionConfirmation operation
type ResendSubscriptionConfirmationResponse struct {
// The underlying http response
RawResponse *http.Response
// The Subscription instance
Subscription `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 ResendSubscriptionConfirmationResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ResendSubscriptionConfirmationResponse) String() string
Subscription The subscription's configuration. For general information about subscriptions, see Notifications Overview (https://docs.oracle.com/iaas/Content/Notification/Concepts/notificationoverview.htm).
type Subscription struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subscription.
Id *string `mandatory:"true" json:"id"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the associated topic.
TopicId *string `mandatory:"true" json:"topicId"`
// The protocol used for the subscription.
// Allowed values:
// * `CUSTOM_HTTPS`
// * `EMAIL`
// * `HTTPS` (deprecated; for PagerDuty endpoints, use `PAGERDUTY`)
// * `ORACLE_FUNCTIONS`
// * `PAGERDUTY`
// * `SLACK`
// * `SMS`
// For information about subscription protocols, see
// To create a subscription (https://docs.oracle.com/iaas/Content/Notification/Tasks/managingtopicsandsubscriptions.htm#createSub).
Protocol *string `mandatory:"true" json:"protocol"`
// A locator that corresponds to the subscription protocol.
// For example, an email address for a subscription that uses the `EMAIL` protocol, or a URL for a subscription that uses an HTTP-based protocol.
Endpoint *string `mandatory:"true" json:"endpoint"`
// The lifecycle state of the subscription. The status of a new subscription is PENDING; when confirmed, the subscription status changes to ACTIVE.
LifecycleState SubscriptionLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment for the subscription.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The time when this suscription was created.
CreatedTime *int64 `mandatory:"false" json:"createdTime"`
// The delivery policy of the subscription. Stored as a JSON string.
DeliverPolicy *string `mandatory:"false" json:"deliverPolicy"`
// For optimistic concurrency control. See `if-match`.
Etag *string `mandatory:"false" json:"etag"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m Subscription) String() string
func (m Subscription) 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
SubscriptionLifecycleStateEnum Enum with underlying type: string
type SubscriptionLifecycleStateEnum string
Set of constants representing the allowable values for SubscriptionLifecycleStateEnum
const (
SubscriptionLifecycleStatePending SubscriptionLifecycleStateEnum = "PENDING"
SubscriptionLifecycleStateActive SubscriptionLifecycleStateEnum = "ACTIVE"
SubscriptionLifecycleStateDeleted SubscriptionLifecycleStateEnum = "DELETED"
)
func GetMappingSubscriptionLifecycleStateEnum(val string) (SubscriptionLifecycleStateEnum, bool)
GetMappingSubscriptionLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetSubscriptionLifecycleStateEnumValues() []SubscriptionLifecycleStateEnum
GetSubscriptionLifecycleStateEnumValues Enumerates the set of values for SubscriptionLifecycleStateEnum
SubscriptionSummary The subscription's configuration summary.
type SubscriptionSummary struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subscription.
Id *string `mandatory:"true" json:"id"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the associated topic.
TopicId *string `mandatory:"true" json:"topicId"`
// The protocol used for the subscription.
// Allowed values:
// * `CUSTOM_HTTPS`
// * `EMAIL`
// * `HTTPS` (deprecated; for PagerDuty endpoints, use `PAGERDUTY`)
// * `ORACLE_FUNCTIONS`
// * `PAGERDUTY`
// * `SLACK`
// * `SMS`
// For information about subscription protocols, see
// To create a subscription (https://docs.oracle.com/iaas/Content/Notification/Tasks/managingtopicsandsubscriptions.htm#createSub).
Protocol *string `mandatory:"true" json:"protocol"`
// A locator that corresponds to the subscription protocol.
// For example, an email address for a subscription that uses the `EMAIL` protocol, or a URL for a subscription that uses an HTTP-based protocol.
Endpoint *string `mandatory:"true" json:"endpoint"`
// The lifecycle state of the subscription. The status of a new subscription is PENDING; when confirmed, the subscription status changes to ACTIVE.
LifecycleState SubscriptionSummaryLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment for the subscription.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The time when this suscription was created.
CreatedTime *int64 `mandatory:"false" json:"createdTime"`
DeliveryPolicy *DeliveryPolicy `mandatory:"false" json:"deliveryPolicy"`
// For optimistic concurrency control. See `if-match`.
Etag *string `mandatory:"false" json:"etag"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m SubscriptionSummary) String() string
func (m SubscriptionSummary) 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
SubscriptionSummaryLifecycleStateEnum Enum with underlying type: string
type SubscriptionSummaryLifecycleStateEnum string
Set of constants representing the allowable values for SubscriptionSummaryLifecycleStateEnum
const (
SubscriptionSummaryLifecycleStatePending SubscriptionSummaryLifecycleStateEnum = "PENDING"
SubscriptionSummaryLifecycleStateActive SubscriptionSummaryLifecycleStateEnum = "ACTIVE"
SubscriptionSummaryLifecycleStateDeleted SubscriptionSummaryLifecycleStateEnum = "DELETED"
)
func GetMappingSubscriptionSummaryLifecycleStateEnum(val string) (SubscriptionSummaryLifecycleStateEnum, bool)
GetMappingSubscriptionSummaryLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetSubscriptionSummaryLifecycleStateEnumValues() []SubscriptionSummaryLifecycleStateEnum
GetSubscriptionSummaryLifecycleStateEnumValues Enumerates the set of values for SubscriptionSummaryLifecycleStateEnum
TopicAttributesDetails The configuration details for updating the topic.
type TopicAttributesDetails struct {
// The description of the topic. Avoid entering confidential information.
Description *string `mandatory:"true" json:"description"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m TopicAttributesDetails) String() string
func (m TopicAttributesDetails) 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
UpdateSubscriptionDetails The configuration details for updating the subscription.
type UpdateSubscriptionDetails struct {
// The delivery policy of the subscription. Stored as a JSON string.
DeliveryPolicy *DeliveryPolicy `mandatory:"false" json:"deliveryPolicy"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m UpdateSubscriptionDetails) String() string
func (m UpdateSubscriptionDetails) 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
UpdateSubscriptionRequest wrapper for the UpdateSubscription operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ons/UpdateSubscription.go.html to see an example of how to use UpdateSubscriptionRequest.
type UpdateSubscriptionRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subscription to update.
SubscriptionId *string `mandatory:"true" contributesTo:"path" name:"subscriptionId"`
// The configuration details for updating the subscription.
UpdateSubscriptionDetails `contributesTo:"body"`
// The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Used for optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
// parameter to the value of the etag from a previous GET or POST response for that resource. The resource
// will be updated or deleted only if the etag you provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request UpdateSubscriptionRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateSubscriptionRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateSubscriptionRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateSubscriptionRequest) String() string
func (request UpdateSubscriptionRequest) 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
UpdateSubscriptionResponse wrapper for the UpdateSubscription operation
type UpdateSubscriptionResponse struct {
// The underlying http response
RawResponse *http.Response
// The UpdateSubscriptionDetails instance
UpdateSubscriptionDetails `presentIn:"body"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
}
func (response UpdateSubscriptionResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateSubscriptionResponse) String() string
UpdateTopicRequest wrapper for the UpdateTopic operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ons/UpdateTopic.go.html to see an example of how to use UpdateTopicRequest.
type UpdateTopicRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the topic to update.
TopicId *string `mandatory:"true" contributesTo:"path" name:"topicId"`
// TopicAttributes
TopicAttributesDetails `contributesTo:"body"`
// The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Used for optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
// parameter to the value of the etag from a previous GET or POST response for that resource. The resource
// will be updated or deleted only if the etag you provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request UpdateTopicRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateTopicRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateTopicRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateTopicRequest) String() string
func (request UpdateTopicRequest) 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
UpdateTopicResponse wrapper for the UpdateTopic operation
type UpdateTopicResponse struct {
// The underlying http response
RawResponse *http.Response
// The NotificationTopic instance
NotificationTopic `presentIn:"body"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
}
func (response UpdateTopicResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateTopicResponse) String() string