announcementsservice

package
v54.0.0 Latest Latest
Warning

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

 Go to latest Published: Dec 14, 2021 License: Apache-2.0, UPL-1.0 Imports: 6 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AffectedResource 

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

AffectedResource The resource affected by the event described in the announcement.

func (AffectedResource) String 

func (m AffectedResource) String() string

type Announcement 

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

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

Announcement A message about an impactful operational event.

func (Announcement) GetAffectedRegions 

func (m Announcement) GetAffectedRegions() []string

GetAffectedRegions returns AffectedRegions

func (Announcement) GetAnnouncementType 

func (m Announcement) GetAnnouncementType() BaseAnnouncementAnnouncementTypeEnum

GetAnnouncementType returns AnnouncementType

func (Announcement) GetId 

func (m Announcement) GetId() *string

GetId returns Id

func (Announcement) GetIsBanner 

func (m Announcement) GetIsBanner() *bool

GetIsBanner returns IsBanner

func (Announcement) GetLifecycleState 

func (m Announcement) GetLifecycleState() BaseAnnouncementLifecycleStateEnum

GetLifecycleState returns LifecycleState

func (Announcement) GetReferenceTicketNumber 

func (m Announcement) GetReferenceTicketNumber() *string

GetReferenceTicketNumber returns ReferenceTicketNumber

func (Announcement) GetServices 

func (m Announcement) GetServices() []string

GetServices returns Services

func (Announcement) GetSummary 

func (m Announcement) GetSummary() *string

GetSummary returns Summary

func (Announcement) GetTimeCreated 

func (m Announcement) GetTimeCreated() *common.SDKTime

GetTimeCreated returns TimeCreated

func (Announcement) GetTimeOneTitle 

func (m Announcement) GetTimeOneTitle() *string

GetTimeOneTitle returns TimeOneTitle

func (Announcement) GetTimeOneType 

func (m Announcement) GetTimeOneType() BaseAnnouncementTimeOneTypeEnum

GetTimeOneType returns TimeOneType

func (Announcement) GetTimeOneValue 

func (m Announcement) GetTimeOneValue() *common.SDKTime

GetTimeOneValue returns TimeOneValue

func (Announcement) GetTimeTwoTitle 

func (m Announcement) GetTimeTwoTitle() *string

GetTimeTwoTitle returns TimeTwoTitle

func (Announcement) GetTimeTwoType 

func (m Announcement) GetTimeTwoType() BaseAnnouncementTimeTwoTypeEnum

GetTimeTwoType returns TimeTwoType

func (Announcement) GetTimeTwoValue 

func (m Announcement) GetTimeTwoValue() *common.SDKTime

GetTimeTwoValue returns TimeTwoValue

func (Announcement) GetTimeUpdated 

func (m Announcement) GetTimeUpdated() *common.SDKTime

GetTimeUpdated returns TimeUpdated

func (Announcement) MarshalJSON 

func (m Announcement) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (Announcement) String 

func (m Announcement) String() string

type AnnouncementClient 

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

AnnouncementClient a client for Announcement

func NewAnnouncementClientWithConfigurationProvider 

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 

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 (*AnnouncementClient) ConfigurationProvider 

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

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

func (AnnouncementClient) GetAnnouncement 

func (client AnnouncementClient) GetAnnouncement(ctx context.Context, request GetAnnouncementRequest) (response GetAnnouncementResponse, err error)

GetAnnouncement Gets the details of a specific announcement.

See also

Click https://docs.cloud.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 (AnnouncementClient) GetAnnouncementUserStatus 

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.

See also

Click https://docs.cloud.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 (AnnouncementClient) ListAnnouncements 

func (client AnnouncementClient) ListAnnouncements(ctx context.Context, request ListAnnouncementsRequest) (response ListAnnouncementsResponse, err error)

ListAnnouncements Gets a list of announcements for the current tenancy.

See also

Click https://docs.cloud.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 (*AnnouncementClient) SetRegion 

