Class ListDistributedDatabasesRequest

Inheritance

object

ListDistributedDatabasesRequest

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

Assembly: OCI.DotNetSDK.Distributeddatabasev26.dll

Syntax

public class ListDistributedDatabasesRequest : IOciRequest

Examples

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

Properties

CompartmentId

Declaration

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

Property Value

Type	Description
string	The ID of the compartment in which to list resources.

Remarks

Required

CompartmentIdInSubtree

Declaration

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

Property Value

Type	Description
bool?	When set to true, returns resources in the specified compartment and in all of its child compartments recursively. Defaults to false.

DbDeploymentType

Declaration

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

Property Value

Type	Description
string	A filter to return only resources whose dbDeploymentType matches the specified value.

DisplayName

Declaration

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

Property Value

Type	Description
string	A filter to return only Globally distributed databases that match the entire name given. The match is not case sensitive.

IsAutoResourceManagementEnabled

Declaration

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

Property Value

Type	Description
bool?	A filter to return only resources where autoResourceManagement is enabled when set to true, or disabled when set to false. If omitted, no autoResourceManagement-based filtering is applied.

LifecycleState

Declaration

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

Property Value

Type	Description
DistributedDatabase.LifecycleStateEnum?	A filter to return only resources whose lifecycleState matches the specified value.

Limit

Declaration

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

Property Value

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

Metadata

Declaration

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

Property Value

Type	Description
string	Comma-separated argument names for which metadata should be retrieved.

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.

PrivateEndpointId

Declaration

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

Property Value

Type	Description
string	A filter to return only resources that are associated with the given privateEndpointId.

SortBy

Declaration

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

Property Value

Type	Description
ListDistributedDatabasesRequest.SortByEnum?	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'.

Implements

IOciRequest