Package com.oracle.bmc.goldengate.requests

Class ListPipelinesRequest.Builder

java.lang.Object

com.oracle.bmc.goldengate.requests.ListPipelinesRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<ListPipelinesRequest,Void>

Enclosing class:

ListPipelinesRequest

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

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ListPipelinesRequest	build()	Build the instance of ListPipelinesRequest as configured by this builder
ListPipelinesRequest	buildWithoutInvocationCallback()	Build the instance of ListPipelinesRequest as configured by this builder
ListPipelinesRequest.Builder	compartmentId(String compartmentId)	The OCID of the compartment that contains the work request.
ListPipelinesRequest.Builder	copy(ListPipelinesRequest o)	Copy method to populate the builder with values from the given instance.
ListPipelinesRequest.Builder	displayName(String displayName)	A filter to return only the resources that match the entire ‘displayName’ given.
ListPipelinesRequest.Builder	invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)	Set the invocation callback for the request to be built.
ListPipelinesRequest.Builder	lifecycleState(Pipeline.LifecycleState lifecycleState)	A filtered list of pipelines to return for a given lifecycleState.
ListPipelinesRequest.Builder	lifecycleSubState(PipelineLifecycleSubState lifecycleSubState)	A filtered list of pipelines to return for a given lifecycleSubState.
ListPipelinesRequest.Builder	limit(Integer limit)	The maximum number of items to return.
ListPipelinesRequest.Builder	opcRequestId(String opcRequestId)	The client request ID for tracing.
ListPipelinesRequest.Builder	page(String page)	The page token representing the page at which to start retrieving results.
ListPipelinesRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration)	Set the retry configuration for the request to be built.
ListPipelinesRequest.Builder	sortBy(ListPipelinesRequest.SortBy sortBy)	The field to sort by.
ListPipelinesRequest.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 ListPipelinesRequest.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

lifecycleState

public ListPipelinesRequest.Builder lifecycleState(Pipeline.LifecycleState lifecycleState)

A filtered list of pipelines to return for a given lifecycleState.

Parameters:

lifecycleState - the value to set

Returns:

this builder instance

lifecycleSubState

public ListPipelinesRequest.Builder lifecycleSubState(PipelineLifecycleSubState lifecycleSubState)

A filtered list of pipelines to return for a given lifecycleSubState.

Parameters:

lifecycleSubState - the value to set

Returns:

this builder instance

displayName

public ListPipelinesRequest.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

limit

public ListPipelinesRequest.Builder limit(Integer limit)

The maximum number of items to return.

Parameters:

limit - the value to set

Returns:

this builder instance

page

public ListPipelinesRequest.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 ListPipelinesRequest.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 ListPipelinesRequest.Builder sortBy(ListPipelinesRequest.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

opcRequestId

public ListPipelinesRequest.Builder opcRequestId(String opcRequestId)

The client request ID for tracing.

Parameters:

opcRequestId - the value to set

Returns:

this builder instance

invocationCallback

public ListPipelinesRequest.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 ListPipelinesRequest.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 ListPipelinesRequest.Builder copy(ListPipelinesRequest o)

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

Specified by:

copy in interface BmcRequest.Builder<ListPipelinesRequest,Void>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public ListPipelinesRequest build()

Build the instance of ListPipelinesRequest 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<ListPipelinesRequest,Void>

Returns:

instance of ListPipelinesRequest

buildWithoutInvocationCallback

public ListPipelinesRequest buildWithoutInvocationCallback()

Build the instance of ListPipelinesRequest 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 ListPipelinesRequest