Class ListDomainsRequest

Inheritance

object

ListDomainsRequest

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

Assembly: OCI.DotNetSDK.Tenantmanagercontrolplane.dll

Syntax

public class ListDomainsRequest : IOciRequest

Examples

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

Properties

CompartmentId

Declaration

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

Property Value

Type	Description
string	The ID of the compartment in which to list resources.

Remarks

Required

DomainId

Declaration

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

Property Value

Type	Description
string	The domain OCID.

LifecycleState

Declaration

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

Property Value

Type	Description
LifecycleState?	The lifecycle state of the resource.

Limit

Declaration

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

Property Value

Type	Description
int?	The maximum number of items to return.

Name

Declaration

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

Property Value

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

OpcRequestId

Declaration

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

Property Value

Type	Description
string	The client request ID for tracing.

Page

Declaration

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

Property Value

Type	Description
string	The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.

SortBy

Declaration

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

Property Value

Type	Description
ListDomainsRequest.SortByEnum?	The field to sort by. Only one sort order can be provided. The default order for timeCreated is descending. The default order for displayName is ascending. If no value is specified, timeCreated is the default.

SortOrder

Declaration

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

Property Value

Type	Description
SortOrder?	The sort order to use, whether 'asc' or 'desc'.

Status

Declaration

[HttpConverter(TargetEnum.Query, "status")]
public Domain.StatusEnum? Status { get; set; }

Property Value

Type	Description
Domain.StatusEnum?	The status of the domain.

Implements

IOciRequest