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

Assembly: OCI.DotNetSDK.Distributeddatabase.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

DbDeploymentType

Declaration

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

Property Value

Type	Description
DistributedDatabase.DbDeploymentTypeEnum?	A filter to return only resources their dbDeploymentType matches the given dbDeploymentType.

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.

LifecycleState

Declaration

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

Property Value

Type	Description
DistributedDatabase.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.

Metadata

Declaration

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

Property Value

Type	Description
string	Comma separated names of argument corresponding to which metadata need to be retrived.

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 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