Show / Hide Table of Contents

Class ListPrivateEndpointsRequest

Inheritance
object
ListPrivateEndpointsRequest
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.GloballydistributeddatabaseService.Requests
Assembly: OCI.DotNetSDK.Globallydistributeddatabase.dll
Syntax
public class ListPrivateEndpointsRequest : IOciRequest
Examples

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

Properties

CompartmentId

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

The ID 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 filter to return only private endpoint that match the entire name given. The match is not case sensitive.

LifecycleState

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

A filter to return only resources their lifecycleState matches the given lifecycleState.

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

A token representing the position at which to start retrieving results. This must come from the opc-next-page header field of a previous response.

SortBy

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

The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending.

SortOrder

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

The sort order to use, either 'ASC' or 'DESC'.

Implements

IOciRequest
In this article
Back to top