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

Assembly: OCI.DotNetSDK.Loganalytics.dll

Syntax

public class ListTemplatesRequest : IOciRequest

Examples

Click here to see an example of how to use ListTemplates 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

Filter

Declaration

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

Property Value

Type	Description
string	filter

LifecycleState

Declaration

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

Property Value

Type	Description
ConfigLifecycleState?	The template lifecycle state used for filtering. Currently supported values are ACTIVE and DELETED.

Limit

Declaration

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

Property Value

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

Name

Declaration

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

Property Value

Type	Description
string	The template name used for filtering.

NamespaceName

Declaration

[Required(ErrorMessage = "NamespaceName is required.")]
[HttpConverter(TargetEnum.Path, "namespaceName")]
public string NamespaceName { get; set; }

Property Value

Type	Description
string	The Logging Analytics namespace used for the request.

Remarks

Required

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.

SortBy

Declaration

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

Property Value

Type	Description
ListTemplatesRequest.SortByEnum?	The attribute used to sort the returned templates

SortOrder

Declaration

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

Property Value

Type	Description
ListTemplatesRequest.SortOrderEnum?	The sort order to use, either ascending (ASC) or descending (DESC).

TemplateDisplayText

Declaration

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

Property Value

Type	Description
string	The template display text used for filtering. Only templates with the specified name or description will be returned.

Type

Declaration

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

Property Value

Type	Description
string	The template type used for filtering. Only templates of the specified type will be returned.

Implements

IOciRequest