func GetAnnouncementSubscriptionLifecycleStateEnumStringValues() []string
GetAnnouncementSubscriptionLifecycleStateEnumStringValues Enumerates the set of values in String for AnnouncementSubscriptionLifecycleStateEnum
func GetBaseAnnouncementAnnouncementTypeEnumStringValues() []string
GetBaseAnnouncementAnnouncementTypeEnumStringValues Enumerates the set of values in String for BaseAnnouncementAnnouncementTypeEnum
func GetBaseAnnouncementLifecycleStateEnumStringValues() []string
GetBaseAnnouncementLifecycleStateEnumStringValues Enumerates the set of values in String for BaseAnnouncementLifecycleStateEnum
func GetBaseAnnouncementPlatformTypeEnumStringValues() []string
GetBaseAnnouncementPlatformTypeEnumStringValues Enumerates the set of values in String for BaseAnnouncementPlatformTypeEnum
func GetBaseAnnouncementTimeOneTypeEnumStringValues() []string
GetBaseAnnouncementTimeOneTypeEnumStringValues Enumerates the set of values in String for BaseAnnouncementTimeOneTypeEnum
func GetBaseAnnouncementTimeTwoTypeEnumStringValues() []string
GetBaseAnnouncementTimeTwoTypeEnumStringValues Enumerates the set of values in String for BaseAnnouncementTimeTwoTypeEnum
func GetBaseCreateAnnouncementsPreferencesDetailsPreferenceTypeEnumStringValues() []string
GetBaseCreateAnnouncementsPreferencesDetailsPreferenceTypeEnumStringValues Enumerates the set of values in String for BaseCreateAnnouncementsPreferencesDetailsPreferenceTypeEnum
func GetBaseServiceLifecycleStateEnumStringValues() []string
GetBaseServiceLifecycleStateEnumStringValues Enumerates the set of values in String for BaseServiceLifecycleStateEnum
func GetCommsManagerNameEnumStringValues() []string
GetCommsManagerNameEnumStringValues Enumerates the set of values in String for CommsManagerNameEnum
func GetFilterTypeEnumStringValues() []string
GetFilterTypeEnumStringValues Enumerates the set of values in String for FilterTypeEnum
func GetListAnnouncementSubscriptionsSortByEnumStringValues() []string
GetListAnnouncementSubscriptionsSortByEnumStringValues Enumerates the set of values in String for ListAnnouncementSubscriptionsSortByEnum
func GetListAnnouncementSubscriptionsSortOrderEnumStringValues() []string
GetListAnnouncementSubscriptionsSortOrderEnumStringValues Enumerates the set of values in String for ListAnnouncementSubscriptionsSortOrderEnum
func GetListAnnouncementsLifecycleStateEnumStringValues() []string
GetListAnnouncementsLifecycleStateEnumStringValues Enumerates the set of values in String for ListAnnouncementsLifecycleStateEnum
func GetListAnnouncementsPlatformTypeEnumStringValues() []string
GetListAnnouncementsPlatformTypeEnumStringValues Enumerates the set of values in String for ListAnnouncementsPlatformTypeEnum
func GetListAnnouncementsSortByEnumStringValues() []string
GetListAnnouncementsSortByEnumStringValues Enumerates the set of values in String for ListAnnouncementsSortByEnum
func GetListAnnouncementsSortOrderEnumStringValues() []string
GetListAnnouncementsSortOrderEnumStringValues Enumerates the set of values in String for ListAnnouncementsSortOrderEnum
func GetListServicesCommsManagerNameEnumStringValues() []string
GetListServicesCommsManagerNameEnumStringValues Enumerates the set of values in String for ListServicesCommsManagerNameEnum
func GetListServicesPlatformTypeEnumStringValues() []string
GetListServicesPlatformTypeEnumStringValues Enumerates the set of values in String for ListServicesPlatformTypeEnum
func GetListServicesSortByEnumStringValues() []string
GetListServicesSortByEnumStringValues Enumerates the set of values in String for ListServicesSortByEnum
func GetListServicesSortOrderEnumStringValues() []string
GetListServicesSortOrderEnumStringValues Enumerates the set of values in String for ListServicesSortOrderEnum
func GetPlatformTypeEnumStringValues() []string
GetPlatformTypeEnumStringValues Enumerates the set of values in String for PlatformTypeEnum
func GetSortOrderEnumStringValues() []string
GetSortOrderEnumStringValues Enumerates the set of values in String for SortOrderEnum
AffectedResource The resource affected by the event described in the announcement.
type AffectedResource struct {
// The OCID of the affected resource.
ResourceId *string `mandatory:"true" json:"resourceId"`
// The friendly name of the resource.
ResourceName *string `mandatory:"true" json:"resourceName"`
// The region where the affected resource exists.
Region *string `mandatory:"true" json:"region"`
// Additional properties associated with the resource.
AdditionalProperties []Property `mandatory:"false" json:"additionalProperties"`
}
func (m AffectedResource) String() string
func (m AffectedResource) 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
Announcement A message about an impactful operational event.
type Announcement struct {
// The OCID of the announcement.
Id *string `mandatory:"true" json:"id"`
// The reference Jira ticket number.
ReferenceTicketNumber *string `mandatory:"true" json:"referenceTicketNumber"`
// A summary of the issue. A summary might appear in the console banner view of the announcement or in
// an email subject line. Avoid entering confidential information.
Summary *string `mandatory:"true" json:"summary"`
// Impacted Oracle Cloud Infrastructure services.
Services []string `mandatory:"true" json:"services"`
// Impacted regions.
AffectedRegions []string `mandatory:"true" json:"affectedRegions"`
// Whether the announcement is displayed as a banner in the console.
IsBanner *bool `mandatory:"true" json:"isBanner"`
// The label associated with an initial time value.
// Example: `Time Started`
TimeOneTitle *string `mandatory:"false" json:"timeOneTitle"`
// The actual value of the first time value for the event. Typically, this denotes the time an event started, but the meaning
// can vary, depending on the announcement type. The `timeOneType` attribute describes the meaning.
TimeOneValue *common.SDKTime `mandatory:"false" json:"timeOneValue"`
// The label associated with a second time value.
// Example: `Time Ended`
TimeTwoTitle *string `mandatory:"false" json:"timeTwoTitle"`
// The actual value of the second time value. Typically, this denotes the time an event ended, but the meaning
// can vary, depending on the announcement type. The `timeTwoType` attribute describes the meaning.
TimeTwoValue *common.SDKTime `mandatory:"false" json:"timeTwoValue"`
// The date and time the announcement was created, expressed in RFC 3339 (https://tools.ietf.org/html/rfc3339) timestamp format.
// Example: `2019-01-01T17:43:01.389+0000`
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// The date and time the announcement was last updated, expressed in RFC 3339 (https://tools.ietf.org/html/rfc3339) timestamp format.
// Example: `2019-01-01T17:43:01.389+0000`
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// The name of the environment that this announcement pertains to.
EnvironmentName *string `mandatory:"false" json:"environmentName"`
// The sequence of connected announcements, or announcement chain, that this announcement belongs to. Related announcements share the same chain ID.
ChainId *string `mandatory:"false" json:"chainId"`
// A detailed explanation of the event, expressed by using Markdown language. Avoid entering
// confidential information.
Description *string `mandatory:"false" json:"description"`
// Additional information about the event, expressed by using Markdown language and included in the
// details view of an announcement. Additional information might include remediation steps or
// answers to frequently asked questions. Avoid entering confidential information.
AdditionalInformation *string `mandatory:"false" json:"additionalInformation"`
// The list of resources, if any, affected by the event described in the announcement.
AffectedResources []AffectedResource `mandatory:"false" json:"affectedResources"`
// The type of a time associated with an initial time value. If the `timeOneTitle` attribute is present, then the `timeOneTitle` attribute contains a label of `timeOneType` in English.
// Example: `START_TIME`
TimeOneType BaseAnnouncementTimeOneTypeEnum `mandatory:"false" json:"timeOneType,omitempty"`
// The type of a time associated with second time value. If the `timeTwoTitle` attribute is present, then the `timeTwoTitle` attribute contains a label of `timeTwoType` in English.
// Example: `END_TIME`
TimeTwoType BaseAnnouncementTimeTwoTypeEnum `mandatory:"false" json:"timeTwoType,omitempty"`
// The type of announcement. An announcement's type signals its severity.
AnnouncementType BaseAnnouncementAnnouncementTypeEnum `mandatory:"true" json:"announcementType"`
// The current lifecycle state of the announcement.
LifecycleState BaseAnnouncementLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The platform type that this announcement pertains to.
PlatformType BaseAnnouncementPlatformTypeEnum `mandatory:"false" json:"platformType,omitempty"`
}
func (m Announcement) GetAffectedRegions() []string
GetAffectedRegions returns AffectedRegions
func (m Announcement) GetAnnouncementType() BaseAnnouncementAnnouncementTypeEnum
GetAnnouncementType returns AnnouncementType
func (m Announcement) GetChainId() *string
GetChainId returns ChainId
func (m Announcement) GetEnvironmentName() *string
GetEnvironmentName returns EnvironmentName
func (m Announcement) GetId() *string
GetId returns Id
func (m Announcement) GetIsBanner() *bool
GetIsBanner returns IsBanner
func (m Announcement) GetLifecycleState() BaseAnnouncementLifecycleStateEnum
GetLifecycleState returns LifecycleState
func (m Announcement) GetPlatformType() BaseAnnouncementPlatformTypeEnum
GetPlatformType returns PlatformType
func (m Announcement) GetReferenceTicketNumber() *string
GetReferenceTicketNumber returns ReferenceTicketNumber
func (m Announcement) GetServices() []string
GetServices returns Services
func (m Announcement) GetSummary() *string
GetSummary returns Summary
func (m Announcement) GetTimeCreated() *common.SDKTime
GetTimeCreated returns TimeCreated
func (m Announcement) GetTimeOneTitle() *string
GetTimeOneTitle returns TimeOneTitle
func (m Announcement) GetTimeOneType() BaseAnnouncementTimeOneTypeEnum
GetTimeOneType returns TimeOneType
func (m Announcement) GetTimeOneValue() *common.SDKTime
GetTimeOneValue returns TimeOneValue
func (m Announcement) GetTimeTwoTitle() *string
GetTimeTwoTitle returns TimeTwoTitle
func (m Announcement) GetTimeTwoType() BaseAnnouncementTimeTwoTypeEnum
GetTimeTwoType returns TimeTwoType
func (m Announcement) GetTimeTwoValue() *common.SDKTime
GetTimeTwoValue returns TimeTwoValue
func (m Announcement) GetTimeUpdated() *common.SDKTime
GetTimeUpdated returns TimeUpdated
func (m Announcement) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m Announcement) String() string
func (m Announcement) 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
AnnouncementClient a client for Announcement
type AnnouncementClient struct {
common.BaseClient
// contains filtered or unexported fields
}
func NewAnnouncementClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client AnnouncementClient, err error)
NewAnnouncementClientWithConfigurationProvider Creates a new default Announcement client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region
func NewAnnouncementClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client AnnouncementClient, err error)
NewAnnouncementClientWithOboToken Creates a new default Announcement 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 *AnnouncementClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client AnnouncementClient) GetAnnouncement(ctx context.Context, request GetAnnouncementRequest) (response GetAnnouncementResponse, err error)
GetAnnouncement Gets the details of a specific announcement. This call is subject to an Announcements limit that applies to the total number of requests across all read or write operations. Announcements might throttle this call to reject an otherwise valid request when the total rate of operations exceeds 20 requests per second for a given user. The service might also throttle this call to reject an otherwise valid request when the total rate of operations exceeds 100 requests per second for a given tenancy.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/announcementsservice/GetAnnouncement.go.html to see an example of how to use GetAnnouncement API.
func (client AnnouncementClient) GetAnnouncementCompartment(ctx context.Context, request GetAnnouncementCompartmentRequest) (response GetAnnouncementCompartmentResponse, err error)
GetAnnouncementCompartment Gets the compartment details of an announcement.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/announcementsservice/GetAnnouncementCompartment.go.html to see an example of how to use GetAnnouncementCompartment API.
func (client AnnouncementClient) GetAnnouncementUserStatus(ctx context.Context, request GetAnnouncementUserStatusRequest) (response GetAnnouncementUserStatusResponse, err error)
GetAnnouncementUserStatus Gets information about whether a specific announcement was acknowledged by a user. This call is subject to an Announcements limit that applies to the total number of requests across all read or write operations. Announcements might throttle this call to reject an otherwise valid request when the total rate of operations exceeds 20 requests per second for a given user. The service might also throttle this call to reject an otherwise valid request when the total rate of operations exceeds 100 requests per second for a given tenancy.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/announcementsservice/GetAnnouncementUserStatus.go.html to see an example of how to use GetAnnouncementUserStatus API.
func (client AnnouncementClient) ListAnnouncements(ctx context.Context, request ListAnnouncementsRequest) (response ListAnnouncementsResponse, err error)
ListAnnouncements Gets a list of announcements for the current tenancy. This call is subject to an Announcements limit that applies to the total number of requests across all read or write operations. Announcements might throttle this call to reject an otherwise valid request when the total rate of operations exceeds 20 requests per second for a given user. The service might also throttle this call to reject an otherwise valid request when the total rate of operations exceeds 100 requests per second for a given tenancy.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/announcementsservice/ListAnnouncements.go.html to see an example of how to use ListAnnouncements API.
func (client *AnnouncementClient) SetRegion(region string)
SetRegion overrides the region of this client.
func (client AnnouncementClient) UpdateAnnouncementUserStatus(ctx context.Context, request UpdateAnnouncementUserStatusRequest) (response UpdateAnnouncementUserStatusResponse, err error)
UpdateAnnouncementUserStatus Updates the status of the specified announcement with regard to whether it has been marked as read. This call is subject to an Announcements limit that applies to the total number of requests across all read or write operations. Announcements might throttle this call to reject an otherwise valid request when the total rate of operations exceeds 20 requests per second for a given user. The service might also throttle this call to reject an otherwise valid request when the total rate of operations exceeds 100 requests per second for a given tenancy.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/announcementsservice/UpdateAnnouncementUserStatus.go.html to see an example of how to use UpdateAnnouncementUserStatus API.
AnnouncementCompartment Compartment details of an announcement.
type AnnouncementCompartment struct {
// The OCID of the compartment to which the announcement belongs to.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
}
func (m AnnouncementCompartment) String() string
func (m AnnouncementCompartment) 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
AnnouncementSubscription A subscription with the Announcements service to receive selected announcements in the format and delivery mechanisms supported by a corresponding topic endpoint configured in the Oracle Cloud Infrastructure Notifications service.
type AnnouncementSubscription struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the announcement subscription.
Id *string `mandatory:"true" json:"id"`
// A user-friendly name for the announcement subscription. Does not have to be unique, and it's changeable. Avoid entering confidential information.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID of the compartment that contains the announcement subscription.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The date and time that the announcement subscription was created, expressed in RFC 3339 (https://tools.ietf.org/html/rfc3339) timestamp format.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The current lifecycle state of the announcement subscription.
LifecycleState AnnouncementSubscriptionLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The OCID of the Notifications service topic that is the target for publishing announcements that match the configured announcement subscription.
OnsTopicId *string `mandatory:"true" json:"onsTopicId"`
// 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:"true" 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:"true" json:"definedTags"`
// A description of the announcement subscription. Avoid entering confidential information.
Description *string `mandatory:"false" json:"description"`
// The date and time that the announcement subscription was updated, expressed in RFC 3339 (https://tools.ietf.org/html/rfc3339) timestamp format.
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// A message describing the current lifecycle state in more detail. For example, details might provide required or recommended actions for a resource in a Failed state.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// A list of filter groups for the announcement subscription. A filter group is a combination of multiple filters applied to announcements for matching purposes.
FilterGroups map[string]FilterGroup `mandatory:"false" json:"filterGroups"`
// (For announcement subscriptions with SaaS configured as the platform type or Oracle Fusion Applications as the service, or both, only) The language in which the user prefers to receive emailed announcements. Specify the preference with a value that uses the x-obmcs-human-language format. For example fr-FR.
PreferredLanguage *string `mandatory:"false" json:"preferredLanguage"`
// The time zone in which the user prefers to receive announcements. Specify the preference with a value that uses the IANA Time Zone Database format (x-obmcs-time-zone). For example - America/Los_Angeles
PreferredTimeZone *string `mandatory:"false" json:"preferredTimeZone"`
// 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 AnnouncementSubscription) String() string
func (m AnnouncementSubscription) 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
AnnouncementSubscriptionClient a client for AnnouncementSubscription
type AnnouncementSubscriptionClient struct {
common.BaseClient
// contains filtered or unexported fields
}
func NewAnnouncementSubscriptionClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client AnnouncementSubscriptionClient, err error)
NewAnnouncementSubscriptionClientWithConfigurationProvider Creates a new default AnnouncementSubscription client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region
func NewAnnouncementSubscriptionClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client AnnouncementSubscriptionClient, err error)
NewAnnouncementSubscriptionClientWithOboToken Creates a new default AnnouncementSubscription 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 AnnouncementSubscriptionClient) ChangeAnnouncementSubscriptionCompartment(ctx context.Context, request ChangeAnnouncementSubscriptionCompartmentRequest) (response ChangeAnnouncementSubscriptionCompartmentResponse, err error)
ChangeAnnouncementSubscriptionCompartment Moves the specified announcement subscription from one compartment to another compartment. When provided, If-Match is checked against ETag values of the resource. This call is subject to an Announcements limit that applies to the total number of requests across all read or write operations. Announcements might throttle this call to reject an otherwise valid request when the total rate of operations exceeds 20 requests per second for a given user. The service might also throttle this call to reject an otherwise valid request when the total rate of operations exceeds 100 requests per second for a given tenancy.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/announcementsservice/ChangeAnnouncementSubscriptionCompartment.go.html to see an example of how to use ChangeAnnouncementSubscriptionCompartment API.
func (client *AnnouncementSubscriptionClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client AnnouncementSubscriptionClient) CreateAnnouncementSubscription(ctx context.Context, request CreateAnnouncementSubscriptionRequest) (response CreateAnnouncementSubscriptionResponse, err error)
CreateAnnouncementSubscription Creates a new announcement subscription. This call is subject to an Announcements limit that applies to the total number of requests across all read or write operations. Announcements might throttle this call to reject an otherwise valid request when the total rate of operations exceeds 20 requests per second for a given user. The service might also throttle this call to reject an otherwise valid request when the total rate of operations exceeds 100 requests per second for a given tenancy.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/announcementsservice/CreateAnnouncementSubscription.go.html to see an example of how to use CreateAnnouncementSubscription API.
func (client AnnouncementSubscriptionClient) CreateFilterGroup(ctx context.Context, request CreateFilterGroupRequest) (response CreateFilterGroupResponse, err error)
CreateFilterGroup Creates a new filter group in the specified announcement subscription. This call is subject to an Announcements limit that applies to the total number of requests across all read or write operations. Announcements might throttle this call to reject an otherwise valid request when the total rate of operations exceeds 20 requests per second for a given user. The service might also throttle this call to reject an otherwise valid request when the total rate of operations exceeds 100 requests per second for a given tenancy.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/announcementsservice/CreateFilterGroup.go.html to see an example of how to use CreateFilterGroup API.
func (client AnnouncementSubscriptionClient) DeleteAnnouncementSubscription(ctx context.Context, request DeleteAnnouncementSubscriptionRequest) (response DeleteAnnouncementSubscriptionResponse, err error)
DeleteAnnouncementSubscription Deletes the specified announcement subscription. This call is subject to an Announcements limit that applies to the total number of requests across all read or write operations. Announcements might throttle this call to reject an otherwise valid request when the total rate of operations exceeds 20 requests per second for a given user. The service might also throttle this call to reject an otherwise valid request when the total rate of operations exceeds 100 requests per second for a given tenancy.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/announcementsservice/DeleteAnnouncementSubscription.go.html to see an example of how to use DeleteAnnouncementSubscription API.
func (client AnnouncementSubscriptionClient) DeleteFilterGroup(ctx context.Context, request DeleteFilterGroupRequest) (response DeleteFilterGroupResponse, err error)
DeleteFilterGroup Deletes a filter group in the specified announcement subscription. This call is subject to an Announcements limit that applies to the total number of requests across all read or write operations. Announcements might throttle this call to reject an otherwise valid request when the total rate of operations exceeds 20 requests per second for a given user. The service might also throttle this call to reject an otherwise valid request when the total rate of operations exceeds 100 requests per second for a given tenancy.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/announcementsservice/DeleteFilterGroup.go.html to see an example of how to use DeleteFilterGroup API.
func (client AnnouncementSubscriptionClient) GetAnnouncementSubscription(ctx context.Context, request GetAnnouncementSubscriptionRequest) (response GetAnnouncementSubscriptionResponse, err error)
GetAnnouncementSubscription Gets the specified announcement subscription. This call is subject to an Announcements limit that applies to the total number of requests across all read or write operations. Announcements might throttle this call to reject an otherwise valid request when the total rate of operations exceeds 20 requests per second for a given user. The service might also throttle this call to reject an otherwise valid request when the total rate of operations exceeds 100 requests per second for a given tenancy.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/announcementsservice/GetAnnouncementSubscription.go.html to see an example of how to use GetAnnouncementSubscription API.
func (client AnnouncementSubscriptionClient) ListAnnouncementSubscriptions(ctx context.Context, request ListAnnouncementSubscriptionsRequest) (response ListAnnouncementSubscriptionsResponse, err error)
ListAnnouncementSubscriptions Gets a list of all announcement subscriptions in the specified compartment. This call is subject to an Announcements limit that applies to the total number of requests across all read or write operations. Announcements might throttle this call to reject an otherwise valid request when the total rate of operations exceeds 20 requests per second for a given user. The service might also throttle this call to reject an otherwise valid request when the total rate of operations exceeds 100 requests per second for a given tenancy.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/announcementsservice/ListAnnouncementSubscriptions.go.html to see an example of how to use ListAnnouncementSubscriptions API.
func (client *AnnouncementSubscriptionClient) SetRegion(region string)
SetRegion overrides the region of this client.
func (client AnnouncementSubscriptionClient) UpdateAnnouncementSubscription(ctx context.Context, request UpdateAnnouncementSubscriptionRequest) (response UpdateAnnouncementSubscriptionResponse, err error)
UpdateAnnouncementSubscription Updates the specified announcement subscription. This call is subject to an Announcements limit that applies to the total number of requests across all read or write operations. Announcements might throttle this call to reject an otherwise valid request when the total rate of operations exceeds 20 requests per second for a given user. The service might also throttle this call to reject an otherwise valid request when the total rate of operations exceeds 100 requests per second for a given tenancy.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/announcementsservice/UpdateAnnouncementSubscription.go.html to see an example of how to use UpdateAnnouncementSubscription API.
func (client AnnouncementSubscriptionClient) UpdateFilterGroup(ctx context.Context, request UpdateFilterGroupRequest) (response UpdateFilterGroupResponse, err error)
UpdateFilterGroup Updates a filter group in the specified announcement subscription. This call is subject to an Announcements limit that applies to the total number of requests across all read or write operations. Announcements might throttle this call to reject an otherwise valid request when the total rate of operations exceeds 20 requests per second for a given user. The service might also throttle this call to reject an otherwise valid request when the total rate of operations exceeds 100 requests per second for a given tenancy.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/announcementsservice/UpdateFilterGroup.go.html to see an example of how to use UpdateFilterGroup API.
AnnouncementSubscriptionCollection The results of a search for announcement subscriptions. This object contains both announcement subscription summary objects and other information, such as metadata.
type AnnouncementSubscriptionCollection struct {
// A list of announcement subscriptions.
Items []AnnouncementSubscriptionSummary `mandatory:"true" json:"items"`
}
func (m AnnouncementSubscriptionCollection) String() string
func (m AnnouncementSubscriptionCollection) 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
AnnouncementSubscriptionLifecycleStateEnum Enum with underlying type: string
type AnnouncementSubscriptionLifecycleStateEnum string
Set of constants representing the allowable values for AnnouncementSubscriptionLifecycleStateEnum
const (
AnnouncementSubscriptionLifecycleStateActive AnnouncementSubscriptionLifecycleStateEnum = "ACTIVE"
AnnouncementSubscriptionLifecycleStateDeleted AnnouncementSubscriptionLifecycleStateEnum = "DELETED"
AnnouncementSubscriptionLifecycleStateFailed AnnouncementSubscriptionLifecycleStateEnum = "FAILED"
)
func GetAnnouncementSubscriptionLifecycleStateEnumValues() []AnnouncementSubscriptionLifecycleStateEnum
GetAnnouncementSubscriptionLifecycleStateEnumValues Enumerates the set of values for AnnouncementSubscriptionLifecycleStateEnum
func GetMappingAnnouncementSubscriptionLifecycleStateEnum(val string) (AnnouncementSubscriptionLifecycleStateEnum, bool)
GetMappingAnnouncementSubscriptionLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
AnnouncementSubscriptionSummary A summary representation of an announcement subscription.
type AnnouncementSubscriptionSummary struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the announcement subscription.
Id *string `mandatory:"true" json:"id"`
// A user-friendly name for the announcement subscription. Does not have to be unique, and it's changeable. Avoid entering confidential information.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID of the compartment that contains the announcement subscription.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The date and time that the announcement subscription was created, expressed in RFC 3339 (https://tools.ietf.org/html/rfc3339) timestamp format.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The current lifecycle state of the announcement subscription.
LifecycleState AnnouncementSubscriptionLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The OCID of the Notifications service topic that is the target for publishing announcements that match the configured announcement subscription.
OnsTopicId *string `mandatory:"true" json:"onsTopicId"`
// 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:"true" 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:"true" json:"definedTags"`
// The date and time that the announcement subscription was updated, expressed in RFC 3339 (https://tools.ietf.org/html/rfc3339) timestamp format.
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// A message describing the current lifecycle state in more detail. For example, details might provide required or recommended actions for a resource in a Failed state.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// 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 AnnouncementSubscriptionSummary) String() string
func (m AnnouncementSubscriptionSummary) 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
AnnouncementSummary A summary representation of an announcement.
type AnnouncementSummary struct {
// The OCID of the announcement.
Id *string `mandatory:"true" json:"id"`
// The reference Jira ticket number.
ReferenceTicketNumber *string `mandatory:"true" json:"referenceTicketNumber"`
// A summary of the issue. A summary might appear in the console banner view of the announcement or in
// an email subject line. Avoid entering confidential information.
Summary *string `mandatory:"true" json:"summary"`
// Impacted Oracle Cloud Infrastructure services.
Services []string `mandatory:"true" json:"services"`
// Impacted regions.
AffectedRegions []string `mandatory:"true" json:"affectedRegions"`
// Whether the announcement is displayed as a banner in the console.
IsBanner *bool `mandatory:"true" json:"isBanner"`
// The label associated with an initial time value.
// Example: `Time Started`
TimeOneTitle *string `mandatory:"false" json:"timeOneTitle"`
// The actual value of the first time value for the event. Typically, this denotes the time an event started, but the meaning
// can vary, depending on the announcement type. The `timeOneType` attribute describes the meaning.
TimeOneValue *common.SDKTime `mandatory:"false" json:"timeOneValue"`
// The label associated with a second time value.
// Example: `Time Ended`
TimeTwoTitle *string `mandatory:"false" json:"timeTwoTitle"`
// The actual value of the second time value. Typically, this denotes the time an event ended, but the meaning
// can vary, depending on the announcement type. The `timeTwoType` attribute describes the meaning.
TimeTwoValue *common.SDKTime `mandatory:"false" json:"timeTwoValue"`
// The date and time the announcement was created, expressed in RFC 3339 (https://tools.ietf.org/html/rfc3339) timestamp format.
// Example: `2019-01-01T17:43:01.389+0000`
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// The date and time the announcement was last updated, expressed in RFC 3339 (https://tools.ietf.org/html/rfc3339) timestamp format.
// Example: `2019-01-01T17:43:01.389+0000`
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// The name of the environment that this announcement pertains to.
EnvironmentName *string `mandatory:"false" json:"environmentName"`
// The sequence of connected announcements, or announcement chain, that this announcement belongs to. Related announcements share the same chain ID.
ChainId *string `mandatory:"false" json:"chainId"`
// The type of a time associated with an initial time value. If the `timeOneTitle` attribute is present, then the `timeOneTitle` attribute contains a label of `timeOneType` in English.
// Example: `START_TIME`
TimeOneType BaseAnnouncementTimeOneTypeEnum `mandatory:"false" json:"timeOneType,omitempty"`
// The type of a time associated with second time value. If the `timeTwoTitle` attribute is present, then the `timeTwoTitle` attribute contains a label of `timeTwoType` in English.
// Example: `END_TIME`
TimeTwoType BaseAnnouncementTimeTwoTypeEnum `mandatory:"false" json:"timeTwoType,omitempty"`
// The type of announcement. An announcement's type signals its severity.
AnnouncementType BaseAnnouncementAnnouncementTypeEnum `mandatory:"true" json:"announcementType"`
// The current lifecycle state of the announcement.
LifecycleState BaseAnnouncementLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The platform type that this announcement pertains to.
PlatformType BaseAnnouncementPlatformTypeEnum `mandatory:"false" json:"platformType,omitempty"`
}
func (m AnnouncementSummary) GetAffectedRegions() []string
GetAffectedRegions returns AffectedRegions
func (m AnnouncementSummary) GetAnnouncementType() BaseAnnouncementAnnouncementTypeEnum
GetAnnouncementType returns AnnouncementType
func (m AnnouncementSummary) GetChainId() *string
GetChainId returns ChainId
func (m AnnouncementSummary) GetEnvironmentName() *string
GetEnvironmentName returns EnvironmentName
func (m AnnouncementSummary) GetId() *string
GetId returns Id
func (m AnnouncementSummary) GetIsBanner() *bool
GetIsBanner returns IsBanner
func (m AnnouncementSummary) GetLifecycleState() BaseAnnouncementLifecycleStateEnum
GetLifecycleState returns LifecycleState
func (m AnnouncementSummary) GetPlatformType() BaseAnnouncementPlatformTypeEnum
GetPlatformType returns PlatformType
func (m AnnouncementSummary) GetReferenceTicketNumber() *string
GetReferenceTicketNumber returns ReferenceTicketNumber
func (m AnnouncementSummary) GetServices() []string
GetServices returns Services
func (m AnnouncementSummary) GetSummary() *string
GetSummary returns Summary
func (m AnnouncementSummary) GetTimeCreated() *common.SDKTime
GetTimeCreated returns TimeCreated
func (m AnnouncementSummary) GetTimeOneTitle() *string
GetTimeOneTitle returns TimeOneTitle
func (m AnnouncementSummary) GetTimeOneType() BaseAnnouncementTimeOneTypeEnum
GetTimeOneType returns TimeOneType
func (m AnnouncementSummary) GetTimeOneValue() *common.SDKTime
GetTimeOneValue returns TimeOneValue
func (m AnnouncementSummary) GetTimeTwoTitle() *string
GetTimeTwoTitle returns TimeTwoTitle
func (m AnnouncementSummary) GetTimeTwoType() BaseAnnouncementTimeTwoTypeEnum
GetTimeTwoType returns TimeTwoType
func (m AnnouncementSummary) GetTimeTwoValue() *common.SDKTime
GetTimeTwoValue returns TimeTwoValue
func (m AnnouncementSummary) GetTimeUpdated() *common.SDKTime
GetTimeUpdated returns TimeUpdated
func (m AnnouncementSummary) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m AnnouncementSummary) String() string
func (m AnnouncementSummary) 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
AnnouncementUserStatusDetails An announcement's status regarding whether it has been acknowledged by a user.
type AnnouncementUserStatusDetails struct {
// The OCID of the announcement that this status is associated with.
UserStatusAnnouncementId *string `mandatory:"true" json:"userStatusAnnouncementId"`
// The OCID of the user that this status is associated with.
UserId *string `mandatory:"true" json:"userId"`
// The date and time the announcement was acknowledged, expressed in RFC 3339 (https://tools.ietf.org/html/rfc3339) timestamp format.
// Example: `2019-01-01T17:43:01.389+0000`
TimeAcknowledged *common.SDKTime `mandatory:"false" json:"timeAcknowledged"`
}
func (m AnnouncementUserStatusDetails) String() string
func (m AnnouncementUserStatusDetails) 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
AnnouncementsCollection A list of announcements that match filter criteria, if any. Results contain both the announcements and the user-specific status of the announcements.
type AnnouncementsCollection struct {
// A collection of announcements.
Items []AnnouncementSummary `mandatory:"false" json:"items"`
// The user-specific status for found announcements.
UserStatuses []AnnouncementUserStatusDetails `mandatory:"false" json:"userStatuses"`
}
func (m AnnouncementsCollection) String() string
func (m AnnouncementsCollection) 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
AnnouncementsPreferences The object for announcement email preferences.
type AnnouncementsPreferences struct {
// The OCID of the compartment for which the email preferences apply. Because announcements are
// specific to a tenancy, specify the tenancy by providing the root compartment OCID.
CompartmentId *string `mandatory:"false" json:"compartmentId"`
// The ID of the preferences.
Id *string `mandatory:"false" json:"id"`
// A Boolean value to indicate whether the specified compartment chooses to not to receive informational announcements by email.
// (Manage preferences for receiving announcements by email by specifying the `preferenceType` attribute instead.)
IsUnsubscribed *bool `mandatory:"false" json:"isUnsubscribed"`
// When the preferences were set initially.
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// When the preferences were last updated.
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// The time zone in which the user prefers to receive announcements. Specify the preference with a value that uses the IANA Time Zone Database format (x-obmcs-time-zone). For example - America/Los_Angeles
PreferredTimeZone *string `mandatory:"false" json:"preferredTimeZone"`
// The string representing the user's preference regarding receiving announcements by email.
PreferenceType BaseCreateAnnouncementsPreferencesDetailsPreferenceTypeEnum `mandatory:"false" json:"preferenceType,omitempty"`
}
func (m AnnouncementsPreferences) GetCompartmentId() *string
GetCompartmentId returns CompartmentId
func (m AnnouncementsPreferences) GetId() *string
GetId returns Id
func (m AnnouncementsPreferences) GetIsUnsubscribed() *bool
GetIsUnsubscribed returns IsUnsubscribed
func (m AnnouncementsPreferences) GetPreferenceType() BaseCreateAnnouncementsPreferencesDetailsPreferenceTypeEnum
GetPreferenceType returns PreferenceType
func (m AnnouncementsPreferences) GetPreferredTimeZone() *string
GetPreferredTimeZone returns PreferredTimeZone
func (m AnnouncementsPreferences) GetTimeCreated() *common.SDKTime
GetTimeCreated returns TimeCreated
func (m AnnouncementsPreferences) GetTimeUpdated() *common.SDKTime
GetTimeUpdated returns TimeUpdated
func (m AnnouncementsPreferences) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m AnnouncementsPreferences) String() string
func (m AnnouncementsPreferences) 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
AnnouncementsPreferencesClient a client for AnnouncementsPreferences
type AnnouncementsPreferencesClient struct {
common.BaseClient
// contains filtered or unexported fields
}
func NewAnnouncementsPreferencesClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client AnnouncementsPreferencesClient, err error)
NewAnnouncementsPreferencesClientWithConfigurationProvider Creates a new default AnnouncementsPreferences client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region
func NewAnnouncementsPreferencesClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client AnnouncementsPreferencesClient, err error)
NewAnnouncementsPreferencesClientWithOboToken Creates a new default AnnouncementsPreferences 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 *AnnouncementsPreferencesClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client AnnouncementsPreferencesClient) CreateAnnouncementsPreference(ctx context.Context, request CreateAnnouncementsPreferenceRequest) (response CreateAnnouncementsPreferenceResponse, err error)
CreateAnnouncementsPreference Creates a request that specifies preferences for the tenancy regarding receiving announcements by email. This call is subject to an Announcements limit that applies to the total number of requests across all read or write operations. Announcements might throttle this call to reject an otherwise valid request when the total rate of operations exceeds 20 requests per second for a given user. The service might also throttle this call to reject an otherwise valid request when the total rate of operations exceeds 100 requests per second for a given tenancy.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/announcementsservice/CreateAnnouncementsPreference.go.html to see an example of how to use CreateAnnouncementsPreference API.
func (client AnnouncementsPreferencesClient) GetAnnouncementsPreference(ctx context.Context, request GetAnnouncementsPreferenceRequest) (response GetAnnouncementsPreferenceResponse, err error)
GetAnnouncementsPreference Gets the current preferences of the tenancy regarding receiving announcements by email. This call is subject to an Announcements limit that applies to the total number of requests across all read or write operations. Announcements might throttle this call to reject an otherwise valid request when the total rate of operations exceeds 20 requests per second for a given user. The service might also throttle this call to reject an otherwise valid request when the total rate of operations exceeds 100 requests per second for a given tenancy.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/announcementsservice/GetAnnouncementsPreference.go.html to see an example of how to use GetAnnouncementsPreference API.
func (client AnnouncementsPreferencesClient) ListAnnouncementsPreferences(ctx context.Context, request ListAnnouncementsPreferencesRequest) (response ListAnnouncementsPreferencesResponse, err error)
ListAnnouncementsPreferences Gets the current preferences of the tenancy regarding receiving announcements by email. This call is subject to an Announcements limit that applies to the total number of requests across all read or write operations. Announcements might throttle this call to reject an otherwise valid request when the total rate of operations exceeds 20 requests per second for a given user. The service might also throttle this call to reject an otherwise valid request when the total rate of operations exceeds 100 requests per second for a given tenancy.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/announcementsservice/ListAnnouncementsPreferences.go.html to see an example of how to use ListAnnouncementsPreferences API.
func (client *AnnouncementsPreferencesClient) SetRegion(region string)
SetRegion overrides the region of this client.
func (client AnnouncementsPreferencesClient) UpdateAnnouncementsPreference(ctx context.Context, request UpdateAnnouncementsPreferenceRequest) (response UpdateAnnouncementsPreferenceResponse, err error)
UpdateAnnouncementsPreference Updates the preferences of the tenancy regarding receiving announcements by email. This call is subject to an Announcements limit that applies to the total number of requests across all read or write operations. Announcements might throttle this call to reject an otherwise valid request when the total rate of operations exceeds 20 requests per second for a given user. The service might also throttle this call to reject an otherwise valid request when the total rate of operations exceeds 100 requests per second for a given tenancy.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/announcementsservice/UpdateAnnouncementsPreference.go.html to see an example of how to use UpdateAnnouncementsPreference API.
AnnouncementsPreferencesSummary The summary object for announcement email preferences.
type AnnouncementsPreferencesSummary struct {
// The OCID of the compartment for which the email preferences apply. Because announcements are
// specific to a tenancy, specify the tenancy by providing the root compartment OCID.
CompartmentId *string `mandatory:"false" json:"compartmentId"`
// The ID of the preferences.
Id *string `mandatory:"false" json:"id"`
// A Boolean value to indicate whether the specified compartment chooses to not to receive informational announcements by email.
// (Manage preferences for receiving announcements by email by specifying the `preferenceType` attribute instead.)
IsUnsubscribed *bool `mandatory:"false" json:"isUnsubscribed"`
// When the preferences were set initially.
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// When the preferences were last updated.
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// The time zone in which the user prefers to receive announcements. Specify the preference with a value that uses the IANA Time Zone Database format (x-obmcs-time-zone). For example - America/Los_Angeles
PreferredTimeZone *string `mandatory:"false" json:"preferredTimeZone"`
// The string representing the user's preference regarding receiving announcements by email.
PreferenceType BaseCreateAnnouncementsPreferencesDetailsPreferenceTypeEnum `mandatory:"false" json:"preferenceType,omitempty"`
}
func (m AnnouncementsPreferencesSummary) GetCompartmentId() *string
GetCompartmentId returns CompartmentId
func (m AnnouncementsPreferencesSummary) GetId() *string
GetId returns Id
func (m AnnouncementsPreferencesSummary) GetIsUnsubscribed() *bool
GetIsUnsubscribed returns IsUnsubscribed
func (m AnnouncementsPreferencesSummary) GetPreferenceType() BaseCreateAnnouncementsPreferencesDetailsPreferenceTypeEnum
GetPreferenceType returns PreferenceType
func (m AnnouncementsPreferencesSummary) GetPreferredTimeZone() *string
GetPreferredTimeZone returns PreferredTimeZone
func (m AnnouncementsPreferencesSummary) GetTimeCreated() *common.SDKTime
GetTimeCreated returns TimeCreated
func (m AnnouncementsPreferencesSummary) GetTimeUpdated() *common.SDKTime
GetTimeUpdated returns TimeUpdated
func (m AnnouncementsPreferencesSummary) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m AnnouncementsPreferencesSummary) String() string
func (m AnnouncementsPreferencesSummary) 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
BaseAnnouncement Incident information that forms the basis of an announcement. Avoid entering confidential information.
type BaseAnnouncement interface {
// The OCID of the announcement.
GetId() *string
// The reference Jira ticket number.
GetReferenceTicketNumber() *string
// A summary of the issue. A summary might appear in the console banner view of the announcement or in
// an email subject line. Avoid entering confidential information.
GetSummary() *string
// Impacted Oracle Cloud Infrastructure services.
GetServices() []string
// Impacted regions.
GetAffectedRegions() []string
// The type of announcement. An announcement's type signals its severity.
GetAnnouncementType() BaseAnnouncementAnnouncementTypeEnum
// The current lifecycle state of the announcement.
GetLifecycleState() BaseAnnouncementLifecycleStateEnum
// Whether the announcement is displayed as a banner in the console.
GetIsBanner() *bool
// The label associated with an initial time value.
// Example: `Time Started`
GetTimeOneTitle() *string
// The type of a time associated with an initial time value. If the `timeOneTitle` attribute is present, then the `timeOneTitle` attribute contains a label of `timeOneType` in English.
// Example: `START_TIME`
GetTimeOneType() BaseAnnouncementTimeOneTypeEnum
// The actual value of the first time value for the event. Typically, this denotes the time an event started, but the meaning
// can vary, depending on the announcement type. The `timeOneType` attribute describes the meaning.
GetTimeOneValue() *common.SDKTime
// The label associated with a second time value.
// Example: `Time Ended`
GetTimeTwoTitle() *string
// The type of a time associated with second time value. If the `timeTwoTitle` attribute is present, then the `timeTwoTitle` attribute contains a label of `timeTwoType` in English.
// Example: `END_TIME`
GetTimeTwoType() BaseAnnouncementTimeTwoTypeEnum
// The actual value of the second time value. Typically, this denotes the time an event ended, but the meaning
// can vary, depending on the announcement type. The `timeTwoType` attribute describes the meaning.
GetTimeTwoValue() *common.SDKTime
// The date and time the announcement was created, expressed in RFC 3339 (https://tools.ietf.org/html/rfc3339) timestamp format.
// Example: `2019-01-01T17:43:01.389+0000`
GetTimeCreated() *common.SDKTime
// The date and time the announcement was last updated, expressed in RFC 3339 (https://tools.ietf.org/html/rfc3339) timestamp format.
// Example: `2019-01-01T17:43:01.389+0000`
GetTimeUpdated() *common.SDKTime
// The name of the environment that this announcement pertains to.
GetEnvironmentName() *string
// The platform type that this announcement pertains to.
GetPlatformType() BaseAnnouncementPlatformTypeEnum
// The sequence of connected announcements, or announcement chain, that this announcement belongs to. Related announcements share the same chain ID.
GetChainId() *string
}
BaseAnnouncementAnnouncementTypeEnum Enum with underlying type: string
type BaseAnnouncementAnnouncementTypeEnum string
Set of constants representing the allowable values for BaseAnnouncementAnnouncementTypeEnum
const (
BaseAnnouncementAnnouncementTypeActionRecommended BaseAnnouncementAnnouncementTypeEnum = "ACTION_RECOMMENDED"
BaseAnnouncementAnnouncementTypeActionRequired BaseAnnouncementAnnouncementTypeEnum = "ACTION_REQUIRED"
BaseAnnouncementAnnouncementTypeEmergencyChange BaseAnnouncementAnnouncementTypeEnum = "EMERGENCY_CHANGE"
BaseAnnouncementAnnouncementTypeEmergencyMaintenance BaseAnnouncementAnnouncementTypeEnum = "EMERGENCY_MAINTENANCE"
BaseAnnouncementAnnouncementTypeEmergencyMaintenanceComplete BaseAnnouncementAnnouncementTypeEnum = "EMERGENCY_MAINTENANCE_COMPLETE"
BaseAnnouncementAnnouncementTypeEmergencyMaintenanceExtended BaseAnnouncementAnnouncementTypeEnum = "EMERGENCY_MAINTENANCE_EXTENDED"
BaseAnnouncementAnnouncementTypeEmergencyMaintenanceRescheduled BaseAnnouncementAnnouncementTypeEnum = "EMERGENCY_MAINTENANCE_RESCHEDULED"
BaseAnnouncementAnnouncementTypeInformation BaseAnnouncementAnnouncementTypeEnum = "INFORMATION"
BaseAnnouncementAnnouncementTypePlannedChange BaseAnnouncementAnnouncementTypeEnum = "PLANNED_CHANGE"
BaseAnnouncementAnnouncementTypePlannedChangeComplete BaseAnnouncementAnnouncementTypeEnum = "PLANNED_CHANGE_COMPLETE"
BaseAnnouncementAnnouncementTypePlannedChangeExtended BaseAnnouncementAnnouncementTypeEnum = "PLANNED_CHANGE_EXTENDED"
BaseAnnouncementAnnouncementTypePlannedChangeRescheduled BaseAnnouncementAnnouncementTypeEnum = "PLANNED_CHANGE_RESCHEDULED"
BaseAnnouncementAnnouncementTypeProductionEventNotification BaseAnnouncementAnnouncementTypeEnum = "PRODUCTION_EVENT_NOTIFICATION"
BaseAnnouncementAnnouncementTypeScheduledMaintenance BaseAnnouncementAnnouncementTypeEnum = "SCHEDULED_MAINTENANCE"
)
func GetBaseAnnouncementAnnouncementTypeEnumValues() []BaseAnnouncementAnnouncementTypeEnum
GetBaseAnnouncementAnnouncementTypeEnumValues Enumerates the set of values for BaseAnnouncementAnnouncementTypeEnum
func GetMappingBaseAnnouncementAnnouncementTypeEnum(val string) (BaseAnnouncementAnnouncementTypeEnum, bool)
GetMappingBaseAnnouncementAnnouncementTypeEnum performs case Insensitive comparison on enum value and return the desired enum
BaseAnnouncementLifecycleStateEnum Enum with underlying type: string
type BaseAnnouncementLifecycleStateEnum string
Set of constants representing the allowable values for BaseAnnouncementLifecycleStateEnum
const (
BaseAnnouncementLifecycleStateActive BaseAnnouncementLifecycleStateEnum = "ACTIVE"
BaseAnnouncementLifecycleStateInactive BaseAnnouncementLifecycleStateEnum = "INACTIVE"
)
func GetBaseAnnouncementLifecycleStateEnumValues() []BaseAnnouncementLifecycleStateEnum
GetBaseAnnouncementLifecycleStateEnumValues Enumerates the set of values for BaseAnnouncementLifecycleStateEnum
func GetMappingBaseAnnouncementLifecycleStateEnum(val string) (BaseAnnouncementLifecycleStateEnum, bool)
GetMappingBaseAnnouncementLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
BaseAnnouncementPlatformTypeEnum Enum with underlying type: string
type BaseAnnouncementPlatformTypeEnum string
Set of constants representing the allowable values for BaseAnnouncementPlatformTypeEnum
const (
BaseAnnouncementPlatformTypeIaas BaseAnnouncementPlatformTypeEnum = "IAAS"
BaseAnnouncementPlatformTypeSaas BaseAnnouncementPlatformTypeEnum = "SAAS"
BaseAnnouncementPlatformTypePaas BaseAnnouncementPlatformTypeEnum = "PAAS"
)
func GetBaseAnnouncementPlatformTypeEnumValues() []BaseAnnouncementPlatformTypeEnum
GetBaseAnnouncementPlatformTypeEnumValues Enumerates the set of values for BaseAnnouncementPlatformTypeEnum
func GetMappingBaseAnnouncementPlatformTypeEnum(val string) (BaseAnnouncementPlatformTypeEnum, bool)
GetMappingBaseAnnouncementPlatformTypeEnum performs case Insensitive comparison on enum value and return the desired enum
BaseAnnouncementTimeOneTypeEnum Enum with underlying type: string
type BaseAnnouncementTimeOneTypeEnum string
Set of constants representing the allowable values for BaseAnnouncementTimeOneTypeEnum
const (
BaseAnnouncementTimeOneTypeActionRequiredBy BaseAnnouncementTimeOneTypeEnum = "ACTION_REQUIRED_BY"
BaseAnnouncementTimeOneTypeNewStartTime BaseAnnouncementTimeOneTypeEnum = "NEW_START_TIME"
BaseAnnouncementTimeOneTypeOriginalEndTime BaseAnnouncementTimeOneTypeEnum = "ORIGINAL_END_TIME"
BaseAnnouncementTimeOneTypeReportDate BaseAnnouncementTimeOneTypeEnum = "REPORT_DATE"
BaseAnnouncementTimeOneTypeStartTime BaseAnnouncementTimeOneTypeEnum = "START_TIME"
BaseAnnouncementTimeOneTypeTimeDetected BaseAnnouncementTimeOneTypeEnum = "TIME_DETECTED"
)
func GetBaseAnnouncementTimeOneTypeEnumValues() []BaseAnnouncementTimeOneTypeEnum
GetBaseAnnouncementTimeOneTypeEnumValues Enumerates the set of values for BaseAnnouncementTimeOneTypeEnum
func GetMappingBaseAnnouncementTimeOneTypeEnum(val string) (BaseAnnouncementTimeOneTypeEnum, bool)
GetMappingBaseAnnouncementTimeOneTypeEnum performs case Insensitive comparison on enum value and return the desired enum
BaseAnnouncementTimeTwoTypeEnum Enum with underlying type: string
type BaseAnnouncementTimeTwoTypeEnum string
Set of constants representing the allowable values for BaseAnnouncementTimeTwoTypeEnum
const (
BaseAnnouncementTimeTwoTypeEndTime BaseAnnouncementTimeTwoTypeEnum = "END_TIME"
BaseAnnouncementTimeTwoTypeNewEndTime BaseAnnouncementTimeTwoTypeEnum = "NEW_END_TIME"
BaseAnnouncementTimeTwoTypeEstimatedEndTime BaseAnnouncementTimeTwoTypeEnum = "ESTIMATED_END_TIME"
)
func GetBaseAnnouncementTimeTwoTypeEnumValues() []BaseAnnouncementTimeTwoTypeEnum
GetBaseAnnouncementTimeTwoTypeEnumValues Enumerates the set of values for BaseAnnouncementTimeTwoTypeEnum
func GetMappingBaseAnnouncementTimeTwoTypeEnum(val string) (BaseAnnouncementTimeTwoTypeEnum, bool)
GetMappingBaseAnnouncementTimeTwoTypeEnum performs case Insensitive comparison on enum value and return the desired enum
BaseAnnouncementsPreferences The object that contains the announcement email preferences configured for the tenancy (root compartment).
type BaseAnnouncementsPreferences interface {
// The OCID of the compartment for which the email preferences apply. Because announcements are
// specific to a tenancy, specify the tenancy by providing the root compartment OCID.
GetCompartmentId() *string
// The ID of the preferences.
GetId() *string
// A Boolean value to indicate whether the specified compartment chooses to not to receive informational announcements by email.
// (Manage preferences for receiving announcements by email by specifying the `preferenceType` attribute instead.)
GetIsUnsubscribed() *bool
// When the preferences were set initially.
GetTimeCreated() *common.SDKTime
// When the preferences were last updated.
GetTimeUpdated() *common.SDKTime
// The string representing the user's preference regarding receiving announcements by email.
GetPreferenceType() BaseCreateAnnouncementsPreferencesDetailsPreferenceTypeEnum
// The time zone in which the user prefers to receive announcements. Specify the preference with a value that uses the IANA Time Zone Database format (x-obmcs-time-zone). For example - America/Los_Angeles
GetPreferredTimeZone() *string
}
BaseCreateAnnouncementsPreferencesDetails The model for the parameters of announcement email preferences configured for the tenancy (root compartment).
type BaseCreateAnnouncementsPreferencesDetails interface {
// The string representing the user's preference, whether to opt in to only required announcements, to opt in to all announcements, including informational announcements, or to opt out of all announcements.
GetPreferenceType() BaseCreateAnnouncementsPreferencesDetailsPreferenceTypeEnum
// A Boolean value to indicate whether the specified compartment chooses to not to receive informational announcements by email.
// (Manage preferences for receiving announcements by email by specifying the `preferenceType` attribute instead.)
GetIsUnsubscribed() *bool
// The OCID of the compartment for which you want to manage announcement email preferences. (Specify the tenancy by providing the
// root compartment OCID.)
GetCompartmentId() *string
// The time zone in which the user prefers to receive announcements. Specify the preference with a value that uses the IANA Time Zone Database format (x-obmcs-time-zone). For example - America/Los_Angeles
GetPreferredTimeZone() *string
}
BaseCreateAnnouncementsPreferencesDetailsPreferenceTypeEnum Enum with underlying type: string
type BaseCreateAnnouncementsPreferencesDetailsPreferenceTypeEnum string
Set of constants representing the allowable values for BaseCreateAnnouncementsPreferencesDetailsPreferenceTypeEnum
const (
BaseCreateAnnouncementsPreferencesDetailsPreferenceTypeInTenantAnnouncements BaseCreateAnnouncementsPreferencesDetailsPreferenceTypeEnum = "OPT_IN_TENANT_ANNOUNCEMENTS"
BaseCreateAnnouncementsPreferencesDetailsPreferenceTypeInTenantAndInformationalAnnouncements BaseCreateAnnouncementsPreferencesDetailsPreferenceTypeEnum = "OPT_IN_TENANT_AND_INFORMATIONAL_ANNOUNCEMENTS"
BaseCreateAnnouncementsPreferencesDetailsPreferenceTypeOutAllAnnouncements BaseCreateAnnouncementsPreferencesDetailsPreferenceTypeEnum = "OPT_OUT_ALL_ANNOUNCEMENTS"
)
func GetBaseCreateAnnouncementsPreferencesDetailsPreferenceTypeEnumValues() []BaseCreateAnnouncementsPreferencesDetailsPreferenceTypeEnum
GetBaseCreateAnnouncementsPreferencesDetailsPreferenceTypeEnumValues Enumerates the set of values for BaseCreateAnnouncementsPreferencesDetailsPreferenceTypeEnum
func GetMappingBaseCreateAnnouncementsPreferencesDetailsPreferenceTypeEnum(val string) (BaseCreateAnnouncementsPreferencesDetailsPreferenceTypeEnum, bool)
GetMappingBaseCreateAnnouncementsPreferencesDetailsPreferenceTypeEnum performs case Insensitive comparison on enum value and return the desired enum
BaseService Object representing a single service.
type BaseService interface {
// ID of the service object.
GetId() *string
// Name of the service represented by this object.
GetServiceName() *string
// Short name of the team to whom this service object is related.
GetShortName() *string
// Team name to which this service object is related.
GetTeamName() *string
// The platform type this service object is related to.
GetPlatformType() PlatformTypeEnum
// Name of the comms manager team that manages Notifications to this service.
GetCommsManagerName() CommsManagerNameEnum
// The list of realms where this service is not available to be used.
GetExcludedRealms() []string
// The list of previously used names for this service object.
GetPreviousServiceNames() []string
// The date and time when the service object was created.
GetTimeCreated() *common.SDKTime
// The date and time when the service object was updated.
GetTimeUpdated() *common.SDKTime
// Current state of the service object.
GetLifecycleState() BaseServiceLifecycleStateEnum
}
BaseServiceLifecycleStateEnum Enum with underlying type: string
type BaseServiceLifecycleStateEnum string
Set of constants representing the allowable values for BaseServiceLifecycleStateEnum
const (
BaseServiceLifecycleStateActive BaseServiceLifecycleStateEnum = "ACTIVE"
BaseServiceLifecycleStateDeleted BaseServiceLifecycleStateEnum = "DELETED"
)
func GetBaseServiceLifecycleStateEnumValues() []BaseServiceLifecycleStateEnum
GetBaseServiceLifecycleStateEnumValues Enumerates the set of values for BaseServiceLifecycleStateEnum
func GetMappingBaseServiceLifecycleStateEnum(val string) (BaseServiceLifecycleStateEnum, bool)
GetMappingBaseServiceLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
ChangeAnnouncementSubscriptionCompartmentDetails The details of the request to change the compartment of the announcement subscription.
type ChangeAnnouncementSubscriptionCompartmentDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment
// into which you want to move the announcement subscription.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
}
func (m ChangeAnnouncementSubscriptionCompartmentDetails) String() string
func (m ChangeAnnouncementSubscriptionCompartmentDetails) 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
ChangeAnnouncementSubscriptionCompartmentRequest wrapper for the ChangeAnnouncementSubscriptionCompartment operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/announcementsservice/ChangeAnnouncementSubscriptionCompartment.go.html to see an example of how to use ChangeAnnouncementSubscriptionCompartmentRequest.
type ChangeAnnouncementSubscriptionCompartmentRequest struct {
// The OCID of the announcement subscription.
AnnouncementSubscriptionId *string `mandatory:"true" contributesTo:"path" name:"announcementSubscriptionId"`
// The compartment information to update.
ChangeAnnouncementSubscriptionCompartmentDetails `contributesTo:"body"`
// The locking version, used for optimistic concurrency control.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The unique Oracle-assigned identifier for the request. If you need to contact Oracle about
// a particular request, please provide the complete 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 ChangeAnnouncementSubscriptionCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ChangeAnnouncementSubscriptionCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ChangeAnnouncementSubscriptionCompartmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ChangeAnnouncementSubscriptionCompartmentRequest) String() string
func (request ChangeAnnouncementSubscriptionCompartmentRequest) 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
ChangeAnnouncementSubscriptionCompartmentResponse wrapper for the ChangeAnnouncementSubscriptionCompartment operation
type ChangeAnnouncementSubscriptionCompartmentResponse 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"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
}
func (response ChangeAnnouncementSubscriptionCompartmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ChangeAnnouncementSubscriptionCompartmentResponse) String() string
CommsManagerNameEnum Enum with underlying type: string
type CommsManagerNameEnum string
Set of constants representing the allowable values for CommsManagerNameEnum
const (
CommsManagerNameCn CommsManagerNameEnum = "CN"
CommsManagerNameFusion CommsManagerNameEnum = "FUSION"
CommsManagerNameAs CommsManagerNameEnum = "AS"
CommsManagerNameErf CommsManagerNameEnum = "ERF"
)
func GetCommsManagerNameEnumValues() []CommsManagerNameEnum
GetCommsManagerNameEnumValues Enumerates the set of values for CommsManagerNameEnum
func GetMappingCommsManagerNameEnum(val string) (CommsManagerNameEnum, bool)
GetMappingCommsManagerNameEnum performs case Insensitive comparison on enum value and return the desired enum
CreateAnnouncementSubscriptionDetails The details for creating a new announcement subscription.
type CreateAnnouncementSubscriptionDetails struct {
// A user-friendly name for the announcement subscription. Does not have to be unique, and it's changeable. Avoid entering confidential information.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment where you want to create the announcement subscription.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The OCID of the Notifications service topic that is the target for publishing announcements that match the configured announcement subscription. The caller of the operation needs the ONS_TOPIC_PUBLISH permission for the targeted Notifications service topic. For more information about Notifications permissions, see Details for Notifications (https://docs.oracle.com/iaas/Content/Identity/policyreference/notificationpolicyreference.htm).
OnsTopicId *string `mandatory:"true" json:"onsTopicId"`
// A description of the announcement subscription. Avoid entering confidential information.
Description *string `mandatory:"false" json:"description"`
// A list of filter groups for the announcement subscription. A filter group combines one or more filters that the Announcements service applies to announcements for matching purposes.
FilterGroups map[string]FilterGroupDetails `mandatory:"false" json:"filterGroups"`
// (For announcement subscriptions with SaaS configured as the platform type or Oracle Fusion Applications as the service, or both, only) The language in which the user prefers to receive emailed announcements. Specify the preference with a value that uses the x-obmcs-human-language format. For example fr-FR.
PreferredLanguage *string `mandatory:"false" json:"preferredLanguage"`
// The time zone in which the user prefers to receive announcements. Specify the preference with a value that uses the IANA Time Zone Database format (x-obmcs-time-zone). For example - America/Los_Angeles
PreferredTimeZone *string `mandatory:"false" json:"preferredTimeZone"`
// 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 CreateAnnouncementSubscriptionDetails) String() string
func (m CreateAnnouncementSubscriptionDetails) 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
CreateAnnouncementSubscriptionRequest wrapper for the CreateAnnouncementSubscription operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/announcementsservice/CreateAnnouncementSubscription.go.html to see an example of how to use CreateAnnouncementSubscriptionRequest.
type CreateAnnouncementSubscriptionRequest struct {
// Details of the new announcement subscription.
CreateAnnouncementSubscriptionDetails `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"`
// The unique Oracle-assigned identifier for the request. If you need to contact Oracle about
// a particular request, please provide the complete 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 CreateAnnouncementSubscriptionRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateAnnouncementSubscriptionRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateAnnouncementSubscriptionRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateAnnouncementSubscriptionRequest) String() string
func (request CreateAnnouncementSubscriptionRequest) 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
CreateAnnouncementSubscriptionResponse wrapper for the CreateAnnouncementSubscription operation
type CreateAnnouncementSubscriptionResponse struct {
// The underlying http response
RawResponse *http.Response
// The AnnouncementSubscription instance
AnnouncementSubscription `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 CreateAnnouncementSubscriptionResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateAnnouncementSubscriptionResponse) String() string
CreateAnnouncementsPreferenceRequest wrapper for the CreateAnnouncementsPreference operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/announcementsservice/CreateAnnouncementsPreference.go.html to see an example of how to use CreateAnnouncementsPreferenceRequest.
type CreateAnnouncementsPreferenceRequest struct {
// The object that contains details about tenancy preferences for receiving announcements by email.
AnnouncementsPreferenceDetails CreateAnnouncementsPreferencesDetails `contributesTo:"body"`
// The unique Oracle-assigned identifier for the request. If you need to contact Oracle about
// a particular request, please provide the complete request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Idempotency token
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request CreateAnnouncementsPreferenceRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateAnnouncementsPreferenceRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateAnnouncementsPreferenceRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateAnnouncementsPreferenceRequest) String() string
func (request CreateAnnouncementsPreferenceRequest) 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
CreateAnnouncementsPreferenceResponse wrapper for the CreateAnnouncementsPreference operation
type CreateAnnouncementsPreferenceResponse struct {
// The underlying http response
RawResponse *http.Response
// The AnnouncementsPreferencesSummary instance
AnnouncementsPreferencesSummary `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 CreateAnnouncementsPreferenceResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateAnnouncementsPreferenceResponse) String() string
CreateAnnouncementsPreferencesDetails The object used to create announcement email preferences.
type CreateAnnouncementsPreferencesDetails struct {
// A Boolean value to indicate whether the specified compartment chooses to not to receive informational announcements by email.
// (Manage preferences for receiving announcements by email by specifying the `preferenceType` attribute instead.)
IsUnsubscribed *bool `mandatory:"false" json:"isUnsubscribed"`
// The OCID of the compartment for which you want to manage announcement email preferences. (Specify the tenancy by providing the
// root compartment OCID.)
CompartmentId *string `mandatory:"false" json:"compartmentId"`
// The time zone in which the user prefers to receive announcements. Specify the preference with a value that uses the IANA Time Zone Database format (x-obmcs-time-zone). For example - America/Los_Angeles
PreferredTimeZone *string `mandatory:"false" json:"preferredTimeZone"`
// The string representing the user's preference, whether to opt in to only required announcements, to opt in to all announcements, including informational announcements, or to opt out of all announcements.
PreferenceType BaseCreateAnnouncementsPreferencesDetailsPreferenceTypeEnum `mandatory:"true" json:"preferenceType"`
}
func (m CreateAnnouncementsPreferencesDetails) GetCompartmentId() *string
GetCompartmentId returns CompartmentId
func (m CreateAnnouncementsPreferencesDetails) GetIsUnsubscribed() *bool
GetIsUnsubscribed returns IsUnsubscribed
func (m CreateAnnouncementsPreferencesDetails) GetPreferenceType() BaseCreateAnnouncementsPreferencesDetailsPreferenceTypeEnum
GetPreferenceType returns PreferenceType
func (m CreateAnnouncementsPreferencesDetails) GetPreferredTimeZone() *string
GetPreferredTimeZone returns PreferredTimeZone
func (m CreateAnnouncementsPreferencesDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m CreateAnnouncementsPreferencesDetails) String() string
func (m CreateAnnouncementsPreferencesDetails) 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
CreateFilterGroupDetails The details for creating a new filter group for an announcement subscription.
type CreateFilterGroupDetails struct {
// The name of the filter group. The name must be unique and it cannot be changed. Avoid entering confidential information.
Name *string `mandatory:"true" json:"name"`
// A list of filters against which the Announcements service will match announcements. You cannot have more than one of any given filter type within a filter group.
Filters []Filter `mandatory:"true" json:"filters"`
}
func (m CreateFilterGroupDetails) String() string
func (m CreateFilterGroupDetails) 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
CreateFilterGroupRequest wrapper for the CreateFilterGroup operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/announcementsservice/CreateFilterGroup.go.html to see an example of how to use CreateFilterGroupRequest.
type CreateFilterGroupRequest struct {
// The OCID of the announcement subscription.
AnnouncementSubscriptionId *string `mandatory:"true" contributesTo:"path" name:"announcementSubscriptionId"`
// Details of the new filter group.
CreateFilterGroupDetails `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"`
// The unique Oracle-assigned identifier for the request. If you need to contact Oracle about
// a particular request, please provide the complete request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// The locking version, used for optimistic concurrency control.
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 CreateFilterGroupRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateFilterGroupRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateFilterGroupRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateFilterGroupRequest) String() string
func (request CreateFilterGroupRequest) 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
CreateFilterGroupResponse wrapper for the CreateFilterGroup operation
type CreateFilterGroupResponse struct {
// The underlying http response
RawResponse *http.Response
// The FilterGroup instance
FilterGroup `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 CreateFilterGroupResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateFilterGroupResponse) String() string
DeleteAnnouncementSubscriptionRequest wrapper for the DeleteAnnouncementSubscription operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/announcementsservice/DeleteAnnouncementSubscription.go.html to see an example of how to use DeleteAnnouncementSubscriptionRequest.
type DeleteAnnouncementSubscriptionRequest struct {
// The OCID of the announcement subscription.
AnnouncementSubscriptionId *string `mandatory:"true" contributesTo:"path" name:"announcementSubscriptionId"`
// The locking version, used for optimistic concurrency control.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The unique Oracle-assigned identifier for the request. If you need to contact Oracle about
// a particular request, please provide the complete 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 DeleteAnnouncementSubscriptionRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteAnnouncementSubscriptionRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteAnnouncementSubscriptionRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteAnnouncementSubscriptionRequest) String() string
func (request DeleteAnnouncementSubscriptionRequest) 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
DeleteAnnouncementSubscriptionResponse wrapper for the DeleteAnnouncementSubscription operation
type DeleteAnnouncementSubscriptionResponse 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 DeleteAnnouncementSubscriptionResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteAnnouncementSubscriptionResponse) String() string
DeleteFilterGroupRequest wrapper for the DeleteFilterGroup operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/announcementsservice/DeleteFilterGroup.go.html to see an example of how to use DeleteFilterGroupRequest.
type DeleteFilterGroupRequest struct {
// The OCID of the announcement subscription.
AnnouncementSubscriptionId *string `mandatory:"true" contributesTo:"path" name:"announcementSubscriptionId"`
// The name of the filter group.
FilterGroupName *string `mandatory:"true" contributesTo:"path" name:"filterGroupName"`
// The unique Oracle-assigned identifier for the request. If you need to contact Oracle about
// a particular request, please provide the complete request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// The locking version, used for optimistic concurrency control.
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 DeleteFilterGroupRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteFilterGroupRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteFilterGroupRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteFilterGroupRequest) String() string
func (request DeleteFilterGroupRequest) 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
DeleteFilterGroupResponse wrapper for the DeleteFilterGroup operation
type DeleteFilterGroupResponse 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"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
}
func (response DeleteFilterGroupResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteFilterGroupResponse) String() string
Filter Criteria that the Announcements service uses to match announcements so it can provide only desired announcements to subscribers.
type Filter struct {
// The type of filter. You cannot combine the RESOURCE_ID filter with any other type of filter within a given filter group. For filter types that support multiple values, specify the values individually.
Type FilterTypeEnum `mandatory:"true" json:"type"`
// The value of the filter.
Value *string `mandatory:"true" json:"value"`
}
func (m Filter) String() string
func (m Filter) 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
FilterGroup A group of filters to match announcements against.
type FilterGroup struct {
// The name of the group. The name must be unique and it cannot be changed. Avoid entering confidential information.
Name *string `mandatory:"true" json:"name"`
// A list of filters against which the Announcements service matches announcements. You cannot combine the RESOURCE_ID filter with any other type of filter within a given filter group. For filter types that support multiple values, specify the values individually.
Filters []Filter `mandatory:"true" json:"filters"`
}
func (m FilterGroup) String() string
func (m FilterGroup) 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
FilterGroupDetails The details of a group of filters to match announcements against. A filter group combines one or more individual filters.
type FilterGroupDetails struct {
// A list of filters against which the Announcements service matches announcements. You cannot combine the RESOURCE_ID filter with any other type of filter within a given filter group. For filter types that support multiple values, specify the values individually.
Filters []Filter `mandatory:"true" json:"filters"`
}
func (m FilterGroupDetails) String() string
func (m FilterGroupDetails) 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
FilterTypeEnum Enum with underlying type: string
type FilterTypeEnum string
Set of constants representing the allowable values for FilterTypeEnum
const (
FilterTypeCompartmentId FilterTypeEnum = "COMPARTMENT_ID"
FilterTypePlatformType FilterTypeEnum = "PLATFORM_TYPE"
FilterTypeRegion FilterTypeEnum = "REGION"
FilterTypeService FilterTypeEnum = "SERVICE"
FilterTypeResourceId FilterTypeEnum = "RESOURCE_ID"
FilterTypeAnnouncementType FilterTypeEnum = "ANNOUNCEMENT_TYPE"
)
func GetFilterTypeEnumValues() []FilterTypeEnum
GetFilterTypeEnumValues Enumerates the set of values for FilterTypeEnum
func GetMappingFilterTypeEnum(val string) (FilterTypeEnum, bool)
GetMappingFilterTypeEnum performs case Insensitive comparison on enum value and return the desired enum
GetAnnouncementCompartmentRequest wrapper for the GetAnnouncementCompartment operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/announcementsservice/GetAnnouncementCompartment.go.html to see an example of how to use GetAnnouncementCompartmentRequest.
type GetAnnouncementCompartmentRequest struct {
// The OCID of the announcement.
AnnouncementId *string `mandatory:"true" contributesTo:"path" name:"announcementId"`
// The unique Oracle-assigned identifier for the request. If you need to contact Oracle about
// a particular request, please provide the complete 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 GetAnnouncementCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetAnnouncementCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetAnnouncementCompartmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetAnnouncementCompartmentRequest) String() string
func (request GetAnnouncementCompartmentRequest) 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
GetAnnouncementCompartmentResponse wrapper for the GetAnnouncementCompartment operation
type GetAnnouncementCompartmentResponse struct {
// The underlying http response
RawResponse *http.Response
// The AnnouncementCompartment instance
AnnouncementCompartment `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 GetAnnouncementCompartmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetAnnouncementCompartmentResponse) String() string
GetAnnouncementRequest wrapper for the GetAnnouncement operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/announcementsservice/GetAnnouncement.go.html to see an example of how to use GetAnnouncementRequest.
type GetAnnouncementRequest struct {
// The OCID of the announcement.
AnnouncementId *string `mandatory:"true" contributesTo:"path" name:"announcementId"`
// The unique Oracle-assigned identifier for the request. If you need to contact Oracle about
// a particular request, please provide the complete 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 GetAnnouncementRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetAnnouncementRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetAnnouncementRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetAnnouncementRequest) String() string
func (request GetAnnouncementRequest) 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
GetAnnouncementResponse wrapper for the GetAnnouncement operation
type GetAnnouncementResponse struct {
// The underlying http response
RawResponse *http.Response
// The Announcement instance
Announcement `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 GetAnnouncementResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetAnnouncementResponse) String() string
GetAnnouncementSubscriptionRequest wrapper for the GetAnnouncementSubscription operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/announcementsservice/GetAnnouncementSubscription.go.html to see an example of how to use GetAnnouncementSubscriptionRequest.
type GetAnnouncementSubscriptionRequest struct {
// The OCID of the announcement subscription.
AnnouncementSubscriptionId *string `mandatory:"true" contributesTo:"path" name:"announcementSubscriptionId"`
// The unique Oracle-assigned identifier for the request. If you need to contact Oracle about
// a particular request, please provide the complete 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 GetAnnouncementSubscriptionRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetAnnouncementSubscriptionRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetAnnouncementSubscriptionRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetAnnouncementSubscriptionRequest) String() string
func (request GetAnnouncementSubscriptionRequest) 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
GetAnnouncementSubscriptionResponse wrapper for the GetAnnouncementSubscription operation
type GetAnnouncementSubscriptionResponse struct {
// The underlying http response
RawResponse *http.Response
// The AnnouncementSubscription instance
AnnouncementSubscription `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 GetAnnouncementSubscriptionResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetAnnouncementSubscriptionResponse) String() string
GetAnnouncementUserStatusRequest wrapper for the GetAnnouncementUserStatus operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/announcementsservice/GetAnnouncementUserStatus.go.html to see an example of how to use GetAnnouncementUserStatusRequest.
type GetAnnouncementUserStatusRequest struct {
// The OCID of the announcement.
AnnouncementId *string `mandatory:"true" contributesTo:"path" name:"announcementId"`
// The unique Oracle-assigned identifier for the request. If you need to contact Oracle about
// a particular request, please provide the complete 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 GetAnnouncementUserStatusRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetAnnouncementUserStatusRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetAnnouncementUserStatusRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetAnnouncementUserStatusRequest) String() string
func (request GetAnnouncementUserStatusRequest) 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
GetAnnouncementUserStatusResponse wrapper for the GetAnnouncementUserStatus operation
type GetAnnouncementUserStatusResponse struct {
// The underlying http response
RawResponse *http.Response
// The AnnouncementUserStatusDetails instance
AnnouncementUserStatusDetails `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 GetAnnouncementUserStatusResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetAnnouncementUserStatusResponse) String() string
GetAnnouncementsPreferenceRequest wrapper for the GetAnnouncementsPreference operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/announcementsservice/GetAnnouncementsPreference.go.html to see an example of how to use GetAnnouncementsPreferenceRequest.
type GetAnnouncementsPreferenceRequest struct {
// The ID of the preference.
PreferenceId *string `mandatory:"true" contributesTo:"path" name:"preferenceId"`
// The unique Oracle-assigned identifier for the request. If you need to contact Oracle about
// a particular request, please provide the complete 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 GetAnnouncementsPreferenceRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetAnnouncementsPreferenceRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetAnnouncementsPreferenceRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetAnnouncementsPreferenceRequest) String() string
func (request GetAnnouncementsPreferenceRequest) 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
GetAnnouncementsPreferenceResponse wrapper for the GetAnnouncementsPreference operation
type GetAnnouncementsPreferenceResponse struct {
// The underlying http response
RawResponse *http.Response
// The AnnouncementsPreferences instance
AnnouncementsPreferences `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 GetAnnouncementsPreferenceResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetAnnouncementsPreferenceResponse) String() string
ListAnnouncementSubscriptionsRequest wrapper for the ListAnnouncementSubscriptions operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/announcementsservice/ListAnnouncementSubscriptions.go.html to see an example of how to use ListAnnouncementSubscriptionsRequest.
type ListAnnouncementSubscriptionsRequest struct {
// The OCID of the compartment.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// A filter to return only announcement subscriptions that match the given lifecycle state.
LifecycleState AnnouncementSubscriptionLifecycleStateEnum `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 OCID of the announcement subscription.
Id *string `mandatory:"false" contributesTo:"query" name:"id"`
// The maximum number of items to return in a paginated "List" call.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The value of the `opc-next-page` response header from the previous "List" call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The sort order to use, whether ascending ('ASC') or descending ('DESC').
SortOrder ListAnnouncementSubscriptionsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The criteria to sort by. You can specify only one sort order. The default sort order for the creation date of resources is descending. The default sort order for display names is ascending.
SortBy ListAnnouncementSubscriptionsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The unique Oracle-assigned identifier for the request. If you need to contact Oracle about
// a particular request, please provide the complete 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 ListAnnouncementSubscriptionsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListAnnouncementSubscriptionsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListAnnouncementSubscriptionsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListAnnouncementSubscriptionsRequest) String() string
func (request ListAnnouncementSubscriptionsRequest) 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
ListAnnouncementSubscriptionsResponse wrapper for the ListAnnouncementSubscriptions operation
type ListAnnouncementSubscriptionsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of AnnouncementSubscriptionCollection instances
AnnouncementSubscriptionCollection `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 ListAnnouncementSubscriptionsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListAnnouncementSubscriptionsResponse) String() string
ListAnnouncementSubscriptionsSortByEnum Enum with underlying type: string
type ListAnnouncementSubscriptionsSortByEnum string
Set of constants representing the allowable values for ListAnnouncementSubscriptionsSortByEnum
const (
ListAnnouncementSubscriptionsSortByTimecreated ListAnnouncementSubscriptionsSortByEnum = "timeCreated"
ListAnnouncementSubscriptionsSortByDisplayname ListAnnouncementSubscriptionsSortByEnum = "displayName"
)
func GetListAnnouncementSubscriptionsSortByEnumValues() []ListAnnouncementSubscriptionsSortByEnum
GetListAnnouncementSubscriptionsSortByEnumValues Enumerates the set of values for ListAnnouncementSubscriptionsSortByEnum
func GetMappingListAnnouncementSubscriptionsSortByEnum(val string) (ListAnnouncementSubscriptionsSortByEnum, bool)
GetMappingListAnnouncementSubscriptionsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListAnnouncementSubscriptionsSortOrderEnum Enum with underlying type: string
type ListAnnouncementSubscriptionsSortOrderEnum string
Set of constants representing the allowable values for ListAnnouncementSubscriptionsSortOrderEnum
const (
ListAnnouncementSubscriptionsSortOrderAsc ListAnnouncementSubscriptionsSortOrderEnum = "ASC"
ListAnnouncementSubscriptionsSortOrderDesc ListAnnouncementSubscriptionsSortOrderEnum = "DESC"
)
func GetListAnnouncementSubscriptionsSortOrderEnumValues() []ListAnnouncementSubscriptionsSortOrderEnum
GetListAnnouncementSubscriptionsSortOrderEnumValues Enumerates the set of values for ListAnnouncementSubscriptionsSortOrderEnum
func GetMappingListAnnouncementSubscriptionsSortOrderEnum(val string) (ListAnnouncementSubscriptionsSortOrderEnum, bool)
GetMappingListAnnouncementSubscriptionsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListAnnouncementsLifecycleStateEnum Enum with underlying type: string
type ListAnnouncementsLifecycleStateEnum string
Set of constants representing the allowable values for ListAnnouncementsLifecycleStateEnum
const (
ListAnnouncementsLifecycleStateActive ListAnnouncementsLifecycleStateEnum = "ACTIVE"
ListAnnouncementsLifecycleStateInactive ListAnnouncementsLifecycleStateEnum = "INACTIVE"
)
func GetListAnnouncementsLifecycleStateEnumValues() []ListAnnouncementsLifecycleStateEnum
GetListAnnouncementsLifecycleStateEnumValues Enumerates the set of values for ListAnnouncementsLifecycleStateEnum
func GetMappingListAnnouncementsLifecycleStateEnum(val string) (ListAnnouncementsLifecycleStateEnum, bool)
GetMappingListAnnouncementsLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
ListAnnouncementsPlatformTypeEnum Enum with underlying type: string
type ListAnnouncementsPlatformTypeEnum string
Set of constants representing the allowable values for ListAnnouncementsPlatformTypeEnum
const (
ListAnnouncementsPlatformTypeIaas ListAnnouncementsPlatformTypeEnum = "IAAS"
ListAnnouncementsPlatformTypeSaas ListAnnouncementsPlatformTypeEnum = "SAAS"
ListAnnouncementsPlatformTypePaas ListAnnouncementsPlatformTypeEnum = "PAAS"
)
func GetListAnnouncementsPlatformTypeEnumValues() []ListAnnouncementsPlatformTypeEnum
GetListAnnouncementsPlatformTypeEnumValues Enumerates the set of values for ListAnnouncementsPlatformTypeEnum
func GetMappingListAnnouncementsPlatformTypeEnum(val string) (ListAnnouncementsPlatformTypeEnum, bool)
GetMappingListAnnouncementsPlatformTypeEnum performs case Insensitive comparison on enum value and return the desired enum
ListAnnouncementsPreferencesRequest wrapper for the ListAnnouncementsPreferences operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/announcementsservice/ListAnnouncementsPreferences.go.html to see an example of how to use ListAnnouncementsPreferencesRequest.
type ListAnnouncementsPreferencesRequest struct {
// The OCID of the compartment.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// The maximum number of items to return in a paginated "List" call.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The value of the `opc-next-page` response header from the previous "List" call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The unique Oracle-assigned identifier for the request. If you need to contact Oracle about
// a particular request, please provide the complete 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 ListAnnouncementsPreferencesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListAnnouncementsPreferencesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListAnnouncementsPreferencesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListAnnouncementsPreferencesRequest) String() string
func (request ListAnnouncementsPreferencesRequest) 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
ListAnnouncementsPreferencesResponse wrapper for the ListAnnouncementsPreferences operation
type ListAnnouncementsPreferencesResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []AnnouncementsPreferencesSummary instances
Items []AnnouncementsPreferencesSummary `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 ListAnnouncementsPreferencesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListAnnouncementsPreferencesResponse) String() string
ListAnnouncementsRequest wrapper for the ListAnnouncements operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/announcementsservice/ListAnnouncements.go.html to see an example of how to use ListAnnouncementsRequest.
type ListAnnouncementsRequest struct {
// The OCID of the compartment.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// The maximum number of items to return in a paginated "List" call.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The value of the `opc-next-page` response header from the previous "List" call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The type of announcement.
AnnouncementType *string `mandatory:"false" contributesTo:"query" name:"announcementType"`
// The announcement's current lifecycle state.
LifecycleState ListAnnouncementsLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// Whether the announcement is displayed as a console banner.
IsBanner *bool `mandatory:"false" contributesTo:"query" name:"isBanner"`
// The criteria to sort by. You can specify only one sort order.
SortBy ListAnnouncementsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The sort order to use. (Sorting by `announcementType` orders the announcements list according to importance.)
SortOrder ListAnnouncementsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The boundary for the earliest `timeOneValue` date on announcements that you want to see.
TimeOneEarliestTime *common.SDKTime `mandatory:"false" contributesTo:"query" name:"timeOneEarliestTime"`
// The boundary for the latest `timeOneValue` date on announcements that you want to see.
TimeOneLatestTime *common.SDKTime `mandatory:"false" contributesTo:"query" name:"timeOneLatestTime"`
// A filter to return only announcements that match a specific environment name.
EnvironmentName *string `mandatory:"false" contributesTo:"query" name:"environmentName"`
// A filter to return only announcements affecting a specific service.
Service *string `mandatory:"false" contributesTo:"query" name:"service"`
// A filter to return only announcements affecting a specific platform.
PlatformType ListAnnouncementsPlatformTypeEnum `mandatory:"false" contributesTo:"query" name:"platformType" omitEmpty:"true"`
// Exclude The type of announcement.
ExcludeAnnouncementTypes []string `contributesTo:"query" name:"excludeAnnouncementTypes" collectionFormat:"multi"`
// A filter to display only the latest announcement in a chain.
ShouldShowOnlyLatestInChain *bool `mandatory:"false" contributesTo:"query" name:"shouldShowOnlyLatestInChain"`
// A filter to return only announcements belonging to the specified announcement chain ID.
ChainId *string `mandatory:"false" contributesTo:"query" name:"chainId"`
// The unique Oracle-assigned identifier for the request. If you need to contact Oracle about
// a particular request, please provide the complete 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 ListAnnouncementsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListAnnouncementsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListAnnouncementsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListAnnouncementsRequest) String() string
func (request ListAnnouncementsRequest) 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
ListAnnouncementsResponse wrapper for the ListAnnouncements operation
type ListAnnouncementsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of AnnouncementsCollection instances
AnnouncementsCollection `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"`
// For pagination of a list of items. Include this value as the `page` parameter for the
// subsequent GET request to get the previous batch of items.
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 ListAnnouncementsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListAnnouncementsResponse) String() string
ListAnnouncementsSortByEnum Enum with underlying type: string
type ListAnnouncementsSortByEnum string
Set of constants representing the allowable values for ListAnnouncementsSortByEnum
const (
ListAnnouncementsSortByTimeonevalue ListAnnouncementsSortByEnum = "timeOneValue"
ListAnnouncementsSortByTimetwovalue ListAnnouncementsSortByEnum = "timeTwoValue"
ListAnnouncementsSortByTimecreated ListAnnouncementsSortByEnum = "timeCreated"
ListAnnouncementsSortByReferenceticketnumber ListAnnouncementsSortByEnum = "referenceTicketNumber"
ListAnnouncementsSortBySummary ListAnnouncementsSortByEnum = "summary"
ListAnnouncementsSortByAnnouncementtype ListAnnouncementsSortByEnum = "announcementType"
)
func GetListAnnouncementsSortByEnumValues() []ListAnnouncementsSortByEnum
GetListAnnouncementsSortByEnumValues Enumerates the set of values for ListAnnouncementsSortByEnum
func GetMappingListAnnouncementsSortByEnum(val string) (ListAnnouncementsSortByEnum, bool)
GetMappingListAnnouncementsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListAnnouncementsSortOrderEnum Enum with underlying type: string
type ListAnnouncementsSortOrderEnum string
Set of constants representing the allowable values for ListAnnouncementsSortOrderEnum
const (
ListAnnouncementsSortOrderAsc ListAnnouncementsSortOrderEnum = "ASC"
ListAnnouncementsSortOrderDesc ListAnnouncementsSortOrderEnum = "DESC"
)
func GetListAnnouncementsSortOrderEnumValues() []ListAnnouncementsSortOrderEnum
GetListAnnouncementsSortOrderEnumValues Enumerates the set of values for ListAnnouncementsSortOrderEnum
func GetMappingListAnnouncementsSortOrderEnum(val string) (ListAnnouncementsSortOrderEnum, bool)
GetMappingListAnnouncementsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListServicesCommsManagerNameEnum Enum with underlying type: string
type ListServicesCommsManagerNameEnum string
Set of constants representing the allowable values for ListServicesCommsManagerNameEnum
const (
ListServicesCommsManagerNameCn ListServicesCommsManagerNameEnum = "CN"
ListServicesCommsManagerNameFusion ListServicesCommsManagerNameEnum = "FUSION"
ListServicesCommsManagerNameAs ListServicesCommsManagerNameEnum = "AS"
ListServicesCommsManagerNameErf ListServicesCommsManagerNameEnum = "ERF"
)
func GetListServicesCommsManagerNameEnumValues() []ListServicesCommsManagerNameEnum
GetListServicesCommsManagerNameEnumValues Enumerates the set of values for ListServicesCommsManagerNameEnum
func GetMappingListServicesCommsManagerNameEnum(val string) (ListServicesCommsManagerNameEnum, bool)
GetMappingListServicesCommsManagerNameEnum performs case Insensitive comparison on enum value and return the desired enum
ListServicesPlatformTypeEnum Enum with underlying type: string
type ListServicesPlatformTypeEnum string
Set of constants representing the allowable values for ListServicesPlatformTypeEnum
const (
ListServicesPlatformTypeIaas ListServicesPlatformTypeEnum = "IAAS"
ListServicesPlatformTypeSaas ListServicesPlatformTypeEnum = "SAAS"
ListServicesPlatformTypePaas ListServicesPlatformTypeEnum = "PAAS"
)
func GetListServicesPlatformTypeEnumValues() []ListServicesPlatformTypeEnum
GetListServicesPlatformTypeEnumValues Enumerates the set of values for ListServicesPlatformTypeEnum
func GetMappingListServicesPlatformTypeEnum(val string) (ListServicesPlatformTypeEnum, bool)
GetMappingListServicesPlatformTypeEnum performs case Insensitive comparison on enum value and return the desired enum
ListServicesRequest wrapper for the ListServices operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/announcementsservice/ListServices.go.html to see an example of how to use ListServicesRequest.
type ListServicesRequest struct {
// The OCID of the compartment.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// A filter to return only announcements affecting a specific platform.
PlatformType ListServicesPlatformTypeEnum `mandatory:"false" contributesTo:"query" name:"platformType" omitEmpty:"true"`
// Filter by comms manager name
CommsManagerName ListServicesCommsManagerNameEnum `mandatory:"false" contributesTo:"query" name:"commsManagerName" omitEmpty:"true"`
// The maximum number of items to return in a paginated "List" call.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The value of the `opc-next-page` response header from the previous "List" call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// Sort by service name parameter
SortBy ListServicesSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The sort order to use, whether ascending ('ASC') or descending ('DESC').
SortOrder ListServicesSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The unique Oracle-assigned identifier for the request. If you need to contact Oracle about
// a particular request, please provide the complete 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 ListServicesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListServicesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListServicesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListServicesRequest) String() string
func (request ListServicesRequest) 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
ListServicesResponse wrapper for the ListServices operation
type ListServicesResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of ServicesCollection instances
ServicesCollection `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 ListServicesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListServicesResponse) String() string
ListServicesSortByEnum Enum with underlying type: string
type ListServicesSortByEnum string
Set of constants representing the allowable values for ListServicesSortByEnum
const (
ListServicesSortByServicename ListServicesSortByEnum = "serviceName"
)
func GetListServicesSortByEnumValues() []ListServicesSortByEnum
GetListServicesSortByEnumValues Enumerates the set of values for ListServicesSortByEnum
func GetMappingListServicesSortByEnum(val string) (ListServicesSortByEnum, bool)
GetMappingListServicesSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListServicesSortOrderEnum Enum with underlying type: string
type ListServicesSortOrderEnum string
Set of constants representing the allowable values for ListServicesSortOrderEnum
const (
ListServicesSortOrderAsc ListServicesSortOrderEnum = "ASC"
ListServicesSortOrderDesc ListServicesSortOrderEnum = "DESC"
)
func GetListServicesSortOrderEnumValues() []ListServicesSortOrderEnum
GetListServicesSortOrderEnumValues Enumerates the set of values for ListServicesSortOrderEnum
func GetMappingListServicesSortOrderEnum(val string) (ListServicesSortOrderEnum, bool)
GetMappingListServicesSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
NotificationsSummary Summary of notification object, return by List API
type NotificationsSummary struct {
// ID of the service object.
Id *string `mandatory:"true" json:"id"`
// Name of the service represented by this object.
ServiceName *string `mandatory:"true" json:"serviceName"`
// Short name of the team to whom this service object is related.
ShortName *string `mandatory:"true" json:"shortName"`
// Team name to which this service object is related.
TeamName *string `mandatory:"true" json:"teamName"`
// The list of realms where this service is not available to be used.
ExcludedRealms []string `mandatory:"true" json:"excludedRealms"`
// The list of previously used names for this service object.
PreviousServiceNames []string `mandatory:"true" json:"previousServiceNames"`
// The date and time when the service object was created.
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// The date and time when the service object was updated.
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// The platform type this service object is related to.
PlatformType PlatformTypeEnum `mandatory:"true" json:"platformType"`
// Name of the comms manager team that manages Notifications to this service.
CommsManagerName CommsManagerNameEnum `mandatory:"true" json:"commsManagerName"`
// Current state of the service object.
LifecycleState BaseServiceLifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
}
func (m NotificationsSummary) GetCommsManagerName() CommsManagerNameEnum
GetCommsManagerName returns CommsManagerName
func (m NotificationsSummary) GetExcludedRealms() []string
GetExcludedRealms returns ExcludedRealms
func (m NotificationsSummary) GetId() *string
GetId returns Id
func (m NotificationsSummary) GetLifecycleState() BaseServiceLifecycleStateEnum
GetLifecycleState returns LifecycleState
func (m NotificationsSummary) GetPlatformType() PlatformTypeEnum
GetPlatformType returns PlatformType
func (m NotificationsSummary) GetPreviousServiceNames() []string
GetPreviousServiceNames returns PreviousServiceNames
func (m NotificationsSummary) GetServiceName() *string
GetServiceName returns ServiceName
func (m NotificationsSummary) GetShortName() *string
GetShortName returns ShortName
func (m NotificationsSummary) GetTeamName() *string
GetTeamName returns TeamName
func (m NotificationsSummary) GetTimeCreated() *common.SDKTime
GetTimeCreated returns TimeCreated
func (m NotificationsSummary) GetTimeUpdated() *common.SDKTime
GetTimeUpdated returns TimeUpdated
func (m NotificationsSummary) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m NotificationsSummary) String() string
func (m NotificationsSummary) 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
PlatformTypeEnum Enum with underlying type: string
type PlatformTypeEnum string
Set of constants representing the allowable values for PlatformTypeEnum
const (
PlatformTypeIaas PlatformTypeEnum = "IAAS"
PlatformTypeSaas PlatformTypeEnum = "SAAS"
PlatformTypePaas PlatformTypeEnum = "PAAS"
)
func GetMappingPlatformTypeEnum(val string) (PlatformTypeEnum, bool)
GetMappingPlatformTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetPlatformTypeEnumValues() []PlatformTypeEnum
GetPlatformTypeEnumValues Enumerates the set of values for PlatformTypeEnum
Property A generic property that might be associated with the affected resource.
type Property struct {
// The name of the property.
Name *string `mandatory:"true" json:"name"`
// The value of the property.
Value *string `mandatory:"true" json:"value"`
}
func (m Property) String() string
func (m Property) 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
Service Summary of the service object.
type Service struct {
// ID of the service object.
Id *string `mandatory:"true" json:"id"`
// Name of the service represented by this object.
ServiceName *string `mandatory:"true" json:"serviceName"`
// Short name of the team to whom this service object is related.
ShortName *string `mandatory:"true" json:"shortName"`
// Team name to which this service object is related.
TeamName *string `mandatory:"true" json:"teamName"`
// The list of realms where this service is not available to be used.
ExcludedRealms []string `mandatory:"true" json:"excludedRealms"`
// The list of previously used names for this service object.
PreviousServiceNames []string `mandatory:"true" json:"previousServiceNames"`
// The date and time when the service object was created.
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// The date and time when the service object was updated.
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// The platform type this service object is related to.
PlatformType PlatformTypeEnum `mandatory:"true" json:"platformType"`
// Name of the comms manager team that manages Notifications to this service.
CommsManagerName CommsManagerNameEnum `mandatory:"true" json:"commsManagerName"`
// Current state of the service object.
LifecycleState BaseServiceLifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
}
func (m Service) GetCommsManagerName() CommsManagerNameEnum
GetCommsManagerName returns CommsManagerName
func (m Service) GetExcludedRealms() []string
GetExcludedRealms returns ExcludedRealms
func (m Service) GetId() *string
GetId returns Id
func (m Service) GetLifecycleState() BaseServiceLifecycleStateEnum
GetLifecycleState returns LifecycleState
func (m Service) GetPlatformType() PlatformTypeEnum
GetPlatformType returns PlatformType
func (m Service) GetPreviousServiceNames() []string
GetPreviousServiceNames returns PreviousServiceNames
func (m Service) GetServiceName() *string
GetServiceName returns ServiceName
func (m Service) GetShortName() *string
GetShortName returns ShortName
func (m Service) GetTeamName() *string
GetTeamName returns TeamName
func (m Service) GetTimeCreated() *common.SDKTime
GetTimeCreated returns TimeCreated
func (m Service) GetTimeUpdated() *common.SDKTime
GetTimeUpdated returns TimeUpdated
func (m Service) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m Service) String() string
func (m Service) 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
ServiceClient a client for Service
type ServiceClient struct {
common.BaseClient
// contains filtered or unexported fields
}
func NewServiceClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client ServiceClient, err error)
NewServiceClientWithConfigurationProvider Creates a new default Service client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region
func NewServiceClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client ServiceClient, err error)
NewServiceClientWithOboToken Creates a new default Service 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 *ServiceClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client ServiceClient) ListServices(ctx context.Context, request ListServicesRequest) (response ListServicesResponse, err error)
ListServices List all active services
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/announcementsservice/ListServices.go.html to see an example of how to use ListServices API.
func (client *ServiceClient) SetRegion(region string)
SetRegion overrides the region of this client.
ServiceSummary Summary of the service object.
type ServiceSummary struct {
// ID of the service object.
Id *string `mandatory:"true" json:"id"`
// Name of the service represented by this object.
ServiceName *string `mandatory:"true" json:"serviceName"`
// Short name of the team to whom this service object is related.
ShortName *string `mandatory:"true" json:"shortName"`
// Team name to which this service object is related.
TeamName *string `mandatory:"true" json:"teamName"`
// The list of realms where this service is not available to be used.
ExcludedRealms []string `mandatory:"true" json:"excludedRealms"`
// The list of previously used names for this service object.
PreviousServiceNames []string `mandatory:"true" json:"previousServiceNames"`
// The date and time when the service object was created.
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// The date and time when the service object was updated.
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// The platform type this service object is related to.
PlatformType PlatformTypeEnum `mandatory:"true" json:"platformType"`
// Name of the comms manager team that manages Notifications to this service.
CommsManagerName CommsManagerNameEnum `mandatory:"true" json:"commsManagerName"`
// Current state of the service object.
LifecycleState BaseServiceLifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
}
func (m ServiceSummary) GetCommsManagerName() CommsManagerNameEnum
GetCommsManagerName returns CommsManagerName
func (m ServiceSummary) GetExcludedRealms() []string
GetExcludedRealms returns ExcludedRealms
func (m ServiceSummary) GetId() *string
GetId returns Id
func (m ServiceSummary) GetLifecycleState() BaseServiceLifecycleStateEnum
GetLifecycleState returns LifecycleState
func (m ServiceSummary) GetPlatformType() PlatformTypeEnum
GetPlatformType returns PlatformType
func (m ServiceSummary) GetPreviousServiceNames() []string
GetPreviousServiceNames returns PreviousServiceNames
func (m ServiceSummary) GetServiceName() *string
GetServiceName returns ServiceName
func (m ServiceSummary) GetShortName() *string
GetShortName returns ShortName
func (m ServiceSummary) GetTeamName() *string
GetTeamName returns TeamName
func (m ServiceSummary) GetTimeCreated() *common.SDKTime
GetTimeCreated returns TimeCreated
func (m ServiceSummary) GetTimeUpdated() *common.SDKTime
GetTimeUpdated returns TimeUpdated
func (m ServiceSummary) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m ServiceSummary) String() string
func (m ServiceSummary) 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
ServicesCollection Collection of all services.
type ServicesCollection struct {
// List of all services.
Items []ServiceSummary `mandatory:"true" json:"items"`
}
func (m ServicesCollection) String() string
func (m ServicesCollection) 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
UpdateAnnouncementSubscriptionDetails The details for updating an announcement subscription.
type UpdateAnnouncementSubscriptionDetails struct {
// A user-friendly name for the announcement subscription. Does not have to be unique, and it's changeable. Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// A description of the announcement subscription. Avoid entering confidential information.
Description *string `mandatory:"false" json:"description"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Notifications service topic that is the target for publishing announcements that match the configured announcement subscription. The caller of the operation needs the ONS_TOPIC_PUBLISH permission for the targeted Notifications service topic. For more information about Notifications permissions, see Details for Notifications (https://docs.oracle.com/iaas/Content/Identity/policyreference/notificationpolicyreference.htm).
OnsTopicId *string `mandatory:"false" json:"onsTopicId"`
// (For announcement subscriptions with SaaS configured as the platform type or Oracle Fusion Applications as the service, or both, only) The language in which the user prefers to receive emailed announcements. Specify the preference with a value that uses the x-obmcs-human-language format. For example fr-FR.
PreferredLanguage *string `mandatory:"false" json:"preferredLanguage"`
// The time zone in which the user prefers to receive announcements. Specify the preference with a value that uses the IANA Time Zone Database format (x-obmcs-time-zone). For example - America/Los_Angeles
PreferredTimeZone *string `mandatory:"false" json:"preferredTimeZone"`
// 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 UpdateAnnouncementSubscriptionDetails) String() string
func (m UpdateAnnouncementSubscriptionDetails) 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
UpdateAnnouncementSubscriptionRequest wrapper for the UpdateAnnouncementSubscription operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/announcementsservice/UpdateAnnouncementSubscription.go.html to see an example of how to use UpdateAnnouncementSubscriptionRequest.
type UpdateAnnouncementSubscriptionRequest struct {
// The OCID of the announcement subscription.
AnnouncementSubscriptionId *string `mandatory:"true" contributesTo:"path" name:"announcementSubscriptionId"`
// The subscription information to update.
UpdateAnnouncementSubscriptionDetails `contributesTo:"body"`
// The locking version, used for optimistic concurrency control.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The unique Oracle-assigned identifier for the request. If you need to contact Oracle about
// a particular request, please provide the complete 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 UpdateAnnouncementSubscriptionRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateAnnouncementSubscriptionRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateAnnouncementSubscriptionRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateAnnouncementSubscriptionRequest) String() string
func (request UpdateAnnouncementSubscriptionRequest) 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
UpdateAnnouncementSubscriptionResponse wrapper for the UpdateAnnouncementSubscription operation
type UpdateAnnouncementSubscriptionResponse struct {
// The underlying http response
RawResponse *http.Response
// The AnnouncementSubscription instance
AnnouncementSubscription `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 UpdateAnnouncementSubscriptionResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateAnnouncementSubscriptionResponse) String() string
UpdateAnnouncementUserStatusRequest wrapper for the UpdateAnnouncementUserStatus operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/announcementsservice/UpdateAnnouncementUserStatus.go.html to see an example of how to use UpdateAnnouncementUserStatusRequest.
type UpdateAnnouncementUserStatusRequest struct {
// The OCID of the announcement.
AnnouncementId *string `mandatory:"true" contributesTo:"path" name:"announcementId"`
// The information to use to update the announcement's read status.
StatusDetails AnnouncementUserStatusDetails `contributesTo:"body"`
// The locking version, used for optimistic concurrency control.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The unique Oracle-assigned identifier for the request. If you need to contact Oracle about
// a particular request, please provide the complete 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 UpdateAnnouncementUserStatusRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateAnnouncementUserStatusRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateAnnouncementUserStatusRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateAnnouncementUserStatusRequest) String() string
func (request UpdateAnnouncementUserStatusRequest) 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
UpdateAnnouncementUserStatusResponse wrapper for the UpdateAnnouncementUserStatus operation
type UpdateAnnouncementUserStatusResponse struct {
// The underlying http response
RawResponse *http.Response
// The AnnouncementUserStatusDetails instance
AnnouncementUserStatusDetails `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 UpdateAnnouncementUserStatusResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateAnnouncementUserStatusResponse) String() string
UpdateAnnouncementsPreferenceRequest wrapper for the UpdateAnnouncementsPreference operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/announcementsservice/UpdateAnnouncementsPreference.go.html to see an example of how to use UpdateAnnouncementsPreferenceRequest.
type UpdateAnnouncementsPreferenceRequest struct {
// The ID of the preference.
PreferenceId *string `mandatory:"true" contributesTo:"path" name:"preferenceId"`
// The object that contains details about tenancy preferences for receiving announcements by email.
AnnouncementsPreferenceDetails UpdateAnnouncementsPreferencesDetails `contributesTo:"body"`
// The unique Oracle-assigned identifier for the request. If you need to contact Oracle about
// a particular request, please provide the complete request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// The locking version, used for optimistic concurrency control.
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 UpdateAnnouncementsPreferenceRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateAnnouncementsPreferenceRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateAnnouncementsPreferenceRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateAnnouncementsPreferenceRequest) String() string
func (request UpdateAnnouncementsPreferenceRequest) 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
UpdateAnnouncementsPreferenceResponse wrapper for the UpdateAnnouncementsPreference operation
type UpdateAnnouncementsPreferenceResponse struct {
// The underlying http response
RawResponse *http.Response
// The AnnouncementsPreferencesSummary instance
AnnouncementsPreferencesSummary `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 UpdateAnnouncementsPreferenceResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateAnnouncementsPreferenceResponse) String() string
UpdateAnnouncementsPreferencesDetails The object used to update announcement email preferences.
type UpdateAnnouncementsPreferencesDetails struct {
// A Boolean value to indicate whether the specified compartment chooses to not to receive informational announcements by email.
// (Manage preferences for receiving announcements by email by specifying the `preferenceType` attribute instead.)
IsUnsubscribed *bool `mandatory:"false" json:"isUnsubscribed"`
// The OCID of the compartment for which you want to manage announcement email preferences. (Specify the tenancy by providing the
// root compartment OCID.)
CompartmentId *string `mandatory:"false" json:"compartmentId"`
// The time zone in which the user prefers to receive announcements. Specify the preference with a value that uses the IANA Time Zone Database format (x-obmcs-time-zone). For example - America/Los_Angeles
PreferredTimeZone *string `mandatory:"false" json:"preferredTimeZone"`
// The string representing the user's preference, whether to opt in to only required announcements, to opt in to all announcements, including informational announcements, or to opt out of all announcements.
PreferenceType BaseCreateAnnouncementsPreferencesDetailsPreferenceTypeEnum `mandatory:"true" json:"preferenceType"`
}
func (m UpdateAnnouncementsPreferencesDetails) GetCompartmentId() *string
GetCompartmentId returns CompartmentId
func (m UpdateAnnouncementsPreferencesDetails) GetIsUnsubscribed() *bool
GetIsUnsubscribed returns IsUnsubscribed
func (m UpdateAnnouncementsPreferencesDetails) GetPreferenceType() BaseCreateAnnouncementsPreferencesDetailsPreferenceTypeEnum
GetPreferenceType returns PreferenceType
func (m UpdateAnnouncementsPreferencesDetails) GetPreferredTimeZone() *string
GetPreferredTimeZone returns PreferredTimeZone
func (m UpdateAnnouncementsPreferencesDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m UpdateAnnouncementsPreferencesDetails) String() string
func (m UpdateAnnouncementsPreferencesDetails) 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
UpdateFilterGroupDetails The details for updating a filter group in an announcement subscription.
type UpdateFilterGroupDetails struct {
// A list of filters against which the Announcements service will match announcements. You cannot combine the RESOURCE_ID filter with any other type of filter within a given filter group. For filter types that support multiple values, specify the values individually.
Filters []Filter `mandatory:"true" json:"filters"`
}
func (m UpdateFilterGroupDetails) String() string
func (m UpdateFilterGroupDetails) 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
UpdateFilterGroupRequest wrapper for the UpdateFilterGroup operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/announcementsservice/UpdateFilterGroup.go.html to see an example of how to use UpdateFilterGroupRequest.
type UpdateFilterGroupRequest struct {
// The OCID of the announcement subscription.
AnnouncementSubscriptionId *string `mandatory:"true" contributesTo:"path" name:"announcementSubscriptionId"`
// The name of the filter group.
FilterGroupName *string `mandatory:"true" contributesTo:"path" name:"filterGroupName"`
// The filter group information to update.
UpdateFilterGroupDetails `contributesTo:"body"`
// The unique Oracle-assigned identifier for the request. If you need to contact Oracle about
// a particular request, please provide the complete request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// The locking version, used for optimistic concurrency control.
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 UpdateFilterGroupRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateFilterGroupRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateFilterGroupRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateFilterGroupRequest) String() string
func (request UpdateFilterGroupRequest) 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
UpdateFilterGroupResponse wrapper for the UpdateFilterGroup operation
type UpdateFilterGroupResponse struct {
// The underlying http response
RawResponse *http.Response
// The FilterGroup instance
FilterGroup `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 UpdateFilterGroupResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateFilterGroupResponse) String() string