Package com.oracle.bmc.goldengate.requests

Class ListRecipesRequest

java.lang.Object

com.oracle.bmc.requests.BmcRequest<Void>

com.oracle.bmc.goldengate.requests.ListRecipesRequest

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20200407")
public class ListRecipesRequest
extends BmcRequest<Void>

Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/goldengate/ListRecipesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListRecipesRequest.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ListRecipesRequest.Builder
static class	ListRecipesRequest.SortBy	The field to sort by.

Constructor Summary

Constructors

Constructor	Description
ListRecipesRequest()

Method Summary

Modifier and Type	Method	Description
static ListRecipesRequest.Builder	builder()	Return a new builder for this request object.
boolean	equals(Object o)	Uses getInvocationCallback and getRetryConfiguration to determine if passed request is equal to ‘this’.
String	getCompartmentId()	The OCID of the compartment that contains the work request.
String	getDisplayName()	A filter to return only the resources that match the entire ‘displayName’ given.
Integer	getLimit()	The maximum number of items to return.
String	getOpcRequestId()	The client request ID for tracing.
String	getPage()	The page token representing the page at which to start retrieving results.
RecipeType	getRecipeType()	The pipeline’s recipe type.
ListRecipesRequest.SortBy	getSortBy()	The field to sort by.
SortOrder	getSortOrder()	The sort order to use, either ‘asc’ or ‘desc’.
int	hashCode()	Uses getInvocationCallback and getRetryConfiguration to generate a hash.
ListRecipesRequest.Builder	toBuilder()	Return an instance of ListRecipesRequest.Builder that allows you to modify request properties.
String	toString()

Methods inherited from class com.oracle.bmc.requests.BmcRequest

getBody$, getInvocationCallback, getRetryConfiguration, setInvocationCallback, setRetryConfiguration, supportsExpect100Continue

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ListRecipesRequest

public ListRecipesRequest()

Method Detail

getCompartmentId

public String getCompartmentId()

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.

getRecipeType

public RecipeType getRecipeType()

The pipeline’s recipe type.

The default value is ZERO_ETL.

getDisplayName

public String getDisplayName()

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

getOpcRequestId

public String getOpcRequestId()

The client request ID for tracing.

getLimit

public Integer getLimit()

The maximum number of items to return.

getPage

public String getPage()

The page token representing the page at which to start retrieving results.

This is usually retrieved from a previous list call.

getSortOrder

public SortOrder getSortOrder()

The sort order to use, either ‘asc’ or ‘desc’.

getSortBy

public ListRecipesRequest.SortBy getSortBy()

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.

toBuilder

public ListRecipesRequest.Builder toBuilder()

Return an instance of ListRecipesRequest.Builder that allows you to modify request properties.

Returns:

instance of ListRecipesRequest.Builder that allows you to modify request properties.

builder

public static ListRecipesRequest.Builder builder()

Return a new builder for this request object.

Returns:

builder for the request object

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Description copied from class: BmcRequest

Uses getInvocationCallback and getRetryConfiguration to determine if passed request is equal to ‘this’.

Overrides:

equals in class BmcRequest<Void>

hashCode

public int hashCode()

Description copied from class: BmcRequest

Uses getInvocationCallback and getRetryConfiguration to generate a hash.

Overrides:

hashCode in class BmcRequest<Void>