Class ListEndpointsRequest

Inheritance

object

ListEndpointsRequest

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

Assembly: OCI.DotNetSDK.Ailanguage.dll

Syntax

public class ListEndpointsRequest : IOciRequest

Examples

Click here to see an example of how to use ListEndpoints 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 resources that match the entire display name given.

EndpointId

Declaration

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

Property Value

Type	Description
string	The OCID of the endpoint.

LifecycleState

Declaration

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

Property Value

Type	Description
Endpoint.LifecycleStateEnum?	Filter results by the specified lifecycle state. Must be a valid state for the resource type.

Limit

Declaration

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

Property Value

Type	Description
int?	The maximum number of items to return.

ModelId

Declaration

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

Property Value

Type	Description
string	The ID of the trained model for which to list the endpoints.

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	The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.

ProjectId

Declaration

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

Property Value

Type	Description
string	The ID of the project for which to list the objects.

SortBy

Declaration

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

Property Value

Type	Description
ListEndpointsRequest.SortByEnum?	Specifies the field to sort by. Accepts only one field. By default, when you sort by timeCreated, the results are shown in descending order. When you sort by displayName, the results are shown in ascending order. Sort order for the displayName field is case sensitive.

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