oci-go-sdk: github.com/oracle/oci-go-sdk/announcementsservice Index | Files

package announcementsservice

import "github.com/oracle/oci-go-sdk/announcementsservice"

Index

Package Files

affected_resource.go announcement.go announcement_summary.go announcement_user_status_details.go announcements_collection.go announcementsservice_announcement_client.go base_announcement.go get_announcement_request_response.go get_announcement_user_status_request_response.go list_announcements_request_response.go update_announcement_user_status_request_response.go

type AffectedResource Uses

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

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

func (AffectedResource) String Uses

func (m AffectedResource) String() string

type Announcement Uses

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 is the time an event started, but the meaning
    // can vary, depending on the announcement type.
    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 is the time an event ended, but the meaning
    // can vary, depending on the announcement type.
    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 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 Uses

func (m Announcement) GetAffectedRegions() []string

GetAffectedRegions returns AffectedRegions

func (Announcement) GetAnnouncementType Uses

func (m Announcement) GetAnnouncementType() BaseAnnouncementAnnouncementTypeEnum

GetAnnouncementType returns AnnouncementType

func (Announcement) GetId Uses

func (m Announcement) GetId() *string

GetId returns Id

func (Announcement) GetIsBanner Uses

func (m Announcement) GetIsBanner() *bool

GetIsBanner returns IsBanner

func (Announcement) GetLifecycleState Uses

func (m Announcement) GetLifecycleState() BaseAnnouncementLifecycleStateEnum

GetLifecycleState returns LifecycleState

func (Announcement) GetReferenceTicketNumber Uses

func (m Announcement) GetReferenceTicketNumber() *string

GetReferenceTicketNumber returns ReferenceTicketNumber

func (Announcement) GetServices Uses

func (m Announcement) GetServices() []string

GetServices returns Services

func (Announcement) GetSummary Uses

func (m Announcement) GetSummary() *string

GetSummary returns Summary

func (Announcement) GetTimeCreated Uses

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

GetTimeCreated returns TimeCreated

func (Announcement) GetTimeOneTitle Uses

func (m Announcement) GetTimeOneTitle() *string

GetTimeOneTitle returns TimeOneTitle

func (Announcement) GetTimeOneValue Uses

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

GetTimeOneValue returns TimeOneValue

func (Announcement) GetTimeTwoTitle Uses

func (m Announcement) GetTimeTwoTitle() *string

GetTimeTwoTitle returns TimeTwoTitle

func (Announcement) GetTimeTwoValue Uses

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

GetTimeTwoValue returns TimeTwoValue

func (Announcement) GetTimeUpdated Uses

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

GetTimeUpdated returns TimeUpdated

func (Announcement) MarshalJSON Uses

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

MarshalJSON marshals to json representation

func (Announcement) String Uses

func (m Announcement) String() string

type AnnouncementClient Uses

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

AnnouncementClient a client for Announcement

func NewAnnouncementClientWithConfigurationProvider Uses

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 Uses

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 Uses

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

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

func (AnnouncementClient) GetAnnouncement Uses

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

GetAnnouncement Gets the details of a specific announcement.

func (AnnouncementClient) GetAnnouncementUserStatus Uses

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.

func (AnnouncementClient) ListAnnouncements Uses

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

ListAnnouncements Gets a list of announcements for the current tenancy.

func (*AnnouncementClient) SetRegion Uses

func (client *AnnouncementClient) SetRegion(region string)

SetRegion overrides the region of this client.

func (AnnouncementClient) UpdateAnnouncementUserStatus Uses

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.

type AnnouncementSummary Uses

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 is the time an event started, but the meaning
    // can vary, depending on the announcement type.
    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 is the time an event ended, but the meaning
    // can vary, depending on the announcement type.
    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 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 Summary representation of an announcement.

func (AnnouncementSummary) GetAffectedRegions Uses

func (m AnnouncementSummary) GetAffectedRegions() []string

GetAffectedRegions returns AffectedRegions

func (AnnouncementSummary) GetAnnouncementType Uses

func (m AnnouncementSummary) GetAnnouncementType() BaseAnnouncementAnnouncementTypeEnum

GetAnnouncementType returns AnnouncementType

func (AnnouncementSummary) GetId Uses

func (m AnnouncementSummary) GetId() *string

GetId returns Id

func (AnnouncementSummary) GetIsBanner Uses

func (m AnnouncementSummary) GetIsBanner() *bool

GetIsBanner returns IsBanner

func (AnnouncementSummary) GetLifecycleState Uses

func (m AnnouncementSummary) GetLifecycleState() BaseAnnouncementLifecycleStateEnum

GetLifecycleState returns LifecycleState

func (AnnouncementSummary) GetReferenceTicketNumber Uses

func (m AnnouncementSummary) GetReferenceTicketNumber() *string

GetReferenceTicketNumber returns ReferenceTicketNumber

func (AnnouncementSummary) GetServices Uses

func (m AnnouncementSummary) GetServices() []string

GetServices returns Services

func (AnnouncementSummary) GetSummary Uses

func (m AnnouncementSummary) GetSummary() *string

GetSummary returns Summary

func (AnnouncementSummary) GetTimeCreated Uses

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

GetTimeCreated returns TimeCreated

func (AnnouncementSummary) GetTimeOneTitle Uses

func (m AnnouncementSummary) GetTimeOneTitle() *string

