Class ListTargetDatabasesRequest

Inheritance

object

ListTargetDatabasesRequest

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

Assembly: OCI.DotNetSDK.Datasafe.dll

Syntax

public class ListTargetDatabasesRequest : IOciRequest

Examples

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

Properties

AccessLevel

Declaration

[HttpConverter(TargetEnum.Query, "accessLevel")]
public ListTargetDatabasesRequest.AccessLevelEnum? AccessLevel { get; set; }

Property Value

Type	Description
ListTargetDatabasesRequest.AccessLevelEnum?	Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed.

AssociatedResourceId

Declaration

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

Property Value

Type	Description
string	A filter to return the target databases that are associated to the resource id passed in as a parameter value.

CompartmentId

Declaration

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

Property Value

Type	Description
string	A filter to return only resources that match the specified compartment OCID.

Remarks

Required

CompartmentIdInSubtree

Declaration

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

Property Value

Type	Description
bool?	Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.

DatabaseType

Declaration

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

Property Value

Type	Description
DatabaseType?	A filter to return only target databases that match the specified database type.

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 specified display name.

InfrastructureType

Declaration

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

Property Value

Type	Description
InfrastructureType?	A filter to return only target databases that match the specified infrastructure type.

LifecycleState

Declaration

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

Property Value

Type	Description
TargetDatabaseLifecycleState?	A filter to return only target databases that match the specified lifecycle state.

Limit

Declaration

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

Property Value

Type	Description
int?	For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

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	For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

SortBy

Declaration

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

Property Value

Type	Description
ListTargetDatabasesRequest.SortByEnum?	The field used for sorting. Only one sorting order (sortOrder) can be specified. The default order for TIMECREATED is descending. The default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.

SortOrder

Declaration

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

Property Value

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

TargetDatabaseId

Declaration

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

Property Value

Type	Description
string	A filter to return the target database that matches the specified OCID.

Implements

IOciRequest