Class ListConnectionsRequest
Implements
Inherited Members
Namespace: Oci.GoldengateService.Requests
Assembly: OCI.DotNetSDK.Goldengate.dll
Syntax
public class ListConnectionsRequest : IOciRequest
Examples
Click here to see an example of how to use ListConnections request.
Properties
AssignableDeploymentId
Declaration
[HttpConverter(TargetEnum.Query, "assignableDeploymentId")]
public string AssignableDeploymentId { get; set; }
Property Value
Type | Description |
---|---|
string | Filters for compatible connections which can be, but currently not assigned to the deployment specified by its id. |
AssignableDeploymentType
Declaration
[HttpConverter(TargetEnum.Query, "assignableDeploymentType")]
public DeploymentType? AssignableDeploymentType { get; set; }
Property Value
Type | Description |
---|---|
DeploymentType? | Filters for connections which can be assigned to the latest version of the specified deployment type. |
AssignedDeploymentId
Declaration
[HttpConverter(TargetEnum.Query, "assignedDeploymentId")]
public string AssignedDeploymentId { get; set; }
Property Value
Type | Description |
---|---|
string | The OCID of the deployment which for the connection must be assigned. |
CompartmentId
Declaration
[Required(ErrorMessage = "CompartmentId is required.")]
[HttpConverter(TargetEnum.Query, "compartmentId")]
public string CompartmentId { get; set; }
Property Value
Type | Description |
---|---|
string | The OCID of the compartment that contains the work request. Work requests should be scoped to the same compartment as the resource the work request affects. If the work request concerns multiple resources, and those resources are not in the same compartment, it is up to the service team to pick the primary resource whose compartment should be used. |
Remarks
Required
ConnectionType
Declaration
[HttpConverter(TargetEnum.Query, "connectionType", CollectionFormatType.Multi)]
public List<ConnectionType> ConnectionType { get; set; }
Property Value
Type | Description |
---|---|
List<ConnectionType> | The array of connection types. |
DisplayName
Declaration
[HttpConverter(TargetEnum.Query, "displayName")]
public string DisplayName { get; set; }
Property Value
Type | Description |
---|---|
string | A filter to return only the resources that match the entire 'displayName' given. |
LifecycleState
Declaration
[HttpConverter(TargetEnum.Query, "lifecycleState")]
public Connection.LifecycleStateEnum? LifecycleState { get; set; }
Property Value
Type | Description |
---|---|
Connection.LifecycleStateEnum? | A filter to return only connections having the 'lifecycleState' given. |
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 | The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. |
SortBy
Declaration
[HttpConverter(TargetEnum.Query, "sortBy")]
public ListConnectionsRequest.SortByEnum? SortBy { get; set; }
Property Value
Type | Description |
---|---|
ListConnectionsRequest.SortByEnum? | The field to sort by. Only one sort order can be provided. Default order for 'timeCreated' is descending. Default order for 'displayName' is ascending. If no value is specified timeCreated is the default. |
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'. |
TechnologyType
Declaration
[HttpConverter(TargetEnum.Query, "technologyType", CollectionFormatType.Multi)]
public List<TechnologyType> TechnologyType { get; set; }
Property Value
Type | Description |
---|---|
List<TechnologyType> | The array of technology types. |