GetTimeOneTitle returns TimeOneTitle

func (AnnouncementSummary) GetTimeOneValue Uses

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

GetTimeOneValue returns TimeOneValue

func (AnnouncementSummary) GetTimeTwoTitle Uses

func (m AnnouncementSummary) GetTimeTwoTitle() *string

GetTimeTwoTitle returns TimeTwoTitle

func (AnnouncementSummary) GetTimeTwoValue Uses

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

GetTimeTwoValue returns TimeTwoValue

func (AnnouncementSummary) GetTimeUpdated Uses

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

GetTimeUpdated returns TimeUpdated

func (AnnouncementSummary) MarshalJSON Uses

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

MarshalJSON marshals to json representation

func (AnnouncementSummary) String Uses

func (m AnnouncementSummary) String() string

type AnnouncementUserStatusDetails Uses

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 Uses

func (m AnnouncementUserStatusDetails) String() string

type AnnouncementsCollection Uses

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 Uses

func (m AnnouncementsCollection) String() string

type BaseAnnouncement Uses

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 actual value of the first time value for the event. Typically, this is the time an event started, but the meaning
    // can vary, depending on the announcement type.
    GetTimeOneValue() *common.SDKTime

    // The label associated with a second time value.
    // Example: `Time Ended`
    GetTimeTwoTitle() *string

    // The actual value of the second time value. Typically, this is the time an event ended, but the meaning
    // can vary, depending on the announcement type.
    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 Uses

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 Uses

func GetBaseAnnouncementAnnouncementTypeEnumValues() []BaseAnnouncementAnnouncementTypeEnum

GetBaseAnnouncementAnnouncementTypeEnumValues Enumerates the set of values for BaseAnnouncementAnnouncementTypeEnum

type BaseAnnouncementLifecycleStateEnum Uses

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 Uses

func GetBaseAnnouncementLifecycleStateEnumValues() []BaseAnnouncementLifecycleStateEnum

GetBaseAnnouncementLifecycleStateEnumValues Enumerates the set of values for BaseAnnouncementLifecycleStateEnum

type GetAnnouncementRequest Uses

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

func (GetAnnouncementRequest) HTTPRequest Uses

func (request GetAnnouncementRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetAnnouncementRequest) RetryPolicy Uses

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

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

func (GetAnnouncementRequest) String Uses

func (request GetAnnouncementRequest) String() string

type GetAnnouncementResponse Uses

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 Uses

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

HTTPResponse implements the OCIResponse interface

func (GetAnnouncementResponse) String Uses

func (response GetAnnouncementResponse) String() string

type GetAnnouncementUserStatusRequest Uses

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

func (GetAnnouncementUserStatusRequest) HTTPRequest Uses

func (request GetAnnouncementUserStatusRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetAnnouncementUserStatusRequest) RetryPolicy Uses

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

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

func (GetAnnouncementUserStatusRequest) String Uses

func (request GetAnnouncementUserStatusRequest) String() string

type GetAnnouncementUserStatusResponse Uses

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 Uses

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

HTTPResponse implements the OCIResponse interface

func (GetAnnouncementUserStatusResponse) String Uses

func (response GetAnnouncementUserStatusResponse) String() string

type ListAnnouncementsLifecycleStateEnum Uses

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 Uses

func GetListAnnouncementsLifecycleStateEnumValues() []ListAnnouncementsLifecycleStateEnum

GetListAnnouncementsLifecycleStateEnumValues Enumerates the set of values for ListAnnouncementsLifecycleStateEnum

type ListAnnouncementsRequest Uses

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

func (ListAnnouncementsRequest) HTTPRequest Uses

func (request ListAnnouncementsRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListAnnouncementsRequest) RetryPolicy Uses

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

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

func (ListAnnouncementsRequest) String Uses

func (request ListAnnouncementsRequest) String() string

type ListAnnouncementsResponse Uses

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 Uses

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

HTTPResponse implements the OCIResponse interface

func (ListAnnouncementsResponse) String Uses

func (response ListAnnouncementsResponse) String() string

type ListAnnouncementsSortByEnum Uses

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 Uses

func GetListAnnouncementsSortByEnumValues() []ListAnnouncementsSortByEnum

GetListAnnouncementsSortByEnumValues Enumerates the set of values for ListAnnouncementsSortByEnum

type ListAnnouncementsSortOrderEnum Uses

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 Uses

func GetListAnnouncementsSortOrderEnumValues() []ListAnnouncementsSortOrderEnum

GetListAnnouncementsSortOrderEnumValues Enumerates the set of values for ListAnnouncementsSortOrderEnum

type UpdateAnnouncementUserStatusRequest Uses

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

func (UpdateAnnouncementUserStatusRequest) HTTPRequest Uses

func (request UpdateAnnouncementUserStatusRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateAnnouncementUserStatusRequest) RetryPolicy Uses

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

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

func (UpdateAnnouncementUserStatusRequest) String Uses

func (request UpdateAnnouncementUserStatusRequest) String() string

type UpdateAnnouncementUserStatusResponse Uses

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 Uses

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

HTTPResponse implements the OCIResponse interface

func (UpdateAnnouncementUserStatusResponse) String Uses

func (response UpdateAnnouncementUserStatusResponse) String() string

Package announcementsservice imports 5 packages (graph). Updated 2020-04-07. Refresh now. Tools for package owners.