Class ListEmailDomainsRequest

Inheritance

object

ListEmailDomainsRequest

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

Assembly: OCI.DotNetSDK.Email.dll

Syntax

public class ListEmailDomainsRequest : IOciRequest

Examples

Click here to see an example of how to use ListEmailDomains 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 for 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 EmailDomain.LifecycleStateEnum? LifecycleState { get; set; }

Property Value

Type	Description
EmailDomain.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. 1 is the minimum, 1000 is the maximum. 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 request ID for tracing from the system

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 ListEmailDomainsRequest.SortByEnum? SortBy { get; set; }

Property Value

Type	Description
ListEmailDomainsRequest.SortByEnum?	Specifies the attribute with which to sort the email domains. Default: TIMECREATED TIMECREATED: Sorts by timeCreated. NAME: Sorts by name. ID: Sorts by id.

SortOrder

Declaration

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

Property Value

Type	Description
SortOrder?	The sort order to use, either ascending or descending order.

Implements

IOciRequest