Class ListPlatformConfigurationsRequest

Inheritance

object

ListPlatformConfigurationsRequest

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

Assembly: OCI.DotNetSDK.Fleetappsmanagement.dll

Syntax

public class ListPlatformConfigurationsRequest : IOciRequest

Examples

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

Properties

CompartmentId

Declaration

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

Property Value

Type	Description
string	The ID of the compartment in which to list resources. Empty only if the resource OCID query param is not specified.

CompartmentIdInSubtree

Declaration

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

Property Value

Type	Description
bool?	If set to true, resources will be returned for not only the provided compartment, but all compartments which descend from it. Which resources are returned and their field contents depends on the value of accessLevel.

ConfigCategory

Declaration

[HttpConverter(TargetEnum.Query, "configCategory")]
public ConfigCategoryDetails.ConfigCategoryEnum? ConfigCategory { get; set; }

Property Value

Type	Description
ConfigCategoryDetails.ConfigCategoryEnum?	Config Category

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 entire display name given.

Id

Declaration

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

Property Value

Type	Description
string	Unique identifier or OCID for listing a single Platform Configuration by id. Either compartmentId or id must be provided.

LifecycleState

Declaration

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

Property Value

Type	Description
PlatformConfiguration.LifecycleStateEnum?	A filter to return only resources their lifecycleState matches the given lifecycleState.

Limit

Declaration

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

Property Value

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

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	A token representing the position at which to start retrieving results. This must come from the opc-next-page header field of a previous response.

SortBy

Declaration

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

Property Value

Type	Description
PlatformConfigurationSortBy?	The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending.

SortOrder

Declaration

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

Property Value

Type	Description
SortOrder?	The sort order to use, either 'ASC' or 'DESC'.

Type

Declaration

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

Property Value

Type	Description
PlatformConfiguration.TypeEnum?	A filter to return Platform Configurations whose type matches the given type.

Implements

IOciRequest