Class ListModelsRequest

Inheritance

object

ListModelsRequest

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

Assembly: OCI.DotNetSDK.Generativeai.dll

Syntax

public class ListModelsRequest : IOciRequest

Examples

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

Properties

Capability

Declaration

[HttpConverter(TargetEnum.Query, "capability", CollectionFormatType.Multi)]
public List<ModelCapability> Capability { get; set; }

Property Value

Type	Description
List<ModelCapability>	A filter to return only resources their capability matches the given capability.

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 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 given display name exactly.

Id

Declaration

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

Property Value

Type	Description
string	The ID of the model.

LifecycleState

Declaration

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

Property Value

Type	Description
Model.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?	For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important 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 Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.

Page

Declaration

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

Property Value

Type	Description
string	For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.

SortBy

Declaration

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

Property Value

Type	Description
ListModelsRequest.SortByEnum?	The field to sort by. You can provide only one sort order. Default order for timeCreated is descending.

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'.

Vendor

Declaration

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

Property Value

Type	Description
string	A filter to return only resources that match the entire vendor given.

Implements

IOciRequest