Class ListTemplatesRequest

Inheritance

object

ListTemplatesRequest

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

Assembly: OCI.DotNetSDK.Resourcemanager.dll

Syntax

public class ListTemplatesRequest : IOciRequest

Examples

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

Properties

CompartmentId

Declaration

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

Property Value

Type	Description
string	A filter to return only resources that exist in the compartment, identified by OCID.

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. Use this filter to list a resource by name. Requires `sortBy` set to `DISPLAYNAME`. Alternatively, when you know the resource OCID, use the related Get operation.

Limit

Declaration

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

Property Value

Type	Description
int?	The number of items returned in a paginated `List` call. For information about pagination, 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.

Page

Declaration

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

Property Value

Type	Description
string	The value of the `opc-next-page` response header from the preceding `List` call. For information about pagination, see List Pagination.

SortBy

Declaration

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

Property Value

Type	Description
ListTemplatesRequest.SortByEnum?	The field to use when sorting returned resources. By default, `TIMECREATED` is ordered descending. By default, `DISPLAYNAME` is ordered ascending. Note that you can sort only on one field.

SortOrder

Declaration

[HttpConverter(TargetEnum.Query, "sortOrder")]
public ListTemplatesRequest.SortOrderEnum? SortOrder { get; set; }

Property Value

Type	Description
ListTemplatesRequest.SortOrderEnum?	The sort order to use when sorting returned resources. Ascending (`ASC`) or descending (`DESC`).

TemplateCategoryId

Declaration

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

Property Value

Type Description

Type	Description
string	Unique identifier for the template category. Possible values are `0` (Quickstarts), `1` (Service), `2` (Architecture), and `3` (Private). Template category labels are displayed in the Console page listing templates. Quickstarts, Service, and Architecture templates (categories 0, 1, and 2) are available in all compartments. Each private template (category 3) is available in the compartment where it was created.

string

Unique identifier for the template category. Possible values are 0 (Quickstarts), 1 (Service), 2 (Architecture), and 3 (Private). Template category labels are displayed in the Console page listing templates. Quickstarts, Service, and Architecture templates (categories 0, 1, and 2) are available in all compartments. Each private template (category 3) is available in the compartment where it was created.

TemplateId

Declaration

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

Property Value

Type	Description
string	The OCID of the template.

Implements

IOciRequest