Class ListVtapsRequest

Inheritance

object

ListVtapsRequest

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

Assembly: OCI.DotNetSDK.Core.dll

Syntax

public class ListVtapsRequest : IOciRequest

Examples

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

Properties

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.

Remarks

Required

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 given display name exactly.

IsVtapEnabled

Declaration

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

Property Value

Type	Description
bool?	Indicates whether to list all VTAPs or only running VTAPs. When FALSE, lists ALL running and stopped VTAPs. When TRUE, lists only running VTAPs (VTAPs where isVtapEnabled = TRUE).

LifecycleState

Declaration

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

Property Value

Type	Description
Vtap.LifecycleStateEnum?	A filter to return only resources that match the given VTAP administrative lifecycle state. The state value is case-insensitive.

Limit

Declaration

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

Property Value

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

OpcRequestId

Declaration

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

Property Value

Type	Description
string	Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Page

Declaration

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

Property Value

Type	Description
string	For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.

SortBy

Declaration

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

Property Value

Type

Description

ListVtapsRequest.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. Note: In general, some "List" operations (for example, ListInstances) let you optionally filter by availability domain if the scope of the resource type is within a single availability domain. If you call one of these "List" operations without specifying an availability domain, the resources are grouped by availability domain, then sorted.

SortOrder

Declaration

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

Property Value

Type	Description
ListVtapsRequest.SortOrderEnum?	The sort order to use, either ascending (ASC) or descending (DESC). The DISPLAYNAME sort order is case sensitive.

Source

Declaration

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

Property Value

Type	Description
string	The OCID of the VTAP source.

TargetId

Declaration

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

Property Value

Type	Description
string	The OCID of the VTAP target.

TargetIp

Declaration

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

Property Value

Type	Description
string	The IP address of the VTAP target.

VcnId

Declaration

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

Property Value

Type	Description
string	The OCID of the VCN.

Implements

IOciRequest