Class ListEmailReturnPathsRequest
Implements
Inherited Members
Namespace: Oci.EmailService.Requests
Assembly: OCI.DotNetSDK.Email.dll
Syntax
public class ListEmailReturnPathsRequest : IOciRequest
Examples
Click here to see an example of how to use ListEmailReturnPaths request.
Properties
CompartmentId
Declaration
[HttpConverter(TargetEnum.Query, "compartmentId")]
public string CompartmentId { get; set; }
Property Value
Type | Description |
---|---|
string | The OCID for the compartment. |
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 EmailReturnPath.LifecycleStateEnum? LifecycleState { get; set; }
Property Value
Type | Description |
---|---|
EmailReturnPath.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. |
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. |
ParentResourceId
Declaration
[HttpConverter(TargetEnum.Query, "parentResourceId")]
public string ParentResourceId { get; set; }
Property Value
Type | Description |
---|---|
string | The OCID of the Email Domain to which this Email Return Path belongs. |
SortBy
Declaration
[HttpConverter(TargetEnum.Query, "sortBy")]
public ListEmailReturnPathsRequest.SortByEnum? SortBy { get; set; }
Property Value
Type | Description |
---|---|
ListEmailReturnPathsRequest.SortByEnum? | Specifies the attribute with which to sort the return paths.
|
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. |