Class ListAnnouncementsRequest

Inheritance

object

ListAnnouncementsRequest

Implements

IOciRequest

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.AnnouncementsService.Requests

Assembly: OCI.DotNetSDK.Announcementsservice.dll

Syntax

public class ListAnnouncementsRequest : IOciRequest

Examples

Click here to see an example of how to use ListAnnouncements request.

Properties

AnnouncementType

Declaration

[HttpConverter(TargetEnum.Query, "announcementType")]
public string AnnouncementType { get; set; }

Property Value

Type	Description
string	The type of announcement.

ChainId

Declaration

[HttpConverter(TargetEnum.Query, "chainId")]
public string ChainId { get; set; }

Property Value

Type	Description
string	A filter to return only announcements belonging to the specified announcement chain ID.

CompartmentId

Declaration

[Required(ErrorMessage = "CompartmentId is required.")]
[HttpConverter(TargetEnum.Query, "compartmentId")]
public string CompartmentId { get; set; }

Property Value

Type	Description
string	The OCID of the compartment.

Remarks

Required

EnvironmentName

Declaration

[HttpConverter(TargetEnum.Query, "environmentName")]
public string EnvironmentName { get; set; }

Property Value

Type	Description
string	A filter to return only announcements that match a specific environment name.

ExcludeAnnouncementTypes

Declaration

[HttpConverter(TargetEnum.Query, "excludeAnnouncementTypes", CollectionFormatType.Multi)]
public List<string> ExcludeAnnouncementTypes { get; set; }

Property Value

Type	Description
List<string>	Exclude The type of announcement.

IsBanner

Declaration

[HttpConverter(TargetEnum.Query, "isBanner")]
public bool? IsBanner { get; set; }

Property Value

Type	Description
bool?	Whether the announcement is displayed as a console banner.

LifecycleState

Declaration

[HttpConverter(TargetEnum.Query, "lifecycleState")]
public ListAnnouncementsRequest.LifecycleStateEnum? LifecycleState { get; set; }

Property Value

Type	Description
ListAnnouncementsRequest.LifecycleStateEnum?	The announcement's current lifecycle state.

Limit

Declaration

[HttpConverter(TargetEnum.Query, "limit")]
public int? Limit { get; set; }

Property Value

Type	Description
int?	The maximum number of items to return in a paginated "List" call.

OpcRequestId

Declaration

[HttpConverter(TargetEnum.Header, "opc-request-id")]
public string OpcRequestId { get; set; }

Property Value

Type	Description
string	The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the complete request ID.

Page

Declaration

[HttpConverter(TargetEnum.Query, "page")]
public string Page { get; set; }

Property Value

Type	Description
string	The value of the opc-next-page response header from the previous "List" call.

PlatformType

Declaration

[HttpConverter(TargetEnum.Query, "platformType")]
public ListAnnouncementsRequest.PlatformTypeEnum? PlatformType { get; set; }

Property Value

Type	Description
ListAnnouncementsRequest.PlatformTypeEnum?	A filter to return only announcements affecting a specific platform.

Service

Declaration

[HttpConverter(TargetEnum.Query, "service")]
public string Service { get; set; }

Property Value

Type	Description
string	A filter to return only announcements affecting a specific service.

ShouldShowOnlyLatestInChain

Declaration

[HttpConverter(TargetEnum.Query, "shouldShowOnlyLatestInChain")]
public bool? ShouldShowOnlyLatestInChain { get; set; }

Property Value

Type	Description
bool?	A filter to display only the latest announcement in a chain.

SortBy

Declaration

[HttpConverter(TargetEnum.Query, "sortBy")]
public ListAnnouncementsRequest.SortByEnum? SortBy { get; set; }

Property Value

Type	Description
ListAnnouncementsRequest.SortByEnum?	The criteria to sort by. You can specify only one sort order.

SortOrder

Declaration

[HttpConverter(TargetEnum.Query, "sortOrder")]
public ListAnnouncementsRequest.SortOrderEnum? SortOrder { get; set; }

Property Value

Type	Description
ListAnnouncementsRequest.SortOrderEnum?	The sort order to use. (Sorting by announcementType orders the announcements list according to importance.)

TimeOneEarliestTime

Declaration

[HttpConverter(TargetEnum.Query, "timeOneEarliestTime")]
public DateTime? TimeOneEarliestTime { get; set; }

Property Value

Type	Description
DateTime?	The boundary for the earliest timeOneValue date on announcements that you want to see.

TimeOneLatestTime

Declaration

[HttpConverter(TargetEnum.Query, "timeOneLatestTime")]
public DateTime? TimeOneLatestTime { get; set; }

Property Value

Type	Description
DateTime?	The boundary for the latest timeOneValue date on announcements that you want to see.

Implements

IOciRequest