Class ListLoadBalancersRequest

Inheritance

object

ListLoadBalancersRequest

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

Assembly: OCI.DotNetSDK.Loadbalancer.dll

Syntax

public class ListLoadBalancersRequest : IOciRequest

Examples

Click here to see an example of how to use ListLoadBalancers 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 containing the load balancers to list.

Remarks

Required

Detail

Declaration

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

Property Value

Type	Description
string	The level of detail to return for each result. Can be `full` or `simple`. Example: full

DisplayName

Declaration

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

Property Value

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

LifecycleState

Declaration

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

Property Value

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

Limit

Declaration

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

Property Value

Type	Description
long?	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. Example: 50

OpcRequestId

Declaration

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

Property Value

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

SortBy

Declaration

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

Property Value

Type	Description
ListLoadBalancersRequest.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 ListLoadBalancersRequest.SortOrderEnum? SortOrder { get; set; }

Property Value

Type	Description
ListLoadBalancersRequest.SortOrderEnum?	The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order is case sensitive.

Implements

IOciRequest