announcementsservice

package
v3.6.0+incompatible Latest Latest
Warning

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

 Go to latest Published: Jan 31, 2019 License: Apache-2.0, UPL-1.0 Imports: 5 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 resource
	ResourceId *string `mandatory:"true" json:"resourceId"`

	// User-friendly name of the resource
	ResourceName *string `mandatory:"true" json:"resourceName"`

	// Region where this resource belongs to
	Region *string `mandatory:"true" json:"region"`
}

AffectedResource Descrption of a resource affected by 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"`

	// Forms part of the email subject and/or the console representation (a banner or alike)
	Summary *string `mandatory:"true" json:"summary"`

	// Show announcement as a banner
	IsBanner *bool `mandatory:"true" json:"isBanner"`

	// The title of the first time value, e.g. Time Started
	TimeOneTitle *string `mandatory:"false" json:"timeOneTitle"`

	// The first time value, actual meaning depending on notification type
	TimeOneValue *common.SDKTime `mandatory:"false" json:"timeOneValue"`

	// The title of the second time value, e.g. Time Ended
	TimeTwoTitle *string `mandatory:"false" json:"timeTwoTitle"`

	// The second time value, actual meaning depending on notification type
	TimeTwoValue *common.SDKTime `mandatory:"false" json:"timeTwoValue"`

	// Impacted services
	Services []string `mandatory:"false" json:"services"`

	// Impacted regions
	AffectedRegions []string `mandatory:"false" json:"affectedRegions"`

	// The date and time the announcement was created, in the format defined by RFC3339
	// Example: `2016-07-22T17:43:01.389+0000`
	TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`

	// The date and time the announcement was last updated, in the format defined by RFC3339
	// Example: `2016-07-22T17:43:01.389+0000`
	TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`

	// A more detailed explanation of the notification. A markdown format input
	Description *string `mandatory:"false" json:"description"`

	// A markdown format input that forms e.g. the FAQ section of a notification
	AdditionalInformation *string `mandatory:"false" json:"additionalInformation"`

	Followups []NotificationFollowupDetails `mandatory:"false" json:"followups"`

	// List of resources (possibly empty) affected by this announcement
	AffectedResources []AffectedResource `mandatory:"false" json:"affectedResources"`

	// The detailed description of an announcement
	AnnouncementType BaseAnnouncementAnnouncementTypeEnum `mandatory:"true" json:"announcementType"`

	// Lifecycle states of announcement
	LifecycleState BaseAnnouncementLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
}

Announcement An announcement object which represents a message targetted to a specific tenant

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

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

GetTimeOneValue returns TimeOneValue

func (Announcement) GetTimeTwoTitle 

func (m Announcement) GetTimeTwoTitle() *string

GetTimeTwoTitle returns TimeTwoTitle

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 (*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 details about single `Announcement` object

func (AnnouncementClient) GetAnnouncementUserStatus 

func (client AnnouncementClient) GetAnnouncementUserStatus(ctx context.Context, request GetAnnouncementUserStatusRequest) (response GetAnnouncementUserStatusResponse, err error)

GetAnnouncementUserStatus Get user status of specified announcement

func (AnnouncementClient) ListAnnouncements 

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

ListAnnouncements Gets a list of `Announcement` objects for the current tenancy

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 Update `Announcement` status with whether user has seen or supressed the announcement

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

	// Forms part of the email subject and/or the console representation (a banner or alike)
	Summary *string `mandatory:"true" json:"summary"`

	// Show announcement as a banner
	IsBanner *bool `mandatory:"true" json:"isBanner"`

	// The title of the first time value, e.g. Time Started
	TimeOneTitle *string `mandatory:"false" json:"timeOneTitle"`

	// The first time value, actual meaning depending on notification type
	TimeOneValue *common.SDKTime `mandatory:"false" json:"timeOneValue"`

	// The title of the second time value, e.g. Time Ended
	TimeTwoTitle *string `mandatory:"false" json:"timeTwoTitle"`

	// The second time value, actual meaning depending on notification type
	TimeTwoValue *common.SDKTime `mandatory:"false" json:"timeTwoValue"`

	// Impacted services
	Services []string `mandatory:"false" json:"services"`

	// Impacted regions
	AffectedRegions []string `mandatory:"false" json:"affectedRegions"`

	// The date and time the announcement was created, in the format defined by RFC3339
	// Example: `2016-07-22T17:43:01.389+0000`
	TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`

	// The date and time the announcement was last updated, in the format defined by RFC3339
	// Example: `2016-07-22T17:43:01.389+0000`
	TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`

	// The detailed description of an announcement
	AnnouncementType BaseAnnouncementAnnouncementTypeEnum `mandatory:"true" json:"announcementType"`

	// Lifecycle states of announcement
	LifecycleState BaseAnnouncementLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
}

AnnouncementSummary An announcement summary object which is returned by List API

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

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

GetTimeOneValue returns TimeOneValue

func (AnnouncementSummary) GetTimeTwoTitle 

func (m AnnouncementSummary) GetTimeTwoTitle() *string

GetTimeTwoTitle returns TimeTwoTitle

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 this status belongs to
	UserStatusAnnouncementId *string `mandatory:"true" json:"userStatusAnnouncementId"`

	// The OCID of the user this status belongs to
	UserId *string `mandatory:"true" json:"userId"`

	// The date and time the announcement was acknowledged, in the format defined by RFC3339
	// Example: `2016-07-22T17:43:01.389+0000`
	TimeAcknowledged *common.SDKTime `mandatory:"false" json:"timeAcknowledged"`
}

