Class ListHistoriesRequest

Inheritance

object

ListHistoriesRequest

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

Assembly: OCI.DotNetSDK.Optimizer.dll

Syntax

public class ListHistoriesRequest : IOciRequest

Examples

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

Properties

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.

Remarks

Required

CompartmentIdInSubtree

Declaration

[Required(ErrorMessage = "CompartmentIdInSubtree is required.")]
[HttpConverter(TargetEnum.Query, "compartmentIdInSubtree")]
public bool? CompartmentIdInSubtree { get; set; }

Property Value

Type	Description
bool?	When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned depending on the the setting of accessLevel. Can only be set to true when performing ListCompartments on the tenancy (root compartment).

Remarks

Required

IncludeResourceMetadata

Declaration

[HttpConverter(TargetEnum.Query, "includeResourceMetadata")]
public bool? IncludeResourceMetadata { get; set; }

Property Value

Type	Description
bool?	Supplement additional resource information in extended metadata response.

LifecycleState

Declaration

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

Property Value

Type	Description
LifecycleState?	A filter that returns results that match the lifecycle state specified.

Limit

Declaration

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

Property Value

Type	Description
int?	The maximum number of items to return in a paginated "List" call.

Name

Declaration

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

Property Value

Type	Description
string	Optional. A filter that returns results that match the name specified.

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 previous "List" call.

RecommendationId

Declaration

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

Property Value

Type	Description
string	The unique OCID associated with the recommendation.

RecommendationName

Declaration

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

Property Value

Type	Description
string	Optional. A filter that returns results that match the recommendation name specified.

ResourceType

Declaration

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

Property Value

Type	Description
string	Optional. A filter that returns results that match the resource type specified.

SortBy

Declaration

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

Property Value

Type	Description
ListHistoriesRequest.SortByEnum?	The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for NAME is ascending. The NAME sort order 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 ascending (ASC) or descending (DESC).

Status

Declaration

[HttpConverter(TargetEnum.Query, "status")]
public Status? Status { get; set; }

Property Value

Type	Description
Status?	A filter that returns recommendations that match the status specified.

Implements

IOciRequest