Show / Hide Table of Contents

Class ListRecipesRequest

Inheritance
object
ListRecipesRequest
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.GoldengateService.Requests
Assembly: OCI.DotNetSDK.Goldengate.dll
Syntax
public class ListRecipesRequest : IOciRequest
Examples

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

Properties

CompartmentId

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

The OCID of the compartment that contains the work request. Work requests should be scoped to the same compartment as the resource the work request affects. If the work request concerns multiple resources, and those resources are not in the same compartment, it is up to the service team to pick the primary resource whose compartment should be used.

Remarks

Required

DisplayName

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

A filter to return only the resources that match the entire 'displayName' given.

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

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.

RecipeType

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

The pipeline's recipe type. The default value is ZERO_ETL.

SortBy

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

The field to sort by. Only one sort order can be provided. Default order for 'timeCreated' is descending. Default order for 'displayName' is ascending. If no value is specified timeCreated is the default.

SortOrder

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

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

Implements

IOciRequest
In this article
Back to top