func (client *AnnouncementClient) SetRegion(region string)

SetRegion overrides the region of this client.

func (AnnouncementClient) UpdateAnnouncementUserStatus 

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.

See also

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

type AnnouncementSummary 

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

AnnouncementSummary A summary representation of an announcement.

func (AnnouncementSummary) GetAffectedRegions 

func (m AnnouncementSummary) GetAffectedRegions() []string

GetAffectedRegions returns AffectedRegions

func (AnnouncementSummary) GetAnnouncementType 

func (m AnnouncementSummary) GetAnnouncementType() BaseAnnouncementAnnouncementTypeEnum

GetAnnouncementType returns AnnouncementType

func (AnnouncementSummary) GetId 

func (m AnnouncementSummary) GetId() *string

GetId returns Id

func (AnnouncementSummary) GetIsBanner 

func (m AnnouncementSummary) GetIsBanner() *bool

GetIsBanner returns IsBanner

func (AnnouncementSummary) GetLifecycleState 

func (m AnnouncementSummary) GetLifecycleState() BaseAnnouncementLifecycleStateEnum

GetLifecycleState returns LifecycleState

func (AnnouncementSummary) GetReferenceTicketNumber 

func (m AnnouncementSummary) GetReferenceTicketNumber() *string

GetReferenceTicketNumber returns ReferenceTicketNumber

func (AnnouncementSummary) GetServices 

func (m AnnouncementSummary) GetServices() []string

GetServices returns Services

func (AnnouncementSummary) GetSummary 

func (m AnnouncementSummary) GetSummary() *string

GetSummary returns Summary

func (AnnouncementSummary) GetTimeCreated 

func (m AnnouncementSummary) GetTimeCreated() *common.SDKTime

GetTimeCreated returns TimeCreated

func (AnnouncementSummary) GetTimeOneTitle 

func (m AnnouncementSummary) GetTimeOneTitle() *string

GetTimeOneTitle returns TimeOneTitle

func (AnnouncementSummary) GetTimeOneType 

func (m AnnouncementSummary) GetTimeOneType() BaseAnnouncementTimeOneTypeEnum

GetTimeOneType returns TimeOneType

func (AnnouncementSummary) GetTimeOneValue 

func (m AnnouncementSummary) GetTimeOneValue() *common.SDKTime

GetTimeOneValue returns TimeOneValue

func (AnnouncementSummary) GetTimeTwoTitle 

func (m AnnouncementSummary) GetTimeTwoTitle() *string

GetTimeTwoTitle returns TimeTwoTitle

func (AnnouncementSummary) GetTimeTwoType 

func (m AnnouncementSummary) GetTimeTwoType() BaseAnnouncementTimeTwoTypeEnum

GetTimeTwoType returns TimeTwoType

func (AnnouncementSummary) GetTimeTwoValue 

func (m AnnouncementSummary) GetTimeTwoValue() *common.SDKTime

GetTimeTwoValue returns TimeTwoValue

func (AnnouncementSummary) GetTimeUpdated 

func (m AnnouncementSummary) GetTimeUpdated() *common.SDKTime

GetTimeUpdated returns TimeUpdated

func (AnnouncementSummary) MarshalJSON 

func (m AnnouncementSummary) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (AnnouncementSummary) String 

func (m AnnouncementSummary) String() string

type AnnouncementUserStatusDetails 

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

AnnouncementUserStatusDetails An announcement's status regarding whether it has been acknowledged by a user.

func (AnnouncementUserStatusDetails) String 

func (m AnnouncementUserStatusDetails) String() string

type AnnouncementsCollection 

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

AnnouncementsCollection A list of announcements that match filter criteria, if any. Results contain both the announcements and the user-specific status of the announcements.

func (AnnouncementsCollection) String 

func (m AnnouncementsCollection) String() string

