Package com.oracle.bmc.goldengate.requests

Class ListPipelinesRequest

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

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

    • Constructor Detail

      • ListPipelinesRequest

        public ListPipelinesRequest()

    • 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.

      • getLifecycleState

        public Pipeline.LifecycleState getLifecycleState()
        A filtered list of pipelines to return for a given lifecycleState.

      • getLifecycleSubState

        public PipelineLifecycleSubState getLifecycleSubState()
        A filtered list of pipelines to return for a given lifecycleSubState.

      • getDisplayName

        public String getDisplayName()
        A filter to return only the resources that match the entire ‘displayName’ given.

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

      • getOpcRequestId

        public String getOpcRequestId()
        The client request ID for tracing.

      • builder

        public static ListPipelinesRequest.Builder builder()
        Return a new builder for this request object.
        Returns:
        builder for the request 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>