Show / Hide Table of Contents

Class ListCustomPropertiesRequest

Inheritance
object
ListCustomPropertiesRequest
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 ListCustomPropertiesRequest : IOciRequest
Examples

Click here to see an example of how to use ListCustomProperties 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

CreatedById

Declaration
[HttpConverter(TargetEnum.Query, "createdById")]
public string CreatedById { get; set; }
Property Value
Type Description
string

OCID of the user who created the resource.

DataTypes

Declaration
[HttpConverter(TargetEnum.Query, "dataTypes", CollectionFormatType.Multi)]
public List<CustomPropertyDataType> DataTypes { get; set; }
Property Value
Type Description
List<CustomPropertyDataType>

Return the custom properties which has specified data types

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 entire display name given. The match is not case sensitive.

DisplayNameContains

Declaration
[HttpConverter(TargetEnum.Query, "displayNameContains")]
public string DisplayNameContains { get; set; }
Property Value
Type Description
string

A filter to return only resources that match display name pattern given. The match is not case sensitive. For Example : /folders?displayNameContains=Cu.* The above would match all folders with display name that starts with "Cu" or has the pattern "Cu" anywhere in between.

Fields

Declaration
[HttpConverter(TargetEnum.Query, "fields", CollectionFormatType.Multi)]
public List<ListCustomPropertiesRequest.FieldsEnum> Fields { get; set; }
Property Value
Type Description
List<ListCustomPropertiesRequest.FieldsEnum>

Specifies the fields to return in a custom property summary response.

LifecycleState

Declaration
[HttpConverter(TargetEnum.Query, "lifecycleState")]
public LifecycleState? LifecycleState { get; set; }
Property Value
Type Description
LifecycleState?

A filter to return only resources that match the specified lifecycle state. The value is case insensitive.

Limit

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

The maximum number of items to return.

NamespaceId

Declaration
[Required(ErrorMessage = "NamespaceId is required.")]
[HttpConverter(TargetEnum.Path, "namespaceId")]
public string NamespaceId { get; set; }
Property Value
Type Description
string

Unique namespace identifier.

Remarks

Required

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 ListCustomPropertiesRequest.SortByEnum? SortBy { get; set; }
Property Value
Type Description
ListCustomPropertiesRequest.SortByEnum?

The field to sort by. Only one sort order may be provided. Default order for USAGECOUNT and DISPLAYNAME is Ascending

SortOrder

Declaration
[HttpConverter(TargetEnum.Query, "sortOrder")]
public ListCustomPropertiesRequest.SortOrderEnum? SortOrder { get; set; }
Property Value
Type Description
ListCustomPropertiesRequest.SortOrderEnum?

The sort order to use, either 'asc' or 'desc'.

TimeCreated

Declaration
[HttpConverter(TargetEnum.Query, "timeCreated")]
public DateTime? TimeCreated { get; set; }
Property Value
Type Description
DateTime?

Time that the resource was created. An RFC3339 formatted datetime string.

TimeUpdated

Declaration
[HttpConverter(TargetEnum.Query, "timeUpdated")]
public DateTime? TimeUpdated { get; set; }
Property Value
Type Description
DateTime?

Time that the resource was updated. An RFC3339 formatted datetime string.

TypeName

Declaration
[HttpConverter(TargetEnum.Query, "typeName", CollectionFormatType.Multi)]
public List<ListCustomPropertiesRequest.TypeNameEnum> TypeName { get; set; }
Property Value
Type Description
List<ListCustomPropertiesRequest.TypeNameEnum>

A filter to return only resources that match the entire type name given. The match is not case sensitive

UpdatedById

Declaration
[HttpConverter(TargetEnum.Query, "updatedById")]
public string UpdatedById { get; set; }
Property Value
Type Description
string

OCID of the user who updated the resource.

Implements

IOciRequest
In this article
Back to top