Show / Hide Table of Contents

Class ListAttributeSetsRequest

Inheritance
object
ListAttributeSetsRequest
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.DatasafeService.Requests
Assembly: OCI.DotNetSDK.Datasafe.dll
Syntax
public class ListAttributeSetsRequest : IOciRequest
Examples

Click here to see an example of how to use ListAttributeSets request.

Properties

AccessLevel

Declaration
[HttpConverter(TargetEnum.Query, "accessLevel")]
public ListAttributeSetsRequest.AccessLevelEnum? AccessLevel { get; set; }
Property Value
Type Description
ListAttributeSetsRequest.AccessLevelEnum?

Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed.

AttributeSetId

Declaration
[HttpConverter(TargetEnum.Query, "attributeSetId")]
public string AttributeSetId { get; set; }
Property Value
Type Description
string

A filter to return only attribute set resources that matches the specified attribute set OCID query param.

AttributeSetType

Declaration
[HttpConverter(TargetEnum.Query, "attributeSetType")]
public AttributeSet.AttributeSetTypeEnum? AttributeSetType { get; set; }
Property Value
Type Description
AttributeSet.AttributeSetTypeEnum?

A filter to return only attribute set resources that matches the specified attribute set type query param.

CompartmentId

Declaration
[Required(ErrorMessage = "CompartmentId is required.")]
[HttpConverter(TargetEnum.Query, "compartmentId")]
public string CompartmentId { get; set; }
Property Value
Type Description
string

A filter to return only resources that match the specified compartment OCID.

Remarks

Required

CompartmentIdInSubtree

Declaration
[HttpConverter(TargetEnum.Query, "compartmentIdInSubtree")]
public bool? CompartmentIdInSubtree { get; set; }
Property Value
Type Description
bool?

Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.

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 specified display name.

InUse

Declaration
[HttpConverter(TargetEnum.Query, "inUse")]
public ListAttributeSetsRequest.InUseEnum? InUse { get; set; }
Property Value
Type Description
ListAttributeSetsRequest.InUseEnum?

A filter to return attribute set resources that are in use by other associated resources.

IsUserDefined

Declaration
[HttpConverter(TargetEnum.Query, "isUserDefined")]
public bool? IsUserDefined { get; set; }
Property Value
Type Description
bool?

A filter to return user defined or seeded attribute set resources that matches the specified is user defined query param. A true value indicates user defined attribute set.

LifecycleState

Declaration
[HttpConverter(TargetEnum.Query, "lifecycleState")]
public AttributeSet.LifecycleStateEnum? LifecycleState { get; set; }
Property Value
Type Description
AttributeSet.LifecycleStateEnum?

The current state of an attribute set.

Limit

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

For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

OpcRequestId

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

Unique identifier for the request.

Page

Declaration
[HttpConverter(TargetEnum.Query, "page")]
public string Page { get; set; }
Property Value
Type Description
string

For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

SortBy

Declaration
[HttpConverter(TargetEnum.Query, "sortBy")]
public ListAttributeSetsRequest.SortByEnum? SortBy { get; set; }
Property Value
Type Description
ListAttributeSetsRequest.SortByEnum?

The field used for sorting. Only one sorting order (sortOrder) can be specified. The default order for TIMECREATED is descending. The default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.

SortOrder

Declaration
[HttpConverter(TargetEnum.Query, "sortOrder")]
public ListAttributeSetsRequest.SortOrderEnum? SortOrder { get; set; }
Property Value
Type Description
ListAttributeSetsRequest.SortOrderEnum?

The sort order to use, either ascending (ASC) or descending (DESC).

Implements

IOciRequest
In this article
Back to top