Class ListDataFilesRequest

Inheritance
object
ListDataFilesRequest
Implements
Inherited Members
Namespace: Oci.ApmconfigService.Requests
Assembly: OCI.DotNetSDK.Apmconfig.dll
Syntax
public class ListDataFilesRequest : IOciRequest
Examples

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

Properties

ApmDomainId

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

The APM Domain ID the request is intended for.
Remarks

Required

ApmType

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

The type of the data file.

Limit

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

The maximum number of items to return.

Metadata

Declaration
[HttpConverter(TargetEnum.Header, "metadata")]
public string Metadata { get; set; }
Property Value
Type Description
string

A string containing a JSON-encoded object with metadata related to the uploaded file or resource. Example: {"fileName":"report.pdf","uploader":"jane.doe","category":"financial"}

Name

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

A filter to return resources that match the specified name. Supports regular expressions to filter data files.

OpcClientRequestId

Declaration
[HttpConverter(TargetEnum.Header, "opc-client-request-id")]
public string OpcClientRequestId { get; set; }
Property Value
Type Description
string

The client request ID for tracing.

OpcRetryToken

Declaration
[HttpConverter(TargetEnum.Header, "opc-retry-token")]
public string OpcRetryToken { get; set; }
Property Value
Type Description
string

A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Page

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

The maximum number of results per page, or items to return in a paginated "List" call. For information on how pagination works, see List Pagination. Example: 50

SortBy

Declaration
[HttpConverter(TargetEnum.Query, "sortBy")]
public ListDataFilesRequest.SortByEnum? SortBy { get; set; }
Property Value
Type Description
ListDataFilesRequest.SortByEnum?

The field to sort by. You can provide one "sortBy" value. The default order for displayName, timeCreated and timeUpdated is ascending. The displayName sort by is case-sensitive.

SortOrder

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

The sort order to use, either ascending (ASC) or descending (DESC). The displayName sort order is case-sensitive.

TimeLastModifiedAfter

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

Return data files with the 'timeLastModified' after the specified time, expressed in RFC 3339 timestamp format. Example: 2020-02-19T22:47:12.613Z

TimeLastModifiedBefore

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

Return data files with time 'timeLastModified' before the specified time, expressed in RFC 3339 timestamp format. Example: 2020-02-19T22:47:12.613Z

Implements