Package com.oracle.bmc.goldengate.requests

Class ListRecipesRequest.Builder

java.lang.Object

com.oracle.bmc.goldengate.requests.ListRecipesRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<ListRecipesRequest,Void>

Enclosing class:

ListRecipesRequest

public static class ListRecipesRequest.Builder
extends Object
implements BmcRequest.Builder<ListRecipesRequest,Void>

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ListRecipesRequest	build()	Build the instance of ListRecipesRequest as configured by this builder
ListRecipesRequest	buildWithoutInvocationCallback()	Build the instance of ListRecipesRequest as configured by this builder
ListRecipesRequest.Builder	compartmentId(String compartmentId)	The OCID of the compartment that contains the work request.
ListRecipesRequest.Builder	copy(ListRecipesRequest o)	Copy method to populate the builder with values from the given instance.
ListRecipesRequest.Builder	displayName(String displayName)	A filter to return only the resources that match the entire ‘displayName’ given.
ListRecipesRequest.Builder	invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)	Set the invocation callback for the request to be built.
ListRecipesRequest.Builder	limit(Integer limit)	The maximum number of items to return.
ListRecipesRequest.Builder	opcRequestId(String opcRequestId)	The client request ID for tracing.
ListRecipesRequest.Builder	page(String page)	The page token representing the page at which to start retrieving results.
ListRecipesRequest.Builder	recipeType(RecipeType recipeType)	The pipeline’s recipe type.
ListRecipesRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration)	Set the retry configuration for the request to be built.
ListRecipesRequest.Builder	sortBy(ListRecipesRequest.SortBy sortBy)	The field to sort by.
ListRecipesRequest.Builder	sortOrder(SortOrder sortOrder)	The sort order to use, either ‘asc’ or ‘desc’.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.oracle.bmc.requests.BmcRequest.Builder

body$

Constructor Detail

Builder

public Builder()

Method Detail

compartmentId

public ListRecipesRequest.Builder compartmentId(String compartmentId)

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.

Parameters:

compartmentId - the value to set

Returns:

this builder instance

recipeType

public ListRecipesRequest.Builder recipeType(RecipeType recipeType)

The pipeline’s recipe type.

The default value is ZERO_ETL.

Parameters:

recipeType - the value to set

Returns:

this builder instance

displayName

public ListRecipesRequest.Builder displayName(String displayName)

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

Parameters:

displayName - the value to set

Returns:

this builder instance

opcRequestId

public ListRecipesRequest.Builder opcRequestId(String opcRequestId)

The client request ID for tracing.

Parameters:

opcRequestId - the value to set

Returns:

this builder instance

limit

public ListRecipesRequest.Builder limit(Integer limit)

The maximum number of items to return.

Parameters:

limit - the value to set

Returns:

this builder instance

page

public ListRecipesRequest.Builder page(String page)

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

This is usually retrieved from a previous list call.

Parameters:

page - the value to set

Returns:

this builder instance

sortOrder

public ListRecipesRequest.Builder sortOrder(SortOrder sortOrder)

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

Parameters:

sortOrder - the value to set

Returns:

this builder instance

sortBy

public ListRecipesRequest.Builder sortBy(ListRecipesRequest.SortBy sortBy)

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.

Parameters:

sortBy - the value to set

Returns:

this builder instance

invocationCallback

public ListRecipesRequest.Builder invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)

Set the invocation callback for the request to be built.

Parameters:

invocationCallback - the invocation callback to be set for the request

Returns:

this builder instance

retryConfiguration

public ListRecipesRequest.Builder retryConfiguration(RetryConfiguration retryConfiguration)

Set the retry configuration for the request to be built.

Parameters:

retryConfiguration - the retry configuration to be used for the request

Returns:

this builder instance

copy

public ListRecipesRequest.Builder copy(ListRecipesRequest o)

Copy method to populate the builder with values from the given instance.

Specified by:

copy in interface BmcRequest.Builder<ListRecipesRequest,Void>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public ListRecipesRequest build()

Build the instance of ListRecipesRequest as configured by this builder

Note that this method takes calls to invocationCallback(com.oracle.bmc.http.client.RequestInterceptor) into account, while the method buildWithoutInvocationCallback() does not.

This is the preferred method to build an instance.

Specified by:

build in interface BmcRequest.Builder<ListRecipesRequest,Void>

Returns:

instance of ListRecipesRequest

buildWithoutInvocationCallback

public ListRecipesRequest buildWithoutInvocationCallback()

Build the instance of ListRecipesRequest as configured by this builder

Note that this method does not take calls to invocationCallback(com.oracle.bmc.http.client.RequestInterceptor) into account, while the method build() does

Returns:

instance of ListRecipesRequest