type AnnouncementsPreferences 

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 string representing the user's preference regarding receiving announcements by email.
	PreferenceType BaseCreateAnnouncementsPreferencesDetailsPreferenceTypeEnum `mandatory:"false" json:"preferenceType,omitempty"`
}

AnnouncementsPreferences The object for announcement email preferences.

func (AnnouncementsPreferences) GetCompartmentId 

func (m AnnouncementsPreferences) GetCompartmentId() *string

GetCompartmentId returns CompartmentId

func (AnnouncementsPreferences) GetId 

func (m AnnouncementsPreferences) GetId() *string

GetId returns Id

func (AnnouncementsPreferences) GetIsUnsubscribed 

func (m AnnouncementsPreferences) GetIsUnsubscribed() *bool

GetIsUnsubscribed returns IsUnsubscribed

func (AnnouncementsPreferences) GetPreferenceType 

func (m AnnouncementsPreferences) GetPreferenceType() BaseCreateAnnouncementsPreferencesDetailsPreferenceTypeEnum

GetPreferenceType returns PreferenceType

func (AnnouncementsPreferences) GetTimeCreated 

func (m AnnouncementsPreferences) GetTimeCreated() *common.SDKTime

GetTimeCreated returns TimeCreated

func (AnnouncementsPreferences) GetTimeUpdated 

func (m AnnouncementsPreferences) GetTimeUpdated() *common.SDKTime

GetTimeUpdated returns TimeUpdated

func (AnnouncementsPreferences) MarshalJSON 

func (m AnnouncementsPreferences) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (AnnouncementsPreferences) String 

func (m AnnouncementsPreferences) String() string

type AnnouncementsPreferencesClient 

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

AnnouncementsPreferencesClient a client for AnnouncementsPreferences

func NewAnnouncementsPreferencesClientWithConfigurationProvider 

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 

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 (*AnnouncementsPreferencesClient) ConfigurationProvider 

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

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

func (AnnouncementsPreferencesClient) CreateAnnouncementsPreference 

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.

See also

Click https://docs.cloud.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 (AnnouncementsPreferencesClient) GetAnnouncementsPreference 

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.

See also

Click https://docs.cloud.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 (AnnouncementsPreferencesClient) ListAnnouncementsPreferences 

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.

See also

Click https://docs.cloud.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 (*AnnouncementsPreferencesClient) SetRegion 

func (client *AnnouncementsPreferencesClient) SetRegion(region string)

SetRegion overrides the region of this client.

func (AnnouncementsPreferencesClient) UpdateAnnouncementsPreference 

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.

See also

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

type AnnouncementsPreferencesSummary 

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 string representing the user's preference regarding receiving announcements by email.
	PreferenceType BaseCreateAnnouncementsPreferencesDetailsPreferenceTypeEnum `mandatory:"false" json:"preferenceType,omitempty"`
}

AnnouncementsPreferencesSummary The summary object for announcement email preferences.

func (AnnouncementsPreferencesSummary) GetCompartmentId 

func (m AnnouncementsPreferencesSummary) GetCompartmentId() *string

GetCompartmentId returns CompartmentId

func (AnnouncementsPreferencesSummary) GetId 

func (m AnnouncementsPreferencesSummary) GetId() *string

GetId returns Id

func (AnnouncementsPreferencesSummary) GetIsUnsubscribed 

func (m AnnouncementsPreferencesSummary) GetIsUnsubscribed() *bool

GetIsUnsubscribed returns IsUnsubscribed

func (AnnouncementsPreferencesSummary) GetPreferenceType 

func (m AnnouncementsPreferencesSummary) GetPreferenceType() BaseCreateAnnouncementsPreferencesDetailsPreferenceTypeEnum

GetPreferenceType returns PreferenceType

func (AnnouncementsPreferencesSummary) GetTimeCreated 

func (m AnnouncementsPreferencesSummary) GetTimeCreated() *common.SDKTime

GetTimeCreated returns TimeCreated

func (AnnouncementsPreferencesSummary) GetTimeUpdated 

