Class ListOnPremConnectorsRequest

Inheritance
object
ListOnPremConnectorsRequest
Implements
Inherited Members
Namespace: Oci.DatasafeService.Requests
Assembly: OCI.DotNetSDK.Datasafe.dll
Syntax
public class ListOnPremConnectorsRequest : IOciRequest
Examples

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

Properties

AccessLevel

Declaration
[HttpConverter(TargetEnum.Query, "accessLevel")]
public ListOnPremConnectorsRequest.AccessLevelEnum? AccessLevel { get; set; }
Property Value
Type Description
ListOnPremConnectorsRequest.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.

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.

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.

OnPremConnectorId

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

A filter to return only the on-premises connector that matches the specified id.

OnPremConnectorLifecycleState

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

A filter to return only on-premises connector resources that match the specified lifecycle state.

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 ListOnPremConnectorsRequest.SortByEnum? SortBy { get; set; }
Property Value
Type Description
ListOnPremConnectorsRequest.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 ListOnPremConnectorsRequest.SortOrderEnum? SortOrder { get; set; }
Property Value
Type Description
ListOnPremConnectorsRequest.SortOrderEnum?

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

Implements