Class ListApisRequest

Inheritance

object

ListApisRequest

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

Assembly: OCI.DotNetSDK.Apigateway.dll

Syntax

public class ListApisRequest : IOciRequest

Examples

Click here to see an example of how to use ListApis 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	A user-friendly name. Does not have to be unique, and it's changeable. Example: My new resource

LifecycleState

Declaration

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

Property Value

Type	Description
ApiSummary.LifecycleStateEnum?	A filter to return only resources that match the given lifecycle state. Example: ACTIVE

Limit

Declaration

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

Property Value

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

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

Property Value

Type	Description
ListApisRequest.SortByEnum?	The field to sort by. You can provide one sort order (sortOrder). Default order for timeCreated is descending. Default order for displayName is ascending. The displayName sort order is case sensitive.

SortOrder

Declaration

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

Property Value

Type	Description
ListApisRequest.SortOrderEnum?	The sort order to use, either 'asc' or 'desc'. The default order depends on the sortBy value.

Implements

IOciRequest