func (m AnnouncementsPreferencesSummary) GetTimeUpdated() *common.SDKTime

GetTimeUpdated returns TimeUpdated

func (AnnouncementsPreferencesSummary) MarshalJSON 

func (m AnnouncementsPreferencesSummary) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (AnnouncementsPreferencesSummary) String 

func (m AnnouncementsPreferencesSummary) String() string

type BaseAnnouncement 

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
}

BaseAnnouncement Incident information that forms the basis of an announcement. Avoid entering confidential information.

type BaseAnnouncementAnnouncementTypeEnum 

type BaseAnnouncementAnnouncementTypeEnum string

BaseAnnouncementAnnouncementTypeEnum Enum with underlying type: string 

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"
)

Set of constants representing the allowable values for BaseAnnouncementAnnouncementTypeEnum

func GetBaseAnnouncementAnnouncementTypeEnumValues 

func GetBaseAnnouncementAnnouncementTypeEnumValues() []BaseAnnouncementAnnouncementTypeEnum

GetBaseAnnouncementAnnouncementTypeEnumValues Enumerates the set of values for BaseAnnouncementAnnouncementTypeEnum

type BaseAnnouncementLifecycleStateEnum 

type BaseAnnouncementLifecycleStateEnum string

BaseAnnouncementLifecycleStateEnum Enum with underlying type: string 

const (
	BaseAnnouncementLifecycleStateActive   BaseAnnouncementLifecycleStateEnum = "ACTIVE"
	BaseAnnouncementLifecycleStateInactive BaseAnnouncementLifecycleStateEnum = "INACTIVE"
)

Set of constants representing the allowable values for BaseAnnouncementLifecycleStateEnum

func GetBaseAnnouncementLifecycleStateEnumValues 

func GetBaseAnnouncementLifecycleStateEnumValues() []BaseAnnouncementLifecycleStateEnum

GetBaseAnnouncementLifecycleStateEnumValues Enumerates the set of values for BaseAnnouncementLifecycleStateEnum

type BaseAnnouncementTimeOneTypeEnum 

type BaseAnnouncementTimeOneTypeEnum string

BaseAnnouncementTimeOneTypeEnum Enum with underlying type: string 

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"
)

Set of constants representing the allowable values for BaseAnnouncementTimeOneTypeEnum

func GetBaseAnnouncementTimeOneTypeEnumValues 

func GetBaseAnnouncementTimeOneTypeEnumValues() []BaseAnnouncementTimeOneTypeEnum

GetBaseAnnouncementTimeOneTypeEnumValues Enumerates the set of values for BaseAnnouncementTimeOneTypeEnum

type BaseAnnouncementTimeTwoTypeEnum 

type BaseAnnouncementTimeTwoTypeEnum string

BaseAnnouncementTimeTwoTypeEnum Enum with underlying type: string 

const (
	BaseAnnouncementTimeTwoTypeEndTime    BaseAnnouncementTimeTwoTypeEnum = "END_TIME"
	BaseAnnouncementTimeTwoTypeNewEndTime BaseAnnouncementTimeTwoTypeEnum = "NEW_END_TIME"
)

Set of constants representing the allowable values for BaseAnnouncementTimeTwoTypeEnum

func GetBaseAnnouncementTimeTwoTypeEnumValues 

func GetBaseAnnouncementTimeTwoTypeEnumValues() []BaseAnnouncementTimeTwoTypeEnum

GetBaseAnnouncementTimeTwoTypeEnumValues Enumerates the set of values for BaseAnnouncementTimeTwoTypeEnum

type BaseAnnouncementsPreferences 

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
}

BaseAnnouncementsPreferences The object that contains the announcement email preferences configured for the tenancy (root compartment).

type BaseCreateAnnouncementsPreferencesDetails 

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
}

BaseCreateAnnouncementsPreferencesDetails The model for the parameters of announcement email preferences configured for the tenancy (root compartment).

