Show / Hide Table of Contents

Class ListPathsRequest

Inheritance
object
ListPathsRequest
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.DevopsService.Requests
Assembly: OCI.DotNetSDK.Devops.dll
Syntax
public class ListPathsRequest : IOciRequest
Examples

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

Properties

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.

FolderPath

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

The fully qualified path to the folder whose contents are returned, including the folder name. For example, /examples is a fully-qualified path to a folder named examples that was created off of the root directory (/) of a repository.

Limit

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

The maximum number of items to return.

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, provide the request ID.

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.

PathsInSubtree

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

Flag to determine if files must be retrived recursively. Flag is False by default.

Ref

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

The name of branch/tag or commit hash it points to. If names conflict, order of preference is commit > branch > tag. You can disambiguate with "heads/foobar" and "tags/foobar". If left blank repository's default branch will be used.

RepositoryId

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

Unique repository identifier.

Remarks

Required

SortBy

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

The field to sort by. Only one sort order may be provided. Default order is ascending. If no value is specified name is default.

SortOrder

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

The sort order to use. Use either ascending or descending.

Implements

IOciRequest
In this article
Back to top