AnnouncementUserStatusDetails An announcement status

func (AnnouncementUserStatusDetails) String 

func (m AnnouncementUserStatusDetails) String() string

type AnnouncementsCollection 

type AnnouncementsCollection struct {

	// collection of announcements
	Items []AnnouncementSummary `mandatory:"false" json:"items"`

	// user specific status of found announcements
	UserStatuses []AnnouncementUserStatusDetails `mandatory:"false" json:"userStatuses"`
}

AnnouncementsCollection Results of annoucements search. Contains both announcements, and user specific status of the announcments

func (AnnouncementsCollection) String 

func (m AnnouncementsCollection) String() string

type BaseAnnouncement 

type BaseAnnouncement interface {

	// The OCID of the announcement
	GetId() *string

	// The reference JIRA ticket number
	GetReferenceTicketNumber() *string

	// Forms part of the email subject and/or the console representation (a banner or alike)
	GetSummary() *string

	// The detailed description of an announcement
	GetAnnouncementType() BaseAnnouncementAnnouncementTypeEnum

	// Lifecycle states of announcement
	GetLifecycleState() BaseAnnouncementLifecycleStateEnum

	// Show announcement as a banner
	GetIsBanner() *bool

	// The title of the first time value, e.g. Time Started
	GetTimeOneTitle() *string

	// The first time value, actual meaning depending on notification type
	GetTimeOneValue() *common.SDKTime

	// The title of the second time value, e.g. Time Ended
	GetTimeTwoTitle() *string

	// The second time value, actual meaning depending on notification type
	GetTimeTwoValue() *common.SDKTime

	// Impacted services
	GetServices() []string

	// Impacted regions
	GetAffectedRegions() []string

	// The date and time the announcement was created, in the format defined by RFC3339
	// Example: `2016-07-22T17:43:01.389+0000`
	GetTimeCreated() *common.SDKTime

	// The date and time the announcement was last updated, in the format defined by RFC3339
	// Example: `2016-07-22T17:43:01.389+0000`
	GetTimeUpdated() *common.SDKTime
}

BaseAnnouncement Base for announcements and incidents

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 GetAnnouncementRequest 

type GetAnnouncementRequest struct {

	// The OCID of the announcement
	AnnouncementId *string `mandatory:"true" contributesTo:"path" name:"announcementId"`

	// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
	// a particular request, please provide the request ID.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

GetAnnouncementRequest wrapper for the GetAnnouncement operation

func (GetAnnouncementRequest) HTTPRequest 

func (request GetAnnouncementRequest) HTTPRequest(method, path 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"`

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

	// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
	// a particular request, please provide the request ID.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

GetAnnouncementUserStatusRequest wrapper for the GetAnnouncementUserStatus operation

func (GetAnnouncementUserStatusRequest) HTTPRequest 

func (request GetAnnouncementUserStatusRequest) HTTPRequest(method, path 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"`

	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 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 ListAnnouncementsRequest 

type ListAnnouncementsRequest struct {

	// OCID of the compartment where search is performed. Announcements are specific to tenancy, so this should an ID 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"`

	// Type of the announcements to show
	AnnouncementType *string `mandatory:"false" contributesTo:"query" name:"announcementType"`

	// Filters returned announcements basing on whether they are active now
	LifecycleState ListAnnouncementsLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`

	// Filters returned announcements basing on whether they should be shown as a banner
	IsBanner *bool `mandatory:"false" contributesTo:"query" name:"isBanner"`

	// announcements sort order
	SortBy ListAnnouncementsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`

	// sort order
	SortOrder ListAnnouncementsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`

	// The earliest timeOneValue to include
	TimeOneEarliestTime *common.SDKTime `mandatory:"false" contributesTo:"query" name:"timeOneEarliestTime"`

	// The latest timeOneValue to include
	TimeOneLatestTime *common.SDKTime `mandatory:"false" contributesTo:"query" name:"timeOneLatestTime"`

	// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
	// a particular request, please provide the request ID.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

ListAnnouncementsRequest wrapper for the ListAnnouncements operation

func (ListAnnouncementsRequest) HTTPRequest 

func (request ListAnnouncementsRequest) HTTPRequest(method, path 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"`

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

	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 NotificationFollowupDetails 

type NotificationFollowupDetails struct {

	// The follow-up message, a markdown format input
	Message *string `mandatory:"false" json:"message"`

	// When the update is made
	TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
}

NotificationFollowupDetails Information represents a notification follow-up

func (NotificationFollowupDetails) String 

func (m NotificationFollowupDetails) String() string

type UpdateAnnouncementUserStatusRequest 

type UpdateAnnouncementUserStatusRequest struct {

	// The OCID of the announcement
	AnnouncementId *string `mandatory:"true" contributesTo:"path" name:"announcementId"`

	// Object for updating a user's status of announcement.
	StatusDetails AnnouncementUserStatusDetails `contributesTo:"body"`

	// Optimistic locking version
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
	// a particular request, please provide the request ID.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

UpdateAnnouncementUserStatusRequest wrapper for the UpdateAnnouncementUserStatus operation

func (UpdateAnnouncementUserStatusRequest) HTTPRequest 

func (request UpdateAnnouncementUserStatusRequest) HTTPRequest(method, path 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

	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

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.