Class GetVcnTopologyRequest

Inheritance

object

GetVcnTopologyRequest

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 GetVcnTopologyRequest : IOciRequest

Examples

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

Properties

AccessLevel

Declaration

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

Property Value

Type	Description
GetVcnTopologyRequest.AccessLevelEnum?	Valid values are `ANY` and `ACCESSIBLE`. The default is `ANY`. Setting this to `ACCESSIBLE` returns only compartments for which a user has INSPECT permissions, either directly or indirectly (permissions can be on a resource in a subcompartment). A restricted set of fields is returned for compartments in which a user has indirect INSPECT permissions. When set to `ANY` permissions are not checked.

CacheControl

Declaration

[HttpConverter(TargetEnum.Header, "cache-control")]
public string CacheControl { get; set; }

Property Value

Type	Description
string	The Cache-Control HTTP header holds directives (instructions) for caching in both requests and responses.

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

IfNoneMatch

Declaration

[HttpConverter(TargetEnum.Header, "if-none-match")]
public string IfNoneMatch { get; set; }

Property Value

Type	Description
string	For querying if there is a cached value on the server. The If-None-Match HTTP request header makes the request conditional. For GET and HEAD methods, the server will send back the requested resource, with a 200 status, only if it doesn't have an ETag matching the given ones. For other methods, the request will be processed only if the eventually existing resource's ETag doesn't match any of the values listed.

Type

Description

string

For querying if there is a cached value on the server. The If-None-Match HTTP request header makes the request conditional. For GET and HEAD methods, the server will send back the requested resource, with a 200 status, only if it doesn't have an ETag matching the given ones. For other methods, the request will be processed only if the eventually existing resource's ETag doesn't match any of the values listed.

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.

QueryCompartmentSubtree

Declaration

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

Property Value

Type	Description
bool?	When set to true, the hierarchy of compartments is traversed and the specified compartment and its subcompartments are inspected depending on the the setting of `accessLevel`. Default is false.

VcnId

Declaration

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

Property Value

Type	Description
string	The OCID of the VCN.

Remarks

Required

Implements

IOciRequest