Class ListWarehouseDataObjectsRequest

Inheritance

object

ListWarehouseDataObjectsRequest

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

Assembly: OCI.DotNetSDK.Opsi.dll

Syntax

public class ListWarehouseDataObjectsRequest : IOciRequest

Examples

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

Properties

DataObjectType

Declaration

[HttpConverter(TargetEnum.Query, "dataObjectType", CollectionFormatType.Multi)]
public List<DataObjectType> DataObjectType { get; set; }

Property Value

Type	Description
List<DataObjectType>	A filter to return only data objects that match the data object type. By default, no filtering will be applied on data object type.

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

Name

Declaration

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

Property Value

Type	Description
string	A filter to return only data objects that match the entire data object name. By default, no filtering will be applied on data object name.

OpcRequestId

Declaration

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

Property Value

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

Owner

Declaration

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

Property Value

Type	Description
string	A filter to return only data objects that match the entire data object owner name. By default, no filtering will be applied on data object owner name.

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 ListWarehouseDataObjectsRequest.SortByEnum? SortBy { get; set; }

Property Value

Type	Description
ListWarehouseDataObjectsRequest.SortByEnum?	Sort options for Warehouse data objects list.

SortOrder

Declaration

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

Property Value

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

SummaryField

Declaration

[HttpConverter(TargetEnum.Query, "summaryField", CollectionFormatType.Multi)]
public List<ListWarehouseDataObjectsRequest.SummaryFieldEnum> SummaryField { get; set; }

Property Value

Type	Description
List<ListWarehouseDataObjectsRequest.SummaryFieldEnum>	Specifies the optional fields to return in a WarehouseDataObjectSummary. Unless requested, these fields are not returned by default.

WarehouseId

Declaration

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

Property Value

Type	Description
string	The OCID of a Warehouse.

Remarks

Required

WarehouseType

Declaration

[Required(ErrorMessage = "WarehouseType is required.")]
[HttpConverter(TargetEnum.Path, "warehouseType")]
public ListWarehouseDataObjectsRequest.WarehouseTypeEnum? WarehouseType { get; set; }

Property Value

Type	Description
ListWarehouseDataObjectsRequest.WarehouseTypeEnum?	Type of the Warehouse.

Remarks

Required

Implements

IOciRequest