type BaseCreateAnnouncementsPreferencesDetailsPreferenceTypeEnum 

type BaseCreateAnnouncementsPreferencesDetailsPreferenceTypeEnum string

BaseCreateAnnouncementsPreferencesDetailsPreferenceTypeEnum Enum with underlying type: string 

const (
	BaseCreateAnnouncementsPreferencesDetailsPreferenceTypeInTenantAnnouncements                 BaseCreateAnnouncementsPreferencesDetailsPreferenceTypeEnum = "OPT_IN_TENANT_ANNOUNCEMENTS"
	BaseCreateAnnouncementsPreferencesDetailsPreferenceTypeInTenantAndInformationalAnnouncements BaseCreateAnnouncementsPreferencesDetailsPreferenceTypeEnum = "OPT_IN_TENANT_AND_INFORMATIONAL_ANNOUNCEMENTS"
	BaseCreateAnnouncementsPreferencesDetailsPreferenceTypeOutAllAnnouncements                   BaseCreateAnnouncementsPreferencesDetailsPreferenceTypeEnum = "OPT_OUT_ALL_ANNOUNCEMENTS"
)

Set of constants representing the allowable values for BaseCreateAnnouncementsPreferencesDetailsPreferenceTypeEnum

func GetBaseCreateAnnouncementsPreferencesDetailsPreferenceTypeEnumValues 

func GetBaseCreateAnnouncementsPreferencesDetailsPreferenceTypeEnumValues() []BaseCreateAnnouncementsPreferencesDetailsPreferenceTypeEnum

GetBaseCreateAnnouncementsPreferencesDetailsPreferenceTypeEnumValues Enumerates the set of values for BaseCreateAnnouncementsPreferencesDetailsPreferenceTypeEnum

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

CreateAnnouncementsPreferenceRequest wrapper for the CreateAnnouncementsPreference operation

See also

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

func (CreateAnnouncementsPreferenceRequest) BinaryRequestBody 

func (request CreateAnnouncementsPreferenceRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (CreateAnnouncementsPreferenceRequest) HTTPRequest 

func (request CreateAnnouncementsPreferenceRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateAnnouncementsPreferenceRequest) RetryPolicy 

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

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

func (CreateAnnouncementsPreferenceRequest) String 

func (request CreateAnnouncementsPreferenceRequest) String() string

type CreateAnnouncementsPreferenceResponse 

type CreateAnnouncementsPreferenceResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The AnnouncementsPreferencesSummary instance
	AnnouncementsPreferencesSummary `presentIn:"body"`

	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`

	Etag *string `presentIn:"header" name:"etag"`
}

CreateAnnouncementsPreferenceResponse wrapper for the CreateAnnouncementsPreference operation

func (CreateAnnouncementsPreferenceResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (CreateAnnouncementsPreferenceResponse) String 

func (response CreateAnnouncementsPreferenceResponse) String() string

type CreateAnnouncementsPreferencesDetails 

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

CreateAnnouncementsPreferencesDetails The object used to create announcement email preferences.

func (CreateAnnouncementsPreferencesDetails) GetCompartmentId 

func (m CreateAnnouncementsPreferencesDetails) GetCompartmentId() *string

GetCompartmentId returns CompartmentId

func (CreateAnnouncementsPreferencesDetails) GetIsUnsubscribed 

func (m CreateAnnouncementsPreferencesDetails) GetIsUnsubscribed() *bool

GetIsUnsubscribed returns IsUnsubscribed

func (CreateAnnouncementsPreferencesDetails) GetPreferenceType 

func (m CreateAnnouncementsPreferencesDetails) GetPreferenceType() BaseCreateAnnouncementsPreferencesDetailsPreferenceTypeEnum

GetPreferenceType returns PreferenceType

func (CreateAnnouncementsPreferencesDetails) MarshalJSON 

func (m CreateAnnouncementsPreferencesDetails) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (CreateAnnouncementsPreferencesDetails) String 

func (m CreateAnnouncementsPreferencesDetails) String() string

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

GetAnnouncementRequest wrapper for the GetAnnouncement operation

See also

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

func (GetAnnouncementRequest) BinaryRequestBody 

func (request GetAnnouncementRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (GetAnnouncementRequest) HTTPRequest 

func (request GetAnnouncementRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetAnnouncementRequest) RetryPolicy 

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

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

func (GetAnnouncementRequest) String 

func (request GetAnnouncementRequest) String() string

type GetAnnouncementResponse 

type GetAnnouncementResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The Announcement instance
	Announcement `presentIn:"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 `presentIn:"header" name:"opc-request-id"`
}

