Class ListIotDomainsRequest

Inheritance

object

ListIotDomainsRequest

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

Assembly: OCI.DotNetSDK.Iot.dll

Syntax

public class ListIotDomainsRequest : IOciRequest

Examples

Click here to see an example of how to use ListIotDomains 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 in which to list resources.

Remarks

Required

DisplayName

Declaration

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

Property Value

Type	Description
string	Filter resources whose display name matches the specified value.

Id

Declaration

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

Property Value

Type	Description
string	Filter resources by OCID. Must be a valid OCID of the resource type.

IotDomainGroupId

Declaration

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

Property Value

Type	Description
string	Filter resources that match the specified OCID of the IoT domain group.

LifecycleState

Declaration

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

Property Value

Type	Description
IotDomain.LifecycleStateEnum?	Filter resources whose lifecycleState matches the specified value.

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.

OpcRequestId

Declaration

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

Property Value

Type	Description
string	Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, 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 on how pagination works, see List Pagination.

SortBy

Declaration

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

Property Value

Type	Description
ListIotDomainsRequest.SortByEnum?	The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending.

SortOrder

Declaration

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

Property Value

Type	Description
ListIotDomainsRequest.SortOrderEnum?	Specifies sort order to use, either ASC (ascending) or DESC (descending).

Implements

IOciRequest