Class ListTopicsRequest

Inheritance

object

ListTopicsRequest

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.OnsService.Requests

Assembly: OCI.DotNetSDK.Ons.dll

Syntax

public class ListTopicsRequest : IOciRequest

Examples

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

Properties

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

Id

Declaration

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

Property Value

Type	Description
string	A filter to only return resources that match the given id exactly.

LifecycleState

Declaration

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

Property Value

Type	Description
NotificationTopicSummary.LifecycleStateEnum?	Filter returned list by specified lifecycle state. This parameter is case-insensitive.

Limit

Declaration

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

Property Value

Type	Description
int?	For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination.

Name

Declaration

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

Property Value

Type	Description
string	A filter to only return resources that match the given name exactly.

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 request ID.

Page

Declaration

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

Property Value

Type	Description
string	For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.

SortBy

Declaration

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

Property Value

Type	Description
ListTopicsRequest.SortByEnum?	The field to sort by. Only one field can be selected for sorting.

SortOrder

Declaration

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

Property Value

Type	Description
ListTopicsRequest.SortOrderEnum?	The sort order to use (ascending or descending).

Implements

IOciRequest