Class GetEntityRequest

Inheritance

object

GetEntityRequest

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

Assembly: OCI.DotNetSDK.Datacatalog.dll

Syntax

public class GetEntityRequest : IOciRequest

Examples

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

Properties

CatalogId

Declaration

[Required(ErrorMessage = "CatalogId is required.")]
[HttpConverter(TargetEnum.Path, "catalogId")]
public string CatalogId { get; set; }

Property Value

Type	Description
string	Unique catalog identifier.

Remarks

Required

DataAssetKey

Declaration

[Required(ErrorMessage = "DataAssetKey is required.")]
[HttpConverter(TargetEnum.Path, "dataAssetKey")]
public string DataAssetKey { get; set; }

Property Value

Type	Description
string	Unique data asset key.

Remarks

Required

EntityKey

Declaration

[Required(ErrorMessage = "EntityKey is required.")]
[HttpConverter(TargetEnum.Path, "entityKey")]
public string EntityKey { get; set; }

Property Value

Type	Description
string	Unique entity key.

Remarks

Required

Fields

Declaration

[HttpConverter(TargetEnum.Query, "fields", CollectionFormatType.Multi)]
public List<GetEntityRequest.FieldsEnum> Fields { get; set; }

Property Value

Type	Description
List<GetEntityRequest.FieldsEnum>	Specifies the fields to return in an entity response.

IsIncludeObjectRelationships

Declaration

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

Property Value

Type	Description
bool?	Indicates whether the list of objects and their relationships to this object will be provided in the response.

OpcRequestId

Declaration

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

Property Value

Type	Description
string	The client request ID for tracing.

Implements

IOciRequest