Class ListGiHomesRequest

Inheritance

object

ListGiHomesRequest

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

Assembly: OCI.DotNetSDK.Database.dll

Syntax

public class ListGiHomesRequest : IOciRequest

Examples

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

Properties

CompartmentId

Declaration

[Required(ErrorMessage = "CompartmentId is required.")]
[HttpConverter(TargetEnum.Query, "compartmentId")]
public string CompartmentId { get; set; }

Property Value

Type	Description
string	The compartment OCID.

Remarks

Required

DbSystemId

Declaration

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

Property Value

Type	Description
string	The DB system OCID. If provided, filters the results to the set of database versions which are supported for the DB system.

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. The match is not case sensitive.

GiVersion

Declaration

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

Property Value

Type	Description
string	The Grid Infrastructure version. If provided, filters the results matching the provided grid infrastructure version.

LifecycleState

Declaration

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

Property Value

Type	Description
GiHomeSummary.LifecycleStateEnum?	A filter to return only resources that match the given lifecycle state exactly.

Limit

Declaration

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

Property Value

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

OpcRequestId

Declaration

[HttpConverter(TargetEnum.Header, "opc-request-id")]
public string OpcRequestId { get; set; }

Property Value

Type	Description
string	Unique identifier for the request.

Page

Declaration

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

Property Value

Type	Description
string	The pagination token to continue listing from.

SortBy

Declaration

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

Property Value

Type	Description
ListGiHomesRequest.SortByEnum?	The field to sort by. You can provide one sort order (sortOrder). Default order for timeCreated is descending. Default order for displayName is ascending. The displayName sort order is case sensitive.

SortOrder

Declaration

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

Property Value

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

Implements

IOciRequest