Class ListGroupsRequest

Inheritance

object

ListGroupsRequest

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

Assembly: OCI.DotNetSDK.Identity.dll

Syntax

public class ListGroupsRequest : IOciRequest

Examples

Click here to see an example of how to use ListGroups 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 (remember that the tenancy is simply the root compartment).

Remarks

Required

LifecycleState

Declaration

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

Property Value

Type	Description
Group.LifecycleStateEnum?	A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.

Limit

Declaration

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

Property Value

Type	Description
int?	The maximum number of 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.

Page

Declaration

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

Property Value

Type	Description
string	The value of the `opc-next-page` response header from the previous "List" call.

SortBy

Declaration

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

Property Value

Type Description

Type	Description
ListGroupsRequest.SortByEnum?	The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for NAME is ascending. The NAME sort order is case sensitive. Note: In general, some "List" operations (for example, `ListInstances`) let you optionally filter by Availability Domain if the scope of the resource type is within a single Availability Domain. If you call one of these "List" operations without specifying an Availability Domain, the resources are grouped by Availability Domain, then sorted.

ListGroupsRequest.SortByEnum?

The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for NAME is ascending. The NAME sort order is case sensitive.
Note: In general, some "List" operations (for example, ListInstances) let you optionally filter by Availability Domain if the scope of the resource type is within a single Availability Domain. If you call one of these "List" operations without specifying an Availability Domain, the resources are grouped by Availability Domain, then sorted.

SortOrder

Declaration

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

Property Value

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

Implements

IOciRequest