Class FilterResourceActionsRequest

Inheritance

object

FilterResourceActionsRequest

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 FilterResourceActionsRequest : IOciRequest

Examples

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

Properties

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. If this list contains a tenancy id that isn't part of the organization of parent P, the request will fail. That is, let's say there is an organization with parent P with children A and B, and also one other tenant T that isn't part of the organization. If T is included in the list of childTenancyIds, the request will fail. It is important to note that if you are setting the includeOrganization parameter value as true and also populating the childTenancyIds parameter with a list of child tenancies, the request will fail. The childTenancyIds and includeOrganization should be used exclusively. When using this parameter, please make sure to set the compartmentId with the parent tenancy ID.

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.
If this list contains a tenancy id that isn't part of the organization of parent P, the request will fail. That is, let's say there is an organization with parent P with children A and B, and also one other tenant T that isn't part of the organization. If T is included in the list of childTenancyIds, the request will fail.
It is important to note that if you are setting the includeOrganization parameter value as true and also populating the childTenancyIds parameter with a list of child tenancies, the request will fail. The childTenancyIds and includeOrganization should be used exclusively.
When using this parameter, please make sure to set the compartmentId with the parent tenancy ID.

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

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. Please note that this parameter shouldn't be used along with childTenancyIds parameter. If you would like to get results specifically for parent P and only child A, use the childTenancyIds parameter and populate the list with tenancy id of P and A. When using this parameter, please make sure to set the compartmentId with the parent tenancy ID.

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.
Please note that this parameter shouldn't be used along with childTenancyIds parameter. If you would like to get results specifically for parent P and only child A, use the childTenancyIds parameter and populate the list with tenancy id of P and A.
When using this parameter, please make sure to set the compartmentId with the parent tenancy ID.

IncludeResourceMetadata

Declaration

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

Property Value

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

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.

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.

QueryDetails

Declaration

[Required(ErrorMessage = "QueryDetails is required.")]
[HttpConverter(TargetEnum.Body)]
public QueryDetails QueryDetails { get; set; }

Property Value

Type	Description
QueryDetails	The request parameters that describe the query criteria.

Remarks

Required

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.

Implements

IOciRequest