Class ListRecommendationsRequest
Implements
Inherited Members
Namespace: Oci.OptimizerService.Requests
Assembly: OCI.DotNetSDK.Optimizer.dll
Syntax
public class ListRecommendationsRequest : IOciRequest
Examples
Click here to see an example of how to use ListRecommendations request.
Properties
CategoryId
Declaration
[HttpConverter(TargetEnum.Query, "categoryId")]
public string CategoryId { get; set; }
Property Value
Type | Description |
---|---|
string | The unique OCID associated with the category. |
CategoryName
Declaration
[HttpConverter(TargetEnum.Query, "categoryName")]
public string CategoryName { get; set; }
Property Value
Type | Description |
---|---|
string | Optional. A filter that returns results that match the category name specified. |
ChildTenancyIds
Declaration
[HttpConverter(TargetEnum.Query, "childTenancyIds", CollectionFormatType.Multi)]
public List<string> ChildTenancyIds { get; set; }
Property Value
Type | Description |
---|---|
List<string> | A list of child tenancies for which the respective data will be returned. Please note that
the parent tenancy id can also be included in this list. For example, if there is a parent P with two
children A and B, to return results of only parent P and child A, this list should be populated with
tenancy id of parent P and child A.
|
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 |
Remarks
Required
IncludeOrganization
Declaration
[HttpConverter(TargetEnum.Query, "includeOrganization")]
public bool? IncludeOrganization { get; set; }
Property Value
Type | Description |
---|---|
bool? | When set to true, the data for all child tenancies including the parent is returned. That is, if
there is an organization with parent P and children A and B, to return the data for the parent P, child
A and child B, this parameter value should be set to true.
|
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 |
SortBy
Declaration
[HttpConverter(TargetEnum.Query, "sortBy")]
public ListRecommendationsRequest.SortByEnum? SortBy { get; set; }
Property Value
Type | Description |
---|---|
ListRecommendationsRequest.SortByEnum? | The field to sort by. You can provide one sort order ( |
SortOrder
Declaration
[HttpConverter(TargetEnum.Query, "sortOrder")]
public SortOrder? SortOrder { get; set; }
Property Value
Type | Description |
---|---|
SortOrder? | The sort order to use, either ascending ( |
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. |