GetAnnouncementResponse wrapper for the GetAnnouncement operation

func (GetAnnouncementResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (GetAnnouncementResponse) String 

func (response GetAnnouncementResponse) String() string

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

GetAnnouncementUserStatusRequest wrapper for the GetAnnouncementUserStatus operation

See also

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

func (GetAnnouncementUserStatusRequest) BinaryRequestBody 

func (request GetAnnouncementUserStatusRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (GetAnnouncementUserStatusRequest) HTTPRequest 

func (request GetAnnouncementUserStatusRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetAnnouncementUserStatusRequest) RetryPolicy 

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

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

func (GetAnnouncementUserStatusRequest) String 

func (request GetAnnouncementUserStatusRequest) String() string

type GetAnnouncementUserStatusResponse 

type GetAnnouncementUserStatusResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The AnnouncementUserStatusDetails instance
	AnnouncementUserStatusDetails `presentIn:"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 `presentIn:"header" name:"opc-request-id"`
}

GetAnnouncementUserStatusResponse wrapper for the GetAnnouncementUserStatus operation

func (GetAnnouncementUserStatusResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (GetAnnouncementUserStatusResponse) String 

func (response GetAnnouncementUserStatusResponse) String() string

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

GetAnnouncementsPreferenceRequest wrapper for the GetAnnouncementsPreference operation

See also

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

func (GetAnnouncementsPreferenceRequest) BinaryRequestBody 

func (request GetAnnouncementsPreferenceRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (GetAnnouncementsPreferenceRequest) HTTPRequest 

func (request GetAnnouncementsPreferenceRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetAnnouncementsPreferenceRequest) RetryPolicy 

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

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

func (GetAnnouncementsPreferenceRequest) String 

func (request GetAnnouncementsPreferenceRequest) String() string

type GetAnnouncementsPreferenceResponse 

type GetAnnouncementsPreferenceResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The AnnouncementsPreferences instance
	AnnouncementsPreferences `presentIn:"body"`

	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

GetAnnouncementsPreferenceResponse wrapper for the GetAnnouncementsPreference operation

func (GetAnnouncementsPreferenceResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (GetAnnouncementsPreferenceResponse) String 

func (response GetAnnouncementsPreferenceResponse) String() string

type ListAnnouncementsLifecycleStateEnum 

type ListAnnouncementsLifecycleStateEnum string

ListAnnouncementsLifecycleStateEnum Enum with underlying type: string 

const (
	ListAnnouncementsLifecycleStateActive   ListAnnouncementsLifecycleStateEnum = "ACTIVE"
	ListAnnouncementsLifecycleStateInactive ListAnnouncementsLifecycleStateEnum = "INACTIVE"
)

Set of constants representing the allowable values for ListAnnouncementsLifecycleStateEnum

func GetListAnnouncementsLifecycleStateEnumValues 

func GetListAnnouncementsLifecycleStateEnumValues() []ListAnnouncementsLifecycleStateEnum

GetListAnnouncementsLifecycleStateEnumValues Enumerates the set of values for ListAnnouncementsLifecycleStateEnum

type ListAnnouncementsPreferencesRequest 

type ListAnnouncementsPreferencesRequest struct {

	// The OCID of the compartment. Because announcements are specific to a tenancy, this is the
	// OCID of the root 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
}

ListAnnouncementsPreferencesRequest wrapper for the ListAnnouncementsPreferences operation

See also

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

func (ListAnnouncementsPreferencesRequest) BinaryRequestBody 

func (request ListAnnouncementsPreferencesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListAnnouncementsPreferencesRequest) HTTPRequest 

func (request ListAnnouncementsPreferencesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListAnnouncementsPreferencesRequest) RetryPolicy 

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

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

func (ListAnnouncementsPreferencesRequest) String 

func (request ListAnnouncementsPreferencesRequest) String() string

type ListAnnouncementsPreferencesResponse 

type ListAnnouncementsPreferencesResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of []AnnouncementsPreferencesSummary instances
	Items []AnnouncementsPreferencesSummary `presentIn:"body"`

	OpcNextPage *string `presentIn:"header" name:"opc-next-page"`

	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

ListAnnouncementsPreferencesResponse wrapper for the ListAnnouncementsPreferences operation

func (ListAnnouncementsPreferencesResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (ListAnnouncementsPreferencesResponse) String 

func (response ListAnnouncementsPreferencesResponse) String() string

type ListAnnouncementsRequest 

type ListAnnouncementsRequest struct {

	// The OCID of the compartment. Because announcements are specific to a tenancy, this is the
	// OCID of the root 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"`

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

ListAnnouncementsRequest wrapper for the ListAnnouncements operation

See also

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

func (ListAnnouncementsRequest) BinaryRequestBody 

func (request ListAnnouncementsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListAnnouncementsRequest) HTTPRequest 

func (request ListAnnouncementsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListAnnouncementsRequest) RetryPolicy 

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

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

func (ListAnnouncementsRequest) String 

func (request ListAnnouncementsRequest) String() string

type ListAnnouncementsResponse 

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 there are additional items still to get. Include this value as the `page` parameter for the subsequent GET request. For information about pagination, see List Pagination (https://docs.cloud.oracle.com/Content/API/Concepts/usingapi.htm#List_Pagination).
	OpcNextPage *string `presentIn:"header" name:"opc-next-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 `presentIn:"header" name:"opc-request-id"`
}

ListAnnouncementsResponse wrapper for the ListAnnouncements operation

func (ListAnnouncementsResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (ListAnnouncementsResponse) String 

func (response ListAnnouncementsResponse) String() string

type ListAnnouncementsSortByEnum 

type ListAnnouncementsSortByEnum string

ListAnnouncementsSortByEnum Enum with underlying type: string 

const (
	ListAnnouncementsSortByTimeonevalue          ListAnnouncementsSortByEnum = "timeOneValue"
	ListAnnouncementsSortByTimetwovalue          ListAnnouncementsSortByEnum = "timeTwoValue"
	ListAnnouncementsSortByTimecreated           ListAnnouncementsSortByEnum = "timeCreated"
	ListAnnouncementsSortByReferenceticketnumber ListAnnouncementsSortByEnum = "referenceTicketNumber"
	ListAnnouncementsSortBySummary               ListAnnouncementsSortByEnum = "summary"
	ListAnnouncementsSortByAnnouncementtype      ListAnnouncementsSortByEnum = "announcementType"
)

Set of constants representing the allowable values for ListAnnouncementsSortByEnum

func GetListAnnouncementsSortByEnumValues 

func GetListAnnouncementsSortByEnumValues() []ListAnnouncementsSortByEnum

GetListAnnouncementsSortByEnumValues Enumerates the set of values for ListAnnouncementsSortByEnum

type ListAnnouncementsSortOrderEnum 

type ListAnnouncementsSortOrderEnum string

ListAnnouncementsSortOrderEnum Enum with underlying type: string 

const (
	ListAnnouncementsSortOrderAsc  ListAnnouncementsSortOrderEnum = "ASC"
	ListAnnouncementsSortOrderDesc ListAnnouncementsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListAnnouncementsSortOrderEnum

func GetListAnnouncementsSortOrderEnumValues 

func GetListAnnouncementsSortOrderEnumValues() []ListAnnouncementsSortOrderEnum

GetListAnnouncementsSortOrderEnumValues Enumerates the set of values for ListAnnouncementsSortOrderEnum

type Property 

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

Property A generic property that might be associated with the affected resource.

func (Property) String 

func (m Property) String() string

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

UpdateAnnouncementUserStatusRequest wrapper for the UpdateAnnouncementUserStatus operation

See also

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

func (UpdateAnnouncementUserStatusRequest) BinaryRequestBody 

func (request UpdateAnnouncementUserStatusRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (UpdateAnnouncementUserStatusRequest) HTTPRequest 

func (request UpdateAnnouncementUserStatusRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateAnnouncementUserStatusRequest) RetryPolicy 

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

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

func (UpdateAnnouncementUserStatusRequest) String 

func (request UpdateAnnouncementUserStatusRequest) String() string

type UpdateAnnouncementUserStatusResponse 

type UpdateAnnouncementUserStatusResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// 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 `presentIn:"header" name:"opc-request-id"`

	Etag *string `presentIn:"header" name:"etag"`
}

UpdateAnnouncementUserStatusResponse wrapper for the UpdateAnnouncementUserStatus operation

func (UpdateAnnouncementUserStatusResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (UpdateAnnouncementUserStatusResponse) String 

func (response UpdateAnnouncementUserStatusResponse) String() string

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

UpdateAnnouncementsPreferenceRequest wrapper for the UpdateAnnouncementsPreference operation

See also

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

func (UpdateAnnouncementsPreferenceRequest) BinaryRequestBody 

func (request UpdateAnnouncementsPreferenceRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (UpdateAnnouncementsPreferenceRequest) HTTPRequest 

func (request UpdateAnnouncementsPreferenceRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateAnnouncementsPreferenceRequest) RetryPolicy 

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

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

func (UpdateAnnouncementsPreferenceRequest) String 

func (request UpdateAnnouncementsPreferenceRequest) String() string

type UpdateAnnouncementsPreferenceResponse 

type UpdateAnnouncementsPreferenceResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The AnnouncementsPreferencesSummary instance
	AnnouncementsPreferencesSummary `presentIn:"body"`

	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`

	Etag *string `presentIn:"header" name:"etag"`
}

UpdateAnnouncementsPreferenceResponse wrapper for the UpdateAnnouncementsPreference operation

func (UpdateAnnouncementsPreferenceResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (UpdateAnnouncementsPreferenceResponse) String 

func (response UpdateAnnouncementsPreferenceResponse) String() string

type UpdateAnnouncementsPreferencesDetails 

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

UpdateAnnouncementsPreferencesDetails The object used to update announcement email preferences.

func (UpdateAnnouncementsPreferencesDetails) GetCompartmentId 

func (m UpdateAnnouncementsPreferencesDetails) GetCompartmentId() *string

GetCompartmentId returns CompartmentId

func (UpdateAnnouncementsPreferencesDetails) GetIsUnsubscribed 

func (m UpdateAnnouncementsPreferencesDetails) GetIsUnsubscribed() *bool

GetIsUnsubscribed returns IsUnsubscribed

func (UpdateAnnouncementsPreferencesDetails) GetPreferenceType 

func (m UpdateAnnouncementsPreferencesDetails) GetPreferenceType() BaseCreateAnnouncementsPreferencesDetailsPreferenceTypeEnum

GetPreferenceType returns PreferenceType

func (UpdateAnnouncementsPreferencesDetails) MarshalJSON 

func (m UpdateAnnouncementsPreferencesDetails) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (UpdateAnnouncementsPreferencesDetails) String 

func (m UpdateAnnouncementsPreferencesDetails) String() string

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.