Show / Hide Table of Contents

Class ListRefsRequest

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

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

Properties

CommitId

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

Commit ID in 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.

RefName

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

A filter to return only resources that match the given reference name.

RefType

Declaration
[HttpConverter(TargetEnum.Query, "refType")]
public ListRefsRequest.RefTypeEnum? RefType { get; set; }
Property Value
Type Description
ListRefsRequest.RefTypeEnum?

Reference type to distinguish between branch and tag. If it is not specified, all references are returned.

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

The field to sort by. Only one sort order may be provided. Default order for reference name is ascending. Default order for reference type is ascending. If no value is specified reference 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